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
10205 Lisp data, so make sure we don't use it here. */
10206 eassert (relocatable_string_data_p (m
) != 1);
10208 if (noninteractive_need_newline
)
10209 putc ('\n', stderr
);
10210 noninteractive_need_newline
= 0;
10211 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10212 if (!cursor_in_echo_area
)
10213 fprintf (stderr
, "\n");
10217 else if (INTERACTIVE
)
10219 /* The frame whose minibuffer we're going to display the message on.
10220 It may be larger than the selected frame, so we need
10221 to use its buffer, not the selected frame's buffer. */
10222 Lisp_Object mini_window
;
10223 struct frame
*f
, *sf
= SELECTED_FRAME ();
10225 /* Get the frame containing the minibuffer
10226 that the selected frame is using. */
10227 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10228 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10230 /* Error messages get reported properly by cmd_error, so this must be
10231 just an informative message; if the frame hasn't really been
10232 initialized yet, just toss it. */
10233 if (f
->glyphs_initialized_p
)
10235 Lisp_Object args
[2], msg
;
10236 struct gcpro gcpro1
, gcpro2
;
10238 args
[0] = build_string (m
);
10239 args
[1] = msg
= string
;
10240 GCPRO2 (args
[0], msg
);
10243 msg
= Fformat (2, args
);
10248 message3_nolog (msg
);
10252 /* Print should start at the beginning of the message
10253 buffer next time. */
10254 message_buf_print
= 0;
10260 /* Dump an informative message to the minibuf. If M is 0, clear out
10261 any existing message, and let the mini-buffer text show through. */
10264 vmessage (const char *m
, va_list ap
)
10266 if (noninteractive
)
10270 if (noninteractive_need_newline
)
10271 putc ('\n', stderr
);
10272 noninteractive_need_newline
= 0;
10273 vfprintf (stderr
, m
, ap
);
10274 if (cursor_in_echo_area
== 0)
10275 fprintf (stderr
, "\n");
10279 else if (INTERACTIVE
)
10281 /* The frame whose mini-buffer we're going to display the message
10282 on. It may be larger than the selected frame, so we need to
10283 use its buffer, not the selected frame's buffer. */
10284 Lisp_Object mini_window
;
10285 struct frame
*f
, *sf
= SELECTED_FRAME ();
10287 /* Get the frame containing the mini-buffer
10288 that the selected frame is using. */
10289 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10290 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10292 /* Error messages get reported properly by cmd_error, so this must be
10293 just an informative message; if the frame hasn't really been
10294 initialized yet, just toss it. */
10295 if (f
->glyphs_initialized_p
)
10300 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10301 char *message_buf
= alloca (maxsize
+ 1);
10303 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10305 message3 (make_string (message_buf
, len
));
10310 /* Print should start at the beginning of the message
10311 buffer next time. */
10312 message_buf_print
= 0;
10318 message (const char *m
, ...)
10328 /* The non-logging version of message. */
10331 message_nolog (const char *m
, ...)
10333 Lisp_Object old_log_max
;
10336 old_log_max
= Vmessage_log_max
;
10337 Vmessage_log_max
= Qnil
;
10339 Vmessage_log_max
= old_log_max
;
10345 /* Display the current message in the current mini-buffer. This is
10346 only called from error handlers in process.c, and is not time
10350 update_echo_area (void)
10352 if (!NILP (echo_area_buffer
[0]))
10354 Lisp_Object string
;
10355 string
= Fcurrent_message ();
10361 /* Make sure echo area buffers in `echo_buffers' are live.
10362 If they aren't, make new ones. */
10365 ensure_echo_area_buffers (void)
10369 for (i
= 0; i
< 2; ++i
)
10370 if (!BUFFERP (echo_buffer
[i
])
10371 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10374 Lisp_Object old_buffer
;
10377 old_buffer
= echo_buffer
[i
];
10378 echo_buffer
[i
] = Fget_buffer_create
10379 (make_formatted_string (name
, " *Echo Area %d*", i
));
10380 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10381 /* to force word wrap in echo area -
10382 it was decided to postpone this*/
10383 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10385 for (j
= 0; j
< 2; ++j
)
10386 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10387 echo_area_buffer
[j
] = echo_buffer
[i
];
10392 /* Call FN with args A1..A2 with either the current or last displayed
10393 echo_area_buffer as current buffer.
10395 WHICH zero means use the current message buffer
10396 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10397 from echo_buffer[] and clear it.
10399 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10400 suitable buffer from echo_buffer[] and clear it.
10402 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10403 that the current message becomes the last displayed one, make
10404 choose a suitable buffer for echo_area_buffer[0], and clear it.
10406 Value is what FN returns. */
10409 with_echo_area_buffer (struct window
*w
, int which
,
10410 int (*fn
) (ptrdiff_t, Lisp_Object
),
10411 ptrdiff_t a1
, Lisp_Object a2
)
10413 Lisp_Object buffer
;
10414 int this_one
, the_other
, clear_buffer_p
, rc
;
10415 ptrdiff_t count
= SPECPDL_INDEX ();
10417 /* If buffers aren't live, make new ones. */
10418 ensure_echo_area_buffers ();
10420 clear_buffer_p
= 0;
10423 this_one
= 0, the_other
= 1;
10424 else if (which
> 0)
10425 this_one
= 1, the_other
= 0;
10428 this_one
= 0, the_other
= 1;
10429 clear_buffer_p
= true;
10431 /* We need a fresh one in case the current echo buffer equals
10432 the one containing the last displayed echo area message. */
10433 if (!NILP (echo_area_buffer
[this_one
])
10434 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10435 echo_area_buffer
[this_one
] = Qnil
;
10438 /* Choose a suitable buffer from echo_buffer[] is we don't
10440 if (NILP (echo_area_buffer
[this_one
]))
10442 echo_area_buffer
[this_one
]
10443 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10444 ? echo_buffer
[the_other
]
10445 : echo_buffer
[this_one
]);
10446 clear_buffer_p
= true;
10449 buffer
= echo_area_buffer
[this_one
];
10451 /* Don't get confused by reusing the buffer used for echoing
10452 for a different purpose. */
10453 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10456 record_unwind_protect (unwind_with_echo_area_buffer
,
10457 with_echo_area_buffer_unwind_data (w
));
10459 /* Make the echo area buffer current. Note that for display
10460 purposes, it is not necessary that the displayed window's buffer
10461 == current_buffer, except for text property lookup. So, let's
10462 only set that buffer temporarily here without doing a full
10463 Fset_window_buffer. We must also change w->pointm, though,
10464 because otherwise an assertions in unshow_buffer fails, and Emacs
10466 set_buffer_internal_1 (XBUFFER (buffer
));
10469 wset_buffer (w
, buffer
);
10470 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10473 bset_undo_list (current_buffer
, Qt
);
10474 bset_read_only (current_buffer
, Qnil
);
10475 specbind (Qinhibit_read_only
, Qt
);
10476 specbind (Qinhibit_modification_hooks
, Qt
);
10478 if (clear_buffer_p
&& Z
> BEG
)
10479 del_range (BEG
, Z
);
10481 eassert (BEGV
>= BEG
);
10482 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10486 eassert (BEGV
>= BEG
);
10487 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10489 unbind_to (count
, Qnil
);
10494 /* Save state that should be preserved around the call to the function
10495 FN called in with_echo_area_buffer. */
10498 with_echo_area_buffer_unwind_data (struct window
*w
)
10501 Lisp_Object vector
, tmp
;
10503 /* Reduce consing by keeping one vector in
10504 Vwith_echo_area_save_vector. */
10505 vector
= Vwith_echo_area_save_vector
;
10506 Vwith_echo_area_save_vector
= Qnil
;
10509 vector
= Fmake_vector (make_number (9), Qnil
);
10511 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10512 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10513 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10517 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10518 ASET (vector
, i
, w
->contents
); ++i
;
10519 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10520 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10521 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10522 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10527 for (; i
< end
; ++i
)
10528 ASET (vector
, i
, Qnil
);
10531 eassert (i
== ASIZE (vector
));
10536 /* Restore global state from VECTOR which was created by
10537 with_echo_area_buffer_unwind_data. */
10540 unwind_with_echo_area_buffer (Lisp_Object vector
)
10542 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10543 Vdeactivate_mark
= AREF (vector
, 1);
10544 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10546 if (WINDOWP (AREF (vector
, 3)))
10549 Lisp_Object buffer
;
10551 w
= XWINDOW (AREF (vector
, 3));
10552 buffer
= AREF (vector
, 4);
10554 wset_buffer (w
, buffer
);
10555 set_marker_both (w
->pointm
, buffer
,
10556 XFASTINT (AREF (vector
, 5)),
10557 XFASTINT (AREF (vector
, 6)));
10558 set_marker_both (w
->start
, buffer
,
10559 XFASTINT (AREF (vector
, 7)),
10560 XFASTINT (AREF (vector
, 8)));
10563 Vwith_echo_area_save_vector
= vector
;
10567 /* Set up the echo area for use by print functions. MULTIBYTE_P
10568 non-zero means we will print multibyte. */
10571 setup_echo_area_for_printing (int multibyte_p
)
10573 /* If we can't find an echo area any more, exit. */
10574 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10575 Fkill_emacs (Qnil
);
10577 ensure_echo_area_buffers ();
10579 if (!message_buf_print
)
10581 /* A message has been output since the last time we printed.
10582 Choose a fresh echo area buffer. */
10583 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10584 echo_area_buffer
[0] = echo_buffer
[1];
10586 echo_area_buffer
[0] = echo_buffer
[0];
10588 /* Switch to that buffer and clear it. */
10589 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10590 bset_truncate_lines (current_buffer
, Qnil
);
10594 ptrdiff_t count
= SPECPDL_INDEX ();
10595 specbind (Qinhibit_read_only
, Qt
);
10596 /* Note that undo recording is always disabled. */
10597 del_range (BEG
, Z
);
10598 unbind_to (count
, Qnil
);
10600 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10602 /* Set up the buffer for the multibyteness we need. */
10604 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10605 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10607 /* Raise the frame containing the echo area. */
10608 if (minibuffer_auto_raise
)
10610 struct frame
*sf
= SELECTED_FRAME ();
10611 Lisp_Object mini_window
;
10612 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10613 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10616 message_log_maybe_newline ();
10617 message_buf_print
= 1;
10621 if (NILP (echo_area_buffer
[0]))
10623 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10624 echo_area_buffer
[0] = echo_buffer
[1];
10626 echo_area_buffer
[0] = echo_buffer
[0];
10629 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10631 /* Someone switched buffers between print requests. */
10632 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10633 bset_truncate_lines (current_buffer
, Qnil
);
10639 /* Display an echo area message in window W. Value is non-zero if W's
10640 height is changed. If display_last_displayed_message_p is
10641 non-zero, display the message that was last displayed, otherwise
10642 display the current message. */
10645 display_echo_area (struct window
*w
)
10647 int i
, no_message_p
, window_height_changed_p
;
10649 /* Temporarily disable garbage collections while displaying the echo
10650 area. This is done because a GC can print a message itself.
10651 That message would modify the echo area buffer's contents while a
10652 redisplay of the buffer is going on, and seriously confuse
10654 ptrdiff_t count
= inhibit_garbage_collection ();
10656 /* If there is no message, we must call display_echo_area_1
10657 nevertheless because it resizes the window. But we will have to
10658 reset the echo_area_buffer in question to nil at the end because
10659 with_echo_area_buffer will sets it to an empty buffer. */
10660 i
= display_last_displayed_message_p
? 1 : 0;
10661 no_message_p
= NILP (echo_area_buffer
[i
]);
10663 window_height_changed_p
10664 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10665 display_echo_area_1
,
10666 (intptr_t) w
, Qnil
);
10669 echo_area_buffer
[i
] = Qnil
;
10671 unbind_to (count
, Qnil
);
10672 return window_height_changed_p
;
10676 /* Helper for display_echo_area. Display the current buffer which
10677 contains the current echo area message in window W, a mini-window,
10678 a pointer to which is passed in A1. A2..A4 are currently not used.
10679 Change the height of W so that all of the message is displayed.
10680 Value is non-zero if height of W was changed. */
10683 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10686 struct window
*w
= (struct window
*) i1
;
10687 Lisp_Object window
;
10688 struct text_pos start
;
10689 int window_height_changed_p
= 0;
10691 /* Do this before displaying, so that we have a large enough glyph
10692 matrix for the display. If we can't get enough space for the
10693 whole text, display the last N lines. That works by setting w->start. */
10694 window_height_changed_p
= resize_mini_window (w
, 0);
10696 /* Use the starting position chosen by resize_mini_window. */
10697 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10700 clear_glyph_matrix (w
->desired_matrix
);
10701 XSETWINDOW (window
, w
);
10702 try_window (window
, start
, 0);
10704 return window_height_changed_p
;
10708 /* Resize the echo area window to exactly the size needed for the
10709 currently displayed message, if there is one. If a mini-buffer
10710 is active, don't shrink it. */
10713 resize_echo_area_exactly (void)
10715 if (BUFFERP (echo_area_buffer
[0])
10716 && WINDOWP (echo_area_window
))
10718 struct window
*w
= XWINDOW (echo_area_window
);
10719 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10720 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10721 (intptr_t) w
, resize_exactly
);
10724 windows_or_buffers_changed
= 42;
10725 update_mode_lines
= 30;
10726 redisplay_internal ();
10732 /* Callback function for with_echo_area_buffer, when used from
10733 resize_echo_area_exactly. A1 contains a pointer to the window to
10734 resize, EXACTLY non-nil means resize the mini-window exactly to the
10735 size of the text displayed. A3 and A4 are not used. Value is what
10736 resize_mini_window returns. */
10739 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10742 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10746 /* Resize mini-window W to fit the size of its contents. EXACT_P
10747 means size the window exactly to the size needed. Otherwise, it's
10748 only enlarged until W's buffer is empty.
10750 Set W->start to the right place to begin display. If the whole
10751 contents fit, start at the beginning. Otherwise, start so as
10752 to make the end of the contents appear. This is particularly
10753 important for y-or-n-p, but seems desirable generally.
10755 Value is non-zero if the window height has been changed. */
10758 resize_mini_window (struct window
*w
, int exact_p
)
10760 struct frame
*f
= XFRAME (w
->frame
);
10761 int window_height_changed_p
= 0;
10763 eassert (MINI_WINDOW_P (w
));
10765 /* By default, start display at the beginning. */
10766 set_marker_both (w
->start
, w
->contents
,
10767 BUF_BEGV (XBUFFER (w
->contents
)),
10768 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10770 /* Don't resize windows while redisplaying a window; it would
10771 confuse redisplay functions when the size of the window they are
10772 displaying changes from under them. Such a resizing can happen,
10773 for instance, when which-func prints a long message while
10774 we are running fontification-functions. We're running these
10775 functions with safe_call which binds inhibit-redisplay to t. */
10776 if (!NILP (Vinhibit_redisplay
))
10779 /* Nil means don't try to resize. */
10780 if (NILP (Vresize_mini_windows
)
10781 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10784 if (!FRAME_MINIBUF_ONLY_P (f
))
10787 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10788 + WINDOW_PIXEL_HEIGHT (w
));
10789 int unit
= FRAME_LINE_HEIGHT (f
);
10790 int height
, max_height
;
10791 struct text_pos start
;
10792 struct buffer
*old_current_buffer
= NULL
;
10794 if (current_buffer
!= XBUFFER (w
->contents
))
10796 old_current_buffer
= current_buffer
;
10797 set_buffer_internal (XBUFFER (w
->contents
));
10800 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10802 /* Compute the max. number of lines specified by the user. */
10803 if (FLOATP (Vmax_mini_window_height
))
10804 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10805 else if (INTEGERP (Vmax_mini_window_height
))
10806 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10808 max_height
= total_height
/ 4;
10810 /* Correct that max. height if it's bogus. */
10811 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10813 /* Find out the height of the text in the window. */
10814 if (it
.line_wrap
== TRUNCATE
)
10819 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10820 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10821 height
= it
.current_y
+ last_height
;
10823 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10824 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10827 /* Compute a suitable window start. */
10828 if (height
> max_height
)
10830 height
= (max_height
/ unit
) * unit
;
10831 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10832 move_it_vertically_backward (&it
, height
- unit
);
10833 start
= it
.current
.pos
;
10836 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10837 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10839 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10841 /* Let it grow only, until we display an empty message, in which
10842 case the window shrinks again. */
10843 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10845 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10847 FRAME_WINDOWS_FROZEN (f
) = 1;
10848 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10849 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10851 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10852 && (exact_p
|| BEGV
== ZV
))
10854 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10856 FRAME_WINDOWS_FROZEN (f
) = 0;
10857 shrink_mini_window (w
, 1);
10858 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10863 /* Always resize to exact size needed. */
10864 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10866 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10868 FRAME_WINDOWS_FROZEN (f
) = 1;
10869 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10870 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10872 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10874 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10876 FRAME_WINDOWS_FROZEN (f
) = 0;
10877 shrink_mini_window (w
, 1);
10881 FRAME_WINDOWS_FROZEN (f
) = 1;
10882 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10885 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10889 if (old_current_buffer
)
10890 set_buffer_internal (old_current_buffer
);
10893 return window_height_changed_p
;
10897 /* Value is the current message, a string, or nil if there is no
10898 current message. */
10901 current_message (void)
10905 if (!BUFFERP (echo_area_buffer
[0]))
10909 with_echo_area_buffer (0, 0, current_message_1
,
10910 (intptr_t) &msg
, Qnil
);
10912 echo_area_buffer
[0] = Qnil
;
10920 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10923 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10926 *msg
= make_buffer_string (BEG
, Z
, 1);
10933 /* Push the current message on Vmessage_stack for later restoration
10934 by restore_message. Value is non-zero if the current message isn't
10935 empty. This is a relatively infrequent operation, so it's not
10936 worth optimizing. */
10939 push_message (void)
10941 Lisp_Object msg
= current_message ();
10942 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10943 return STRINGP (msg
);
10947 /* Restore message display from the top of Vmessage_stack. */
10950 restore_message (void)
10952 eassert (CONSP (Vmessage_stack
));
10953 message3_nolog (XCAR (Vmessage_stack
));
10957 /* Handler for unwind-protect calling pop_message. */
10960 pop_message_unwind (void)
10962 /* Pop the top-most entry off Vmessage_stack. */
10963 eassert (CONSP (Vmessage_stack
));
10964 Vmessage_stack
= XCDR (Vmessage_stack
);
10968 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10969 exits. If the stack is not empty, we have a missing pop_message
10973 check_message_stack (void)
10975 if (!NILP (Vmessage_stack
))
10980 /* Truncate to NCHARS what will be displayed in the echo area the next
10981 time we display it---but don't redisplay it now. */
10984 truncate_echo_area (ptrdiff_t nchars
)
10987 echo_area_buffer
[0] = Qnil
;
10988 else if (!noninteractive
10990 && !NILP (echo_area_buffer
[0]))
10992 struct frame
*sf
= SELECTED_FRAME ();
10993 /* Error messages get reported properly by cmd_error, so this must be
10994 just an informative message; if the frame hasn't really been
10995 initialized yet, just toss it. */
10996 if (sf
->glyphs_initialized_p
)
10997 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11002 /* Helper function for truncate_echo_area. Truncate the current
11003 message to at most NCHARS characters. */
11006 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11008 if (BEG
+ nchars
< Z
)
11009 del_range (BEG
+ nchars
, Z
);
11011 echo_area_buffer
[0] = Qnil
;
11015 /* Set the current message to STRING. */
11018 set_message (Lisp_Object string
)
11020 eassert (STRINGP (string
));
11022 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11024 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11025 message_buf_print
= 0;
11026 help_echo_showing_p
= 0;
11028 if (STRINGP (Vdebug_on_message
)
11029 && STRINGP (string
)
11030 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11031 call_debugger (list2 (Qerror
, string
));
11035 /* Helper function for set_message. First argument is ignored and second
11036 argument has the same meaning as for set_message.
11037 This function is called with the echo area buffer being current. */
11040 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11042 eassert (STRINGP (string
));
11044 /* Change multibyteness of the echo buffer appropriately. */
11045 if (message_enable_multibyte
11046 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11047 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11049 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11050 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11051 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11053 /* Insert new message at BEG. */
11054 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11056 /* This function takes care of single/multibyte conversion.
11057 We just have to ensure that the echo area buffer has the right
11058 setting of enable_multibyte_characters. */
11059 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11065 /* Clear messages. CURRENT_P non-zero means clear the current
11066 message. LAST_DISPLAYED_P non-zero means clear the message
11070 clear_message (bool current_p
, bool last_displayed_p
)
11074 echo_area_buffer
[0] = Qnil
;
11075 message_cleared_p
= true;
11078 if (last_displayed_p
)
11079 echo_area_buffer
[1] = Qnil
;
11081 message_buf_print
= 0;
11084 /* Clear garbaged frames.
11086 This function is used where the old redisplay called
11087 redraw_garbaged_frames which in turn called redraw_frame which in
11088 turn called clear_frame. The call to clear_frame was a source of
11089 flickering. I believe a clear_frame is not necessary. It should
11090 suffice in the new redisplay to invalidate all current matrices,
11091 and ensure a complete redisplay of all windows. */
11094 clear_garbaged_frames (void)
11096 if (frame_garbaged
)
11098 Lisp_Object tail
, frame
;
11100 FOR_EACH_FRAME (tail
, frame
)
11102 struct frame
*f
= XFRAME (frame
);
11104 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11109 clear_current_matrices (f
);
11110 fset_redisplay (f
);
11111 f
->garbaged
= false;
11112 f
->resized_p
= false;
11116 frame_garbaged
= false;
11121 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11122 is non-zero update selected_frame. Value is non-zero if the
11123 mini-windows height has been changed. */
11126 echo_area_display (int update_frame_p
)
11128 Lisp_Object mini_window
;
11131 int window_height_changed_p
= 0;
11132 struct frame
*sf
= SELECTED_FRAME ();
11134 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11135 w
= XWINDOW (mini_window
);
11136 f
= XFRAME (WINDOW_FRAME (w
));
11138 /* Don't display if frame is invisible or not yet initialized. */
11139 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11142 #ifdef HAVE_WINDOW_SYSTEM
11143 /* When Emacs starts, selected_frame may be the initial terminal
11144 frame. If we let this through, a message would be displayed on
11146 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11148 #endif /* HAVE_WINDOW_SYSTEM */
11150 /* Redraw garbaged frames. */
11151 clear_garbaged_frames ();
11153 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11155 echo_area_window
= mini_window
;
11156 window_height_changed_p
= display_echo_area (w
);
11157 w
->must_be_updated_p
= true;
11159 /* Update the display, unless called from redisplay_internal.
11160 Also don't update the screen during redisplay itself. The
11161 update will happen at the end of redisplay, and an update
11162 here could cause confusion. */
11163 if (update_frame_p
&& !redisplaying_p
)
11167 /* If the display update has been interrupted by pending
11168 input, update mode lines in the frame. Due to the
11169 pending input, it might have been that redisplay hasn't
11170 been called, so that mode lines above the echo area are
11171 garbaged. This looks odd, so we prevent it here. */
11172 if (!display_completed
)
11173 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11175 if (window_height_changed_p
11176 /* Don't do this if Emacs is shutting down. Redisplay
11177 needs to run hooks. */
11178 && !NILP (Vrun_hooks
))
11180 /* Must update other windows. Likewise as in other
11181 cases, don't let this update be interrupted by
11183 ptrdiff_t count
= SPECPDL_INDEX ();
11184 specbind (Qredisplay_dont_pause
, Qt
);
11185 windows_or_buffers_changed
= 44;
11186 redisplay_internal ();
11187 unbind_to (count
, Qnil
);
11189 else if (FRAME_WINDOW_P (f
) && n
== 0)
11191 /* Window configuration is the same as before.
11192 Can do with a display update of the echo area,
11193 unless we displayed some mode lines. */
11194 update_single_window (w
, 1);
11198 update_frame (f
, 1, 1);
11200 /* If cursor is in the echo area, make sure that the next
11201 redisplay displays the minibuffer, so that the cursor will
11202 be replaced with what the minibuffer wants. */
11203 if (cursor_in_echo_area
)
11204 wset_redisplay (XWINDOW (mini_window
));
11207 else if (!EQ (mini_window
, selected_window
))
11208 wset_redisplay (XWINDOW (mini_window
));
11210 /* Last displayed message is now the current message. */
11211 echo_area_buffer
[1] = echo_area_buffer
[0];
11212 /* Inform read_char that we're not echoing. */
11213 echo_message_buffer
= Qnil
;
11215 /* Prevent redisplay optimization in redisplay_internal by resetting
11216 this_line_start_pos. This is done because the mini-buffer now
11217 displays the message instead of its buffer text. */
11218 if (EQ (mini_window
, selected_window
))
11219 CHARPOS (this_line_start_pos
) = 0;
11221 return window_height_changed_p
;
11224 /* Nonzero if W's buffer was changed but not saved. */
11227 window_buffer_changed (struct window
*w
)
11229 struct buffer
*b
= XBUFFER (w
->contents
);
11231 eassert (BUFFER_LIVE_P (b
));
11233 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11236 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11239 mode_line_update_needed (struct window
*w
)
11241 return (w
->column_number_displayed
!= -1
11242 && !(PT
== w
->last_point
&& !window_outdated (w
))
11243 && (w
->column_number_displayed
!= current_column ()));
11246 /* Nonzero if window start of W is frozen and may not be changed during
11250 window_frozen_p (struct window
*w
)
11252 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11254 Lisp_Object window
;
11256 XSETWINDOW (window
, w
);
11257 if (MINI_WINDOW_P (w
))
11259 else if (EQ (window
, selected_window
))
11261 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11262 && EQ (window
, Vminibuf_scroll_window
))
11263 /* This special window can't be frozen too. */
11271 /***********************************************************************
11272 Mode Lines and Frame Titles
11273 ***********************************************************************/
11275 /* A buffer for constructing non-propertized mode-line strings and
11276 frame titles in it; allocated from the heap in init_xdisp and
11277 resized as needed in store_mode_line_noprop_char. */
11279 static char *mode_line_noprop_buf
;
11281 /* The buffer's end, and a current output position in it. */
11283 static char *mode_line_noprop_buf_end
;
11284 static char *mode_line_noprop_ptr
;
11286 #define MODE_LINE_NOPROP_LEN(start) \
11287 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11290 MODE_LINE_DISPLAY
= 0,
11294 } mode_line_target
;
11296 /* Alist that caches the results of :propertize.
11297 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11298 static Lisp_Object mode_line_proptrans_alist
;
11300 /* List of strings making up the mode-line. */
11301 static Lisp_Object mode_line_string_list
;
11303 /* Base face property when building propertized mode line string. */
11304 static Lisp_Object mode_line_string_face
;
11305 static Lisp_Object mode_line_string_face_prop
;
11308 /* Unwind data for mode line strings */
11310 static Lisp_Object Vmode_line_unwind_vector
;
11313 format_mode_line_unwind_data (struct frame
*target_frame
,
11314 struct buffer
*obuf
,
11316 int save_proptrans
)
11318 Lisp_Object vector
, tmp
;
11320 /* Reduce consing by keeping one vector in
11321 Vwith_echo_area_save_vector. */
11322 vector
= Vmode_line_unwind_vector
;
11323 Vmode_line_unwind_vector
= Qnil
;
11326 vector
= Fmake_vector (make_number (10), Qnil
);
11328 ASET (vector
, 0, make_number (mode_line_target
));
11329 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11330 ASET (vector
, 2, mode_line_string_list
);
11331 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11332 ASET (vector
, 4, mode_line_string_face
);
11333 ASET (vector
, 5, mode_line_string_face_prop
);
11336 XSETBUFFER (tmp
, obuf
);
11339 ASET (vector
, 6, tmp
);
11340 ASET (vector
, 7, owin
);
11343 /* Similarly to `with-selected-window', if the operation selects
11344 a window on another frame, we must restore that frame's
11345 selected window, and (for a tty) the top-frame. */
11346 ASET (vector
, 8, target_frame
->selected_window
);
11347 if (FRAME_TERMCAP_P (target_frame
))
11348 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11355 unwind_format_mode_line (Lisp_Object vector
)
11357 Lisp_Object old_window
= AREF (vector
, 7);
11358 Lisp_Object target_frame_window
= AREF (vector
, 8);
11359 Lisp_Object old_top_frame
= AREF (vector
, 9);
11361 mode_line_target
= XINT (AREF (vector
, 0));
11362 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11363 mode_line_string_list
= AREF (vector
, 2);
11364 if (! EQ (AREF (vector
, 3), Qt
))
11365 mode_line_proptrans_alist
= AREF (vector
, 3);
11366 mode_line_string_face
= AREF (vector
, 4);
11367 mode_line_string_face_prop
= AREF (vector
, 5);
11369 /* Select window before buffer, since it may change the buffer. */
11370 if (!NILP (old_window
))
11372 /* If the operation that we are unwinding had selected a window
11373 on a different frame, reset its frame-selected-window. For a
11374 text terminal, reset its top-frame if necessary. */
11375 if (!NILP (target_frame_window
))
11378 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11380 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11381 Fselect_window (target_frame_window
, Qt
);
11383 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11384 Fselect_frame (old_top_frame
, Qt
);
11387 Fselect_window (old_window
, Qt
);
11390 if (!NILP (AREF (vector
, 6)))
11392 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11393 ASET (vector
, 6, Qnil
);
11396 Vmode_line_unwind_vector
= vector
;
11400 /* Store a single character C for the frame title in mode_line_noprop_buf.
11401 Re-allocate mode_line_noprop_buf if necessary. */
11404 store_mode_line_noprop_char (char c
)
11406 /* If output position has reached the end of the allocated buffer,
11407 increase the buffer's size. */
11408 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11410 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11411 ptrdiff_t size
= len
;
11412 mode_line_noprop_buf
=
11413 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11414 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11415 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11418 *mode_line_noprop_ptr
++ = c
;
11422 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11423 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11424 characters that yield more columns than PRECISION; PRECISION <= 0
11425 means copy the whole string. Pad with spaces until FIELD_WIDTH
11426 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11427 pad. Called from display_mode_element when it is used to build a
11431 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11433 const unsigned char *str
= (const unsigned char *) string
;
11435 ptrdiff_t dummy
, nbytes
;
11437 /* Copy at most PRECISION chars from STR. */
11438 nbytes
= strlen (string
);
11439 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11441 store_mode_line_noprop_char (*str
++);
11443 /* Fill up with spaces until FIELD_WIDTH reached. */
11444 while (field_width
> 0
11445 && n
< field_width
)
11447 store_mode_line_noprop_char (' ');
11454 /***********************************************************************
11456 ***********************************************************************/
11458 #ifdef HAVE_WINDOW_SYSTEM
11460 /* Set the title of FRAME, if it has changed. The title format is
11461 Vicon_title_format if FRAME is iconified, otherwise it is
11462 frame_title_format. */
11465 x_consider_frame_title (Lisp_Object frame
)
11467 struct frame
*f
= XFRAME (frame
);
11469 if (FRAME_WINDOW_P (f
)
11470 || FRAME_MINIBUF_ONLY_P (f
)
11471 || f
->explicit_name
)
11473 /* Do we have more than one visible frame on this X display? */
11474 Lisp_Object tail
, other_frame
, fmt
;
11475 ptrdiff_t title_start
;
11479 ptrdiff_t count
= SPECPDL_INDEX ();
11481 FOR_EACH_FRAME (tail
, other_frame
)
11483 struct frame
*tf
= XFRAME (other_frame
);
11486 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11487 && !FRAME_MINIBUF_ONLY_P (tf
)
11488 && !EQ (other_frame
, tip_frame
)
11489 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11493 /* Set global variable indicating that multiple frames exist. */
11494 multiple_frames
= CONSP (tail
);
11496 /* Switch to the buffer of selected window of the frame. Set up
11497 mode_line_target so that display_mode_element will output into
11498 mode_line_noprop_buf; then display the title. */
11499 record_unwind_protect (unwind_format_mode_line
,
11500 format_mode_line_unwind_data
11501 (f
, current_buffer
, selected_window
, 0));
11503 Fselect_window (f
->selected_window
, Qt
);
11504 set_buffer_internal_1
11505 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11506 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11508 mode_line_target
= MODE_LINE_TITLE
;
11509 title_start
= MODE_LINE_NOPROP_LEN (0);
11510 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11511 NULL
, DEFAULT_FACE_ID
);
11512 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11513 len
= MODE_LINE_NOPROP_LEN (title_start
);
11514 title
= mode_line_noprop_buf
+ title_start
;
11515 unbind_to (count
, Qnil
);
11517 /* Set the title only if it's changed. This avoids consing in
11518 the common case where it hasn't. (If it turns out that we've
11519 already wasted too much time by walking through the list with
11520 display_mode_element, then we might need to optimize at a
11521 higher level than this.) */
11522 if (! STRINGP (f
->name
)
11523 || SBYTES (f
->name
) != len
11524 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11525 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11529 #endif /* not HAVE_WINDOW_SYSTEM */
11532 /***********************************************************************
11534 ***********************************************************************/
11536 /* Non-zero if we will not redisplay all visible windows. */
11537 #define REDISPLAY_SOME_P() \
11538 ((windows_or_buffers_changed == 0 \
11539 || windows_or_buffers_changed == REDISPLAY_SOME) \
11540 && (update_mode_lines == 0 \
11541 || update_mode_lines == REDISPLAY_SOME))
11543 /* Prepare for redisplay by updating menu-bar item lists when
11544 appropriate. This can call eval. */
11547 prepare_menu_bars (void)
11549 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11550 bool some_windows
= REDISPLAY_SOME_P ();
11551 struct gcpro gcpro1
, gcpro2
;
11552 Lisp_Object tooltip_frame
;
11554 #ifdef HAVE_WINDOW_SYSTEM
11555 tooltip_frame
= tip_frame
;
11557 tooltip_frame
= Qnil
;
11560 if (FUNCTIONP (Vpre_redisplay_function
))
11562 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11563 if (all_windows
&& some_windows
)
11565 Lisp_Object ws
= window_list ();
11566 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11568 Lisp_Object
this = XCAR (ws
);
11569 struct window
*w
= XWINDOW (this);
11571 || XFRAME (w
->frame
)->redisplay
11572 || XBUFFER (w
->contents
)->text
->redisplay
)
11574 windows
= Fcons (this, windows
);
11578 safe__call1 (true, Vpre_redisplay_function
, windows
);
11581 /* Update all frame titles based on their buffer names, etc. We do
11582 this before the menu bars so that the buffer-menu will show the
11583 up-to-date frame titles. */
11584 #ifdef HAVE_WINDOW_SYSTEM
11587 Lisp_Object tail
, frame
;
11589 FOR_EACH_FRAME (tail
, frame
)
11591 struct frame
*f
= XFRAME (frame
);
11592 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11596 && !XBUFFER (w
->contents
)->text
->redisplay
)
11599 if (!EQ (frame
, tooltip_frame
)
11600 && (FRAME_ICONIFIED_P (f
)
11601 || FRAME_VISIBLE_P (f
) == 1
11602 /* Exclude TTY frames that are obscured because they
11603 are not the top frame on their console. This is
11604 because x_consider_frame_title actually switches
11605 to the frame, which for TTY frames means it is
11606 marked as garbaged, and will be completely
11607 redrawn on the next redisplay cycle. This causes
11608 TTY frames to be completely redrawn, when there
11609 are more than one of them, even though nothing
11610 should be changed on display. */
11611 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11612 x_consider_frame_title (frame
);
11615 #endif /* HAVE_WINDOW_SYSTEM */
11617 /* Update the menu bar item lists, if appropriate. This has to be
11618 done before any actual redisplay or generation of display lines. */
11622 Lisp_Object tail
, frame
;
11623 ptrdiff_t count
= SPECPDL_INDEX ();
11624 /* 1 means that update_menu_bar has run its hooks
11625 so any further calls to update_menu_bar shouldn't do so again. */
11626 int menu_bar_hooks_run
= 0;
11628 record_unwind_save_match_data ();
11630 FOR_EACH_FRAME (tail
, frame
)
11632 struct frame
*f
= XFRAME (frame
);
11633 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11635 /* Ignore tooltip frame. */
11636 if (EQ (frame
, tooltip_frame
))
11642 && !XBUFFER (w
->contents
)->text
->redisplay
)
11645 /* If a window on this frame changed size, report that to
11646 the user and clear the size-change flag. */
11647 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11649 Lisp_Object functions
;
11651 /* Clear flag first in case we get an error below. */
11652 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11653 functions
= Vwindow_size_change_functions
;
11654 GCPRO2 (tail
, functions
);
11656 while (CONSP (functions
))
11658 if (!EQ (XCAR (functions
), Qt
))
11659 call1 (XCAR (functions
), frame
);
11660 functions
= XCDR (functions
);
11666 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11667 #ifdef HAVE_WINDOW_SYSTEM
11668 update_tool_bar (f
, 0);
11671 if (windows_or_buffers_changed
11674 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11679 unbind_to (count
, Qnil
);
11683 struct frame
*sf
= SELECTED_FRAME ();
11684 update_menu_bar (sf
, 1, 0);
11685 #ifdef HAVE_WINDOW_SYSTEM
11686 update_tool_bar (sf
, 1);
11692 /* Update the menu bar item list for frame F. This has to be done
11693 before we start to fill in any display lines, because it can call
11696 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11698 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11699 already ran the menu bar hooks for this redisplay, so there
11700 is no need to run them again. The return value is the
11701 updated value of this flag, to pass to the next call. */
11704 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11706 Lisp_Object window
;
11707 register struct window
*w
;
11709 /* If called recursively during a menu update, do nothing. This can
11710 happen when, for instance, an activate-menubar-hook causes a
11712 if (inhibit_menubar_update
)
11715 window
= FRAME_SELECTED_WINDOW (f
);
11716 w
= XWINDOW (window
);
11718 if (FRAME_WINDOW_P (f
)
11720 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11721 || defined (HAVE_NS) || defined (USE_GTK)
11722 FRAME_EXTERNAL_MENU_BAR (f
)
11724 FRAME_MENU_BAR_LINES (f
) > 0
11726 : FRAME_MENU_BAR_LINES (f
) > 0)
11728 /* If the user has switched buffers or windows, we need to
11729 recompute to reflect the new bindings. But we'll
11730 recompute when update_mode_lines is set too; that means
11731 that people can use force-mode-line-update to request
11732 that the menu bar be recomputed. The adverse effect on
11733 the rest of the redisplay algorithm is about the same as
11734 windows_or_buffers_changed anyway. */
11735 if (windows_or_buffers_changed
11736 /* This used to test w->update_mode_line, but we believe
11737 there is no need to recompute the menu in that case. */
11738 || update_mode_lines
11739 || window_buffer_changed (w
))
11741 struct buffer
*prev
= current_buffer
;
11742 ptrdiff_t count
= SPECPDL_INDEX ();
11744 specbind (Qinhibit_menubar_update
, Qt
);
11746 set_buffer_internal_1 (XBUFFER (w
->contents
));
11747 if (save_match_data
)
11748 record_unwind_save_match_data ();
11749 if (NILP (Voverriding_local_map_menu_flag
))
11751 specbind (Qoverriding_terminal_local_map
, Qnil
);
11752 specbind (Qoverriding_local_map
, Qnil
);
11757 /* Run the Lucid hook. */
11758 safe_run_hooks (Qactivate_menubar_hook
);
11760 /* If it has changed current-menubar from previous value,
11761 really recompute the menu-bar from the value. */
11762 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11763 call0 (Qrecompute_lucid_menubar
);
11765 safe_run_hooks (Qmenu_bar_update_hook
);
11770 XSETFRAME (Vmenu_updating_frame
, f
);
11771 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11773 /* Redisplay the menu bar in case we changed it. */
11774 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11775 || defined (HAVE_NS) || defined (USE_GTK)
11776 if (FRAME_WINDOW_P (f
))
11778 #if defined (HAVE_NS)
11779 /* All frames on Mac OS share the same menubar. So only
11780 the selected frame should be allowed to set it. */
11781 if (f
== SELECTED_FRAME ())
11783 set_frame_menubar (f
, 0, 0);
11786 /* On a terminal screen, the menu bar is an ordinary screen
11787 line, and this makes it get updated. */
11788 w
->update_mode_line
= 1;
11789 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11790 /* In the non-toolkit version, the menu bar is an ordinary screen
11791 line, and this makes it get updated. */
11792 w
->update_mode_line
= 1;
11793 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11795 unbind_to (count
, Qnil
);
11796 set_buffer_internal_1 (prev
);
11803 /***********************************************************************
11805 ***********************************************************************/
11807 #ifdef HAVE_WINDOW_SYSTEM
11809 /* Tool-bar item index of the item on which a mouse button was pressed
11812 int last_tool_bar_item
;
11814 /* Select `frame' temporarily without running all the code in
11816 FIXME: Maybe do_switch_frame should be trimmed down similarly
11817 when `norecord' is set. */
11819 fast_set_selected_frame (Lisp_Object frame
)
11821 if (!EQ (selected_frame
, frame
))
11823 selected_frame
= frame
;
11824 selected_window
= XFRAME (frame
)->selected_window
;
11828 /* Update the tool-bar item list for frame F. This has to be done
11829 before we start to fill in any display lines. Called from
11830 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11831 and restore it here. */
11834 update_tool_bar (struct frame
*f
, int save_match_data
)
11836 #if defined (USE_GTK) || defined (HAVE_NS)
11837 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11839 int do_update
= (WINDOWP (f
->tool_bar_window
)
11840 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11845 Lisp_Object window
;
11848 window
= FRAME_SELECTED_WINDOW (f
);
11849 w
= XWINDOW (window
);
11851 /* If the user has switched buffers or windows, we need to
11852 recompute to reflect the new bindings. But we'll
11853 recompute when update_mode_lines is set too; that means
11854 that people can use force-mode-line-update to request
11855 that the menu bar be recomputed. The adverse effect on
11856 the rest of the redisplay algorithm is about the same as
11857 windows_or_buffers_changed anyway. */
11858 if (windows_or_buffers_changed
11859 || w
->update_mode_line
11860 || update_mode_lines
11861 || window_buffer_changed (w
))
11863 struct buffer
*prev
= current_buffer
;
11864 ptrdiff_t count
= SPECPDL_INDEX ();
11865 Lisp_Object frame
, new_tool_bar
;
11866 int new_n_tool_bar
;
11867 struct gcpro gcpro1
;
11869 /* Set current_buffer to the buffer of the selected
11870 window of the frame, so that we get the right local
11872 set_buffer_internal_1 (XBUFFER (w
->contents
));
11874 /* Save match data, if we must. */
11875 if (save_match_data
)
11876 record_unwind_save_match_data ();
11878 /* Make sure that we don't accidentally use bogus keymaps. */
11879 if (NILP (Voverriding_local_map_menu_flag
))
11881 specbind (Qoverriding_terminal_local_map
, Qnil
);
11882 specbind (Qoverriding_local_map
, Qnil
);
11885 GCPRO1 (new_tool_bar
);
11887 /* We must temporarily set the selected frame to this frame
11888 before calling tool_bar_items, because the calculation of
11889 the tool-bar keymap uses the selected frame (see
11890 `tool-bar-make-keymap' in tool-bar.el). */
11891 eassert (EQ (selected_window
,
11892 /* Since we only explicitly preserve selected_frame,
11893 check that selected_window would be redundant. */
11894 XFRAME (selected_frame
)->selected_window
));
11895 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11896 XSETFRAME (frame
, f
);
11897 fast_set_selected_frame (frame
);
11899 /* Build desired tool-bar items from keymaps. */
11901 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11904 /* Redisplay the tool-bar if we changed it. */
11905 if (new_n_tool_bar
!= f
->n_tool_bar_items
11906 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11908 /* Redisplay that happens asynchronously due to an expose event
11909 may access f->tool_bar_items. Make sure we update both
11910 variables within BLOCK_INPUT so no such event interrupts. */
11912 fset_tool_bar_items (f
, new_tool_bar
);
11913 f
->n_tool_bar_items
= new_n_tool_bar
;
11914 w
->update_mode_line
= 1;
11920 unbind_to (count
, Qnil
);
11921 set_buffer_internal_1 (prev
);
11926 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11928 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11929 F's desired tool-bar contents. F->tool_bar_items must have
11930 been set up previously by calling prepare_menu_bars. */
11933 build_desired_tool_bar_string (struct frame
*f
)
11935 int i
, size
, size_needed
;
11936 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11937 Lisp_Object image
, plist
, props
;
11939 image
= plist
= props
= Qnil
;
11940 GCPRO3 (image
, plist
, props
);
11942 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11943 Otherwise, make a new string. */
11945 /* The size of the string we might be able to reuse. */
11946 size
= (STRINGP (f
->desired_tool_bar_string
)
11947 ? SCHARS (f
->desired_tool_bar_string
)
11950 /* We need one space in the string for each image. */
11951 size_needed
= f
->n_tool_bar_items
;
11953 /* Reuse f->desired_tool_bar_string, if possible. */
11954 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11955 fset_desired_tool_bar_string
11956 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11959 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11960 Fremove_text_properties (make_number (0), make_number (size
),
11961 props
, f
->desired_tool_bar_string
);
11964 /* Put a `display' property on the string for the images to display,
11965 put a `menu_item' property on tool-bar items with a value that
11966 is the index of the item in F's tool-bar item vector. */
11967 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11969 #define PROP(IDX) \
11970 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11972 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11973 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11974 int hmargin
, vmargin
, relief
, idx
, end
;
11976 /* If image is a vector, choose the image according to the
11978 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11979 if (VECTORP (image
))
11983 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11984 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11987 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11988 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11990 eassert (ASIZE (image
) >= idx
);
11991 image
= AREF (image
, idx
);
11996 /* Ignore invalid image specifications. */
11997 if (!valid_image_p (image
))
12000 /* Display the tool-bar button pressed, or depressed. */
12001 plist
= Fcopy_sequence (XCDR (image
));
12003 /* Compute margin and relief to draw. */
12004 relief
= (tool_bar_button_relief
>= 0
12005 ? tool_bar_button_relief
12006 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12007 hmargin
= vmargin
= relief
;
12009 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12010 INT_MAX
- max (hmargin
, vmargin
)))
12012 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12013 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12015 else if (CONSP (Vtool_bar_button_margin
))
12017 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12018 INT_MAX
- hmargin
))
12019 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12021 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12022 INT_MAX
- vmargin
))
12023 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12026 if (auto_raise_tool_bar_buttons_p
)
12028 /* Add a `:relief' property to the image spec if the item is
12032 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12039 /* If image is selected, display it pressed, i.e. with a
12040 negative relief. If it's not selected, display it with a
12042 plist
= Fplist_put (plist
, QCrelief
,
12044 ? make_number (-relief
)
12045 : make_number (relief
)));
12050 /* Put a margin around the image. */
12051 if (hmargin
|| vmargin
)
12053 if (hmargin
== vmargin
)
12054 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12056 plist
= Fplist_put (plist
, QCmargin
,
12057 Fcons (make_number (hmargin
),
12058 make_number (vmargin
)));
12061 /* If button is not enabled, and we don't have special images
12062 for the disabled state, make the image appear disabled by
12063 applying an appropriate algorithm to it. */
12064 if (!enabled_p
&& idx
< 0)
12065 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12067 /* Put a `display' text property on the string for the image to
12068 display. Put a `menu-item' property on the string that gives
12069 the start of this item's properties in the tool-bar items
12071 image
= Fcons (Qimage
, plist
);
12072 props
= list4 (Qdisplay
, image
,
12073 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12075 /* Let the last image hide all remaining spaces in the tool bar
12076 string. The string can be longer than needed when we reuse a
12077 previous string. */
12078 if (i
+ 1 == f
->n_tool_bar_items
)
12079 end
= SCHARS (f
->desired_tool_bar_string
);
12082 Fadd_text_properties (make_number (i
), make_number (end
),
12083 props
, f
->desired_tool_bar_string
);
12091 /* Display one line of the tool-bar of frame IT->f.
12093 HEIGHT specifies the desired height of the tool-bar line.
12094 If the actual height of the glyph row is less than HEIGHT, the
12095 row's height is increased to HEIGHT, and the icons are centered
12096 vertically in the new height.
12098 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12099 count a final empty row in case the tool-bar width exactly matches
12104 display_tool_bar_line (struct it
*it
, int height
)
12106 struct glyph_row
*row
= it
->glyph_row
;
12107 int max_x
= it
->last_visible_x
;
12108 struct glyph
*last
;
12110 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12111 clear_glyph_row (row
);
12112 row
->enabled_p
= true;
12113 row
->y
= it
->current_y
;
12115 /* Note that this isn't made use of if the face hasn't a box,
12116 so there's no need to check the face here. */
12117 it
->start_of_box_run_p
= 1;
12119 while (it
->current_x
< max_x
)
12121 int x
, n_glyphs_before
, i
, nglyphs
;
12122 struct it it_before
;
12124 /* Get the next display element. */
12125 if (!get_next_display_element (it
))
12127 /* Don't count empty row if we are counting needed tool-bar lines. */
12128 if (height
< 0 && !it
->hpos
)
12133 /* Produce glyphs. */
12134 n_glyphs_before
= row
->used
[TEXT_AREA
];
12137 PRODUCE_GLYPHS (it
);
12139 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12141 x
= it_before
.current_x
;
12142 while (i
< nglyphs
)
12144 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12146 if (x
+ glyph
->pixel_width
> max_x
)
12148 /* Glyph doesn't fit on line. Backtrack. */
12149 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12151 /* If this is the only glyph on this line, it will never fit on the
12152 tool-bar, so skip it. But ensure there is at least one glyph,
12153 so we don't accidentally disable the tool-bar. */
12154 if (n_glyphs_before
== 0
12155 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12161 x
+= glyph
->pixel_width
;
12165 /* Stop at line end. */
12166 if (ITERATOR_AT_END_OF_LINE_P (it
))
12169 set_iterator_to_next (it
, 1);
12174 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12176 /* Use default face for the border below the tool bar.
12178 FIXME: When auto-resize-tool-bars is grow-only, there is
12179 no additional border below the possibly empty tool-bar lines.
12180 So to make the extra empty lines look "normal", we have to
12181 use the tool-bar face for the border too. */
12182 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12183 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12184 it
->face_id
= DEFAULT_FACE_ID
;
12186 extend_face_to_end_of_line (it
);
12187 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12188 last
->right_box_line_p
= 1;
12189 if (last
== row
->glyphs
[TEXT_AREA
])
12190 last
->left_box_line_p
= 1;
12192 /* Make line the desired height and center it vertically. */
12193 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12195 /* Don't add more than one line height. */
12196 height
%= FRAME_LINE_HEIGHT (it
->f
);
12197 it
->max_ascent
+= height
/ 2;
12198 it
->max_descent
+= (height
+ 1) / 2;
12201 compute_line_metrics (it
);
12203 /* If line is empty, make it occupy the rest of the tool-bar. */
12204 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12206 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12207 row
->visible_height
= row
->height
;
12208 row
->ascent
= row
->phys_ascent
= 0;
12209 row
->extra_line_spacing
= 0;
12212 row
->full_width_p
= 1;
12213 row
->continued_p
= 0;
12214 row
->truncated_on_left_p
= 0;
12215 row
->truncated_on_right_p
= 0;
12217 it
->current_x
= it
->hpos
= 0;
12218 it
->current_y
+= row
->height
;
12224 /* Max tool-bar height. Basically, this is what makes all other windows
12225 disappear when the frame gets too small. Rethink this! */
12227 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12228 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12230 /* Value is the number of pixels needed to make all tool-bar items of
12231 frame F visible. The actual number of glyph rows needed is
12232 returned in *N_ROWS if non-NULL. */
12235 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12237 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12239 /* tool_bar_height is called from redisplay_tool_bar after building
12240 the desired matrix, so use (unused) mode-line row as temporary row to
12241 avoid destroying the first tool-bar row. */
12242 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12244 /* Initialize an iterator for iteration over
12245 F->desired_tool_bar_string in the tool-bar window of frame F. */
12246 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12247 it
.first_visible_x
= 0;
12248 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12249 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12250 it
.paragraph_embedding
= L2R
;
12252 while (!ITERATOR_AT_END_P (&it
))
12254 clear_glyph_row (temp_row
);
12255 it
.glyph_row
= temp_row
;
12256 display_tool_bar_line (&it
, -1);
12258 clear_glyph_row (temp_row
);
12260 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12262 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12265 return it
.current_y
;
12267 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12270 #endif /* !USE_GTK && !HAVE_NS */
12272 #if defined USE_GTK || defined HAVE_NS
12273 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12274 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12277 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12279 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12280 If FRAME is nil or omitted, use the selected frame. Optional argument
12281 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12282 (Lisp_Object frame
, Lisp_Object pixelwise
)
12286 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12287 struct frame
*f
= decode_any_frame (frame
);
12289 if (WINDOWP (f
->tool_bar_window
)
12290 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12292 update_tool_bar (f
, 1);
12293 if (f
->n_tool_bar_items
)
12295 build_desired_tool_bar_string (f
);
12296 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12301 return make_number (height
);
12305 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12306 height should be changed. */
12309 redisplay_tool_bar (struct frame
*f
)
12311 #if defined (USE_GTK) || defined (HAVE_NS)
12313 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12314 update_frame_tool_bar (f
);
12317 #else /* !USE_GTK && !HAVE_NS */
12321 struct glyph_row
*row
;
12323 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12324 do anything. This means you must start with tool-bar-lines
12325 non-zero to get the auto-sizing effect. Or in other words, you
12326 can turn off tool-bars by specifying tool-bar-lines zero. */
12327 if (!WINDOWP (f
->tool_bar_window
)
12328 || (w
= XWINDOW (f
->tool_bar_window
),
12329 WINDOW_PIXEL_HEIGHT (w
) == 0))
12332 /* Set up an iterator for the tool-bar window. */
12333 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12334 it
.first_visible_x
= 0;
12335 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12336 row
= it
.glyph_row
;
12338 /* Build a string that represents the contents of the tool-bar. */
12339 build_desired_tool_bar_string (f
);
12340 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12341 /* FIXME: This should be controlled by a user option. But it
12342 doesn't make sense to have an R2L tool bar if the menu bar cannot
12343 be drawn also R2L, and making the menu bar R2L is tricky due
12344 toolkit-specific code that implements it. If an R2L tool bar is
12345 ever supported, display_tool_bar_line should also be augmented to
12346 call unproduce_glyphs like display_line and display_string
12348 it
.paragraph_embedding
= L2R
;
12350 if (f
->n_tool_bar_rows
== 0)
12352 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12354 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12357 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12358 / FRAME_LINE_HEIGHT (f
));
12360 XSETFRAME (frame
, f
);
12361 Fmodify_frame_parameters (frame
,
12362 list1 (Fcons (Qtool_bar_lines
,
12363 make_number (new_lines
))));
12364 /* Always do that now. */
12365 clear_glyph_matrix (w
->desired_matrix
);
12366 f
->fonts_changed
= 1;
12371 /* Display as many lines as needed to display all tool-bar items. */
12373 if (f
->n_tool_bar_rows
> 0)
12375 int border
, rows
, height
, extra
;
12377 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12378 border
= XINT (Vtool_bar_border
);
12379 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12380 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12381 else if (EQ (Vtool_bar_border
, Qborder_width
))
12382 border
= f
->border_width
;
12388 rows
= f
->n_tool_bar_rows
;
12389 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12390 extra
= it
.last_visible_y
- border
- height
* rows
;
12392 while (it
.current_y
< it
.last_visible_y
)
12395 if (extra
> 0 && rows
-- > 0)
12397 h
= (extra
+ rows
- 1) / rows
;
12400 display_tool_bar_line (&it
, height
+ h
);
12405 while (it
.current_y
< it
.last_visible_y
)
12406 display_tool_bar_line (&it
, 0);
12409 /* It doesn't make much sense to try scrolling in the tool-bar
12410 window, so don't do it. */
12411 w
->desired_matrix
->no_scrolling_p
= 1;
12412 w
->must_be_updated_p
= 1;
12414 if (!NILP (Vauto_resize_tool_bars
))
12416 /* Do we really allow the toolbar to occupy the whole frame? */
12417 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12418 int change_height_p
= 0;
12420 /* If we couldn't display everything, change the tool-bar's
12421 height if there is room for more. */
12422 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12423 && it
.current_y
< max_tool_bar_height
)
12424 change_height_p
= 1;
12426 /* We subtract 1 because display_tool_bar_line advances the
12427 glyph_row pointer before returning to its caller. We want to
12428 examine the last glyph row produced by
12429 display_tool_bar_line. */
12430 row
= it
.glyph_row
- 1;
12432 /* If there are blank lines at the end, except for a partially
12433 visible blank line at the end that is smaller than
12434 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12435 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12436 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12437 change_height_p
= 1;
12439 /* If row displays tool-bar items, but is partially visible,
12440 change the tool-bar's height. */
12441 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12442 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12443 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12444 change_height_p
= 1;
12446 /* Resize windows as needed by changing the `tool-bar-lines'
12447 frame parameter. */
12448 if (change_height_p
)
12452 int new_height
= tool_bar_height (f
, &nrows
, 1);
12454 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12455 && !f
->minimize_tool_bar_window_p
)
12456 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12457 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12458 f
->minimize_tool_bar_window_p
= 0;
12460 if (change_height_p
)
12462 /* Current size of the tool-bar window in canonical line
12464 int old_lines
= WINDOW_TOTAL_LINES (w
);
12465 /* Required size of the tool-bar window in canonical
12467 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12468 / FRAME_LINE_HEIGHT (f
));
12469 /* Maximum size of the tool-bar window in canonical line
12470 units that this frame can allow. */
12472 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12474 /* Don't try to change the tool-bar window size and set
12475 the fonts_changed flag unless really necessary. That
12476 flag causes redisplay to give up and retry
12477 redisplaying the frame from scratch, so setting it
12478 unnecessarily can lead to nasty redisplay loops. */
12479 if (new_lines
<= max_lines
12480 && eabs (new_lines
- old_lines
) >= 1)
12482 XSETFRAME (frame
, f
);
12483 Fmodify_frame_parameters (frame
,
12484 list1 (Fcons (Qtool_bar_lines
,
12485 make_number (new_lines
))));
12486 clear_glyph_matrix (w
->desired_matrix
);
12487 f
->n_tool_bar_rows
= nrows
;
12488 f
->fonts_changed
= 1;
12495 f
->minimize_tool_bar_window_p
= 0;
12498 #endif /* USE_GTK || HAVE_NS */
12501 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12503 /* Get information about the tool-bar item which is displayed in GLYPH
12504 on frame F. Return in *PROP_IDX the index where tool-bar item
12505 properties start in F->tool_bar_items. Value is zero if
12506 GLYPH doesn't display a tool-bar item. */
12509 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12515 /* This function can be called asynchronously, which means we must
12516 exclude any possibility that Fget_text_property signals an
12518 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12519 charpos
= max (0, charpos
);
12521 /* Get the text property `menu-item' at pos. The value of that
12522 property is the start index of this item's properties in
12523 F->tool_bar_items. */
12524 prop
= Fget_text_property (make_number (charpos
),
12525 Qmenu_item
, f
->current_tool_bar_string
);
12526 if (INTEGERP (prop
))
12528 *prop_idx
= XINT (prop
);
12538 /* Get information about the tool-bar item at position X/Y on frame F.
12539 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12540 the current matrix of the tool-bar window of F, or NULL if not
12541 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12542 item in F->tool_bar_items. Value is
12544 -1 if X/Y is not on a tool-bar item
12545 0 if X/Y is on the same item that was highlighted before.
12549 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12550 int *hpos
, int *vpos
, int *prop_idx
)
12552 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12553 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12556 /* Find the glyph under X/Y. */
12557 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12558 if (*glyph
== NULL
)
12561 /* Get the start of this tool-bar item's properties in
12562 f->tool_bar_items. */
12563 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12566 /* Is mouse on the highlighted item? */
12567 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12568 && *vpos
>= hlinfo
->mouse_face_beg_row
12569 && *vpos
<= hlinfo
->mouse_face_end_row
12570 && (*vpos
> hlinfo
->mouse_face_beg_row
12571 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12572 && (*vpos
< hlinfo
->mouse_face_end_row
12573 || *hpos
< hlinfo
->mouse_face_end_col
12574 || hlinfo
->mouse_face_past_end
))
12582 Handle mouse button event on the tool-bar of frame F, at
12583 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12584 0 for button release. MODIFIERS is event modifiers for button
12588 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12591 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12592 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12593 int hpos
, vpos
, prop_idx
;
12594 struct glyph
*glyph
;
12595 Lisp_Object enabled_p
;
12598 /* If not on the highlighted tool-bar item, and mouse-highlight is
12599 non-nil, return. This is so we generate the tool-bar button
12600 click only when the mouse button is released on the same item as
12601 where it was pressed. However, when mouse-highlight is disabled,
12602 generate the click when the button is released regardless of the
12603 highlight, since tool-bar items are not highlighted in that
12605 frame_to_window_pixel_xy (w
, &x
, &y
);
12606 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12608 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12611 /* When mouse-highlight is off, generate the click for the item
12612 where the button was pressed, disregarding where it was
12614 if (NILP (Vmouse_highlight
) && !down_p
)
12615 prop_idx
= last_tool_bar_item
;
12617 /* If item is disabled, do nothing. */
12618 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12619 if (NILP (enabled_p
))
12624 /* Show item in pressed state. */
12625 if (!NILP (Vmouse_highlight
))
12626 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12627 last_tool_bar_item
= prop_idx
;
12631 Lisp_Object key
, frame
;
12632 struct input_event event
;
12633 EVENT_INIT (event
);
12635 /* Show item in released state. */
12636 if (!NILP (Vmouse_highlight
))
12637 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12639 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12641 XSETFRAME (frame
, f
);
12642 event
.kind
= TOOL_BAR_EVENT
;
12643 event
.frame_or_window
= frame
;
12645 kbd_buffer_store_event (&event
);
12647 event
.kind
= TOOL_BAR_EVENT
;
12648 event
.frame_or_window
= frame
;
12650 event
.modifiers
= modifiers
;
12651 kbd_buffer_store_event (&event
);
12652 last_tool_bar_item
= -1;
12657 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12658 tool-bar window-relative coordinates X/Y. Called from
12659 note_mouse_highlight. */
12662 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12664 Lisp_Object window
= f
->tool_bar_window
;
12665 struct window
*w
= XWINDOW (window
);
12666 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12667 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12669 struct glyph
*glyph
;
12670 struct glyph_row
*row
;
12672 Lisp_Object enabled_p
;
12674 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12675 int mouse_down_p
, rc
;
12677 /* Function note_mouse_highlight is called with negative X/Y
12678 values when mouse moves outside of the frame. */
12679 if (x
<= 0 || y
<= 0)
12681 clear_mouse_face (hlinfo
);
12685 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12688 /* Not on tool-bar item. */
12689 clear_mouse_face (hlinfo
);
12693 /* On same tool-bar item as before. */
12694 goto set_help_echo
;
12696 clear_mouse_face (hlinfo
);
12698 /* Mouse is down, but on different tool-bar item? */
12699 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12700 && f
== dpyinfo
->last_mouse_frame
);
12703 && last_tool_bar_item
!= prop_idx
)
12706 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12708 /* If tool-bar item is not enabled, don't highlight it. */
12709 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12710 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12712 /* Compute the x-position of the glyph. In front and past the
12713 image is a space. We include this in the highlighted area. */
12714 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12715 for (i
= x
= 0; i
< hpos
; ++i
)
12716 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12718 /* Record this as the current active region. */
12719 hlinfo
->mouse_face_beg_col
= hpos
;
12720 hlinfo
->mouse_face_beg_row
= vpos
;
12721 hlinfo
->mouse_face_beg_x
= x
;
12722 hlinfo
->mouse_face_past_end
= 0;
12724 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12725 hlinfo
->mouse_face_end_row
= vpos
;
12726 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12727 hlinfo
->mouse_face_window
= window
;
12728 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12730 /* Display it as active. */
12731 show_mouse_face (hlinfo
, draw
);
12736 /* Set help_echo_string to a help string to display for this tool-bar item.
12737 XTread_socket does the rest. */
12738 help_echo_object
= help_echo_window
= Qnil
;
12739 help_echo_pos
= -1;
12740 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12741 if (NILP (help_echo_string
))
12742 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12745 #endif /* !USE_GTK && !HAVE_NS */
12747 #endif /* HAVE_WINDOW_SYSTEM */
12751 /************************************************************************
12752 Horizontal scrolling
12753 ************************************************************************/
12755 static int hscroll_window_tree (Lisp_Object
);
12756 static int hscroll_windows (Lisp_Object
);
12758 /* For all leaf windows in the window tree rooted at WINDOW, set their
12759 hscroll value so that PT is (i) visible in the window, and (ii) so
12760 that it is not within a certain margin at the window's left and
12761 right border. Value is non-zero if any window's hscroll has been
12765 hscroll_window_tree (Lisp_Object window
)
12767 int hscrolled_p
= 0;
12768 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12769 int hscroll_step_abs
= 0;
12770 double hscroll_step_rel
= 0;
12772 if (hscroll_relative_p
)
12774 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12775 if (hscroll_step_rel
< 0)
12777 hscroll_relative_p
= 0;
12778 hscroll_step_abs
= 0;
12781 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12783 hscroll_step_abs
= XINT (Vhscroll_step
);
12784 if (hscroll_step_abs
< 0)
12785 hscroll_step_abs
= 0;
12788 hscroll_step_abs
= 0;
12790 while (WINDOWP (window
))
12792 struct window
*w
= XWINDOW (window
);
12794 if (WINDOWP (w
->contents
))
12795 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12796 else if (w
->cursor
.vpos
>= 0)
12799 int text_area_width
;
12800 struct glyph_row
*cursor_row
;
12801 struct glyph_row
*bottom_row
;
12804 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12805 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12806 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12808 cursor_row
= bottom_row
- 1;
12810 if (!cursor_row
->enabled_p
)
12812 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12813 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12814 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12816 cursor_row
= bottom_row
- 1;
12818 row_r2l_p
= cursor_row
->reversed_p
;
12820 text_area_width
= window_box_width (w
, TEXT_AREA
);
12822 /* Scroll when cursor is inside this scroll margin. */
12823 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12825 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12826 /* For left-to-right rows, hscroll when cursor is either
12827 (i) inside the right hscroll margin, or (ii) if it is
12828 inside the left margin and the window is already
12832 && w
->cursor
.x
<= h_margin
)
12833 || (cursor_row
->enabled_p
12834 && cursor_row
->truncated_on_right_p
12835 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12836 /* For right-to-left rows, the logic is similar,
12837 except that rules for scrolling to left and right
12838 are reversed. E.g., if cursor.x <= h_margin, we
12839 need to hscroll "to the right" unconditionally,
12840 and that will scroll the screen to the left so as
12841 to reveal the next portion of the row. */
12843 && ((cursor_row
->enabled_p
12844 /* FIXME: It is confusing to set the
12845 truncated_on_right_p flag when R2L rows
12846 are actually truncated on the left. */
12847 && cursor_row
->truncated_on_right_p
12848 && w
->cursor
.x
<= h_margin
)
12850 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12854 struct buffer
*saved_current_buffer
;
12858 /* Find point in a display of infinite width. */
12859 saved_current_buffer
= current_buffer
;
12860 current_buffer
= XBUFFER (w
->contents
);
12862 if (w
== XWINDOW (selected_window
))
12865 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12867 /* Move iterator to pt starting at cursor_row->start in
12868 a line with infinite width. */
12869 init_to_row_start (&it
, w
, cursor_row
);
12870 it
.last_visible_x
= INFINITY
;
12871 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12872 current_buffer
= saved_current_buffer
;
12874 /* Position cursor in window. */
12875 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12876 hscroll
= max (0, (it
.current_x
12877 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12878 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12879 : (text_area_width
/ 2))))
12880 / FRAME_COLUMN_WIDTH (it
.f
);
12881 else if ((!row_r2l_p
12882 && w
->cursor
.x
>= text_area_width
- h_margin
)
12883 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12885 if (hscroll_relative_p
)
12886 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12889 wanted_x
= text_area_width
12890 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12893 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12897 if (hscroll_relative_p
)
12898 wanted_x
= text_area_width
* hscroll_step_rel
12901 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12904 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12906 hscroll
= max (hscroll
, w
->min_hscroll
);
12908 /* Don't prevent redisplay optimizations if hscroll
12909 hasn't changed, as it will unnecessarily slow down
12911 if (w
->hscroll
!= hscroll
)
12913 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12914 w
->hscroll
= hscroll
;
12923 /* Value is non-zero if hscroll of any leaf window has been changed. */
12924 return hscrolled_p
;
12928 /* Set hscroll so that cursor is visible and not inside horizontal
12929 scroll margins for all windows in the tree rooted at WINDOW. See
12930 also hscroll_window_tree above. Value is non-zero if any window's
12931 hscroll has been changed. If it has, desired matrices on the frame
12932 of WINDOW are cleared. */
12935 hscroll_windows (Lisp_Object window
)
12937 int hscrolled_p
= hscroll_window_tree (window
);
12939 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12940 return hscrolled_p
;
12945 /************************************************************************
12947 ************************************************************************/
12949 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12950 to a non-zero value. This is sometimes handy to have in a debugger
12955 /* First and last unchanged row for try_window_id. */
12957 static int debug_first_unchanged_at_end_vpos
;
12958 static int debug_last_unchanged_at_beg_vpos
;
12960 /* Delta vpos and y. */
12962 static int debug_dvpos
, debug_dy
;
12964 /* Delta in characters and bytes for try_window_id. */
12966 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12968 /* Values of window_end_pos and window_end_vpos at the end of
12971 static ptrdiff_t debug_end_vpos
;
12973 /* Append a string to W->desired_matrix->method. FMT is a printf
12974 format string. If trace_redisplay_p is true also printf the
12975 resulting string to stderr. */
12977 static void debug_method_add (struct window
*, char const *, ...)
12978 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12981 debug_method_add (struct window
*w
, char const *fmt
, ...)
12984 char *method
= w
->desired_matrix
->method
;
12985 int len
= strlen (method
);
12986 int size
= sizeof w
->desired_matrix
->method
;
12987 int remaining
= size
- len
- 1;
12990 if (len
&& remaining
)
12993 --remaining
, ++len
;
12996 va_start (ap
, fmt
);
12997 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13000 if (trace_redisplay_p
)
13001 fprintf (stderr
, "%p (%s): %s\n",
13003 ((BUFFERP (w
->contents
)
13004 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13005 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13010 #endif /* GLYPH_DEBUG */
13013 /* Value is non-zero if all changes in window W, which displays
13014 current_buffer, are in the text between START and END. START is a
13015 buffer position, END is given as a distance from Z. Used in
13016 redisplay_internal for display optimization. */
13019 text_outside_line_unchanged_p (struct window
*w
,
13020 ptrdiff_t start
, ptrdiff_t end
)
13022 int unchanged_p
= 1;
13024 /* If text or overlays have changed, see where. */
13025 if (window_outdated (w
))
13027 /* Gap in the line? */
13028 if (GPT
< start
|| Z
- GPT
< end
)
13031 /* Changes start in front of the line, or end after it? */
13033 && (BEG_UNCHANGED
< start
- 1
13034 || END_UNCHANGED
< end
))
13037 /* If selective display, can't optimize if changes start at the
13038 beginning of the line. */
13040 && INTEGERP (BVAR (current_buffer
, selective_display
))
13041 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13042 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13045 /* If there are overlays at the start or end of the line, these
13046 may have overlay strings with newlines in them. A change at
13047 START, for instance, may actually concern the display of such
13048 overlay strings as well, and they are displayed on different
13049 lines. So, quickly rule out this case. (For the future, it
13050 might be desirable to implement something more telling than
13051 just BEG/END_UNCHANGED.) */
13054 if (BEG
+ BEG_UNCHANGED
== start
13055 && overlay_touches_p (start
))
13057 if (END_UNCHANGED
== end
13058 && overlay_touches_p (Z
- end
))
13062 /* Under bidi reordering, adding or deleting a character in the
13063 beginning of a paragraph, before the first strong directional
13064 character, can change the base direction of the paragraph (unless
13065 the buffer specifies a fixed paragraph direction), which will
13066 require to redisplay the whole paragraph. It might be worthwhile
13067 to find the paragraph limits and widen the range of redisplayed
13068 lines to that, but for now just give up this optimization. */
13069 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13070 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13074 return unchanged_p
;
13078 /* Do a frame update, taking possible shortcuts into account. This is
13079 the main external entry point for redisplay.
13081 If the last redisplay displayed an echo area message and that message
13082 is no longer requested, we clear the echo area or bring back the
13083 mini-buffer if that is in use. */
13088 redisplay_internal ();
13093 overlay_arrow_string_or_property (Lisp_Object var
)
13097 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13100 return Voverlay_arrow_string
;
13103 /* Return 1 if there are any overlay-arrows in current_buffer. */
13105 overlay_arrow_in_current_buffer_p (void)
13109 for (vlist
= Voverlay_arrow_variable_list
;
13111 vlist
= XCDR (vlist
))
13113 Lisp_Object var
= XCAR (vlist
);
13116 if (!SYMBOLP (var
))
13118 val
= find_symbol_value (var
);
13120 && current_buffer
== XMARKER (val
)->buffer
)
13127 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13131 overlay_arrows_changed_p (void)
13135 for (vlist
= Voverlay_arrow_variable_list
;
13137 vlist
= XCDR (vlist
))
13139 Lisp_Object var
= XCAR (vlist
);
13140 Lisp_Object val
, pstr
;
13142 if (!SYMBOLP (var
))
13144 val
= find_symbol_value (var
);
13145 if (!MARKERP (val
))
13147 if (! EQ (COERCE_MARKER (val
),
13148 Fget (var
, Qlast_arrow_position
))
13149 || ! (pstr
= overlay_arrow_string_or_property (var
),
13150 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13156 /* Mark overlay arrows to be updated on next redisplay. */
13159 update_overlay_arrows (int up_to_date
)
13163 for (vlist
= Voverlay_arrow_variable_list
;
13165 vlist
= XCDR (vlist
))
13167 Lisp_Object var
= XCAR (vlist
);
13169 if (!SYMBOLP (var
))
13172 if (up_to_date
> 0)
13174 Lisp_Object val
= find_symbol_value (var
);
13175 Fput (var
, Qlast_arrow_position
,
13176 COERCE_MARKER (val
));
13177 Fput (var
, Qlast_arrow_string
,
13178 overlay_arrow_string_or_property (var
));
13180 else if (up_to_date
< 0
13181 || !NILP (Fget (var
, Qlast_arrow_position
)))
13183 Fput (var
, Qlast_arrow_position
, Qt
);
13184 Fput (var
, Qlast_arrow_string
, Qt
);
13190 /* Return overlay arrow string to display at row.
13191 Return integer (bitmap number) for arrow bitmap in left fringe.
13192 Return nil if no overlay arrow. */
13195 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13199 for (vlist
= Voverlay_arrow_variable_list
;
13201 vlist
= XCDR (vlist
))
13203 Lisp_Object var
= XCAR (vlist
);
13206 if (!SYMBOLP (var
))
13209 val
= find_symbol_value (var
);
13212 && current_buffer
== XMARKER (val
)->buffer
13213 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13215 if (FRAME_WINDOW_P (it
->f
)
13216 /* FIXME: if ROW->reversed_p is set, this should test
13217 the right fringe, not the left one. */
13218 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13220 #ifdef HAVE_WINDOW_SYSTEM
13221 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13224 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13225 return make_number (fringe_bitmap
);
13228 return make_number (-1); /* Use default arrow bitmap. */
13230 return overlay_arrow_string_or_property (var
);
13237 /* Return 1 if point moved out of or into a composition. Otherwise
13238 return 0. PREV_BUF and PREV_PT are the last point buffer and
13239 position. BUF and PT are the current point buffer and position. */
13242 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13243 struct buffer
*buf
, ptrdiff_t pt
)
13245 ptrdiff_t start
, end
;
13247 Lisp_Object buffer
;
13249 XSETBUFFER (buffer
, buf
);
13250 /* Check a composition at the last point if point moved within the
13252 if (prev_buf
== buf
)
13255 /* Point didn't move. */
13258 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13259 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13260 && composition_valid_p (start
, end
, prop
)
13261 && start
< prev_pt
&& end
> prev_pt
)
13262 /* The last point was within the composition. Return 1 iff
13263 point moved out of the composition. */
13264 return (pt
<= start
|| pt
>= end
);
13267 /* Check a composition at the current point. */
13268 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13269 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13270 && composition_valid_p (start
, end
, prop
)
13271 && start
< pt
&& end
> pt
);
13274 /* Reconsider the clip changes of buffer which is displayed in W. */
13277 reconsider_clip_changes (struct window
*w
)
13279 struct buffer
*b
= XBUFFER (w
->contents
);
13281 if (b
->clip_changed
13282 && w
->window_end_valid
13283 && w
->current_matrix
->buffer
== b
13284 && w
->current_matrix
->zv
== BUF_ZV (b
)
13285 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13286 b
->clip_changed
= 0;
13288 /* If display wasn't paused, and W is not a tool bar window, see if
13289 point has been moved into or out of a composition. In that case,
13290 we set b->clip_changed to 1 to force updating the screen. If
13291 b->clip_changed has already been set to 1, we can skip this
13293 if (!b
->clip_changed
&& w
->window_end_valid
)
13295 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13296 ? PT
: marker_position (w
->pointm
));
13298 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13299 && check_point_in_composition (w
->current_matrix
->buffer
,
13300 w
->last_point
, b
, pt
))
13301 b
->clip_changed
= 1;
13306 propagate_buffer_redisplay (void)
13307 { /* Resetting b->text->redisplay is problematic!
13308 We can't just reset it in the case that some window that displays
13309 it has not been redisplayed; and such a window can stay
13310 unredisplayed for a long time if it's currently invisible.
13311 But we do want to reset it at the end of redisplay otherwise
13312 its displayed windows will keep being redisplayed over and over
13314 So we copy all b->text->redisplay flags up to their windows here,
13315 such that mark_window_display_accurate can safely reset
13316 b->text->redisplay. */
13317 Lisp_Object ws
= window_list ();
13318 for (; CONSP (ws
); ws
= XCDR (ws
))
13320 struct window
*thisw
= XWINDOW (XCAR (ws
));
13321 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13322 if (thisb
->text
->redisplay
)
13323 thisw
->redisplay
= true;
13327 #define STOP_POLLING \
13328 do { if (! polling_stopped_here) stop_polling (); \
13329 polling_stopped_here = 1; } while (0)
13331 #define RESUME_POLLING \
13332 do { if (polling_stopped_here) start_polling (); \
13333 polling_stopped_here = 0; } while (0)
13336 /* Perhaps in the future avoid recentering windows if it
13337 is not necessary; currently that causes some problems. */
13340 redisplay_internal (void)
13342 struct window
*w
= XWINDOW (selected_window
);
13346 bool must_finish
= 0, match_p
;
13347 struct text_pos tlbufpos
, tlendpos
;
13348 int number_of_visible_frames
;
13351 int polling_stopped_here
= 0;
13352 Lisp_Object tail
, frame
;
13354 /* True means redisplay has to consider all windows on all
13355 frames. False, only selected_window is considered. */
13356 bool consider_all_windows_p
;
13358 /* True means redisplay has to redisplay the miniwindow. */
13359 bool update_miniwindow_p
= false;
13361 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13363 /* No redisplay if running in batch mode or frame is not yet fully
13364 initialized, or redisplay is explicitly turned off by setting
13365 Vinhibit_redisplay. */
13366 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13367 || !NILP (Vinhibit_redisplay
))
13370 /* Don't examine these until after testing Vinhibit_redisplay.
13371 When Emacs is shutting down, perhaps because its connection to
13372 X has dropped, we should not look at them at all. */
13373 fr
= XFRAME (w
->frame
);
13374 sf
= SELECTED_FRAME ();
13376 if (!fr
->glyphs_initialized_p
)
13379 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13380 if (popup_activated ())
13384 /* I don't think this happens but let's be paranoid. */
13385 if (redisplaying_p
)
13388 /* Record a function that clears redisplaying_p
13389 when we leave this function. */
13390 count
= SPECPDL_INDEX ();
13391 record_unwind_protect_void (unwind_redisplay
);
13392 redisplaying_p
= 1;
13393 specbind (Qinhibit_free_realized_faces
, Qnil
);
13395 /* Record this function, so it appears on the profiler's backtraces. */
13396 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13398 FOR_EACH_FRAME (tail
, frame
)
13399 XFRAME (frame
)->already_hscrolled_p
= 0;
13402 /* Remember the currently selected window. */
13406 last_escape_glyph_frame
= NULL
;
13407 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13408 last_glyphless_glyph_frame
= NULL
;
13409 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13411 /* If face_change_count is non-zero, init_iterator will free all
13412 realized faces, which includes the faces referenced from current
13413 matrices. So, we can't reuse current matrices in this case. */
13414 if (face_change_count
)
13415 windows_or_buffers_changed
= 47;
13417 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13418 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13420 /* Since frames on a single ASCII terminal share the same
13421 display area, displaying a different frame means redisplay
13422 the whole thing. */
13423 SET_FRAME_GARBAGED (sf
);
13425 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13427 FRAME_TTY (sf
)->previous_frame
= sf
;
13430 /* Set the visible flags for all frames. Do this before checking for
13431 resized or garbaged frames; they want to know if their frames are
13432 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13433 number_of_visible_frames
= 0;
13435 FOR_EACH_FRAME (tail
, frame
)
13437 struct frame
*f
= XFRAME (frame
);
13439 if (FRAME_VISIBLE_P (f
))
13441 ++number_of_visible_frames
;
13442 /* Adjust matrices for visible frames only. */
13443 if (f
->fonts_changed
)
13445 adjust_frame_glyphs (f
);
13446 f
->fonts_changed
= 0;
13448 /* If cursor type has been changed on the frame
13449 other than selected, consider all frames. */
13450 if (f
!= sf
&& f
->cursor_type_changed
)
13451 update_mode_lines
= 31;
13453 clear_desired_matrices (f
);
13456 /* Notice any pending interrupt request to change frame size. */
13457 do_pending_window_change (1);
13459 /* do_pending_window_change could change the selected_window due to
13460 frame resizing which makes the selected window too small. */
13461 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13464 /* Clear frames marked as garbaged. */
13465 clear_garbaged_frames ();
13467 /* Build menubar and tool-bar items. */
13468 if (NILP (Vmemory_full
))
13469 prepare_menu_bars ();
13471 reconsider_clip_changes (w
);
13473 /* In most cases selected window displays current buffer. */
13474 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13477 /* Detect case that we need to write or remove a star in the mode line. */
13478 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13479 w
->update_mode_line
= 1;
13481 if (mode_line_update_needed (w
))
13482 w
->update_mode_line
= 1;
13485 /* Normally the message* functions will have already displayed and
13486 updated the echo area, but the frame may have been trashed, or
13487 the update may have been preempted, so display the echo area
13488 again here. Checking message_cleared_p captures the case that
13489 the echo area should be cleared. */
13490 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13491 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13492 || (message_cleared_p
13493 && minibuf_level
== 0
13494 /* If the mini-window is currently selected, this means the
13495 echo-area doesn't show through. */
13496 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13498 int window_height_changed_p
= echo_area_display (0);
13500 if (message_cleared_p
)
13501 update_miniwindow_p
= true;
13505 /* If we don't display the current message, don't clear the
13506 message_cleared_p flag, because, if we did, we wouldn't clear
13507 the echo area in the next redisplay which doesn't preserve
13509 if (!display_last_displayed_message_p
)
13510 message_cleared_p
= 0;
13512 if (window_height_changed_p
)
13514 windows_or_buffers_changed
= 50;
13516 /* If window configuration was changed, frames may have been
13517 marked garbaged. Clear them or we will experience
13518 surprises wrt scrolling. */
13519 clear_garbaged_frames ();
13522 else if (EQ (selected_window
, minibuf_window
)
13523 && (current_buffer
->clip_changed
|| window_outdated (w
))
13524 && resize_mini_window (w
, 0))
13526 /* Resized active mini-window to fit the size of what it is
13527 showing if its contents might have changed. */
13530 /* If window configuration was changed, frames may have been
13531 marked garbaged. Clear them or we will experience
13532 surprises wrt scrolling. */
13533 clear_garbaged_frames ();
13536 if (windows_or_buffers_changed
&& !update_mode_lines
)
13537 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13538 only the windows's contents needs to be refreshed, or whether the
13539 mode-lines also need a refresh. */
13540 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13541 ? REDISPLAY_SOME
: 32);
13543 /* If specs for an arrow have changed, do thorough redisplay
13544 to ensure we remove any arrow that should no longer exist. */
13545 if (overlay_arrows_changed_p ())
13546 /* Apparently, this is the only case where we update other windows,
13547 without updating other mode-lines. */
13548 windows_or_buffers_changed
= 49;
13550 consider_all_windows_p
= (update_mode_lines
13551 || windows_or_buffers_changed
);
13553 #define AINC(a,i) \
13554 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13555 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13557 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13558 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13560 /* Optimize the case that only the line containing the cursor in the
13561 selected window has changed. Variables starting with this_ are
13562 set in display_line and record information about the line
13563 containing the cursor. */
13564 tlbufpos
= this_line_start_pos
;
13565 tlendpos
= this_line_end_pos
;
13566 if (!consider_all_windows_p
13567 && CHARPOS (tlbufpos
) > 0
13568 && !w
->update_mode_line
13569 && !current_buffer
->clip_changed
13570 && !current_buffer
->prevent_redisplay_optimizations_p
13571 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13572 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13573 && !XFRAME (w
->frame
)->cursor_type_changed
13574 /* Make sure recorded data applies to current buffer, etc. */
13575 && this_line_buffer
== current_buffer
13578 && !w
->optional_new_start
13579 /* Point must be on the line that we have info recorded about. */
13580 && PT
>= CHARPOS (tlbufpos
)
13581 && PT
<= Z
- CHARPOS (tlendpos
)
13582 /* All text outside that line, including its final newline,
13583 must be unchanged. */
13584 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13585 CHARPOS (tlendpos
)))
13587 if (CHARPOS (tlbufpos
) > BEGV
13588 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13589 && (CHARPOS (tlbufpos
) == ZV
13590 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13591 /* Former continuation line has disappeared by becoming empty. */
13593 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13595 /* We have to handle the case of continuation around a
13596 wide-column character (see the comment in indent.c around
13599 For instance, in the following case:
13601 -------- Insert --------
13602 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13603 J_I_ ==> J_I_ `^^' are cursors.
13607 As we have to redraw the line above, we cannot use this
13611 int line_height_before
= this_line_pixel_height
;
13613 /* Note that start_display will handle the case that the
13614 line starting at tlbufpos is a continuation line. */
13615 start_display (&it
, w
, tlbufpos
);
13617 /* Implementation note: It this still necessary? */
13618 if (it
.current_x
!= this_line_start_x
)
13621 TRACE ((stderr
, "trying display optimization 1\n"));
13622 w
->cursor
.vpos
= -1;
13623 overlay_arrow_seen
= 0;
13624 it
.vpos
= this_line_vpos
;
13625 it
.current_y
= this_line_y
;
13626 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13627 display_line (&it
);
13629 /* If line contains point, is not continued,
13630 and ends at same distance from eob as before, we win. */
13631 if (w
->cursor
.vpos
>= 0
13632 /* Line is not continued, otherwise this_line_start_pos
13633 would have been set to 0 in display_line. */
13634 && CHARPOS (this_line_start_pos
)
13635 /* Line ends as before. */
13636 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13637 /* Line has same height as before. Otherwise other lines
13638 would have to be shifted up or down. */
13639 && this_line_pixel_height
== line_height_before
)
13641 /* If this is not the window's last line, we must adjust
13642 the charstarts of the lines below. */
13643 if (it
.current_y
< it
.last_visible_y
)
13645 struct glyph_row
*row
13646 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13647 ptrdiff_t delta
, delta_bytes
;
13649 /* We used to distinguish between two cases here,
13650 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13651 when the line ends in a newline or the end of the
13652 buffer's accessible portion. But both cases did
13653 the same, so they were collapsed. */
13655 - CHARPOS (tlendpos
)
13656 - MATRIX_ROW_START_CHARPOS (row
));
13657 delta_bytes
= (Z_BYTE
13658 - BYTEPOS (tlendpos
)
13659 - MATRIX_ROW_START_BYTEPOS (row
));
13661 increment_matrix_positions (w
->current_matrix
,
13662 this_line_vpos
+ 1,
13663 w
->current_matrix
->nrows
,
13664 delta
, delta_bytes
);
13667 /* If this row displays text now but previously didn't,
13668 or vice versa, w->window_end_vpos may have to be
13670 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13672 if (w
->window_end_vpos
< this_line_vpos
)
13673 w
->window_end_vpos
= this_line_vpos
;
13675 else if (w
->window_end_vpos
== this_line_vpos
13676 && this_line_vpos
> 0)
13677 w
->window_end_vpos
= this_line_vpos
- 1;
13678 w
->window_end_valid
= 0;
13680 /* Update hint: No need to try to scroll in update_window. */
13681 w
->desired_matrix
->no_scrolling_p
= 1;
13684 *w
->desired_matrix
->method
= 0;
13685 debug_method_add (w
, "optimization 1");
13687 #ifdef HAVE_WINDOW_SYSTEM
13688 update_window_fringes (w
, 0);
13695 else if (/* Cursor position hasn't changed. */
13696 PT
== w
->last_point
13697 /* Make sure the cursor was last displayed
13698 in this window. Otherwise we have to reposition it. */
13700 /* PXW: Must be converted to pixels, probably. */
13701 && 0 <= w
->cursor
.vpos
13702 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13706 do_pending_window_change (1);
13707 /* If selected_window changed, redisplay again. */
13708 if (WINDOWP (selected_window
)
13709 && (w
= XWINDOW (selected_window
)) != sw
)
13712 /* We used to always goto end_of_redisplay here, but this
13713 isn't enough if we have a blinking cursor. */
13714 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13715 goto end_of_redisplay
;
13719 /* If highlighting the region, or if the cursor is in the echo area,
13720 then we can't just move the cursor. */
13721 else if (NILP (Vshow_trailing_whitespace
)
13722 && !cursor_in_echo_area
)
13725 struct glyph_row
*row
;
13727 /* Skip from tlbufpos to PT and see where it is. Note that
13728 PT may be in invisible text. If so, we will end at the
13729 next visible position. */
13730 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13731 NULL
, DEFAULT_FACE_ID
);
13732 it
.current_x
= this_line_start_x
;
13733 it
.current_y
= this_line_y
;
13734 it
.vpos
= this_line_vpos
;
13736 /* The call to move_it_to stops in front of PT, but
13737 moves over before-strings. */
13738 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13740 if (it
.vpos
== this_line_vpos
13741 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13744 eassert (this_line_vpos
== it
.vpos
);
13745 eassert (this_line_y
== it
.current_y
);
13746 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13748 *w
->desired_matrix
->method
= 0;
13749 debug_method_add (w
, "optimization 3");
13758 /* Text changed drastically or point moved off of line. */
13759 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13762 CHARPOS (this_line_start_pos
) = 0;
13763 ++clear_face_cache_count
;
13764 #ifdef HAVE_WINDOW_SYSTEM
13765 ++clear_image_cache_count
;
13768 /* Build desired matrices, and update the display. If
13769 consider_all_windows_p is non-zero, do it for all windows on all
13770 frames. Otherwise do it for selected_window, only. */
13772 if (consider_all_windows_p
)
13774 FOR_EACH_FRAME (tail
, frame
)
13775 XFRAME (frame
)->updated_p
= 0;
13777 propagate_buffer_redisplay ();
13779 FOR_EACH_FRAME (tail
, frame
)
13781 struct frame
*f
= XFRAME (frame
);
13783 /* We don't have to do anything for unselected terminal
13785 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13786 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13791 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13794 /* Only GC scrollbars when we redisplay the whole frame. */
13795 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13796 /* Mark all the scroll bars to be removed; we'll redeem
13797 the ones we want when we redisplay their windows. */
13798 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13799 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13801 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13802 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13803 /* Remember that the invisible frames need to be redisplayed next
13804 time they're visible. */
13805 else if (!REDISPLAY_SOME_P ())
13806 f
->redisplay
= true;
13808 /* The X error handler may have deleted that frame. */
13809 if (!FRAME_LIVE_P (f
))
13812 /* Any scroll bars which redisplay_windows should have
13813 nuked should now go away. */
13814 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13815 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13817 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13819 /* If fonts changed on visible frame, display again. */
13820 if (f
->fonts_changed
)
13822 adjust_frame_glyphs (f
);
13823 f
->fonts_changed
= 0;
13827 /* See if we have to hscroll. */
13828 if (!f
->already_hscrolled_p
)
13830 f
->already_hscrolled_p
= 1;
13831 if (hscroll_windows (f
->root_window
))
13835 /* Prevent various kinds of signals during display
13836 update. stdio is not robust about handling
13837 signals, which can cause an apparent I/O error. */
13838 if (interrupt_input
)
13839 unrequest_sigio ();
13842 pending
|= update_frame (f
, 0, 0);
13843 f
->cursor_type_changed
= 0;
13849 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13853 /* Do the mark_window_display_accurate after all windows have
13854 been redisplayed because this call resets flags in buffers
13855 which are needed for proper redisplay. */
13856 FOR_EACH_FRAME (tail
, frame
)
13858 struct frame
*f
= XFRAME (frame
);
13861 f
->redisplay
= false;
13862 mark_window_display_accurate (f
->root_window
, 1);
13863 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13864 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13869 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13871 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13872 struct frame
*mini_frame
;
13874 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13875 /* Use list_of_error, not Qerror, so that
13876 we catch only errors and don't run the debugger. */
13877 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13879 redisplay_window_error
);
13880 if (update_miniwindow_p
)
13881 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13883 redisplay_window_error
);
13885 /* Compare desired and current matrices, perform output. */
13888 /* If fonts changed, display again. */
13889 if (sf
->fonts_changed
)
13892 /* Prevent various kinds of signals during display update.
13893 stdio is not robust about handling signals,
13894 which can cause an apparent I/O error. */
13895 if (interrupt_input
)
13896 unrequest_sigio ();
13899 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13901 if (hscroll_windows (selected_window
))
13904 XWINDOW (selected_window
)->must_be_updated_p
= true;
13905 pending
= update_frame (sf
, 0, 0);
13906 sf
->cursor_type_changed
= 0;
13909 /* We may have called echo_area_display at the top of this
13910 function. If the echo area is on another frame, that may
13911 have put text on a frame other than the selected one, so the
13912 above call to update_frame would not have caught it. Catch
13914 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13915 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13917 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13919 XWINDOW (mini_window
)->must_be_updated_p
= true;
13920 pending
|= update_frame (mini_frame
, 0, 0);
13921 mini_frame
->cursor_type_changed
= 0;
13922 if (!pending
&& hscroll_windows (mini_window
))
13927 /* If display was paused because of pending input, make sure we do a
13928 thorough update the next time. */
13931 /* Prevent the optimization at the beginning of
13932 redisplay_internal that tries a single-line update of the
13933 line containing the cursor in the selected window. */
13934 CHARPOS (this_line_start_pos
) = 0;
13936 /* Let the overlay arrow be updated the next time. */
13937 update_overlay_arrows (0);
13939 /* If we pause after scrolling, some rows in the current
13940 matrices of some windows are not valid. */
13941 if (!WINDOW_FULL_WIDTH_P (w
)
13942 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13943 update_mode_lines
= 36;
13947 if (!consider_all_windows_p
)
13949 /* This has already been done above if
13950 consider_all_windows_p is set. */
13951 if (XBUFFER (w
->contents
)->text
->redisplay
13952 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13953 /* This can happen if b->text->redisplay was set during
13955 propagate_buffer_redisplay ();
13956 mark_window_display_accurate_1 (w
, 1);
13958 /* Say overlay arrows are up to date. */
13959 update_overlay_arrows (1);
13961 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13962 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13965 update_mode_lines
= 0;
13966 windows_or_buffers_changed
= 0;
13969 /* Start SIGIO interrupts coming again. Having them off during the
13970 code above makes it less likely one will discard output, but not
13971 impossible, since there might be stuff in the system buffer here.
13972 But it is much hairier to try to do anything about that. */
13973 if (interrupt_input
)
13977 /* If a frame has become visible which was not before, redisplay
13978 again, so that we display it. Expose events for such a frame
13979 (which it gets when becoming visible) don't call the parts of
13980 redisplay constructing glyphs, so simply exposing a frame won't
13981 display anything in this case. So, we have to display these
13982 frames here explicitly. */
13987 FOR_EACH_FRAME (tail
, frame
)
13989 if (XFRAME (frame
)->visible
)
13993 if (new_count
!= number_of_visible_frames
)
13994 windows_or_buffers_changed
= 52;
13997 /* Change frame size now if a change is pending. */
13998 do_pending_window_change (1);
14000 /* If we just did a pending size change, or have additional
14001 visible frames, or selected_window changed, redisplay again. */
14002 if ((windows_or_buffers_changed
&& !pending
)
14003 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14006 /* Clear the face and image caches.
14008 We used to do this only if consider_all_windows_p. But the cache
14009 needs to be cleared if a timer creates images in the current
14010 buffer (e.g. the test case in Bug#6230). */
14012 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14014 clear_face_cache (0);
14015 clear_face_cache_count
= 0;
14018 #ifdef HAVE_WINDOW_SYSTEM
14019 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14021 clear_image_caches (Qnil
);
14022 clear_image_cache_count
= 0;
14024 #endif /* HAVE_WINDOW_SYSTEM */
14027 if (interrupt_input
&& interrupts_deferred
)
14030 unbind_to (count
, Qnil
);
14035 /* Redisplay, but leave alone any recent echo area message unless
14036 another message has been requested in its place.
14038 This is useful in situations where you need to redisplay but no
14039 user action has occurred, making it inappropriate for the message
14040 area to be cleared. See tracking_off and
14041 wait_reading_process_output for examples of these situations.
14043 FROM_WHERE is an integer saying from where this function was
14044 called. This is useful for debugging. */
14047 redisplay_preserve_echo_area (int from_where
)
14049 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14051 if (!NILP (echo_area_buffer
[1]))
14053 /* We have a previously displayed message, but no current
14054 message. Redisplay the previous message. */
14055 display_last_displayed_message_p
= 1;
14056 redisplay_internal ();
14057 display_last_displayed_message_p
= 0;
14060 redisplay_internal ();
14062 flush_frame (SELECTED_FRAME ());
14066 /* Function registered with record_unwind_protect in redisplay_internal. */
14069 unwind_redisplay (void)
14071 redisplaying_p
= 0;
14075 /* Mark the display of leaf window W as accurate or inaccurate.
14076 If ACCURATE_P is non-zero mark display of W as accurate. If
14077 ACCURATE_P is zero, arrange for W to be redisplayed the next
14078 time redisplay_internal is called. */
14081 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14083 struct buffer
*b
= XBUFFER (w
->contents
);
14085 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14086 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14087 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14091 b
->clip_changed
= false;
14092 b
->prevent_redisplay_optimizations_p
= false;
14093 eassert (buffer_window_count (b
) > 0);
14094 /* Resetting b->text->redisplay is problematic!
14095 In order to make it safer to do it here, redisplay_internal must
14096 have copied all b->text->redisplay to their respective windows. */
14097 b
->text
->redisplay
= false;
14099 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14100 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14101 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14102 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14104 w
->current_matrix
->buffer
= b
;
14105 w
->current_matrix
->begv
= BUF_BEGV (b
);
14106 w
->current_matrix
->zv
= BUF_ZV (b
);
14108 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14109 w
->last_cursor_off_p
= w
->cursor_off_p
;
14111 if (w
== XWINDOW (selected_window
))
14112 w
->last_point
= BUF_PT (b
);
14114 w
->last_point
= marker_position (w
->pointm
);
14116 w
->window_end_valid
= true;
14117 w
->update_mode_line
= false;
14120 w
->redisplay
= !accurate_p
;
14124 /* Mark the display of windows in the window tree rooted at WINDOW as
14125 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14126 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14127 be redisplayed the next time redisplay_internal is called. */
14130 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14134 for (; !NILP (window
); window
= w
->next
)
14136 w
= XWINDOW (window
);
14137 if (WINDOWP (w
->contents
))
14138 mark_window_display_accurate (w
->contents
, accurate_p
);
14140 mark_window_display_accurate_1 (w
, accurate_p
);
14144 update_overlay_arrows (1);
14146 /* Force a thorough redisplay the next time by setting
14147 last_arrow_position and last_arrow_string to t, which is
14148 unequal to any useful value of Voverlay_arrow_... */
14149 update_overlay_arrows (-1);
14153 /* Return value in display table DP (Lisp_Char_Table *) for character
14154 C. Since a display table doesn't have any parent, we don't have to
14155 follow parent. Do not call this function directly but use the
14156 macro DISP_CHAR_VECTOR. */
14159 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14163 if (ASCII_CHAR_P (c
))
14166 if (SUB_CHAR_TABLE_P (val
))
14167 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14173 XSETCHAR_TABLE (table
, dp
);
14174 val
= char_table_ref (table
, c
);
14183 /***********************************************************************
14185 ***********************************************************************/
14187 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14190 redisplay_windows (Lisp_Object window
)
14192 while (!NILP (window
))
14194 struct window
*w
= XWINDOW (window
);
14196 if (WINDOWP (w
->contents
))
14197 redisplay_windows (w
->contents
);
14198 else if (BUFFERP (w
->contents
))
14200 displayed_buffer
= XBUFFER (w
->contents
);
14201 /* Use list_of_error, not Qerror, so that
14202 we catch only errors and don't run the debugger. */
14203 internal_condition_case_1 (redisplay_window_0
, window
,
14205 redisplay_window_error
);
14213 redisplay_window_error (Lisp_Object ignore
)
14215 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14220 redisplay_window_0 (Lisp_Object window
)
14222 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14223 redisplay_window (window
, false);
14228 redisplay_window_1 (Lisp_Object window
)
14230 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14231 redisplay_window (window
, true);
14236 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14237 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14238 which positions recorded in ROW differ from current buffer
14241 Return 0 if cursor is not on this row, 1 otherwise. */
14244 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14245 struct glyph_matrix
*matrix
,
14246 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14249 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14250 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14251 struct glyph
*cursor
= NULL
;
14252 /* The last known character position in row. */
14253 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14255 ptrdiff_t pt_old
= PT
- delta
;
14256 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14257 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14258 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14259 /* A glyph beyond the edge of TEXT_AREA which we should never
14261 struct glyph
*glyphs_end
= end
;
14262 /* Non-zero means we've found a match for cursor position, but that
14263 glyph has the avoid_cursor_p flag set. */
14264 int match_with_avoid_cursor
= 0;
14265 /* Non-zero means we've seen at least one glyph that came from a
14267 int string_seen
= 0;
14268 /* Largest and smallest buffer positions seen so far during scan of
14270 ptrdiff_t bpos_max
= pos_before
;
14271 ptrdiff_t bpos_min
= pos_after
;
14272 /* Last buffer position covered by an overlay string with an integer
14273 `cursor' property. */
14274 ptrdiff_t bpos_covered
= 0;
14275 /* Non-zero means the display string on which to display the cursor
14276 comes from a text property, not from an overlay. */
14277 int string_from_text_prop
= 0;
14279 /* Don't even try doing anything if called for a mode-line or
14280 header-line row, since the rest of the code isn't prepared to
14281 deal with such calamities. */
14282 eassert (!row
->mode_line_p
);
14283 if (row
->mode_line_p
)
14286 /* Skip over glyphs not having an object at the start and the end of
14287 the row. These are special glyphs like truncation marks on
14288 terminal frames. */
14289 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14291 if (!row
->reversed_p
)
14294 && INTEGERP (glyph
->object
)
14295 && glyph
->charpos
< 0)
14297 x
+= glyph
->pixel_width
;
14301 && INTEGERP ((end
- 1)->object
)
14302 /* CHARPOS is zero for blanks and stretch glyphs
14303 inserted by extend_face_to_end_of_line. */
14304 && (end
- 1)->charpos
<= 0)
14306 glyph_before
= glyph
- 1;
14313 /* If the glyph row is reversed, we need to process it from back
14314 to front, so swap the edge pointers. */
14315 glyphs_end
= end
= glyph
- 1;
14316 glyph
+= row
->used
[TEXT_AREA
] - 1;
14318 while (glyph
> end
+ 1
14319 && INTEGERP (glyph
->object
)
14320 && glyph
->charpos
< 0)
14323 x
-= glyph
->pixel_width
;
14325 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14327 /* By default, in reversed rows we put the cursor on the
14328 rightmost (first in the reading order) glyph. */
14329 for (g
= end
+ 1; g
< glyph
; g
++)
14330 x
+= g
->pixel_width
;
14332 && INTEGERP ((end
+ 1)->object
)
14333 && (end
+ 1)->charpos
<= 0)
14335 glyph_before
= glyph
+ 1;
14339 else if (row
->reversed_p
)
14341 /* In R2L rows that don't display text, put the cursor on the
14342 rightmost glyph. Case in point: an empty last line that is
14343 part of an R2L paragraph. */
14345 /* Avoid placing the cursor on the last glyph of the row, where
14346 on terminal frames we hold the vertical border between
14347 adjacent windows. */
14348 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14349 && !WINDOW_RIGHTMOST_P (w
)
14350 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14352 x
= -1; /* will be computed below, at label compute_x */
14355 /* Step 1: Try to find the glyph whose character position
14356 corresponds to point. If that's not possible, find 2 glyphs
14357 whose character positions are the closest to point, one before
14358 point, the other after it. */
14359 if (!row
->reversed_p
)
14360 while (/* not marched to end of glyph row */
14362 /* glyph was not inserted by redisplay for internal purposes */
14363 && !INTEGERP (glyph
->object
))
14365 if (BUFFERP (glyph
->object
))
14367 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14369 if (glyph
->charpos
> bpos_max
)
14370 bpos_max
= glyph
->charpos
;
14371 if (glyph
->charpos
< bpos_min
)
14372 bpos_min
= glyph
->charpos
;
14373 if (!glyph
->avoid_cursor_p
)
14375 /* If we hit point, we've found the glyph on which to
14376 display the cursor. */
14379 match_with_avoid_cursor
= 0;
14382 /* See if we've found a better approximation to
14383 POS_BEFORE or to POS_AFTER. */
14384 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14386 pos_before
= glyph
->charpos
;
14387 glyph_before
= glyph
;
14389 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14391 pos_after
= glyph
->charpos
;
14392 glyph_after
= glyph
;
14395 else if (dpos
== 0)
14396 match_with_avoid_cursor
= 1;
14398 else if (STRINGP (glyph
->object
))
14400 Lisp_Object chprop
;
14401 ptrdiff_t glyph_pos
= glyph
->charpos
;
14403 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14405 if (!NILP (chprop
))
14407 /* If the string came from a `display' text property,
14408 look up the buffer position of that property and
14409 use that position to update bpos_max, as if we
14410 actually saw such a position in one of the row's
14411 glyphs. This helps with supporting integer values
14412 of `cursor' property on the display string in
14413 situations where most or all of the row's buffer
14414 text is completely covered by display properties,
14415 so that no glyph with valid buffer positions is
14416 ever seen in the row. */
14417 ptrdiff_t prop_pos
=
14418 string_buffer_position_lim (glyph
->object
, pos_before
,
14421 if (prop_pos
>= pos_before
)
14422 bpos_max
= prop_pos
- 1;
14424 if (INTEGERP (chprop
))
14426 bpos_covered
= bpos_max
+ XINT (chprop
);
14427 /* If the `cursor' property covers buffer positions up
14428 to and including point, we should display cursor on
14429 this glyph. Note that, if a `cursor' property on one
14430 of the string's characters has an integer value, we
14431 will break out of the loop below _before_ we get to
14432 the position match above. IOW, integer values of
14433 the `cursor' property override the "exact match for
14434 point" strategy of positioning the cursor. */
14435 /* Implementation note: bpos_max == pt_old when, e.g.,
14436 we are in an empty line, where bpos_max is set to
14437 MATRIX_ROW_START_CHARPOS, see above. */
14438 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14447 x
+= glyph
->pixel_width
;
14450 else if (glyph
> end
) /* row is reversed */
14451 while (!INTEGERP (glyph
->object
))
14453 if (BUFFERP (glyph
->object
))
14455 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14457 if (glyph
->charpos
> bpos_max
)
14458 bpos_max
= glyph
->charpos
;
14459 if (glyph
->charpos
< bpos_min
)
14460 bpos_min
= glyph
->charpos
;
14461 if (!glyph
->avoid_cursor_p
)
14465 match_with_avoid_cursor
= 0;
14468 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14470 pos_before
= glyph
->charpos
;
14471 glyph_before
= glyph
;
14473 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14475 pos_after
= glyph
->charpos
;
14476 glyph_after
= glyph
;
14479 else if (dpos
== 0)
14480 match_with_avoid_cursor
= 1;
14482 else if (STRINGP (glyph
->object
))
14484 Lisp_Object chprop
;
14485 ptrdiff_t glyph_pos
= glyph
->charpos
;
14487 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14489 if (!NILP (chprop
))
14491 ptrdiff_t prop_pos
=
14492 string_buffer_position_lim (glyph
->object
, pos_before
,
14495 if (prop_pos
>= pos_before
)
14496 bpos_max
= prop_pos
- 1;
14498 if (INTEGERP (chprop
))
14500 bpos_covered
= bpos_max
+ XINT (chprop
);
14501 /* If the `cursor' property covers buffer positions up
14502 to and including point, we should display cursor on
14504 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14513 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14515 x
--; /* can't use any pixel_width */
14518 x
-= glyph
->pixel_width
;
14521 /* Step 2: If we didn't find an exact match for point, we need to
14522 look for a proper place to put the cursor among glyphs between
14523 GLYPH_BEFORE and GLYPH_AFTER. */
14524 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14525 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14526 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14528 /* An empty line has a single glyph whose OBJECT is zero and
14529 whose CHARPOS is the position of a newline on that line.
14530 Note that on a TTY, there are more glyphs after that, which
14531 were produced by extend_face_to_end_of_line, but their
14532 CHARPOS is zero or negative. */
14534 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14535 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14536 /* On a TTY, continued and truncated rows also have a glyph at
14537 their end whose OBJECT is zero and whose CHARPOS is
14538 positive (the continuation and truncation glyphs), but such
14539 rows are obviously not "empty". */
14540 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14542 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14544 ptrdiff_t ellipsis_pos
;
14546 /* Scan back over the ellipsis glyphs. */
14547 if (!row
->reversed_p
)
14549 ellipsis_pos
= (glyph
- 1)->charpos
;
14550 while (glyph
> row
->glyphs
[TEXT_AREA
]
14551 && (glyph
- 1)->charpos
== ellipsis_pos
)
14552 glyph
--, x
-= glyph
->pixel_width
;
14553 /* That loop always goes one position too far, including
14554 the glyph before the ellipsis. So scan forward over
14556 x
+= glyph
->pixel_width
;
14559 else /* row is reversed */
14561 ellipsis_pos
= (glyph
+ 1)->charpos
;
14562 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14563 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14564 glyph
++, x
+= glyph
->pixel_width
;
14565 x
-= glyph
->pixel_width
;
14569 else if (match_with_avoid_cursor
)
14571 cursor
= glyph_after
;
14574 else if (string_seen
)
14576 int incr
= row
->reversed_p
? -1 : +1;
14578 /* Need to find the glyph that came out of a string which is
14579 present at point. That glyph is somewhere between
14580 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14581 positioned between POS_BEFORE and POS_AFTER in the
14583 struct glyph
*start
, *stop
;
14584 ptrdiff_t pos
= pos_before
;
14588 /* If the row ends in a newline from a display string,
14589 reordering could have moved the glyphs belonging to the
14590 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14591 in this case we extend the search to the last glyph in
14592 the row that was not inserted by redisplay. */
14593 if (row
->ends_in_newline_from_string_p
)
14596 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14599 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14600 correspond to POS_BEFORE and POS_AFTER, respectively. We
14601 need START and STOP in the order that corresponds to the
14602 row's direction as given by its reversed_p flag. If the
14603 directionality of characters between POS_BEFORE and
14604 POS_AFTER is the opposite of the row's base direction,
14605 these characters will have been reordered for display,
14606 and we need to reverse START and STOP. */
14607 if (!row
->reversed_p
)
14609 start
= min (glyph_before
, glyph_after
);
14610 stop
= max (glyph_before
, glyph_after
);
14614 start
= max (glyph_before
, glyph_after
);
14615 stop
= min (glyph_before
, glyph_after
);
14617 for (glyph
= start
+ incr
;
14618 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14621 /* Any glyphs that come from the buffer are here because
14622 of bidi reordering. Skip them, and only pay
14623 attention to glyphs that came from some string. */
14624 if (STRINGP (glyph
->object
))
14628 /* If the display property covers the newline, we
14629 need to search for it one position farther. */
14630 ptrdiff_t lim
= pos_after
14631 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14633 string_from_text_prop
= 0;
14634 str
= glyph
->object
;
14635 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14636 if (tem
== 0 /* from overlay */
14639 /* If the string from which this glyph came is
14640 found in the buffer at point, or at position
14641 that is closer to point than pos_after, then
14642 we've found the glyph we've been looking for.
14643 If it comes from an overlay (tem == 0), and
14644 it has the `cursor' property on one of its
14645 glyphs, record that glyph as a candidate for
14646 displaying the cursor. (As in the
14647 unidirectional version, we will display the
14648 cursor on the last candidate we find.) */
14651 || (tem
- pt_old
> 0 && tem
< pos_after
))
14653 /* The glyphs from this string could have
14654 been reordered. Find the one with the
14655 smallest string position. Or there could
14656 be a character in the string with the
14657 `cursor' property, which means display
14658 cursor on that character's glyph. */
14659 ptrdiff_t strpos
= glyph
->charpos
;
14664 string_from_text_prop
= 1;
14667 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14668 && EQ (glyph
->object
, str
);
14672 ptrdiff_t gpos
= glyph
->charpos
;
14674 cprop
= Fget_char_property (make_number (gpos
),
14682 if (tem
&& glyph
->charpos
< strpos
)
14684 strpos
= glyph
->charpos
;
14690 || (tem
- pt_old
> 0 && tem
< pos_after
))
14694 pos
= tem
+ 1; /* don't find previous instances */
14696 /* This string is not what we want; skip all of the
14697 glyphs that came from it. */
14698 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14699 && EQ (glyph
->object
, str
))
14706 /* If we reached the end of the line, and END was from a string,
14707 the cursor is not on this line. */
14709 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14710 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14711 && STRINGP (end
->object
)
14712 && row
->continued_p
)
14715 /* A truncated row may not include PT among its character positions.
14716 Setting the cursor inside the scroll margin will trigger
14717 recalculation of hscroll in hscroll_window_tree. But if a
14718 display string covers point, defer to the string-handling
14719 code below to figure this out. */
14720 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14722 cursor
= glyph_before
;
14725 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14726 /* Zero-width characters produce no glyphs. */
14728 && (row
->reversed_p
14729 ? glyph_after
> glyphs_end
14730 : glyph_after
< glyphs_end
)))
14732 cursor
= glyph_after
;
14738 if (cursor
!= NULL
)
14740 else if (glyph
== glyphs_end
14741 && pos_before
== pos_after
14742 && STRINGP ((row
->reversed_p
14743 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14744 : row
->glyphs
[TEXT_AREA
])->object
))
14746 /* If all the glyphs of this row came from strings, put the
14747 cursor on the first glyph of the row. This avoids having the
14748 cursor outside of the text area in this very rare and hard
14752 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14753 : row
->glyphs
[TEXT_AREA
];
14759 /* Need to compute x that corresponds to GLYPH. */
14760 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14762 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14764 x
+= g
->pixel_width
;
14768 /* ROW could be part of a continued line, which, under bidi
14769 reordering, might have other rows whose start and end charpos
14770 occlude point. Only set w->cursor if we found a better
14771 approximation to the cursor position than we have from previously
14772 examined candidate rows belonging to the same continued line. */
14773 if (/* We already have a candidate row. */
14774 w
->cursor
.vpos
>= 0
14775 /* That candidate is not the row we are processing. */
14776 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14777 /* Make sure cursor.vpos specifies a row whose start and end
14778 charpos occlude point, and it is valid candidate for being a
14779 cursor-row. This is because some callers of this function
14780 leave cursor.vpos at the row where the cursor was displayed
14781 during the last redisplay cycle. */
14782 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14783 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14784 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14787 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14789 /* Don't consider glyphs that are outside TEXT_AREA. */
14790 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14792 /* Keep the candidate whose buffer position is the closest to
14793 point or has the `cursor' property. */
14794 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14795 w
->cursor
.hpos
>= 0
14796 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14797 && ((BUFFERP (g1
->object
)
14798 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14799 || (BUFFERP (glyph
->object
)
14800 && eabs (g1
->charpos
- pt_old
)
14801 < eabs (glyph
->charpos
- pt_old
))))
14802 /* Previous candidate is a glyph from a string that has
14803 a non-nil `cursor' property. */
14804 || (STRINGP (g1
->object
)
14805 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14806 Qcursor
, g1
->object
))
14807 /* Previous candidate is from the same display
14808 string as this one, and the display string
14809 came from a text property. */
14810 || (EQ (g1
->object
, glyph
->object
)
14811 && string_from_text_prop
)
14812 /* this candidate is from newline and its
14813 position is not an exact match */
14814 || (INTEGERP (glyph
->object
)
14815 && glyph
->charpos
!= pt_old
)))))
14817 /* If this candidate gives an exact match, use that. */
14818 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14819 /* If this candidate is a glyph created for the
14820 terminating newline of a line, and point is on that
14821 newline, it wins because it's an exact match. */
14822 || (!row
->continued_p
14823 && INTEGERP (glyph
->object
)
14824 && glyph
->charpos
== 0
14825 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14826 /* Otherwise, keep the candidate that comes from a row
14827 spanning less buffer positions. This may win when one or
14828 both candidate positions are on glyphs that came from
14829 display strings, for which we cannot compare buffer
14831 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14832 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14833 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14836 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14838 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14839 w
->cursor
.y
= row
->y
+ dy
;
14841 if (w
== XWINDOW (selected_window
))
14843 if (!row
->continued_p
14844 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14847 this_line_buffer
= XBUFFER (w
->contents
);
14849 CHARPOS (this_line_start_pos
)
14850 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14851 BYTEPOS (this_line_start_pos
)
14852 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14854 CHARPOS (this_line_end_pos
)
14855 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14856 BYTEPOS (this_line_end_pos
)
14857 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14859 this_line_y
= w
->cursor
.y
;
14860 this_line_pixel_height
= row
->height
;
14861 this_line_vpos
= w
->cursor
.vpos
;
14862 this_line_start_x
= row
->x
;
14865 CHARPOS (this_line_start_pos
) = 0;
14872 /* Run window scroll functions, if any, for WINDOW with new window
14873 start STARTP. Sets the window start of WINDOW to that position.
14875 We assume that the window's buffer is really current. */
14877 static struct text_pos
14878 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14880 struct window
*w
= XWINDOW (window
);
14881 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14883 eassert (current_buffer
== XBUFFER (w
->contents
));
14885 if (!NILP (Vwindow_scroll_functions
))
14887 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14888 make_number (CHARPOS (startp
)));
14889 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14890 /* In case the hook functions switch buffers. */
14891 set_buffer_internal (XBUFFER (w
->contents
));
14898 /* Make sure the line containing the cursor is fully visible.
14899 A value of 1 means there is nothing to be done.
14900 (Either the line is fully visible, or it cannot be made so,
14901 or we cannot tell.)
14903 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14904 is higher than window.
14906 A value of 0 means the caller should do scrolling
14907 as if point had gone off the screen. */
14910 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14912 struct glyph_matrix
*matrix
;
14913 struct glyph_row
*row
;
14916 if (!make_cursor_line_fully_visible_p
)
14919 /* It's not always possible to find the cursor, e.g, when a window
14920 is full of overlay strings. Don't do anything in that case. */
14921 if (w
->cursor
.vpos
< 0)
14924 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14925 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14927 /* If the cursor row is not partially visible, there's nothing to do. */
14928 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14931 /* If the row the cursor is in is taller than the window's height,
14932 it's not clear what to do, so do nothing. */
14933 window_height
= window_box_height (w
);
14934 if (row
->height
>= window_height
)
14936 if (!force_p
|| MINI_WINDOW_P (w
)
14937 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14944 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14945 non-zero means only WINDOW is redisplayed in redisplay_internal.
14946 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14947 in redisplay_window to bring a partially visible line into view in
14948 the case that only the cursor has moved.
14950 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14951 last screen line's vertical height extends past the end of the screen.
14955 1 if scrolling succeeded
14957 0 if scrolling didn't find point.
14959 -1 if new fonts have been loaded so that we must interrupt
14960 redisplay, adjust glyph matrices, and try again. */
14966 SCROLLING_NEED_LARGER_MATRICES
14969 /* If scroll-conservatively is more than this, never recenter.
14971 If you change this, don't forget to update the doc string of
14972 `scroll-conservatively' and the Emacs manual. */
14973 #define SCROLL_LIMIT 100
14976 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14977 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14978 int temp_scroll_step
, int last_line_misfit
)
14980 struct window
*w
= XWINDOW (window
);
14981 struct frame
*f
= XFRAME (w
->frame
);
14982 struct text_pos pos
, startp
;
14984 int this_scroll_margin
, scroll_max
, rc
, height
;
14985 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14986 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14987 Lisp_Object aggressive
;
14988 /* We will never try scrolling more than this number of lines. */
14989 int scroll_limit
= SCROLL_LIMIT
;
14990 int frame_line_height
= default_line_pixel_height (w
);
14991 int window_total_lines
14992 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14995 debug_method_add (w
, "try_scrolling");
14998 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15000 /* Compute scroll margin height in pixels. We scroll when point is
15001 within this distance from the top or bottom of the window. */
15002 if (scroll_margin
> 0)
15003 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15004 * frame_line_height
;
15006 this_scroll_margin
= 0;
15008 /* Force arg_scroll_conservatively to have a reasonable value, to
15009 avoid scrolling too far away with slow move_it_* functions. Note
15010 that the user can supply scroll-conservatively equal to
15011 `most-positive-fixnum', which can be larger than INT_MAX. */
15012 if (arg_scroll_conservatively
> scroll_limit
)
15014 arg_scroll_conservatively
= scroll_limit
+ 1;
15015 scroll_max
= scroll_limit
* frame_line_height
;
15017 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15018 /* Compute how much we should try to scroll maximally to bring
15019 point into view. */
15020 scroll_max
= (max (scroll_step
,
15021 max (arg_scroll_conservatively
, temp_scroll_step
))
15022 * frame_line_height
);
15023 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15024 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15025 /* We're trying to scroll because of aggressive scrolling but no
15026 scroll_step is set. Choose an arbitrary one. */
15027 scroll_max
= 10 * frame_line_height
;
15033 /* Decide whether to scroll down. */
15034 if (PT
> CHARPOS (startp
))
15036 int scroll_margin_y
;
15038 /* Compute the pixel ypos of the scroll margin, then move IT to
15039 either that ypos or PT, whichever comes first. */
15040 start_display (&it
, w
, startp
);
15041 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15042 - frame_line_height
* extra_scroll_margin_lines
;
15043 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15044 (MOVE_TO_POS
| MOVE_TO_Y
));
15046 if (PT
> CHARPOS (it
.current
.pos
))
15048 int y0
= line_bottom_y (&it
);
15049 /* Compute how many pixels below window bottom to stop searching
15050 for PT. This avoids costly search for PT that is far away if
15051 the user limited scrolling by a small number of lines, but
15052 always finds PT if scroll_conservatively is set to a large
15053 number, such as most-positive-fixnum. */
15054 int slack
= max (scroll_max
, 10 * frame_line_height
);
15055 int y_to_move
= it
.last_visible_y
+ slack
;
15057 /* Compute the distance from the scroll margin to PT or to
15058 the scroll limit, whichever comes first. This should
15059 include the height of the cursor line, to make that line
15061 move_it_to (&it
, PT
, -1, y_to_move
,
15062 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15063 dy
= line_bottom_y (&it
) - y0
;
15065 if (dy
> scroll_max
)
15066 return SCROLLING_FAILED
;
15075 /* Point is in or below the bottom scroll margin, so move the
15076 window start down. If scrolling conservatively, move it just
15077 enough down to make point visible. If scroll_step is set,
15078 move it down by scroll_step. */
15079 if (arg_scroll_conservatively
)
15081 = min (max (dy
, frame_line_height
),
15082 frame_line_height
* arg_scroll_conservatively
);
15083 else if (scroll_step
|| temp_scroll_step
)
15084 amount_to_scroll
= scroll_max
;
15087 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15088 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15089 if (NUMBERP (aggressive
))
15091 double float_amount
= XFLOATINT (aggressive
) * height
;
15092 int aggressive_scroll
= float_amount
;
15093 if (aggressive_scroll
== 0 && float_amount
> 0)
15094 aggressive_scroll
= 1;
15095 /* Don't let point enter the scroll margin near top of
15096 the window. This could happen if the value of
15097 scroll_up_aggressively is too large and there are
15098 non-zero margins, because scroll_up_aggressively
15099 means put point that fraction of window height
15100 _from_the_bottom_margin_. */
15101 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15102 aggressive_scroll
= height
- 2*this_scroll_margin
;
15103 amount_to_scroll
= dy
+ aggressive_scroll
;
15107 if (amount_to_scroll
<= 0)
15108 return SCROLLING_FAILED
;
15110 start_display (&it
, w
, startp
);
15111 if (arg_scroll_conservatively
<= scroll_limit
)
15112 move_it_vertically (&it
, amount_to_scroll
);
15115 /* Extra precision for users who set scroll-conservatively
15116 to a large number: make sure the amount we scroll
15117 the window start is never less than amount_to_scroll,
15118 which was computed as distance from window bottom to
15119 point. This matters when lines at window top and lines
15120 below window bottom have different height. */
15122 void *it1data
= NULL
;
15123 /* We use a temporary it1 because line_bottom_y can modify
15124 its argument, if it moves one line down; see there. */
15127 SAVE_IT (it1
, it
, it1data
);
15128 start_y
= line_bottom_y (&it1
);
15130 RESTORE_IT (&it
, &it
, it1data
);
15131 move_it_by_lines (&it
, 1);
15132 SAVE_IT (it1
, it
, it1data
);
15133 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15136 /* If STARTP is unchanged, move it down another screen line. */
15137 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15138 move_it_by_lines (&it
, 1);
15139 startp
= it
.current
.pos
;
15143 struct text_pos scroll_margin_pos
= startp
;
15146 /* See if point is inside the scroll margin at the top of the
15148 if (this_scroll_margin
)
15152 start_display (&it
, w
, startp
);
15153 y_start
= it
.current_y
;
15154 move_it_vertically (&it
, this_scroll_margin
);
15155 scroll_margin_pos
= it
.current
.pos
;
15156 /* If we didn't move enough before hitting ZV, request
15157 additional amount of scroll, to move point out of the
15159 if (IT_CHARPOS (it
) == ZV
15160 && it
.current_y
- y_start
< this_scroll_margin
)
15161 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15164 if (PT
< CHARPOS (scroll_margin_pos
))
15166 /* Point is in the scroll margin at the top of the window or
15167 above what is displayed in the window. */
15170 /* Compute the vertical distance from PT to the scroll
15171 margin position. Move as far as scroll_max allows, or
15172 one screenful, or 10 screen lines, whichever is largest.
15173 Give up if distance is greater than scroll_max or if we
15174 didn't reach the scroll margin position. */
15175 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15176 start_display (&it
, w
, pos
);
15178 y_to_move
= max (it
.last_visible_y
,
15179 max (scroll_max
, 10 * frame_line_height
));
15180 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15182 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15183 dy
= it
.current_y
- y0
;
15184 if (dy
> scroll_max
15185 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15186 return SCROLLING_FAILED
;
15188 /* Additional scroll for when ZV was too close to point. */
15191 /* Compute new window start. */
15192 start_display (&it
, w
, startp
);
15194 if (arg_scroll_conservatively
)
15195 amount_to_scroll
= max (dy
, frame_line_height
*
15196 max (scroll_step
, temp_scroll_step
));
15197 else if (scroll_step
|| temp_scroll_step
)
15198 amount_to_scroll
= scroll_max
;
15201 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15202 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15203 if (NUMBERP (aggressive
))
15205 double float_amount
= XFLOATINT (aggressive
) * height
;
15206 int aggressive_scroll
= float_amount
;
15207 if (aggressive_scroll
== 0 && float_amount
> 0)
15208 aggressive_scroll
= 1;
15209 /* Don't let point enter the scroll margin near
15210 bottom of the window, if the value of
15211 scroll_down_aggressively happens to be too
15213 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15214 aggressive_scroll
= height
- 2*this_scroll_margin
;
15215 amount_to_scroll
= dy
+ aggressive_scroll
;
15219 if (amount_to_scroll
<= 0)
15220 return SCROLLING_FAILED
;
15222 move_it_vertically_backward (&it
, amount_to_scroll
);
15223 startp
= it
.current
.pos
;
15227 /* Run window scroll functions. */
15228 startp
= run_window_scroll_functions (window
, startp
);
15230 /* Display the window. Give up if new fonts are loaded, or if point
15232 if (!try_window (window
, startp
, 0))
15233 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15234 else if (w
->cursor
.vpos
< 0)
15236 clear_glyph_matrix (w
->desired_matrix
);
15237 rc
= SCROLLING_FAILED
;
15241 /* Maybe forget recorded base line for line number display. */
15242 if (!just_this_one_p
15243 || current_buffer
->clip_changed
15244 || BEG_UNCHANGED
< CHARPOS (startp
))
15245 w
->base_line_number
= 0;
15247 /* If cursor ends up on a partially visible line,
15248 treat that as being off the bottom of the screen. */
15249 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15250 /* It's possible that the cursor is on the first line of the
15251 buffer, which is partially obscured due to a vscroll
15252 (Bug#7537). In that case, avoid looping forever. */
15253 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15255 clear_glyph_matrix (w
->desired_matrix
);
15256 ++extra_scroll_margin_lines
;
15259 rc
= SCROLLING_SUCCESS
;
15266 /* Compute a suitable window start for window W if display of W starts
15267 on a continuation line. Value is non-zero if a new window start
15270 The new window start will be computed, based on W's width, starting
15271 from the start of the continued line. It is the start of the
15272 screen line with the minimum distance from the old start W->start. */
15275 compute_window_start_on_continuation_line (struct window
*w
)
15277 struct text_pos pos
, start_pos
;
15278 int window_start_changed_p
= 0;
15280 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15282 /* If window start is on a continuation line... Window start may be
15283 < BEGV in case there's invisible text at the start of the
15284 buffer (M-x rmail, for example). */
15285 if (CHARPOS (start_pos
) > BEGV
15286 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15289 struct glyph_row
*row
;
15291 /* Handle the case that the window start is out of range. */
15292 if (CHARPOS (start_pos
) < BEGV
)
15293 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15294 else if (CHARPOS (start_pos
) > ZV
)
15295 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15297 /* Find the start of the continued line. This should be fast
15298 because find_newline is fast (newline cache). */
15299 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15300 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15301 row
, DEFAULT_FACE_ID
);
15302 reseat_at_previous_visible_line_start (&it
);
15304 /* If the line start is "too far" away from the window start,
15305 say it takes too much time to compute a new window start. */
15306 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15307 /* PXW: Do we need upper bounds here? */
15308 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15310 int min_distance
, distance
;
15312 /* Move forward by display lines to find the new window
15313 start. If window width was enlarged, the new start can
15314 be expected to be > the old start. If window width was
15315 decreased, the new window start will be < the old start.
15316 So, we're looking for the display line start with the
15317 minimum distance from the old window start. */
15318 pos
= it
.current
.pos
;
15319 min_distance
= INFINITY
;
15320 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15321 distance
< min_distance
)
15323 min_distance
= distance
;
15324 pos
= it
.current
.pos
;
15325 if (it
.line_wrap
== WORD_WRAP
)
15327 /* Under WORD_WRAP, move_it_by_lines is likely to
15328 overshoot and stop not at the first, but the
15329 second character from the left margin. So in
15330 that case, we need a more tight control on the X
15331 coordinate of the iterator than move_it_by_lines
15332 promises in its contract. The method is to first
15333 go to the last (rightmost) visible character of a
15334 line, then move to the leftmost character on the
15335 next line in a separate call. */
15336 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15337 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15338 move_it_to (&it
, ZV
, 0,
15339 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15340 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15343 move_it_by_lines (&it
, 1);
15346 /* Set the window start there. */
15347 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15348 window_start_changed_p
= 1;
15352 return window_start_changed_p
;
15356 /* Try cursor movement in case text has not changed in window WINDOW,
15357 with window start STARTP. Value is
15359 CURSOR_MOVEMENT_SUCCESS if successful
15361 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15363 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15364 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15365 we want to scroll as if scroll-step were set to 1. See the code.
15367 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15368 which case we have to abort this redisplay, and adjust matrices
15373 CURSOR_MOVEMENT_SUCCESS
,
15374 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15375 CURSOR_MOVEMENT_MUST_SCROLL
,
15376 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15380 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15382 struct window
*w
= XWINDOW (window
);
15383 struct frame
*f
= XFRAME (w
->frame
);
15384 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15387 if (inhibit_try_cursor_movement
)
15391 /* Previously, there was a check for Lisp integer in the
15392 if-statement below. Now, this field is converted to
15393 ptrdiff_t, thus zero means invalid position in a buffer. */
15394 eassert (w
->last_point
> 0);
15395 /* Likewise there was a check whether window_end_vpos is nil or larger
15396 than the window. Now window_end_vpos is int and so never nil, but
15397 let's leave eassert to check whether it fits in the window. */
15398 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15400 /* Handle case where text has not changed, only point, and it has
15401 not moved off the frame. */
15402 if (/* Point may be in this window. */
15403 PT
>= CHARPOS (startp
)
15404 /* Selective display hasn't changed. */
15405 && !current_buffer
->clip_changed
15406 /* Function force-mode-line-update is used to force a thorough
15407 redisplay. It sets either windows_or_buffers_changed or
15408 update_mode_lines. So don't take a shortcut here for these
15410 && !update_mode_lines
15411 && !windows_or_buffers_changed
15412 && !f
->cursor_type_changed
15413 && NILP (Vshow_trailing_whitespace
)
15414 /* This code is not used for mini-buffer for the sake of the case
15415 of redisplaying to replace an echo area message; since in
15416 that case the mini-buffer contents per se are usually
15417 unchanged. This code is of no real use in the mini-buffer
15418 since the handling of this_line_start_pos, etc., in redisplay
15419 handles the same cases. */
15420 && !EQ (window
, minibuf_window
)
15421 && (FRAME_WINDOW_P (f
)
15422 || !overlay_arrow_in_current_buffer_p ()))
15424 int this_scroll_margin
, top_scroll_margin
;
15425 struct glyph_row
*row
= NULL
;
15426 int frame_line_height
= default_line_pixel_height (w
);
15427 int window_total_lines
15428 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15431 debug_method_add (w
, "cursor movement");
15434 /* Scroll if point within this distance from the top or bottom
15435 of the window. This is a pixel value. */
15436 if (scroll_margin
> 0)
15438 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15439 this_scroll_margin
*= frame_line_height
;
15442 this_scroll_margin
= 0;
15444 top_scroll_margin
= this_scroll_margin
;
15445 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15446 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15448 /* Start with the row the cursor was displayed during the last
15449 not paused redisplay. Give up if that row is not valid. */
15450 if (w
->last_cursor_vpos
< 0
15451 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15452 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15455 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15456 if (row
->mode_line_p
)
15458 if (!row
->enabled_p
)
15459 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15462 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15464 int scroll_p
= 0, must_scroll
= 0;
15465 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15467 if (PT
> w
->last_point
)
15469 /* Point has moved forward. */
15470 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15471 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15473 eassert (row
->enabled_p
);
15477 /* If the end position of a row equals the start
15478 position of the next row, and PT is at that position,
15479 we would rather display cursor in the next line. */
15480 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15481 && MATRIX_ROW_END_CHARPOS (row
) == PT
15482 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15483 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15484 && !cursor_row_p (row
))
15487 /* If within the scroll margin, scroll. Note that
15488 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15489 the next line would be drawn, and that
15490 this_scroll_margin can be zero. */
15491 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15492 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15493 /* Line is completely visible last line in window
15494 and PT is to be set in the next line. */
15495 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15496 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15497 && !row
->ends_at_zv_p
15498 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15501 else if (PT
< w
->last_point
)
15503 /* Cursor has to be moved backward. Note that PT >=
15504 CHARPOS (startp) because of the outer if-statement. */
15505 while (!row
->mode_line_p
15506 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15507 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15508 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15509 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15510 row
> w
->current_matrix
->rows
15511 && (row
-1)->ends_in_newline_from_string_p
))))
15512 && (row
->y
> top_scroll_margin
15513 || CHARPOS (startp
) == BEGV
))
15515 eassert (row
->enabled_p
);
15519 /* Consider the following case: Window starts at BEGV,
15520 there is invisible, intangible text at BEGV, so that
15521 display starts at some point START > BEGV. It can
15522 happen that we are called with PT somewhere between
15523 BEGV and START. Try to handle that case. */
15524 if (row
< w
->current_matrix
->rows
15525 || row
->mode_line_p
)
15527 row
= w
->current_matrix
->rows
;
15528 if (row
->mode_line_p
)
15532 /* Due to newlines in overlay strings, we may have to
15533 skip forward over overlay strings. */
15534 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15535 && MATRIX_ROW_END_CHARPOS (row
) == PT
15536 && !cursor_row_p (row
))
15539 /* If within the scroll margin, scroll. */
15540 if (row
->y
< top_scroll_margin
15541 && CHARPOS (startp
) != BEGV
)
15546 /* Cursor did not move. So don't scroll even if cursor line
15547 is partially visible, as it was so before. */
15548 rc
= CURSOR_MOVEMENT_SUCCESS
;
15551 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15552 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15554 /* if PT is not in the glyph row, give up. */
15555 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15558 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15559 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15561 struct glyph_row
*row1
;
15563 /* If rows are bidi-reordered and point moved, back up
15564 until we find a row that does not belong to a
15565 continuation line. This is because we must consider
15566 all rows of a continued line as candidates for the
15567 new cursor positioning, since row start and end
15568 positions change non-linearly with vertical position
15570 /* FIXME: Revisit this when glyph ``spilling'' in
15571 continuation lines' rows is implemented for
15572 bidi-reordered rows. */
15573 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15574 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15577 /* If we hit the beginning of the displayed portion
15578 without finding the first row of a continued
15582 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15585 eassert (row
->enabled_p
);
15590 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15591 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15592 /* Make sure this isn't a header line by any chance, since
15593 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15594 && !row
->mode_line_p
15595 && make_cursor_line_fully_visible_p
)
15597 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15598 && !row
->ends_at_zv_p
15599 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15600 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15601 else if (row
->height
> window_box_height (w
))
15603 /* If we end up in a partially visible line, let's
15604 make it fully visible, except when it's taller
15605 than the window, in which case we can't do much
15608 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15612 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15613 if (!cursor_row_fully_visible_p (w
, 0, 1))
15614 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15616 rc
= CURSOR_MOVEMENT_SUCCESS
;
15620 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15621 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15622 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15624 /* With bidi-reordered rows, there could be more than
15625 one candidate row whose start and end positions
15626 occlude point. We need to let set_cursor_from_row
15627 find the best candidate. */
15628 /* FIXME: Revisit this when glyph ``spilling'' in
15629 continuation lines' rows is implemented for
15630 bidi-reordered rows. */
15635 int at_zv_p
= 0, exact_match_p
= 0;
15637 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15638 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15639 && cursor_row_p (row
))
15640 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15642 /* As soon as we've found the exact match for point,
15643 or the first suitable row whose ends_at_zv_p flag
15644 is set, we are done. */
15647 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15648 w
->cursor
.vpos
)->ends_at_zv_p
;
15650 && w
->cursor
.hpos
>= 0
15651 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15654 struct glyph_row
*candidate
=
15655 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15657 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15658 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15661 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15662 || (INTEGERP (g
->object
)
15663 && (g
->charpos
== PT
15664 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15666 if (at_zv_p
|| exact_match_p
)
15668 rc
= CURSOR_MOVEMENT_SUCCESS
;
15672 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15676 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15677 || row
->continued_p
)
15678 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15679 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15680 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15681 /* If we didn't find any candidate rows, or exited the
15682 loop before all the candidates were examined, signal
15683 to the caller that this method failed. */
15684 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15686 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15687 && !row
->continued_p
))
15688 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15690 rc
= CURSOR_MOVEMENT_SUCCESS
;
15696 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15698 rc
= CURSOR_MOVEMENT_SUCCESS
;
15703 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15704 && MATRIX_ROW_START_CHARPOS (row
) == PT
15705 && cursor_row_p (row
));
15713 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15717 set_vertical_scroll_bar (struct window
*w
)
15719 ptrdiff_t start
, end
, whole
;
15721 /* Calculate the start and end positions for the current window.
15722 At some point, it would be nice to choose between scrollbars
15723 which reflect the whole buffer size, with special markers
15724 indicating narrowing, and scrollbars which reflect only the
15727 Note that mini-buffers sometimes aren't displaying any text. */
15728 if (!MINI_WINDOW_P (w
)
15729 || (w
== XWINDOW (minibuf_window
)
15730 && NILP (echo_area_buffer
[0])))
15732 struct buffer
*buf
= XBUFFER (w
->contents
);
15733 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15734 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15735 /* I don't think this is guaranteed to be right. For the
15736 moment, we'll pretend it is. */
15737 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15741 if (whole
< (end
- start
))
15742 whole
= end
- start
;
15745 start
= end
= whole
= 0;
15747 /* Indicate what this scroll bar ought to be displaying now. */
15748 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15749 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15750 (w
, end
- start
, whole
, start
);
15754 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15755 selected_window is redisplayed.
15757 We can return without actually redisplaying the window if fonts has been
15758 changed on window's frame. In that case, redisplay_internal will retry. */
15761 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15763 struct window
*w
= XWINDOW (window
);
15764 struct frame
*f
= XFRAME (w
->frame
);
15765 struct buffer
*buffer
= XBUFFER (w
->contents
);
15766 struct buffer
*old
= current_buffer
;
15767 struct text_pos lpoint
, opoint
, startp
;
15768 int update_mode_line
;
15771 /* Record it now because it's overwritten. */
15772 bool current_matrix_up_to_date_p
= false;
15773 bool used_current_matrix_p
= false;
15774 /* This is less strict than current_matrix_up_to_date_p.
15775 It indicates that the buffer contents and narrowing are unchanged. */
15776 bool buffer_unchanged_p
= false;
15777 int temp_scroll_step
= 0;
15778 ptrdiff_t count
= SPECPDL_INDEX ();
15780 int centering_position
= -1;
15781 int last_line_misfit
= 0;
15782 ptrdiff_t beg_unchanged
, end_unchanged
;
15783 int frame_line_height
;
15785 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15789 *w
->desired_matrix
->method
= 0;
15792 if (!just_this_one_p
15793 && REDISPLAY_SOME_P ()
15796 && !buffer
->text
->redisplay
15797 && BUF_PT (buffer
) == w
->last_point
)
15800 /* Make sure that both W's markers are valid. */
15801 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15802 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15805 reconsider_clip_changes (w
);
15806 frame_line_height
= default_line_pixel_height (w
);
15808 /* Has the mode line to be updated? */
15809 update_mode_line
= (w
->update_mode_line
15810 || update_mode_lines
15811 || buffer
->clip_changed
15812 || buffer
->prevent_redisplay_optimizations_p
);
15814 if (!just_this_one_p
)
15815 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15816 cleverly elsewhere. */
15817 w
->must_be_updated_p
= true;
15819 if (MINI_WINDOW_P (w
))
15821 if (w
== XWINDOW (echo_area_window
)
15822 && !NILP (echo_area_buffer
[0]))
15824 if (update_mode_line
)
15825 /* We may have to update a tty frame's menu bar or a
15826 tool-bar. Example `M-x C-h C-h C-g'. */
15827 goto finish_menu_bars
;
15829 /* We've already displayed the echo area glyphs in this window. */
15830 goto finish_scroll_bars
;
15832 else if ((w
!= XWINDOW (minibuf_window
)
15833 || minibuf_level
== 0)
15834 /* When buffer is nonempty, redisplay window normally. */
15835 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15836 /* Quail displays non-mini buffers in minibuffer window.
15837 In that case, redisplay the window normally. */
15838 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15840 /* W is a mini-buffer window, but it's not active, so clear
15842 int yb
= window_text_bottom_y (w
);
15843 struct glyph_row
*row
;
15846 for (y
= 0, row
= w
->desired_matrix
->rows
;
15848 y
+= row
->height
, ++row
)
15849 blank_row (w
, row
, y
);
15850 goto finish_scroll_bars
;
15853 clear_glyph_matrix (w
->desired_matrix
);
15856 /* Otherwise set up data on this window; select its buffer and point
15858 /* Really select the buffer, for the sake of buffer-local
15860 set_buffer_internal_1 (XBUFFER (w
->contents
));
15862 current_matrix_up_to_date_p
15863 = (w
->window_end_valid
15864 && !current_buffer
->clip_changed
15865 && !current_buffer
->prevent_redisplay_optimizations_p
15866 && !window_outdated (w
));
15868 /* Run the window-bottom-change-functions
15869 if it is possible that the text on the screen has changed
15870 (either due to modification of the text, or any other reason). */
15871 if (!current_matrix_up_to_date_p
15872 && !NILP (Vwindow_text_change_functions
))
15874 safe_run_hooks (Qwindow_text_change_functions
);
15878 beg_unchanged
= BEG_UNCHANGED
;
15879 end_unchanged
= END_UNCHANGED
;
15881 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15883 specbind (Qinhibit_point_motion_hooks
, Qt
);
15886 = (w
->window_end_valid
15887 && !current_buffer
->clip_changed
15888 && !window_outdated (w
));
15890 /* When windows_or_buffers_changed is non-zero, we can't rely
15891 on the window end being valid, so set it to zero there. */
15892 if (windows_or_buffers_changed
)
15894 /* If window starts on a continuation line, maybe adjust the
15895 window start in case the window's width changed. */
15896 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15897 compute_window_start_on_continuation_line (w
);
15899 w
->window_end_valid
= false;
15900 /* If so, we also can't rely on current matrix
15901 and should not fool try_cursor_movement below. */
15902 current_matrix_up_to_date_p
= false;
15905 /* Some sanity checks. */
15906 CHECK_WINDOW_END (w
);
15907 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15909 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15912 if (mode_line_update_needed (w
))
15913 update_mode_line
= 1;
15915 /* Point refers normally to the selected window. For any other
15916 window, set up appropriate value. */
15917 if (!EQ (window
, selected_window
))
15919 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15920 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15924 new_pt_byte
= BEGV_BYTE
;
15925 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15927 else if (new_pt
> (ZV
- 1))
15930 new_pt_byte
= ZV_BYTE
;
15931 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15934 /* We don't use SET_PT so that the point-motion hooks don't run. */
15935 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15938 /* If any of the character widths specified in the display table
15939 have changed, invalidate the width run cache. It's true that
15940 this may be a bit late to catch such changes, but the rest of
15941 redisplay goes (non-fatally) haywire when the display table is
15942 changed, so why should we worry about doing any better? */
15943 if (current_buffer
->width_run_cache
15944 || (current_buffer
->base_buffer
15945 && current_buffer
->base_buffer
->width_run_cache
))
15947 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15949 if (! disptab_matches_widthtab
15950 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15952 struct buffer
*buf
= current_buffer
;
15954 if (buf
->base_buffer
)
15955 buf
= buf
->base_buffer
;
15956 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
15957 recompute_width_table (current_buffer
, disptab
);
15961 /* If window-start is screwed up, choose a new one. */
15962 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15965 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15967 /* If someone specified a new starting point but did not insist,
15968 check whether it can be used. */
15969 if (w
->optional_new_start
15970 && CHARPOS (startp
) >= BEGV
15971 && CHARPOS (startp
) <= ZV
)
15973 w
->optional_new_start
= 0;
15974 start_display (&it
, w
, startp
);
15975 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15976 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15977 if (IT_CHARPOS (it
) == PT
)
15978 w
->force_start
= 1;
15979 /* IT may overshoot PT if text at PT is invisible. */
15980 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15981 w
->force_start
= 1;
15986 /* Handle case where place to start displaying has been specified,
15987 unless the specified location is outside the accessible range. */
15988 if (w
->force_start
|| window_frozen_p (w
))
15990 /* We set this later on if we have to adjust point. */
15993 w
->force_start
= 0;
15995 w
->window_end_valid
= 0;
15997 /* Forget any recorded base line for line number display. */
15998 if (!buffer_unchanged_p
)
15999 w
->base_line_number
= 0;
16001 /* Redisplay the mode line. Select the buffer properly for that.
16002 Also, run the hook window-scroll-functions
16003 because we have scrolled. */
16004 /* Note, we do this after clearing force_start because
16005 if there's an error, it is better to forget about force_start
16006 than to get into an infinite loop calling the hook functions
16007 and having them get more errors. */
16008 if (!update_mode_line
16009 || ! NILP (Vwindow_scroll_functions
))
16011 update_mode_line
= 1;
16012 w
->update_mode_line
= 1;
16013 startp
= run_window_scroll_functions (window
, startp
);
16016 if (CHARPOS (startp
) < BEGV
)
16017 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16018 else if (CHARPOS (startp
) > ZV
)
16019 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16021 /* Redisplay, then check if cursor has been set during the
16022 redisplay. Give up if new fonts were loaded. */
16023 /* We used to issue a CHECK_MARGINS argument to try_window here,
16024 but this causes scrolling to fail when point begins inside
16025 the scroll margin (bug#148) -- cyd */
16026 if (!try_window (window
, startp
, 0))
16028 w
->force_start
= 1;
16029 clear_glyph_matrix (w
->desired_matrix
);
16030 goto need_larger_matrices
;
16033 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16035 /* If point does not appear, try to move point so it does
16036 appear. The desired matrix has been built above, so we
16037 can use it here. */
16038 new_vpos
= window_box_height (w
) / 2;
16041 if (!cursor_row_fully_visible_p (w
, 0, 0))
16043 /* Point does appear, but on a line partly visible at end of window.
16044 Move it back to a fully-visible line. */
16045 new_vpos
= window_box_height (w
);
16047 else if (w
->cursor
.vpos
>= 0)
16049 /* Some people insist on not letting point enter the scroll
16050 margin, even though this part handles windows that didn't
16052 int window_total_lines
16053 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16054 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16055 int pixel_margin
= margin
* frame_line_height
;
16056 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16058 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16059 below, which finds the row to move point to, advances by
16060 the Y coordinate of the _next_ row, see the definition of
16061 MATRIX_ROW_BOTTOM_Y. */
16062 if (w
->cursor
.vpos
< margin
+ header_line
)
16064 w
->cursor
.vpos
= -1;
16065 clear_glyph_matrix (w
->desired_matrix
);
16066 goto try_to_scroll
;
16070 int window_height
= window_box_height (w
);
16073 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16074 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16076 w
->cursor
.vpos
= -1;
16077 clear_glyph_matrix (w
->desired_matrix
);
16078 goto try_to_scroll
;
16083 /* If we need to move point for either of the above reasons,
16084 now actually do it. */
16087 struct glyph_row
*row
;
16089 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16090 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16093 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16094 MATRIX_ROW_START_BYTEPOS (row
));
16096 if (w
!= XWINDOW (selected_window
))
16097 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16098 else if (current_buffer
== old
)
16099 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16101 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16103 /* If we are highlighting the region, then we just changed
16104 the region, so redisplay to show it. */
16105 /* FIXME: We need to (re)run pre-redisplay-function! */
16106 /* if (markpos_of_region () >= 0)
16108 clear_glyph_matrix (w->desired_matrix);
16109 if (!try_window (window, startp, 0))
16110 goto need_larger_matrices;
16116 debug_method_add (w
, "forced window start");
16121 /* Handle case where text has not changed, only point, and it has
16122 not moved off the frame, and we are not retrying after hscroll.
16123 (current_matrix_up_to_date_p is nonzero when retrying.) */
16124 if (current_matrix_up_to_date_p
16125 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16126 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16130 case CURSOR_MOVEMENT_SUCCESS
:
16131 used_current_matrix_p
= 1;
16134 case CURSOR_MOVEMENT_MUST_SCROLL
:
16135 goto try_to_scroll
;
16141 /* If current starting point was originally the beginning of a line
16142 but no longer is, find a new starting point. */
16143 else if (w
->start_at_line_beg
16144 && !(CHARPOS (startp
) <= BEGV
16145 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16148 debug_method_add (w
, "recenter 1");
16153 /* Try scrolling with try_window_id. Value is > 0 if update has
16154 been done, it is -1 if we know that the same window start will
16155 not work. It is 0 if unsuccessful for some other reason. */
16156 else if ((tem
= try_window_id (w
)) != 0)
16159 debug_method_add (w
, "try_window_id %d", tem
);
16162 if (f
->fonts_changed
)
16163 goto need_larger_matrices
;
16167 /* Otherwise try_window_id has returned -1 which means that we
16168 don't want the alternative below this comment to execute. */
16170 else if (CHARPOS (startp
) >= BEGV
16171 && CHARPOS (startp
) <= ZV
16172 && PT
>= CHARPOS (startp
)
16173 && (CHARPOS (startp
) < ZV
16174 /* Avoid starting at end of buffer. */
16175 || CHARPOS (startp
) == BEGV
16176 || !window_outdated (w
)))
16178 int d1
, d2
, d3
, d4
, d5
, d6
;
16180 /* If first window line is a continuation line, and window start
16181 is inside the modified region, but the first change is before
16182 current window start, we must select a new window start.
16184 However, if this is the result of a down-mouse event (e.g. by
16185 extending the mouse-drag-overlay), we don't want to select a
16186 new window start, since that would change the position under
16187 the mouse, resulting in an unwanted mouse-movement rather
16188 than a simple mouse-click. */
16189 if (!w
->start_at_line_beg
16190 && NILP (do_mouse_tracking
)
16191 && CHARPOS (startp
) > BEGV
16192 && CHARPOS (startp
) > BEG
+ beg_unchanged
16193 && CHARPOS (startp
) <= Z
- end_unchanged
16194 /* Even if w->start_at_line_beg is nil, a new window may
16195 start at a line_beg, since that's how set_buffer_window
16196 sets it. So, we need to check the return value of
16197 compute_window_start_on_continuation_line. (See also
16199 && XMARKER (w
->start
)->buffer
== current_buffer
16200 && compute_window_start_on_continuation_line (w
)
16201 /* It doesn't make sense to force the window start like we
16202 do at label force_start if it is already known that point
16203 will not be visible in the resulting window, because
16204 doing so will move point from its correct position
16205 instead of scrolling the window to bring point into view.
16207 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16209 w
->force_start
= 1;
16210 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16215 debug_method_add (w
, "same window start");
16218 /* Try to redisplay starting at same place as before.
16219 If point has not moved off frame, accept the results. */
16220 if (!current_matrix_up_to_date_p
16221 /* Don't use try_window_reusing_current_matrix in this case
16222 because a window scroll function can have changed the
16224 || !NILP (Vwindow_scroll_functions
)
16225 || MINI_WINDOW_P (w
)
16226 || !(used_current_matrix_p
16227 = try_window_reusing_current_matrix (w
)))
16229 IF_DEBUG (debug_method_add (w
, "1"));
16230 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16231 /* -1 means we need to scroll.
16232 0 means we need new matrices, but fonts_changed
16233 is set in that case, so we will detect it below. */
16234 goto try_to_scroll
;
16237 if (f
->fonts_changed
)
16238 goto need_larger_matrices
;
16240 if (w
->cursor
.vpos
>= 0)
16242 if (!just_this_one_p
16243 || current_buffer
->clip_changed
16244 || BEG_UNCHANGED
< CHARPOS (startp
))
16245 /* Forget any recorded base line for line number display. */
16246 w
->base_line_number
= 0;
16248 if (!cursor_row_fully_visible_p (w
, 1, 0))
16250 clear_glyph_matrix (w
->desired_matrix
);
16251 last_line_misfit
= 1;
16253 /* Drop through and scroll. */
16258 clear_glyph_matrix (w
->desired_matrix
);
16263 /* Redisplay the mode line. Select the buffer properly for that. */
16264 if (!update_mode_line
)
16266 update_mode_line
= 1;
16267 w
->update_mode_line
= 1;
16270 /* Try to scroll by specified few lines. */
16271 if ((scroll_conservatively
16272 || emacs_scroll_step
16273 || temp_scroll_step
16274 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16275 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16276 && CHARPOS (startp
) >= BEGV
16277 && CHARPOS (startp
) <= ZV
)
16279 /* The function returns -1 if new fonts were loaded, 1 if
16280 successful, 0 if not successful. */
16281 int ss
= try_scrolling (window
, just_this_one_p
,
16282 scroll_conservatively
,
16284 temp_scroll_step
, last_line_misfit
);
16287 case SCROLLING_SUCCESS
:
16290 case SCROLLING_NEED_LARGER_MATRICES
:
16291 goto need_larger_matrices
;
16293 case SCROLLING_FAILED
:
16301 /* Finally, just choose a place to start which positions point
16302 according to user preferences. */
16307 debug_method_add (w
, "recenter");
16310 /* Forget any previously recorded base line for line number display. */
16311 if (!buffer_unchanged_p
)
16312 w
->base_line_number
= 0;
16314 /* Determine the window start relative to point. */
16315 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16316 it
.current_y
= it
.last_visible_y
;
16317 if (centering_position
< 0)
16319 int window_total_lines
16320 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16323 ? min (scroll_margin
, window_total_lines
/ 4)
16325 ptrdiff_t margin_pos
= CHARPOS (startp
);
16326 Lisp_Object aggressive
;
16329 /* If there is a scroll margin at the top of the window, find
16330 its character position. */
16332 /* Cannot call start_display if startp is not in the
16333 accessible region of the buffer. This can happen when we
16334 have just switched to a different buffer and/or changed
16335 its restriction. In that case, startp is initialized to
16336 the character position 1 (BEGV) because we did not yet
16337 have chance to display the buffer even once. */
16338 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16341 void *it1data
= NULL
;
16343 SAVE_IT (it1
, it
, it1data
);
16344 start_display (&it1
, w
, startp
);
16345 move_it_vertically (&it1
, margin
* frame_line_height
);
16346 margin_pos
= IT_CHARPOS (it1
);
16347 RESTORE_IT (&it
, &it
, it1data
);
16349 scrolling_up
= PT
> margin_pos
;
16352 ? BVAR (current_buffer
, scroll_up_aggressively
)
16353 : BVAR (current_buffer
, scroll_down_aggressively
);
16355 if (!MINI_WINDOW_P (w
)
16356 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16360 /* Setting scroll-conservatively overrides
16361 scroll-*-aggressively. */
16362 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16364 double float_amount
= XFLOATINT (aggressive
);
16366 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16367 if (pt_offset
== 0 && float_amount
> 0)
16369 if (pt_offset
&& margin
> 0)
16372 /* Compute how much to move the window start backward from
16373 point so that point will be displayed where the user
16377 centering_position
= it
.last_visible_y
;
16379 centering_position
-= pt_offset
;
16380 centering_position
-=
16381 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16382 + WINDOW_HEADER_LINE_HEIGHT (w
);
16383 /* Don't let point enter the scroll margin near top of
16385 if (centering_position
< margin
* frame_line_height
)
16386 centering_position
= margin
* frame_line_height
;
16389 centering_position
= margin
* frame_line_height
+ pt_offset
;
16392 /* Set the window start half the height of the window backward
16394 centering_position
= window_box_height (w
) / 2;
16396 move_it_vertically_backward (&it
, centering_position
);
16398 eassert (IT_CHARPOS (it
) >= BEGV
);
16400 /* The function move_it_vertically_backward may move over more
16401 than the specified y-distance. If it->w is small, e.g. a
16402 mini-buffer window, we may end up in front of the window's
16403 display area. Start displaying at the start of the line
16404 containing PT in this case. */
16405 if (it
.current_y
<= 0)
16407 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16408 move_it_vertically_backward (&it
, 0);
16412 it
.current_x
= it
.hpos
= 0;
16414 /* Set the window start position here explicitly, to avoid an
16415 infinite loop in case the functions in window-scroll-functions
16417 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16419 /* Run scroll hooks. */
16420 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16422 /* Redisplay the window. */
16423 if (!current_matrix_up_to_date_p
16424 || windows_or_buffers_changed
16425 || f
->cursor_type_changed
16426 /* Don't use try_window_reusing_current_matrix in this case
16427 because it can have changed the buffer. */
16428 || !NILP (Vwindow_scroll_functions
)
16429 || !just_this_one_p
16430 || MINI_WINDOW_P (w
)
16431 || !(used_current_matrix_p
16432 = try_window_reusing_current_matrix (w
)))
16433 try_window (window
, startp
, 0);
16435 /* If new fonts have been loaded (due to fontsets), give up. We
16436 have to start a new redisplay since we need to re-adjust glyph
16438 if (f
->fonts_changed
)
16439 goto need_larger_matrices
;
16441 /* If cursor did not appear assume that the middle of the window is
16442 in the first line of the window. Do it again with the next line.
16443 (Imagine a window of height 100, displaying two lines of height
16444 60. Moving back 50 from it->last_visible_y will end in the first
16446 if (w
->cursor
.vpos
< 0)
16448 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16450 clear_glyph_matrix (w
->desired_matrix
);
16451 move_it_by_lines (&it
, 1);
16452 try_window (window
, it
.current
.pos
, 0);
16454 else if (PT
< IT_CHARPOS (it
))
16456 clear_glyph_matrix (w
->desired_matrix
);
16457 move_it_by_lines (&it
, -1);
16458 try_window (window
, it
.current
.pos
, 0);
16462 /* Not much we can do about it. */
16466 /* Consider the following case: Window starts at BEGV, there is
16467 invisible, intangible text at BEGV, so that display starts at
16468 some point START > BEGV. It can happen that we are called with
16469 PT somewhere between BEGV and START. Try to handle that case,
16470 and similar ones. */
16471 if (w
->cursor
.vpos
< 0)
16473 /* First, try locating the proper glyph row for PT. */
16474 struct glyph_row
*row
=
16475 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16477 /* Sometimes point is at the beginning of invisible text that is
16478 before the 1st character displayed in the row. In that case,
16479 row_containing_pos fails to find the row, because no glyphs
16480 with appropriate buffer positions are present in the row.
16481 Therefore, we next try to find the row which shows the 1st
16482 position after the invisible text. */
16486 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16489 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16492 Lisp_Object invis_end
=
16493 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16496 if (NATNUMP (invis_end
))
16497 alt_pos
= XFASTINT (invis_end
);
16500 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16504 /* Finally, fall back on the first row of the window after the
16505 header line (if any). This is slightly better than not
16506 displaying the cursor at all. */
16509 row
= w
->current_matrix
->rows
;
16510 if (row
->mode_line_p
)
16513 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16516 if (!cursor_row_fully_visible_p (w
, 0, 0))
16518 /* If vscroll is enabled, disable it and try again. */
16522 clear_glyph_matrix (w
->desired_matrix
);
16526 /* Users who set scroll-conservatively to a large number want
16527 point just above/below the scroll margin. If we ended up
16528 with point's row partially visible, move the window start to
16529 make that row fully visible and out of the margin. */
16530 if (scroll_conservatively
> SCROLL_LIMIT
)
16532 int window_total_lines
16533 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16536 ? min (scroll_margin
, window_total_lines
/ 4)
16538 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16540 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16541 clear_glyph_matrix (w
->desired_matrix
);
16542 if (1 == try_window (window
, it
.current
.pos
,
16543 TRY_WINDOW_CHECK_MARGINS
))
16547 /* If centering point failed to make the whole line visible,
16548 put point at the top instead. That has to make the whole line
16549 visible, if it can be done. */
16550 if (centering_position
== 0)
16553 clear_glyph_matrix (w
->desired_matrix
);
16554 centering_position
= 0;
16560 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16561 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16562 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16564 /* Display the mode line, if we must. */
16565 if ((update_mode_line
16566 /* If window not full width, must redo its mode line
16567 if (a) the window to its side is being redone and
16568 (b) we do a frame-based redisplay. This is a consequence
16569 of how inverted lines are drawn in frame-based redisplay. */
16570 || (!just_this_one_p
16571 && !FRAME_WINDOW_P (f
)
16572 && !WINDOW_FULL_WIDTH_P (w
))
16573 /* Line number to display. */
16574 || w
->base_line_pos
> 0
16575 /* Column number is displayed and different from the one displayed. */
16576 || (w
->column_number_displayed
!= -1
16577 && (w
->column_number_displayed
!= current_column ())))
16578 /* This means that the window has a mode line. */
16579 && (WINDOW_WANTS_MODELINE_P (w
)
16580 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16583 display_mode_lines (w
);
16585 /* If mode line height has changed, arrange for a thorough
16586 immediate redisplay using the correct mode line height. */
16587 if (WINDOW_WANTS_MODELINE_P (w
)
16588 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16590 f
->fonts_changed
= 1;
16591 w
->mode_line_height
= -1;
16592 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16593 = DESIRED_MODE_LINE_HEIGHT (w
);
16596 /* If header line height has changed, arrange for a thorough
16597 immediate redisplay using the correct header line height. */
16598 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16599 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16601 f
->fonts_changed
= 1;
16602 w
->header_line_height
= -1;
16603 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16604 = DESIRED_HEADER_LINE_HEIGHT (w
);
16607 if (f
->fonts_changed
)
16608 goto need_larger_matrices
;
16611 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16613 w
->base_line_pos
= 0;
16614 w
->base_line_number
= 0;
16619 /* When we reach a frame's selected window, redo the frame's menu bar. */
16620 if (update_mode_line
16621 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16623 int redisplay_menu_p
= 0;
16625 if (FRAME_WINDOW_P (f
))
16627 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16628 || defined (HAVE_NS) || defined (USE_GTK)
16629 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16631 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16635 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16637 if (redisplay_menu_p
)
16638 display_menu_bar (w
);
16640 #ifdef HAVE_WINDOW_SYSTEM
16641 if (FRAME_WINDOW_P (f
))
16643 #if defined (USE_GTK) || defined (HAVE_NS)
16644 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16645 redisplay_tool_bar (f
);
16647 if (WINDOWP (f
->tool_bar_window
)
16648 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16649 || !NILP (Vauto_resize_tool_bars
))
16650 && redisplay_tool_bar (f
))
16651 ignore_mouse_drag_p
= 1;
16657 #ifdef HAVE_WINDOW_SYSTEM
16658 if (FRAME_WINDOW_P (f
)
16659 && update_window_fringes (w
, (just_this_one_p
16660 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16661 || w
->pseudo_window_p
)))
16665 if (draw_window_fringes (w
, 1))
16667 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16668 x_draw_right_divider (w
);
16670 x_draw_vertical_border (w
);
16676 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16677 x_draw_bottom_divider (w
);
16678 #endif /* HAVE_WINDOW_SYSTEM */
16680 /* We go to this label, with fonts_changed set, if it is
16681 necessary to try again using larger glyph matrices.
16682 We have to redeem the scroll bar even in this case,
16683 because the loop in redisplay_internal expects that. */
16684 need_larger_matrices
:
16686 finish_scroll_bars
:
16688 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16690 /* Set the thumb's position and size. */
16691 set_vertical_scroll_bar (w
);
16693 /* Note that we actually used the scroll bar attached to this
16694 window, so it shouldn't be deleted at the end of redisplay. */
16695 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16696 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16699 /* Restore current_buffer and value of point in it. The window
16700 update may have changed the buffer, so first make sure `opoint'
16701 is still valid (Bug#6177). */
16702 if (CHARPOS (opoint
) < BEGV
)
16703 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16704 else if (CHARPOS (opoint
) > ZV
)
16705 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16707 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16709 set_buffer_internal_1 (old
);
16710 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16711 shorter. This can be caused by log truncation in *Messages*. */
16712 if (CHARPOS (lpoint
) <= ZV
)
16713 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16715 unbind_to (count
, Qnil
);
16719 /* Build the complete desired matrix of WINDOW with a window start
16720 buffer position POS.
16722 Value is 1 if successful. It is zero if fonts were loaded during
16723 redisplay which makes re-adjusting glyph matrices necessary, and -1
16724 if point would appear in the scroll margins.
16725 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16726 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16730 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16732 struct window
*w
= XWINDOW (window
);
16734 struct glyph_row
*last_text_row
= NULL
;
16735 struct frame
*f
= XFRAME (w
->frame
);
16736 int frame_line_height
= default_line_pixel_height (w
);
16738 /* Make POS the new window start. */
16739 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16741 /* Mark cursor position as unknown. No overlay arrow seen. */
16742 w
->cursor
.vpos
= -1;
16743 overlay_arrow_seen
= 0;
16745 /* Initialize iterator and info to start at POS. */
16746 start_display (&it
, w
, pos
);
16748 /* Display all lines of W. */
16749 while (it
.current_y
< it
.last_visible_y
)
16751 if (display_line (&it
))
16752 last_text_row
= it
.glyph_row
- 1;
16753 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16757 /* Don't let the cursor end in the scroll margins. */
16758 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16759 && !MINI_WINDOW_P (w
))
16761 int this_scroll_margin
;
16762 int window_total_lines
16763 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16765 if (scroll_margin
> 0)
16767 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16768 this_scroll_margin
*= frame_line_height
;
16771 this_scroll_margin
= 0;
16773 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16774 && w
->cursor
.y
< this_scroll_margin
16775 && CHARPOS (pos
) > BEGV
16776 && IT_CHARPOS (it
) < ZV
)
16777 /* rms: considering make_cursor_line_fully_visible_p here
16778 seems to give wrong results. We don't want to recenter
16779 when the last line is partly visible, we want to allow
16780 that case to be handled in the usual way. */
16781 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16783 w
->cursor
.vpos
= -1;
16784 clear_glyph_matrix (w
->desired_matrix
);
16789 /* If bottom moved off end of frame, change mode line percentage. */
16790 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16791 w
->update_mode_line
= 1;
16793 /* Set window_end_pos to the offset of the last character displayed
16794 on the window from the end of current_buffer. Set
16795 window_end_vpos to its row number. */
16798 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16799 adjust_window_ends (w
, last_text_row
, 0);
16801 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16802 w
->window_end_vpos
)));
16806 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16807 w
->window_end_pos
= Z
- ZV
;
16808 w
->window_end_vpos
= 0;
16811 /* But that is not valid info until redisplay finishes. */
16812 w
->window_end_valid
= 0;
16818 /************************************************************************
16819 Window redisplay reusing current matrix when buffer has not changed
16820 ************************************************************************/
16822 /* Try redisplay of window W showing an unchanged buffer with a
16823 different window start than the last time it was displayed by
16824 reusing its current matrix. Value is non-zero if successful.
16825 W->start is the new window start. */
16828 try_window_reusing_current_matrix (struct window
*w
)
16830 struct frame
*f
= XFRAME (w
->frame
);
16831 struct glyph_row
*bottom_row
;
16834 struct text_pos start
, new_start
;
16835 int nrows_scrolled
, i
;
16836 struct glyph_row
*last_text_row
;
16837 struct glyph_row
*last_reused_text_row
;
16838 struct glyph_row
*start_row
;
16839 int start_vpos
, min_y
, max_y
;
16842 if (inhibit_try_window_reusing
)
16846 if (/* This function doesn't handle terminal frames. */
16847 !FRAME_WINDOW_P (f
)
16848 /* Don't try to reuse the display if windows have been split
16850 || windows_or_buffers_changed
16851 || f
->cursor_type_changed
)
16854 /* Can't do this if showing trailing whitespace. */
16855 if (!NILP (Vshow_trailing_whitespace
))
16858 /* If top-line visibility has changed, give up. */
16859 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16860 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16863 /* Give up if old or new display is scrolled vertically. We could
16864 make this function handle this, but right now it doesn't. */
16865 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16866 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16869 /* The variable new_start now holds the new window start. The old
16870 start `start' can be determined from the current matrix. */
16871 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16872 start
= start_row
->minpos
;
16873 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16875 /* Clear the desired matrix for the display below. */
16876 clear_glyph_matrix (w
->desired_matrix
);
16878 if (CHARPOS (new_start
) <= CHARPOS (start
))
16880 /* Don't use this method if the display starts with an ellipsis
16881 displayed for invisible text. It's not easy to handle that case
16882 below, and it's certainly not worth the effort since this is
16883 not a frequent case. */
16884 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16887 IF_DEBUG (debug_method_add (w
, "twu1"));
16889 /* Display up to a row that can be reused. The variable
16890 last_text_row is set to the last row displayed that displays
16891 text. Note that it.vpos == 0 if or if not there is a
16892 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16893 start_display (&it
, w
, new_start
);
16894 w
->cursor
.vpos
= -1;
16895 last_text_row
= last_reused_text_row
= NULL
;
16897 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16899 /* If we have reached into the characters in the START row,
16900 that means the line boundaries have changed. So we
16901 can't start copying with the row START. Maybe it will
16902 work to start copying with the following row. */
16903 while (IT_CHARPOS (it
) > CHARPOS (start
))
16905 /* Advance to the next row as the "start". */
16907 start
= start_row
->minpos
;
16908 /* If there are no more rows to try, or just one, give up. */
16909 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16910 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16911 || CHARPOS (start
) == ZV
)
16913 clear_glyph_matrix (w
->desired_matrix
);
16917 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16919 /* If we have reached alignment, we can copy the rest of the
16921 if (IT_CHARPOS (it
) == CHARPOS (start
)
16922 /* Don't accept "alignment" inside a display vector,
16923 since start_row could have started in the middle of
16924 that same display vector (thus their character
16925 positions match), and we have no way of telling if
16926 that is the case. */
16927 && it
.current
.dpvec_index
< 0)
16930 if (display_line (&it
))
16931 last_text_row
= it
.glyph_row
- 1;
16935 /* A value of current_y < last_visible_y means that we stopped
16936 at the previous window start, which in turn means that we
16937 have at least one reusable row. */
16938 if (it
.current_y
< it
.last_visible_y
)
16940 struct glyph_row
*row
;
16942 /* IT.vpos always starts from 0; it counts text lines. */
16943 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16945 /* Find PT if not already found in the lines displayed. */
16946 if (w
->cursor
.vpos
< 0)
16948 int dy
= it
.current_y
- start_row
->y
;
16950 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16951 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16953 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16954 dy
, nrows_scrolled
);
16957 clear_glyph_matrix (w
->desired_matrix
);
16962 /* Scroll the display. Do it before the current matrix is
16963 changed. The problem here is that update has not yet
16964 run, i.e. part of the current matrix is not up to date.
16965 scroll_run_hook will clear the cursor, and use the
16966 current matrix to get the height of the row the cursor is
16968 run
.current_y
= start_row
->y
;
16969 run
.desired_y
= it
.current_y
;
16970 run
.height
= it
.last_visible_y
- it
.current_y
;
16972 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16975 FRAME_RIF (f
)->update_window_begin_hook (w
);
16976 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16977 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16978 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16982 /* Shift current matrix down by nrows_scrolled lines. */
16983 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16984 rotate_matrix (w
->current_matrix
,
16986 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16989 /* Disable lines that must be updated. */
16990 for (i
= 0; i
< nrows_scrolled
; ++i
)
16991 (start_row
+ i
)->enabled_p
= false;
16993 /* Re-compute Y positions. */
16994 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16995 max_y
= it
.last_visible_y
;
16996 for (row
= start_row
+ nrows_scrolled
;
17000 row
->y
= it
.current_y
;
17001 row
->visible_height
= row
->height
;
17003 if (row
->y
< min_y
)
17004 row
->visible_height
-= min_y
- row
->y
;
17005 if (row
->y
+ row
->height
> max_y
)
17006 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17007 if (row
->fringe_bitmap_periodic_p
)
17008 row
->redraw_fringe_bitmaps_p
= 1;
17010 it
.current_y
+= row
->height
;
17012 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17013 last_reused_text_row
= row
;
17014 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17018 /* Disable lines in the current matrix which are now
17019 below the window. */
17020 for (++row
; row
< bottom_row
; ++row
)
17021 row
->enabled_p
= row
->mode_line_p
= 0;
17024 /* Update window_end_pos etc.; last_reused_text_row is the last
17025 reused row from the current matrix containing text, if any.
17026 The value of last_text_row is the last displayed line
17027 containing text. */
17028 if (last_reused_text_row
)
17029 adjust_window_ends (w
, last_reused_text_row
, 1);
17030 else if (last_text_row
)
17031 adjust_window_ends (w
, last_text_row
, 0);
17034 /* This window must be completely empty. */
17035 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17036 w
->window_end_pos
= Z
- ZV
;
17037 w
->window_end_vpos
= 0;
17039 w
->window_end_valid
= 0;
17041 /* Update hint: don't try scrolling again in update_window. */
17042 w
->desired_matrix
->no_scrolling_p
= 1;
17045 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17049 else if (CHARPOS (new_start
) > CHARPOS (start
))
17051 struct glyph_row
*pt_row
, *row
;
17052 struct glyph_row
*first_reusable_row
;
17053 struct glyph_row
*first_row_to_display
;
17055 int yb
= window_text_bottom_y (w
);
17057 /* Find the row starting at new_start, if there is one. Don't
17058 reuse a partially visible line at the end. */
17059 first_reusable_row
= start_row
;
17060 while (first_reusable_row
->enabled_p
17061 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17062 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17063 < CHARPOS (new_start
)))
17064 ++first_reusable_row
;
17066 /* Give up if there is no row to reuse. */
17067 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17068 || !first_reusable_row
->enabled_p
17069 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17070 != CHARPOS (new_start
)))
17073 /* We can reuse fully visible rows beginning with
17074 first_reusable_row to the end of the window. Set
17075 first_row_to_display to the first row that cannot be reused.
17076 Set pt_row to the row containing point, if there is any. */
17078 for (first_row_to_display
= first_reusable_row
;
17079 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17080 ++first_row_to_display
)
17082 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17083 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17084 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17085 && first_row_to_display
->ends_at_zv_p
17086 && pt_row
== NULL
)))
17087 pt_row
= first_row_to_display
;
17090 /* Start displaying at the start of first_row_to_display. */
17091 eassert (first_row_to_display
->y
< yb
);
17092 init_to_row_start (&it
, w
, first_row_to_display
);
17094 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17096 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17098 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17099 + WINDOW_HEADER_LINE_HEIGHT (w
));
17101 /* Display lines beginning with first_row_to_display in the
17102 desired matrix. Set last_text_row to the last row displayed
17103 that displays text. */
17104 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17105 if (pt_row
== NULL
)
17106 w
->cursor
.vpos
= -1;
17107 last_text_row
= NULL
;
17108 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17109 if (display_line (&it
))
17110 last_text_row
= it
.glyph_row
- 1;
17112 /* If point is in a reused row, adjust y and vpos of the cursor
17116 w
->cursor
.vpos
-= nrows_scrolled
;
17117 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17120 /* Give up if point isn't in a row displayed or reused. (This
17121 also handles the case where w->cursor.vpos < nrows_scrolled
17122 after the calls to display_line, which can happen with scroll
17123 margins. See bug#1295.) */
17124 if (w
->cursor
.vpos
< 0)
17126 clear_glyph_matrix (w
->desired_matrix
);
17130 /* Scroll the display. */
17131 run
.current_y
= first_reusable_row
->y
;
17132 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17133 run
.height
= it
.last_visible_y
- run
.current_y
;
17134 dy
= run
.current_y
- run
.desired_y
;
17139 FRAME_RIF (f
)->update_window_begin_hook (w
);
17140 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17141 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17142 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17146 /* Adjust Y positions of reused rows. */
17147 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17148 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17149 max_y
= it
.last_visible_y
;
17150 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17153 row
->visible_height
= row
->height
;
17154 if (row
->y
< min_y
)
17155 row
->visible_height
-= min_y
- row
->y
;
17156 if (row
->y
+ row
->height
> max_y
)
17157 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17158 if (row
->fringe_bitmap_periodic_p
)
17159 row
->redraw_fringe_bitmaps_p
= 1;
17162 /* Scroll the current matrix. */
17163 eassert (nrows_scrolled
> 0);
17164 rotate_matrix (w
->current_matrix
,
17166 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17169 /* Disable rows not reused. */
17170 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17171 row
->enabled_p
= false;
17173 /* Point may have moved to a different line, so we cannot assume that
17174 the previous cursor position is valid; locate the correct row. */
17177 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17179 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17180 && !row
->ends_at_zv_p
;
17184 w
->cursor
.y
= row
->y
;
17186 if (row
< bottom_row
)
17188 /* Can't simply scan the row for point with
17189 bidi-reordered glyph rows. Let set_cursor_from_row
17190 figure out where to put the cursor, and if it fails,
17192 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17194 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17197 clear_glyph_matrix (w
->desired_matrix
);
17203 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17204 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17207 && (!BUFFERP (glyph
->object
)
17208 || glyph
->charpos
< PT
);
17212 w
->cursor
.x
+= glyph
->pixel_width
;
17218 /* Adjust window end. A null value of last_text_row means that
17219 the window end is in reused rows which in turn means that
17220 only its vpos can have changed. */
17222 adjust_window_ends (w
, last_text_row
, 0);
17224 w
->window_end_vpos
-= nrows_scrolled
;
17226 w
->window_end_valid
= 0;
17227 w
->desired_matrix
->no_scrolling_p
= 1;
17230 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17240 /************************************************************************
17241 Window redisplay reusing current matrix when buffer has changed
17242 ************************************************************************/
17244 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17245 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17246 ptrdiff_t *, ptrdiff_t *);
17247 static struct glyph_row
*
17248 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17249 struct glyph_row
*);
17252 /* Return the last row in MATRIX displaying text. If row START is
17253 non-null, start searching with that row. IT gives the dimensions
17254 of the display. Value is null if matrix is empty; otherwise it is
17255 a pointer to the row found. */
17257 static struct glyph_row
*
17258 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17259 struct glyph_row
*start
)
17261 struct glyph_row
*row
, *row_found
;
17263 /* Set row_found to the last row in IT->w's current matrix
17264 displaying text. The loop looks funny but think of partially
17267 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17268 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17270 eassert (row
->enabled_p
);
17272 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17281 /* Return the last row in the current matrix of W that is not affected
17282 by changes at the start of current_buffer that occurred since W's
17283 current matrix was built. Value is null if no such row exists.
17285 BEG_UNCHANGED us the number of characters unchanged at the start of
17286 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17287 first changed character in current_buffer. Characters at positions <
17288 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17289 when the current matrix was built. */
17291 static struct glyph_row
*
17292 find_last_unchanged_at_beg_row (struct window
*w
)
17294 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17295 struct glyph_row
*row
;
17296 struct glyph_row
*row_found
= NULL
;
17297 int yb
= window_text_bottom_y (w
);
17299 /* Find the last row displaying unchanged text. */
17300 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17301 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17302 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17305 if (/* If row ends before first_changed_pos, it is unchanged,
17306 except in some case. */
17307 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17308 /* When row ends in ZV and we write at ZV it is not
17310 && !row
->ends_at_zv_p
17311 /* When first_changed_pos is the end of a continued line,
17312 row is not unchanged because it may be no longer
17314 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17315 && (row
->continued_p
17316 || row
->exact_window_width_line_p
))
17317 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17318 needs to be recomputed, so don't consider this row as
17319 unchanged. This happens when the last line was
17320 bidi-reordered and was killed immediately before this
17321 redisplay cycle. In that case, ROW->end stores the
17322 buffer position of the first visual-order character of
17323 the killed text, which is now beyond ZV. */
17324 && CHARPOS (row
->end
.pos
) <= ZV
)
17327 /* Stop if last visible row. */
17328 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17336 /* Find the first glyph row in the current matrix of W that is not
17337 affected by changes at the end of current_buffer since the
17338 time W's current matrix was built.
17340 Return in *DELTA the number of chars by which buffer positions in
17341 unchanged text at the end of current_buffer must be adjusted.
17343 Return in *DELTA_BYTES the corresponding number of bytes.
17345 Value is null if no such row exists, i.e. all rows are affected by
17348 static struct glyph_row
*
17349 find_first_unchanged_at_end_row (struct window
*w
,
17350 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17352 struct glyph_row
*row
;
17353 struct glyph_row
*row_found
= NULL
;
17355 *delta
= *delta_bytes
= 0;
17357 /* Display must not have been paused, otherwise the current matrix
17358 is not up to date. */
17359 eassert (w
->window_end_valid
);
17361 /* A value of window_end_pos >= END_UNCHANGED means that the window
17362 end is in the range of changed text. If so, there is no
17363 unchanged row at the end of W's current matrix. */
17364 if (w
->window_end_pos
>= END_UNCHANGED
)
17367 /* Set row to the last row in W's current matrix displaying text. */
17368 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17370 /* If matrix is entirely empty, no unchanged row exists. */
17371 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17373 /* The value of row is the last glyph row in the matrix having a
17374 meaningful buffer position in it. The end position of row
17375 corresponds to window_end_pos. This allows us to translate
17376 buffer positions in the current matrix to current buffer
17377 positions for characters not in changed text. */
17379 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17380 ptrdiff_t Z_BYTE_old
=
17381 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17382 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17383 struct glyph_row
*first_text_row
17384 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17386 *delta
= Z
- Z_old
;
17387 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17389 /* Set last_unchanged_pos to the buffer position of the last
17390 character in the buffer that has not been changed. Z is the
17391 index + 1 of the last character in current_buffer, i.e. by
17392 subtracting END_UNCHANGED we get the index of the last
17393 unchanged character, and we have to add BEG to get its buffer
17395 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17396 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17398 /* Search backward from ROW for a row displaying a line that
17399 starts at a minimum position >= last_unchanged_pos_old. */
17400 for (; row
> first_text_row
; --row
)
17402 /* This used to abort, but it can happen.
17403 It is ok to just stop the search instead here. KFS. */
17404 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17407 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17412 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17418 /* Make sure that glyph rows in the current matrix of window W
17419 reference the same glyph memory as corresponding rows in the
17420 frame's frame matrix. This function is called after scrolling W's
17421 current matrix on a terminal frame in try_window_id and
17422 try_window_reusing_current_matrix. */
17425 sync_frame_with_window_matrix_rows (struct window
*w
)
17427 struct frame
*f
= XFRAME (w
->frame
);
17428 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17430 /* Preconditions: W must be a leaf window and full-width. Its frame
17431 must have a frame matrix. */
17432 eassert (BUFFERP (w
->contents
));
17433 eassert (WINDOW_FULL_WIDTH_P (w
));
17434 eassert (!FRAME_WINDOW_P (f
));
17436 /* If W is a full-width window, glyph pointers in W's current matrix
17437 have, by definition, to be the same as glyph pointers in the
17438 corresponding frame matrix. Note that frame matrices have no
17439 marginal areas (see build_frame_matrix). */
17440 window_row
= w
->current_matrix
->rows
;
17441 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17442 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17443 while (window_row
< window_row_end
)
17445 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17446 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17448 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17449 frame_row
->glyphs
[TEXT_AREA
] = start
;
17450 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17451 frame_row
->glyphs
[LAST_AREA
] = end
;
17453 /* Disable frame rows whose corresponding window rows have
17454 been disabled in try_window_id. */
17455 if (!window_row
->enabled_p
)
17456 frame_row
->enabled_p
= false;
17458 ++window_row
, ++frame_row
;
17463 /* Find the glyph row in window W containing CHARPOS. Consider all
17464 rows between START and END (not inclusive). END null means search
17465 all rows to the end of the display area of W. Value is the row
17466 containing CHARPOS or null. */
17469 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17470 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17472 struct glyph_row
*row
= start
;
17473 struct glyph_row
*best_row
= NULL
;
17474 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17477 /* If we happen to start on a header-line, skip that. */
17478 if (row
->mode_line_p
)
17481 if ((end
&& row
>= end
) || !row
->enabled_p
)
17484 last_y
= window_text_bottom_y (w
) - dy
;
17488 /* Give up if we have gone too far. */
17489 if (end
&& row
>= end
)
17491 /* This formerly returned if they were equal.
17492 I think that both quantities are of a "last plus one" type;
17493 if so, when they are equal, the row is within the screen. -- rms. */
17494 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17497 /* If it is in this row, return this row. */
17498 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17499 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17500 /* The end position of a row equals the start
17501 position of the next row. If CHARPOS is there, we
17502 would rather consider it displayed in the next
17503 line, except when this line ends in ZV. */
17504 && !row_for_charpos_p (row
, charpos
)))
17505 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17509 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17510 || (!best_row
&& !row
->continued_p
))
17512 /* In bidi-reordered rows, there could be several rows whose
17513 edges surround CHARPOS, all of these rows belonging to
17514 the same continued line. We need to find the row which
17515 fits CHARPOS the best. */
17516 for (g
= row
->glyphs
[TEXT_AREA
];
17517 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17520 if (!STRINGP (g
->object
))
17522 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17524 mindif
= eabs (g
->charpos
- charpos
);
17526 /* Exact match always wins. */
17533 else if (best_row
&& !row
->continued_p
)
17540 /* Try to redisplay window W by reusing its existing display. W's
17541 current matrix must be up to date when this function is called,
17542 i.e. window_end_valid must be nonzero.
17546 >= 1 if successful, i.e. display has been updated
17548 1 means the changes were in front of a newline that precedes
17549 the window start, and the whole current matrix was reused
17550 2 means the changes were after the last position displayed
17551 in the window, and the whole current matrix was reused
17552 3 means portions of the current matrix were reused, while
17553 some of the screen lines were redrawn
17554 -1 if redisplay with same window start is known not to succeed
17555 0 if otherwise unsuccessful
17557 The following steps are performed:
17559 1. Find the last row in the current matrix of W that is not
17560 affected by changes at the start of current_buffer. If no such row
17563 2. Find the first row in W's current matrix that is not affected by
17564 changes at the end of current_buffer. Maybe there is no such row.
17566 3. Display lines beginning with the row + 1 found in step 1 to the
17567 row found in step 2 or, if step 2 didn't find a row, to the end of
17570 4. If cursor is not known to appear on the window, give up.
17572 5. If display stopped at the row found in step 2, scroll the
17573 display and current matrix as needed.
17575 6. Maybe display some lines at the end of W, if we must. This can
17576 happen under various circumstances, like a partially visible line
17577 becoming fully visible, or because newly displayed lines are displayed
17578 in smaller font sizes.
17580 7. Update W's window end information. */
17583 try_window_id (struct window
*w
)
17585 struct frame
*f
= XFRAME (w
->frame
);
17586 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17587 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17588 struct glyph_row
*last_unchanged_at_beg_row
;
17589 struct glyph_row
*first_unchanged_at_end_row
;
17590 struct glyph_row
*row
;
17591 struct glyph_row
*bottom_row
;
17594 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17596 struct text_pos start_pos
;
17598 int first_unchanged_at_end_vpos
= 0;
17599 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17600 struct text_pos start
;
17601 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17604 if (inhibit_try_window_id
)
17608 /* This is handy for debugging. */
17610 #define GIVE_UP(X) \
17612 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17616 #define GIVE_UP(X) return 0
17619 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17621 /* Don't use this for mini-windows because these can show
17622 messages and mini-buffers, and we don't handle that here. */
17623 if (MINI_WINDOW_P (w
))
17626 /* This flag is used to prevent redisplay optimizations. */
17627 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17630 /* This function's optimizations cannot be used if overlays have
17631 changed in the buffer displayed by the window, so give up if they
17633 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17636 /* Verify that narrowing has not changed.
17637 Also verify that we were not told to prevent redisplay optimizations.
17638 It would be nice to further
17639 reduce the number of cases where this prevents try_window_id. */
17640 if (current_buffer
->clip_changed
17641 || current_buffer
->prevent_redisplay_optimizations_p
)
17644 /* Window must either use window-based redisplay or be full width. */
17645 if (!FRAME_WINDOW_P (f
)
17646 && (!FRAME_LINE_INS_DEL_OK (f
)
17647 || !WINDOW_FULL_WIDTH_P (w
)))
17650 /* Give up if point is known NOT to appear in W. */
17651 if (PT
< CHARPOS (start
))
17654 /* Another way to prevent redisplay optimizations. */
17655 if (w
->last_modified
== 0)
17658 /* Verify that window is not hscrolled. */
17659 if (w
->hscroll
!= 0)
17662 /* Verify that display wasn't paused. */
17663 if (!w
->window_end_valid
)
17666 /* Likewise if highlighting trailing whitespace. */
17667 if (!NILP (Vshow_trailing_whitespace
))
17670 /* Can't use this if overlay arrow position and/or string have
17672 if (overlay_arrows_changed_p ())
17675 /* When word-wrap is on, adding a space to the first word of a
17676 wrapped line can change the wrap position, altering the line
17677 above it. It might be worthwhile to handle this more
17678 intelligently, but for now just redisplay from scratch. */
17679 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17682 /* Under bidi reordering, adding or deleting a character in the
17683 beginning of a paragraph, before the first strong directional
17684 character, can change the base direction of the paragraph (unless
17685 the buffer specifies a fixed paragraph direction), which will
17686 require to redisplay the whole paragraph. It might be worthwhile
17687 to find the paragraph limits and widen the range of redisplayed
17688 lines to that, but for now just give up this optimization and
17689 redisplay from scratch. */
17690 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17691 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17694 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17695 only if buffer has really changed. The reason is that the gap is
17696 initially at Z for freshly visited files. The code below would
17697 set end_unchanged to 0 in that case. */
17698 if (MODIFF
> SAVE_MODIFF
17699 /* This seems to happen sometimes after saving a buffer. */
17700 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17702 if (GPT
- BEG
< BEG_UNCHANGED
)
17703 BEG_UNCHANGED
= GPT
- BEG
;
17704 if (Z
- GPT
< END_UNCHANGED
)
17705 END_UNCHANGED
= Z
- GPT
;
17708 /* The position of the first and last character that has been changed. */
17709 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17710 last_changed_charpos
= Z
- END_UNCHANGED
;
17712 /* If window starts after a line end, and the last change is in
17713 front of that newline, then changes don't affect the display.
17714 This case happens with stealth-fontification. Note that although
17715 the display is unchanged, glyph positions in the matrix have to
17716 be adjusted, of course. */
17717 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17718 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17719 && ((last_changed_charpos
< CHARPOS (start
)
17720 && CHARPOS (start
) == BEGV
)
17721 || (last_changed_charpos
< CHARPOS (start
) - 1
17722 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17724 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17725 struct glyph_row
*r0
;
17727 /* Compute how many chars/bytes have been added to or removed
17728 from the buffer. */
17729 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17730 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17731 Z_delta
= Z
- Z_old
;
17732 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17734 /* Give up if PT is not in the window. Note that it already has
17735 been checked at the start of try_window_id that PT is not in
17736 front of the window start. */
17737 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17740 /* If window start is unchanged, we can reuse the whole matrix
17741 as is, after adjusting glyph positions. No need to compute
17742 the window end again, since its offset from Z hasn't changed. */
17743 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17744 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17745 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17746 /* PT must not be in a partially visible line. */
17747 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17748 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17750 /* Adjust positions in the glyph matrix. */
17751 if (Z_delta
|| Z_delta_bytes
)
17753 struct glyph_row
*r1
17754 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17755 increment_matrix_positions (w
->current_matrix
,
17756 MATRIX_ROW_VPOS (r0
, current_matrix
),
17757 MATRIX_ROW_VPOS (r1
, current_matrix
),
17758 Z_delta
, Z_delta_bytes
);
17761 /* Set the cursor. */
17762 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17764 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17769 /* Handle the case that changes are all below what is displayed in
17770 the window, and that PT is in the window. This shortcut cannot
17771 be taken if ZV is visible in the window, and text has been added
17772 there that is visible in the window. */
17773 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17774 /* ZV is not visible in the window, or there are no
17775 changes at ZV, actually. */
17776 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17777 || first_changed_charpos
== last_changed_charpos
))
17779 struct glyph_row
*r0
;
17781 /* Give up if PT is not in the window. Note that it already has
17782 been checked at the start of try_window_id that PT is not in
17783 front of the window start. */
17784 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17787 /* If window start is unchanged, we can reuse the whole matrix
17788 as is, without changing glyph positions since no text has
17789 been added/removed in front of the window end. */
17790 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17791 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17792 /* PT must not be in a partially visible line. */
17793 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17794 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17796 /* We have to compute the window end anew since text
17797 could have been added/removed after it. */
17798 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17799 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17801 /* Set the cursor. */
17802 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17804 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17809 /* Give up if window start is in the changed area.
17811 The condition used to read
17813 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17815 but why that was tested escapes me at the moment. */
17816 if (CHARPOS (start
) >= first_changed_charpos
17817 && CHARPOS (start
) <= last_changed_charpos
)
17820 /* Check that window start agrees with the start of the first glyph
17821 row in its current matrix. Check this after we know the window
17822 start is not in changed text, otherwise positions would not be
17824 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17825 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17828 /* Give up if the window ends in strings. Overlay strings
17829 at the end are difficult to handle, so don't try. */
17830 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17831 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17834 /* Compute the position at which we have to start displaying new
17835 lines. Some of the lines at the top of the window might be
17836 reusable because they are not displaying changed text. Find the
17837 last row in W's current matrix not affected by changes at the
17838 start of current_buffer. Value is null if changes start in the
17839 first line of window. */
17840 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17841 if (last_unchanged_at_beg_row
)
17843 /* Avoid starting to display in the middle of a character, a TAB
17844 for instance. This is easier than to set up the iterator
17845 exactly, and it's not a frequent case, so the additional
17846 effort wouldn't really pay off. */
17847 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17848 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17849 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17850 --last_unchanged_at_beg_row
;
17852 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17855 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17857 start_pos
= it
.current
.pos
;
17859 /* Start displaying new lines in the desired matrix at the same
17860 vpos we would use in the current matrix, i.e. below
17861 last_unchanged_at_beg_row. */
17862 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17864 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17865 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17867 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17871 /* There are no reusable lines at the start of the window.
17872 Start displaying in the first text line. */
17873 start_display (&it
, w
, start
);
17874 it
.vpos
= it
.first_vpos
;
17875 start_pos
= it
.current
.pos
;
17878 /* Find the first row that is not affected by changes at the end of
17879 the buffer. Value will be null if there is no unchanged row, in
17880 which case we must redisplay to the end of the window. delta
17881 will be set to the value by which buffer positions beginning with
17882 first_unchanged_at_end_row have to be adjusted due to text
17884 first_unchanged_at_end_row
17885 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17886 IF_DEBUG (debug_delta
= delta
);
17887 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17889 /* Set stop_pos to the buffer position up to which we will have to
17890 display new lines. If first_unchanged_at_end_row != NULL, this
17891 is the buffer position of the start of the line displayed in that
17892 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17893 that we don't stop at a buffer position. */
17895 if (first_unchanged_at_end_row
)
17897 eassert (last_unchanged_at_beg_row
== NULL
17898 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17900 /* If this is a continuation line, move forward to the next one
17901 that isn't. Changes in lines above affect this line.
17902 Caution: this may move first_unchanged_at_end_row to a row
17903 not displaying text. */
17904 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17905 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17906 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17907 < it
.last_visible_y
))
17908 ++first_unchanged_at_end_row
;
17910 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17911 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17912 >= it
.last_visible_y
))
17913 first_unchanged_at_end_row
= NULL
;
17916 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17918 first_unchanged_at_end_vpos
17919 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17920 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17923 else if (last_unchanged_at_beg_row
== NULL
)
17929 /* Either there is no unchanged row at the end, or the one we have
17930 now displays text. This is a necessary condition for the window
17931 end pos calculation at the end of this function. */
17932 eassert (first_unchanged_at_end_row
== NULL
17933 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17935 debug_last_unchanged_at_beg_vpos
17936 = (last_unchanged_at_beg_row
17937 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17939 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17941 #endif /* GLYPH_DEBUG */
17944 /* Display new lines. Set last_text_row to the last new line
17945 displayed which has text on it, i.e. might end up as being the
17946 line where the window_end_vpos is. */
17947 w
->cursor
.vpos
= -1;
17948 last_text_row
= NULL
;
17949 overlay_arrow_seen
= 0;
17950 while (it
.current_y
< it
.last_visible_y
17951 && !f
->fonts_changed
17952 && (first_unchanged_at_end_row
== NULL
17953 || IT_CHARPOS (it
) < stop_pos
))
17955 if (display_line (&it
))
17956 last_text_row
= it
.glyph_row
- 1;
17959 if (f
->fonts_changed
)
17963 /* Compute differences in buffer positions, y-positions etc. for
17964 lines reused at the bottom of the window. Compute what we can
17966 if (first_unchanged_at_end_row
17967 /* No lines reused because we displayed everything up to the
17968 bottom of the window. */
17969 && it
.current_y
< it
.last_visible_y
)
17972 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17974 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17975 run
.current_y
= first_unchanged_at_end_row
->y
;
17976 run
.desired_y
= run
.current_y
+ dy
;
17977 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17981 delta
= delta_bytes
= dvpos
= dy
17982 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17983 first_unchanged_at_end_row
= NULL
;
17985 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
17988 /* Find the cursor if not already found. We have to decide whether
17989 PT will appear on this window (it sometimes doesn't, but this is
17990 not a very frequent case.) This decision has to be made before
17991 the current matrix is altered. A value of cursor.vpos < 0 means
17992 that PT is either in one of the lines beginning at
17993 first_unchanged_at_end_row or below the window. Don't care for
17994 lines that might be displayed later at the window end; as
17995 mentioned, this is not a frequent case. */
17996 if (w
->cursor
.vpos
< 0)
17998 /* Cursor in unchanged rows at the top? */
17999 if (PT
< CHARPOS (start_pos
)
18000 && last_unchanged_at_beg_row
)
18002 row
= row_containing_pos (w
, PT
,
18003 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18004 last_unchanged_at_beg_row
+ 1, 0);
18006 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18009 /* Start from first_unchanged_at_end_row looking for PT. */
18010 else if (first_unchanged_at_end_row
)
18012 row
= row_containing_pos (w
, PT
- delta
,
18013 first_unchanged_at_end_row
, NULL
, 0);
18015 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18016 delta_bytes
, dy
, dvpos
);
18019 /* Give up if cursor was not found. */
18020 if (w
->cursor
.vpos
< 0)
18022 clear_glyph_matrix (w
->desired_matrix
);
18027 /* Don't let the cursor end in the scroll margins. */
18029 int this_scroll_margin
, cursor_height
;
18030 int frame_line_height
= default_line_pixel_height (w
);
18031 int window_total_lines
18032 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18034 this_scroll_margin
=
18035 max (0, min (scroll_margin
, window_total_lines
/ 4));
18036 this_scroll_margin
*= frame_line_height
;
18037 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18039 if ((w
->cursor
.y
< this_scroll_margin
18040 && CHARPOS (start
) > BEGV
)
18041 /* Old redisplay didn't take scroll margin into account at the bottom,
18042 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18043 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18044 ? cursor_height
+ this_scroll_margin
18045 : 1)) > it
.last_visible_y
)
18047 w
->cursor
.vpos
= -1;
18048 clear_glyph_matrix (w
->desired_matrix
);
18053 /* Scroll the display. Do it before changing the current matrix so
18054 that xterm.c doesn't get confused about where the cursor glyph is
18056 if (dy
&& run
.height
)
18060 if (FRAME_WINDOW_P (f
))
18062 FRAME_RIF (f
)->update_window_begin_hook (w
);
18063 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18064 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18065 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18069 /* Terminal frame. In this case, dvpos gives the number of
18070 lines to scroll by; dvpos < 0 means scroll up. */
18072 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18073 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18074 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18075 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18076 + window_internal_height (w
));
18078 #if defined (HAVE_GPM) || defined (MSDOS)
18079 x_clear_window_mouse_face (w
);
18081 /* Perform the operation on the screen. */
18084 /* Scroll last_unchanged_at_beg_row to the end of the
18085 window down dvpos lines. */
18086 set_terminal_window (f
, end
);
18088 /* On dumb terminals delete dvpos lines at the end
18089 before inserting dvpos empty lines. */
18090 if (!FRAME_SCROLL_REGION_OK (f
))
18091 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18093 /* Insert dvpos empty lines in front of
18094 last_unchanged_at_beg_row. */
18095 ins_del_lines (f
, from
, dvpos
);
18097 else if (dvpos
< 0)
18099 /* Scroll up last_unchanged_at_beg_vpos to the end of
18100 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18101 set_terminal_window (f
, end
);
18103 /* Delete dvpos lines in front of
18104 last_unchanged_at_beg_vpos. ins_del_lines will set
18105 the cursor to the given vpos and emit |dvpos| delete
18107 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18109 /* On a dumb terminal insert dvpos empty lines at the
18111 if (!FRAME_SCROLL_REGION_OK (f
))
18112 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18115 set_terminal_window (f
, 0);
18121 /* Shift reused rows of the current matrix to the right position.
18122 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18124 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18125 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18128 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18129 bottom_vpos
, dvpos
);
18130 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18133 else if (dvpos
> 0)
18135 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18136 bottom_vpos
, dvpos
);
18137 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18138 first_unchanged_at_end_vpos
+ dvpos
);
18141 /* For frame-based redisplay, make sure that current frame and window
18142 matrix are in sync with respect to glyph memory. */
18143 if (!FRAME_WINDOW_P (f
))
18144 sync_frame_with_window_matrix_rows (w
);
18146 /* Adjust buffer positions in reused rows. */
18147 if (delta
|| delta_bytes
)
18148 increment_matrix_positions (current_matrix
,
18149 first_unchanged_at_end_vpos
+ dvpos
,
18150 bottom_vpos
, delta
, delta_bytes
);
18152 /* Adjust Y positions. */
18154 shift_glyph_matrix (w
, current_matrix
,
18155 first_unchanged_at_end_vpos
+ dvpos
,
18158 if (first_unchanged_at_end_row
)
18160 first_unchanged_at_end_row
+= dvpos
;
18161 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18162 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18163 first_unchanged_at_end_row
= NULL
;
18166 /* If scrolling up, there may be some lines to display at the end of
18168 last_text_row_at_end
= NULL
;
18171 /* Scrolling up can leave for example a partially visible line
18172 at the end of the window to be redisplayed. */
18173 /* Set last_row to the glyph row in the current matrix where the
18174 window end line is found. It has been moved up or down in
18175 the matrix by dvpos. */
18176 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18177 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18179 /* If last_row is the window end line, it should display text. */
18180 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18182 /* If window end line was partially visible before, begin
18183 displaying at that line. Otherwise begin displaying with the
18184 line following it. */
18185 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18187 init_to_row_start (&it
, w
, last_row
);
18188 it
.vpos
= last_vpos
;
18189 it
.current_y
= last_row
->y
;
18193 init_to_row_end (&it
, w
, last_row
);
18194 it
.vpos
= 1 + last_vpos
;
18195 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18199 /* We may start in a continuation line. If so, we have to
18200 get the right continuation_lines_width and current_x. */
18201 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18202 it
.hpos
= it
.current_x
= 0;
18204 /* Display the rest of the lines at the window end. */
18205 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18206 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18208 /* Is it always sure that the display agrees with lines in
18209 the current matrix? I don't think so, so we mark rows
18210 displayed invalid in the current matrix by setting their
18211 enabled_p flag to zero. */
18212 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18213 if (display_line (&it
))
18214 last_text_row_at_end
= it
.glyph_row
- 1;
18218 /* Update window_end_pos and window_end_vpos. */
18219 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18221 /* Window end line if one of the preserved rows from the current
18222 matrix. Set row to the last row displaying text in current
18223 matrix starting at first_unchanged_at_end_row, after
18225 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18226 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18227 first_unchanged_at_end_row
);
18228 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18229 adjust_window_ends (w
, row
, 1);
18230 eassert (w
->window_end_bytepos
>= 0);
18231 IF_DEBUG (debug_method_add (w
, "A"));
18233 else if (last_text_row_at_end
)
18235 adjust_window_ends (w
, last_text_row_at_end
, 0);
18236 eassert (w
->window_end_bytepos
>= 0);
18237 IF_DEBUG (debug_method_add (w
, "B"));
18239 else if (last_text_row
)
18241 /* We have displayed either to the end of the window or at the
18242 end of the window, i.e. the last row with text is to be found
18243 in the desired matrix. */
18244 adjust_window_ends (w
, last_text_row
, 0);
18245 eassert (w
->window_end_bytepos
>= 0);
18247 else if (first_unchanged_at_end_row
== NULL
18248 && last_text_row
== NULL
18249 && last_text_row_at_end
== NULL
)
18251 /* Displayed to end of window, but no line containing text was
18252 displayed. Lines were deleted at the end of the window. */
18253 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18254 int vpos
= w
->window_end_vpos
;
18255 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18256 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18259 row
== NULL
&& vpos
>= first_vpos
;
18260 --vpos
, --current_row
, --desired_row
)
18262 if (desired_row
->enabled_p
)
18264 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18267 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18271 eassert (row
!= NULL
);
18272 w
->window_end_vpos
= vpos
+ 1;
18273 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18274 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18275 eassert (w
->window_end_bytepos
>= 0);
18276 IF_DEBUG (debug_method_add (w
, "C"));
18281 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18282 debug_end_vpos
= w
->window_end_vpos
));
18284 /* Record that display has not been completed. */
18285 w
->window_end_valid
= 0;
18286 w
->desired_matrix
->no_scrolling_p
= 1;
18294 /***********************************************************************
18295 More debugging support
18296 ***********************************************************************/
18300 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18301 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18302 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18305 /* Dump the contents of glyph matrix MATRIX on stderr.
18307 GLYPHS 0 means don't show glyph contents.
18308 GLYPHS 1 means show glyphs in short form
18309 GLYPHS > 1 means show glyphs in long form. */
18312 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18315 for (i
= 0; i
< matrix
->nrows
; ++i
)
18316 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18320 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18321 the glyph row and area where the glyph comes from. */
18324 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18326 if (glyph
->type
== CHAR_GLYPH
18327 || glyph
->type
== GLYPHLESS_GLYPH
)
18330 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18331 glyph
- row
->glyphs
[TEXT_AREA
],
18332 (glyph
->type
== CHAR_GLYPH
18336 (BUFFERP (glyph
->object
)
18338 : (STRINGP (glyph
->object
)
18340 : (INTEGERP (glyph
->object
)
18343 glyph
->pixel_width
,
18345 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18349 glyph
->left_box_line_p
,
18350 glyph
->right_box_line_p
);
18352 else if (glyph
->type
== STRETCH_GLYPH
)
18355 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18356 glyph
- row
->glyphs
[TEXT_AREA
],
18359 (BUFFERP (glyph
->object
)
18361 : (STRINGP (glyph
->object
)
18363 : (INTEGERP (glyph
->object
)
18366 glyph
->pixel_width
,
18370 glyph
->left_box_line_p
,
18371 glyph
->right_box_line_p
);
18373 else if (glyph
->type
== IMAGE_GLYPH
)
18376 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18377 glyph
- row
->glyphs
[TEXT_AREA
],
18380 (BUFFERP (glyph
->object
)
18382 : (STRINGP (glyph
->object
)
18384 : (INTEGERP (glyph
->object
)
18387 glyph
->pixel_width
,
18391 glyph
->left_box_line_p
,
18392 glyph
->right_box_line_p
);
18394 else if (glyph
->type
== COMPOSITE_GLYPH
)
18397 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18398 glyph
- row
->glyphs
[TEXT_AREA
],
18401 (BUFFERP (glyph
->object
)
18403 : (STRINGP (glyph
->object
)
18405 : (INTEGERP (glyph
->object
)
18408 glyph
->pixel_width
,
18410 if (glyph
->u
.cmp
.automatic
)
18413 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18414 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18416 glyph
->left_box_line_p
,
18417 glyph
->right_box_line_p
);
18422 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18423 GLYPHS 0 means don't show glyph contents.
18424 GLYPHS 1 means show glyphs in short form
18425 GLYPHS > 1 means show glyphs in long form. */
18428 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18432 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18433 fprintf (stderr
, "==============================================================================\n");
18435 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18436 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18438 MATRIX_ROW_START_CHARPOS (row
),
18439 MATRIX_ROW_END_CHARPOS (row
),
18440 row
->used
[TEXT_AREA
],
18441 row
->contains_overlapping_glyphs_p
,
18443 row
->truncated_on_left_p
,
18444 row
->truncated_on_right_p
,
18446 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18447 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18450 row
->ends_in_middle_of_char_p
,
18451 row
->starts_in_middle_of_char_p
,
18457 row
->visible_height
,
18460 /* The next 3 lines should align to "Start" in the header. */
18461 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18462 row
->end
.overlay_string_index
,
18463 row
->continuation_lines_width
);
18464 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18465 CHARPOS (row
->start
.string_pos
),
18466 CHARPOS (row
->end
.string_pos
));
18467 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18468 row
->end
.dpvec_index
);
18475 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18477 struct glyph
*glyph
= row
->glyphs
[area
];
18478 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18480 /* Glyph for a line end in text. */
18481 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18484 if (glyph
< glyph_end
)
18485 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18487 for (; glyph
< glyph_end
; ++glyph
)
18488 dump_glyph (row
, glyph
, area
);
18491 else if (glyphs
== 1)
18495 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18497 char *s
= alloca (row
->used
[area
] + 4);
18500 for (i
= 0; i
< row
->used
[area
]; ++i
)
18502 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18503 if (i
== row
->used
[area
] - 1
18504 && area
== TEXT_AREA
18505 && INTEGERP (glyph
->object
)
18506 && glyph
->type
== CHAR_GLYPH
18507 && glyph
->u
.ch
== ' ')
18509 strcpy (&s
[i
], "[\\n]");
18512 else if (glyph
->type
== CHAR_GLYPH
18513 && glyph
->u
.ch
< 0x80
18514 && glyph
->u
.ch
>= ' ')
18515 s
[i
] = glyph
->u
.ch
;
18521 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18527 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18528 Sdump_glyph_matrix
, 0, 1, "p",
18529 doc
: /* Dump the current matrix of the selected window to stderr.
18530 Shows contents of glyph row structures. With non-nil
18531 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18532 glyphs in short form, otherwise show glyphs in long form. */)
18533 (Lisp_Object glyphs
)
18535 struct window
*w
= XWINDOW (selected_window
);
18536 struct buffer
*buffer
= XBUFFER (w
->contents
);
18538 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18539 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18540 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18541 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18542 fprintf (stderr
, "=============================================\n");
18543 dump_glyph_matrix (w
->current_matrix
,
18544 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18549 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18550 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18553 struct frame
*f
= XFRAME (selected_frame
);
18554 dump_glyph_matrix (f
->current_matrix
, 1);
18559 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18560 doc
: /* Dump glyph row ROW to stderr.
18561 GLYPH 0 means don't dump glyphs.
18562 GLYPH 1 means dump glyphs in short form.
18563 GLYPH > 1 or omitted means dump glyphs in long form. */)
18564 (Lisp_Object row
, Lisp_Object glyphs
)
18566 struct glyph_matrix
*matrix
;
18569 CHECK_NUMBER (row
);
18570 matrix
= XWINDOW (selected_window
)->current_matrix
;
18572 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18573 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18575 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18580 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18581 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18582 GLYPH 0 means don't dump glyphs.
18583 GLYPH 1 means dump glyphs in short form.
18584 GLYPH > 1 or omitted means dump glyphs in long form.
18586 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18588 (Lisp_Object row
, Lisp_Object glyphs
)
18590 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18591 struct frame
*sf
= SELECTED_FRAME ();
18592 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18595 CHECK_NUMBER (row
);
18597 if (vpos
>= 0 && vpos
< m
->nrows
)
18598 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18599 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18605 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18606 doc
: /* Toggle tracing of redisplay.
18607 With ARG, turn tracing on if and only if ARG is positive. */)
18611 trace_redisplay_p
= !trace_redisplay_p
;
18614 arg
= Fprefix_numeric_value (arg
);
18615 trace_redisplay_p
= XINT (arg
) > 0;
18622 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18623 doc
: /* Like `format', but print result to stderr.
18624 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18625 (ptrdiff_t nargs
, Lisp_Object
*args
)
18627 Lisp_Object s
= Fformat (nargs
, args
);
18628 fprintf (stderr
, "%s", SDATA (s
));
18632 #endif /* GLYPH_DEBUG */
18636 /***********************************************************************
18637 Building Desired Matrix Rows
18638 ***********************************************************************/
18640 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18641 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18643 static struct glyph_row
*
18644 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18646 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18647 struct buffer
*buffer
= XBUFFER (w
->contents
);
18648 struct buffer
*old
= current_buffer
;
18649 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18650 int arrow_len
= SCHARS (overlay_arrow_string
);
18651 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18652 const unsigned char *p
;
18655 int n_glyphs_before
;
18657 set_buffer_temp (buffer
);
18658 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18659 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18660 SET_TEXT_POS (it
.position
, 0, 0);
18662 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18664 while (p
< arrow_end
)
18666 Lisp_Object face
, ilisp
;
18668 /* Get the next character. */
18670 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18673 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18674 if (! ASCII_CHAR_P (it
.c
))
18675 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18679 /* Get its face. */
18680 ilisp
= make_number (p
- arrow_string
);
18681 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18682 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18684 /* Compute its width, get its glyphs. */
18685 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18686 SET_TEXT_POS (it
.position
, -1, -1);
18687 PRODUCE_GLYPHS (&it
);
18689 /* If this character doesn't fit any more in the line, we have
18690 to remove some glyphs. */
18691 if (it
.current_x
> it
.last_visible_x
)
18693 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18698 set_buffer_temp (old
);
18699 return it
.glyph_row
;
18703 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18704 glyphs to insert is determined by produce_special_glyphs. */
18707 insert_left_trunc_glyphs (struct it
*it
)
18709 struct it truncate_it
;
18710 struct glyph
*from
, *end
, *to
, *toend
;
18712 eassert (!FRAME_WINDOW_P (it
->f
)
18713 || (!it
->glyph_row
->reversed_p
18714 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18715 || (it
->glyph_row
->reversed_p
18716 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18718 /* Get the truncation glyphs. */
18720 truncate_it
.current_x
= 0;
18721 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18722 truncate_it
.glyph_row
= &scratch_glyph_row
;
18723 truncate_it
.area
= TEXT_AREA
;
18724 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18725 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18726 truncate_it
.object
= make_number (0);
18727 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18729 /* Overwrite glyphs from IT with truncation glyphs. */
18730 if (!it
->glyph_row
->reversed_p
)
18732 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18734 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18735 end
= from
+ tused
;
18736 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18737 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18738 if (FRAME_WINDOW_P (it
->f
))
18740 /* On GUI frames, when variable-size fonts are displayed,
18741 the truncation glyphs may need more pixels than the row's
18742 glyphs they overwrite. We overwrite more glyphs to free
18743 enough screen real estate, and enlarge the stretch glyph
18744 on the right (see display_line), if there is one, to
18745 preserve the screen position of the truncation glyphs on
18748 struct glyph
*g
= to
;
18751 /* The first glyph could be partially visible, in which case
18752 it->glyph_row->x will be negative. But we want the left
18753 truncation glyphs to be aligned at the left margin of the
18754 window, so we override the x coordinate at which the row
18756 it
->glyph_row
->x
= 0;
18757 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18759 w
+= g
->pixel_width
;
18762 if (g
- to
- tused
> 0)
18764 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18765 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18767 used
= it
->glyph_row
->used
[TEXT_AREA
];
18768 if (it
->glyph_row
->truncated_on_right_p
18769 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18770 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18773 int extra
= w
- it
->truncation_pixel_width
;
18775 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18782 /* There may be padding glyphs left over. Overwrite them too. */
18783 if (!FRAME_WINDOW_P (it
->f
))
18785 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18787 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18794 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18798 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18800 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18801 that back to front. */
18802 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18803 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18804 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18805 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18806 if (FRAME_WINDOW_P (it
->f
))
18809 struct glyph
*g
= to
;
18811 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18813 w
+= g
->pixel_width
;
18816 if (to
- g
- tused
> 0)
18818 if (it
->glyph_row
->truncated_on_right_p
18819 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18820 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18822 int extra
= w
- it
->truncation_pixel_width
;
18824 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18828 while (from
>= end
&& to
>= toend
)
18830 if (!FRAME_WINDOW_P (it
->f
))
18832 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18835 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18836 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18837 while (from
>= end
&& to
>= toend
)
18843 /* Need to free some room before prepending additional
18845 int move_by
= from
- end
+ 1;
18846 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18847 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18849 for ( ; g
>= g0
; g
--)
18851 while (from
>= end
)
18853 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18858 /* Compute the hash code for ROW. */
18860 row_hash (struct glyph_row
*row
)
18863 unsigned hashval
= 0;
18865 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18866 for (k
= 0; k
< row
->used
[area
]; ++k
)
18867 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18868 + row
->glyphs
[area
][k
].u
.val
18869 + row
->glyphs
[area
][k
].face_id
18870 + row
->glyphs
[area
][k
].padding_p
18871 + (row
->glyphs
[area
][k
].type
<< 2));
18876 /* Compute the pixel height and width of IT->glyph_row.
18878 Most of the time, ascent and height of a display line will be equal
18879 to the max_ascent and max_height values of the display iterator
18880 structure. This is not the case if
18882 1. We hit ZV without displaying anything. In this case, max_ascent
18883 and max_height will be zero.
18885 2. We have some glyphs that don't contribute to the line height.
18886 (The glyph row flag contributes_to_line_height_p is for future
18887 pixmap extensions).
18889 The first case is easily covered by using default values because in
18890 these cases, the line height does not really matter, except that it
18891 must not be zero. */
18894 compute_line_metrics (struct it
*it
)
18896 struct glyph_row
*row
= it
->glyph_row
;
18898 if (FRAME_WINDOW_P (it
->f
))
18900 int i
, min_y
, max_y
;
18902 /* The line may consist of one space only, that was added to
18903 place the cursor on it. If so, the row's height hasn't been
18905 if (row
->height
== 0)
18907 if (it
->max_ascent
+ it
->max_descent
== 0)
18908 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18909 row
->ascent
= it
->max_ascent
;
18910 row
->height
= it
->max_ascent
+ it
->max_descent
;
18911 row
->phys_ascent
= it
->max_phys_ascent
;
18912 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18913 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18916 /* Compute the width of this line. */
18917 row
->pixel_width
= row
->x
;
18918 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18919 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18921 eassert (row
->pixel_width
>= 0);
18922 eassert (row
->ascent
>= 0 && row
->height
> 0);
18924 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18925 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18927 /* If first line's physical ascent is larger than its logical
18928 ascent, use the physical ascent, and make the row taller.
18929 This makes accented characters fully visible. */
18930 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18931 && row
->phys_ascent
> row
->ascent
)
18933 row
->height
+= row
->phys_ascent
- row
->ascent
;
18934 row
->ascent
= row
->phys_ascent
;
18937 /* Compute how much of the line is visible. */
18938 row
->visible_height
= row
->height
;
18940 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18941 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18943 if (row
->y
< min_y
)
18944 row
->visible_height
-= min_y
- row
->y
;
18945 if (row
->y
+ row
->height
> max_y
)
18946 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18950 row
->pixel_width
= row
->used
[TEXT_AREA
];
18951 if (row
->continued_p
)
18952 row
->pixel_width
-= it
->continuation_pixel_width
;
18953 else if (row
->truncated_on_right_p
)
18954 row
->pixel_width
-= it
->truncation_pixel_width
;
18955 row
->ascent
= row
->phys_ascent
= 0;
18956 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18957 row
->extra_line_spacing
= 0;
18960 /* Compute a hash code for this row. */
18961 row
->hash
= row_hash (row
);
18963 it
->max_ascent
= it
->max_descent
= 0;
18964 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18968 /* Append one space to the glyph row of iterator IT if doing a
18969 window-based redisplay. The space has the same face as
18970 IT->face_id. Value is non-zero if a space was added.
18972 This function is called to make sure that there is always one glyph
18973 at the end of a glyph row that the cursor can be set on under
18974 window-systems. (If there weren't such a glyph we would not know
18975 how wide and tall a box cursor should be displayed).
18977 At the same time this space let's a nicely handle clearing to the
18978 end of the line if the row ends in italic text. */
18981 append_space_for_newline (struct it
*it
, int default_face_p
)
18983 if (FRAME_WINDOW_P (it
->f
))
18985 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18987 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18988 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18990 /* Save some values that must not be changed.
18991 Must save IT->c and IT->len because otherwise
18992 ITERATOR_AT_END_P wouldn't work anymore after
18993 append_space_for_newline has been called. */
18994 enum display_element_type saved_what
= it
->what
;
18995 int saved_c
= it
->c
, saved_len
= it
->len
;
18996 int saved_char_to_display
= it
->char_to_display
;
18997 int saved_x
= it
->current_x
;
18998 int saved_face_id
= it
->face_id
;
18999 int saved_box_end
= it
->end_of_box_run_p
;
19000 struct text_pos saved_pos
;
19001 Lisp_Object saved_object
;
19004 saved_object
= it
->object
;
19005 saved_pos
= it
->position
;
19007 it
->what
= IT_CHARACTER
;
19008 memset (&it
->position
, 0, sizeof it
->position
);
19009 it
->object
= make_number (0);
19010 it
->c
= it
->char_to_display
= ' ';
19013 /* If the default face was remapped, be sure to use the
19014 remapped face for the appended newline. */
19015 if (default_face_p
)
19016 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19017 else if (it
->face_before_selective_p
)
19018 it
->face_id
= it
->saved_face_id
;
19019 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19020 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19021 /* In R2L rows, we will prepend a stretch glyph that will
19022 have the end_of_box_run_p flag set for it, so there's no
19023 need for the appended newline glyph to have that flag
19025 if (it
->glyph_row
->reversed_p
19026 /* But if the appended newline glyph goes all the way to
19027 the end of the row, there will be no stretch glyph,
19028 so leave the box flag set. */
19029 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19030 it
->end_of_box_run_p
= 0;
19032 PRODUCE_GLYPHS (it
);
19034 it
->override_ascent
= -1;
19035 it
->constrain_row_ascent_descent_p
= 0;
19036 it
->current_x
= saved_x
;
19037 it
->object
= saved_object
;
19038 it
->position
= saved_pos
;
19039 it
->what
= saved_what
;
19040 it
->face_id
= saved_face_id
;
19041 it
->len
= saved_len
;
19043 it
->char_to_display
= saved_char_to_display
;
19044 it
->end_of_box_run_p
= saved_box_end
;
19053 /* Extend the face of the last glyph in the text area of IT->glyph_row
19054 to the end of the display line. Called from display_line. If the
19055 glyph row is empty, add a space glyph to it so that we know the
19056 face to draw. Set the glyph row flag fill_line_p. If the glyph
19057 row is R2L, prepend a stretch glyph to cover the empty space to the
19058 left of the leftmost glyph. */
19061 extend_face_to_end_of_line (struct it
*it
)
19063 struct face
*face
, *default_face
;
19064 struct frame
*f
= it
->f
;
19066 /* If line is already filled, do nothing. Non window-system frames
19067 get a grace of one more ``pixel'' because their characters are
19068 1-``pixel'' wide, so they hit the equality too early. This grace
19069 is needed only for R2L rows that are not continued, to produce
19070 one extra blank where we could display the cursor. */
19071 if ((it
->current_x
>= it
->last_visible_x
19072 + (!FRAME_WINDOW_P (f
)
19073 && it
->glyph_row
->reversed_p
19074 && !it
->glyph_row
->continued_p
))
19075 /* If the window has display margins, we will need to extend
19076 their face even if the text area is filled. */
19077 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19078 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19081 /* The default face, possibly remapped. */
19082 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19084 /* Face extension extends the background and box of IT->face_id
19085 to the end of the line. If the background equals the background
19086 of the frame, we don't have to do anything. */
19087 if (it
->face_before_selective_p
)
19088 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19090 face
= FACE_FROM_ID (f
, it
->face_id
);
19092 if (FRAME_WINDOW_P (f
)
19093 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19094 && face
->box
== FACE_NO_BOX
19095 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19096 #ifdef HAVE_WINDOW_SYSTEM
19099 && !it
->glyph_row
->reversed_p
)
19102 /* Set the glyph row flag indicating that the face of the last glyph
19103 in the text area has to be drawn to the end of the text area. */
19104 it
->glyph_row
->fill_line_p
= 1;
19106 /* If current character of IT is not ASCII, make sure we have the
19107 ASCII face. This will be automatically undone the next time
19108 get_next_display_element returns a multibyte character. Note
19109 that the character will always be single byte in unibyte
19111 if (!ASCII_CHAR_P (it
->c
))
19113 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19116 if (FRAME_WINDOW_P (f
))
19118 /* If the row is empty, add a space with the current face of IT,
19119 so that we know which face to draw. */
19120 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19122 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19123 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19124 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19126 /* Mode line and the header line don't have margins, and
19127 likewise the frame's tool-bar window, if there is any. */
19128 if (!(it
->glyph_row
->mode_line_p
19129 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19130 || (WINDOWP (f
->tool_bar_window
)
19131 && it
->w
== XWINDOW (f
->tool_bar_window
))
19135 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19136 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19138 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19139 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19141 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19143 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19144 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19146 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19147 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19149 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19152 #ifdef HAVE_WINDOW_SYSTEM
19153 if (it
->glyph_row
->reversed_p
)
19155 /* Prepend a stretch glyph to the row, such that the
19156 rightmost glyph will be drawn flushed all the way to the
19157 right margin of the window. The stretch glyph that will
19158 occupy the empty space, if any, to the left of the
19160 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19161 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19162 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19164 int row_width
, stretch_ascent
, stretch_width
;
19165 struct text_pos saved_pos
;
19166 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19168 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19169 row_width
+= g
->pixel_width
;
19170 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19171 if (stretch_width
> 0)
19174 (((it
->ascent
+ it
->descent
)
19175 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19176 saved_pos
= it
->position
;
19177 memset (&it
->position
, 0, sizeof it
->position
);
19178 saved_avoid_cursor
= it
->avoid_cursor_p
;
19179 it
->avoid_cursor_p
= 1;
19180 saved_face_id
= it
->face_id
;
19181 saved_box_start
= it
->start_of_box_run_p
;
19182 /* The last row's stretch glyph should get the default
19183 face, to avoid painting the rest of the window with
19184 the region face, if the region ends at ZV. */
19185 if (it
->glyph_row
->ends_at_zv_p
)
19186 it
->face_id
= default_face
->id
;
19188 it
->face_id
= face
->id
;
19189 it
->start_of_box_run_p
= 0;
19190 append_stretch_glyph (it
, make_number (0), stretch_width
,
19191 it
->ascent
+ it
->descent
, stretch_ascent
);
19192 it
->position
= saved_pos
;
19193 it
->avoid_cursor_p
= saved_avoid_cursor
;
19194 it
->face_id
= saved_face_id
;
19195 it
->start_of_box_run_p
= saved_box_start
;
19198 #endif /* HAVE_WINDOW_SYSTEM */
19202 /* Save some values that must not be changed. */
19203 int saved_x
= it
->current_x
;
19204 struct text_pos saved_pos
;
19205 Lisp_Object saved_object
;
19206 enum display_element_type saved_what
= it
->what
;
19207 int saved_face_id
= it
->face_id
;
19209 saved_object
= it
->object
;
19210 saved_pos
= it
->position
;
19212 it
->what
= IT_CHARACTER
;
19213 memset (&it
->position
, 0, sizeof it
->position
);
19214 it
->object
= make_number (0);
19215 it
->c
= it
->char_to_display
= ' ';
19218 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19219 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19220 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19221 && !it
->glyph_row
->mode_line_p
19222 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19224 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19225 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19227 for (it
->current_x
= 0; g
< e
; g
++)
19228 it
->current_x
+= g
->pixel_width
;
19230 it
->area
= LEFT_MARGIN_AREA
;
19231 it
->face_id
= default_face
->id
;
19232 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19233 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19235 PRODUCE_GLYPHS (it
);
19236 /* term.c:produce_glyphs advances it->current_x only for
19238 it
->current_x
+= it
->pixel_width
;
19241 it
->current_x
= saved_x
;
19242 it
->area
= TEXT_AREA
;
19245 /* The last row's blank glyphs should get the default face, to
19246 avoid painting the rest of the window with the region face,
19247 if the region ends at ZV. */
19248 if (it
->glyph_row
->ends_at_zv_p
)
19249 it
->face_id
= default_face
->id
;
19251 it
->face_id
= face
->id
;
19252 PRODUCE_GLYPHS (it
);
19254 while (it
->current_x
<= it
->last_visible_x
)
19255 PRODUCE_GLYPHS (it
);
19257 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19258 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19259 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19260 && !it
->glyph_row
->mode_line_p
19261 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19263 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19264 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19266 for ( ; g
< e
; g
++)
19267 it
->current_x
+= g
->pixel_width
;
19269 it
->area
= RIGHT_MARGIN_AREA
;
19270 it
->face_id
= default_face
->id
;
19271 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19272 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19274 PRODUCE_GLYPHS (it
);
19275 it
->current_x
+= it
->pixel_width
;
19278 it
->area
= TEXT_AREA
;
19281 /* Don't count these blanks really. It would let us insert a left
19282 truncation glyph below and make us set the cursor on them, maybe. */
19283 it
->current_x
= saved_x
;
19284 it
->object
= saved_object
;
19285 it
->position
= saved_pos
;
19286 it
->what
= saved_what
;
19287 it
->face_id
= saved_face_id
;
19292 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19293 trailing whitespace. */
19296 trailing_whitespace_p (ptrdiff_t charpos
)
19298 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19301 while (bytepos
< ZV_BYTE
19302 && (c
= FETCH_CHAR (bytepos
),
19303 c
== ' ' || c
== '\t'))
19306 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19308 if (bytepos
!= PT_BYTE
)
19315 /* Highlight trailing whitespace, if any, in ROW. */
19318 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19320 int used
= row
->used
[TEXT_AREA
];
19324 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19325 struct glyph
*glyph
= start
+ used
- 1;
19327 if (row
->reversed_p
)
19329 /* Right-to-left rows need to be processed in the opposite
19330 direction, so swap the edge pointers. */
19332 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19335 /* Skip over glyphs inserted to display the cursor at the
19336 end of a line, for extending the face of the last glyph
19337 to the end of the line on terminals, and for truncation
19338 and continuation glyphs. */
19339 if (!row
->reversed_p
)
19341 while (glyph
>= start
19342 && glyph
->type
== CHAR_GLYPH
19343 && INTEGERP (glyph
->object
))
19348 while (glyph
<= start
19349 && glyph
->type
== CHAR_GLYPH
19350 && INTEGERP (glyph
->object
))
19354 /* If last glyph is a space or stretch, and it's trailing
19355 whitespace, set the face of all trailing whitespace glyphs in
19356 IT->glyph_row to `trailing-whitespace'. */
19357 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19358 && BUFFERP (glyph
->object
)
19359 && (glyph
->type
== STRETCH_GLYPH
19360 || (glyph
->type
== CHAR_GLYPH
19361 && glyph
->u
.ch
== ' '))
19362 && trailing_whitespace_p (glyph
->charpos
))
19364 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19368 if (!row
->reversed_p
)
19370 while (glyph
>= start
19371 && BUFFERP (glyph
->object
)
19372 && (glyph
->type
== STRETCH_GLYPH
19373 || (glyph
->type
== CHAR_GLYPH
19374 && glyph
->u
.ch
== ' ')))
19375 (glyph
--)->face_id
= face_id
;
19379 while (glyph
<= start
19380 && BUFFERP (glyph
->object
)
19381 && (glyph
->type
== STRETCH_GLYPH
19382 || (glyph
->type
== CHAR_GLYPH
19383 && glyph
->u
.ch
== ' ')))
19384 (glyph
++)->face_id
= face_id
;
19391 /* Value is non-zero if glyph row ROW should be
19392 considered to hold the buffer position CHARPOS. */
19395 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19399 if (charpos
== CHARPOS (row
->end
.pos
)
19400 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19402 /* Suppose the row ends on a string.
19403 Unless the row is continued, that means it ends on a newline
19404 in the string. If it's anything other than a display string
19405 (e.g., a before-string from an overlay), we don't want the
19406 cursor there. (This heuristic seems to give the optimal
19407 behavior for the various types of multi-line strings.)
19408 One exception: if the string has `cursor' property on one of
19409 its characters, we _do_ want the cursor there. */
19410 if (CHARPOS (row
->end
.string_pos
) >= 0)
19412 if (row
->continued_p
)
19416 /* Check for `display' property. */
19417 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19418 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19419 struct glyph
*glyph
;
19422 for (glyph
= end
; glyph
>= beg
; --glyph
)
19423 if (STRINGP (glyph
->object
))
19426 = Fget_char_property (make_number (charpos
),
19430 && display_prop_string_p (prop
, glyph
->object
));
19431 /* If there's a `cursor' property on one of the
19432 string's characters, this row is a cursor row,
19433 even though this is not a display string. */
19436 Lisp_Object s
= glyph
->object
;
19438 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19440 ptrdiff_t gpos
= glyph
->charpos
;
19442 if (!NILP (Fget_char_property (make_number (gpos
),
19454 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19456 /* If the row ends in middle of a real character,
19457 and the line is continued, we want the cursor here.
19458 That's because CHARPOS (ROW->end.pos) would equal
19459 PT if PT is before the character. */
19460 if (!row
->ends_in_ellipsis_p
)
19461 result
= row
->continued_p
;
19463 /* If the row ends in an ellipsis, then
19464 CHARPOS (ROW->end.pos) will equal point after the
19465 invisible text. We want that position to be displayed
19466 after the ellipsis. */
19469 /* If the row ends at ZV, display the cursor at the end of that
19470 row instead of at the start of the row below. */
19471 else if (row
->ends_at_zv_p
)
19480 /* Value is non-zero if glyph row ROW should be
19481 used to hold the cursor. */
19484 cursor_row_p (struct glyph_row
*row
)
19486 return row_for_charpos_p (row
, PT
);
19491 /* Push the property PROP so that it will be rendered at the current
19492 position in IT. Return 1 if PROP was successfully pushed, 0
19493 otherwise. Called from handle_line_prefix to handle the
19494 `line-prefix' and `wrap-prefix' properties. */
19497 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19499 struct text_pos pos
=
19500 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19502 eassert (it
->method
== GET_FROM_BUFFER
19503 || it
->method
== GET_FROM_DISPLAY_VECTOR
19504 || it
->method
== GET_FROM_STRING
);
19506 /* We need to save the current buffer/string position, so it will be
19507 restored by pop_it, because iterate_out_of_display_property
19508 depends on that being set correctly, but some situations leave
19509 it->position not yet set when this function is called. */
19510 push_it (it
, &pos
);
19512 if (STRINGP (prop
))
19514 if (SCHARS (prop
) == 0)
19521 it
->string_from_prefix_prop_p
= 1;
19522 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19523 it
->current
.overlay_string_index
= -1;
19524 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19525 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19526 it
->method
= GET_FROM_STRING
;
19527 it
->stop_charpos
= 0;
19529 it
->base_level_stop
= 0;
19531 /* Force paragraph direction to be that of the parent
19533 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19534 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19536 it
->paragraph_embedding
= L2R
;
19538 /* Set up the bidi iterator for this display string. */
19541 it
->bidi_it
.string
.lstring
= it
->string
;
19542 it
->bidi_it
.string
.s
= NULL
;
19543 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19544 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19545 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19546 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19547 it
->bidi_it
.w
= it
->w
;
19548 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19551 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19553 it
->method
= GET_FROM_STRETCH
;
19556 #ifdef HAVE_WINDOW_SYSTEM
19557 else if (IMAGEP (prop
))
19559 it
->what
= IT_IMAGE
;
19560 it
->image_id
= lookup_image (it
->f
, prop
);
19561 it
->method
= GET_FROM_IMAGE
;
19563 #endif /* HAVE_WINDOW_SYSTEM */
19566 pop_it (it
); /* bogus display property, give up */
19573 /* Return the character-property PROP at the current position in IT. */
19576 get_it_property (struct it
*it
, Lisp_Object prop
)
19578 Lisp_Object position
, object
= it
->object
;
19580 if (STRINGP (object
))
19581 position
= make_number (IT_STRING_CHARPOS (*it
));
19582 else if (BUFFERP (object
))
19584 position
= make_number (IT_CHARPOS (*it
));
19585 object
= it
->window
;
19590 return Fget_char_property (position
, prop
, object
);
19593 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19596 handle_line_prefix (struct it
*it
)
19598 Lisp_Object prefix
;
19600 if (it
->continuation_lines_width
> 0)
19602 prefix
= get_it_property (it
, Qwrap_prefix
);
19604 prefix
= Vwrap_prefix
;
19608 prefix
= get_it_property (it
, Qline_prefix
);
19610 prefix
= Vline_prefix
;
19612 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19614 /* If the prefix is wider than the window, and we try to wrap
19615 it, it would acquire its own wrap prefix, and so on till the
19616 iterator stack overflows. So, don't wrap the prefix. */
19617 it
->line_wrap
= TRUNCATE
;
19618 it
->avoid_cursor_p
= 1;
19624 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19625 only for R2L lines from display_line and display_string, when they
19626 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19627 the line/string needs to be continued on the next glyph row. */
19629 unproduce_glyphs (struct it
*it
, int n
)
19631 struct glyph
*glyph
, *end
;
19633 eassert (it
->glyph_row
);
19634 eassert (it
->glyph_row
->reversed_p
);
19635 eassert (it
->area
== TEXT_AREA
);
19636 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19638 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19639 n
= it
->glyph_row
->used
[TEXT_AREA
];
19640 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19641 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19642 for ( ; glyph
< end
; glyph
++)
19643 glyph
[-n
] = *glyph
;
19646 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19647 and ROW->maxpos. */
19649 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19650 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19651 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19653 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19654 lines' rows is implemented for bidi-reordered rows. */
19656 /* ROW->minpos is the value of min_pos, the minimal buffer position
19657 we have in ROW, or ROW->start.pos if that is smaller. */
19658 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19659 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19661 /* We didn't find buffer positions smaller than ROW->start, or
19662 didn't find _any_ valid buffer positions in any of the glyphs,
19663 so we must trust the iterator's computed positions. */
19664 row
->minpos
= row
->start
.pos
;
19667 max_pos
= CHARPOS (it
->current
.pos
);
19668 max_bpos
= BYTEPOS (it
->current
.pos
);
19671 /* Here are the various use-cases for ending the row, and the
19672 corresponding values for ROW->maxpos:
19674 Line ends in a newline from buffer eol_pos + 1
19675 Line is continued from buffer max_pos + 1
19676 Line is truncated on right it->current.pos
19677 Line ends in a newline from string max_pos + 1(*)
19678 (*) + 1 only when line ends in a forward scan
19679 Line is continued from string max_pos
19680 Line is continued from display vector max_pos
19681 Line is entirely from a string min_pos == max_pos
19682 Line is entirely from a display vector min_pos == max_pos
19683 Line that ends at ZV ZV
19685 If you discover other use-cases, please add them here as
19687 if (row
->ends_at_zv_p
)
19688 row
->maxpos
= it
->current
.pos
;
19689 else if (row
->used
[TEXT_AREA
])
19691 int seen_this_string
= 0;
19692 struct glyph_row
*r1
= row
- 1;
19694 /* Did we see the same display string on the previous row? */
19695 if (STRINGP (it
->object
)
19696 /* this is not the first row */
19697 && row
> it
->w
->desired_matrix
->rows
19698 /* previous row is not the header line */
19699 && !r1
->mode_line_p
19700 /* previous row also ends in a newline from a string */
19701 && r1
->ends_in_newline_from_string_p
)
19703 struct glyph
*start
, *end
;
19705 /* Search for the last glyph of the previous row that came
19706 from buffer or string. Depending on whether the row is
19707 L2R or R2L, we need to process it front to back or the
19708 other way round. */
19709 if (!r1
->reversed_p
)
19711 start
= r1
->glyphs
[TEXT_AREA
];
19712 end
= start
+ r1
->used
[TEXT_AREA
];
19713 /* Glyphs inserted by redisplay have an integer (zero)
19714 as their object. */
19716 && INTEGERP ((end
- 1)->object
)
19717 && (end
- 1)->charpos
<= 0)
19721 if (EQ ((end
- 1)->object
, it
->object
))
19722 seen_this_string
= 1;
19725 /* If all the glyphs of the previous row were inserted
19726 by redisplay, it means the previous row was
19727 produced from a single newline, which is only
19728 possible if that newline came from the same string
19729 as the one which produced this ROW. */
19730 seen_this_string
= 1;
19734 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19735 start
= end
+ r1
->used
[TEXT_AREA
];
19737 && INTEGERP ((end
+ 1)->object
)
19738 && (end
+ 1)->charpos
<= 0)
19742 if (EQ ((end
+ 1)->object
, it
->object
))
19743 seen_this_string
= 1;
19746 seen_this_string
= 1;
19749 /* Take note of each display string that covers a newline only
19750 once, the first time we see it. This is for when a display
19751 string includes more than one newline in it. */
19752 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19754 /* If we were scanning the buffer forward when we displayed
19755 the string, we want to account for at least one buffer
19756 position that belongs to this row (position covered by
19757 the display string), so that cursor positioning will
19758 consider this row as a candidate when point is at the end
19759 of the visual line represented by this row. This is not
19760 required when scanning back, because max_pos will already
19761 have a much larger value. */
19762 if (CHARPOS (row
->end
.pos
) > max_pos
)
19763 INC_BOTH (max_pos
, max_bpos
);
19764 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19766 else if (CHARPOS (it
->eol_pos
) > 0)
19767 SET_TEXT_POS (row
->maxpos
,
19768 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19769 else if (row
->continued_p
)
19771 /* If max_pos is different from IT's current position, it
19772 means IT->method does not belong to the display element
19773 at max_pos. However, it also means that the display
19774 element at max_pos was displayed in its entirety on this
19775 line, which is equivalent to saying that the next line
19776 starts at the next buffer position. */
19777 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19778 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19781 INC_BOTH (max_pos
, max_bpos
);
19782 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19785 else if (row
->truncated_on_right_p
)
19786 /* display_line already called reseat_at_next_visible_line_start,
19787 which puts the iterator at the beginning of the next line, in
19788 the logical order. */
19789 row
->maxpos
= it
->current
.pos
;
19790 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19791 /* A line that is entirely from a string/image/stretch... */
19792 row
->maxpos
= row
->minpos
;
19797 row
->maxpos
= it
->current
.pos
;
19800 /* Construct the glyph row IT->glyph_row in the desired matrix of
19801 IT->w from text at the current position of IT. See dispextern.h
19802 for an overview of struct it. Value is non-zero if
19803 IT->glyph_row displays text, as opposed to a line displaying ZV
19807 display_line (struct it
*it
)
19809 struct glyph_row
*row
= it
->glyph_row
;
19810 Lisp_Object overlay_arrow_string
;
19812 void *wrap_data
= NULL
;
19813 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19814 int wrap_row_used
= -1;
19815 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19816 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19817 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19818 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19819 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19821 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19822 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19824 /* We always start displaying at hpos zero even if hscrolled. */
19825 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19827 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19828 >= it
->w
->desired_matrix
->nrows
)
19830 it
->w
->nrows_scale_factor
++;
19831 it
->f
->fonts_changed
= 1;
19835 /* Clear the result glyph row and enable it. */
19836 prepare_desired_row (row
);
19838 row
->y
= it
->current_y
;
19839 row
->start
= it
->start
;
19840 row
->continuation_lines_width
= it
->continuation_lines_width
;
19841 row
->displays_text_p
= 1;
19842 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19843 it
->starts_in_middle_of_char_p
= 0;
19845 /* Arrange the overlays nicely for our purposes. Usually, we call
19846 display_line on only one line at a time, in which case this
19847 can't really hurt too much, or we call it on lines which appear
19848 one after another in the buffer, in which case all calls to
19849 recenter_overlay_lists but the first will be pretty cheap. */
19850 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19852 /* Move over display elements that are not visible because we are
19853 hscrolled. This may stop at an x-position < IT->first_visible_x
19854 if the first glyph is partially visible or if we hit a line end. */
19855 if (it
->current_x
< it
->first_visible_x
)
19857 enum move_it_result move_result
;
19859 this_line_min_pos
= row
->start
.pos
;
19860 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19861 MOVE_TO_POS
| MOVE_TO_X
);
19862 /* If we are under a large hscroll, move_it_in_display_line_to
19863 could hit the end of the line without reaching
19864 it->first_visible_x. Pretend that we did reach it. This is
19865 especially important on a TTY, where we will call
19866 extend_face_to_end_of_line, which needs to know how many
19867 blank glyphs to produce. */
19868 if (it
->current_x
< it
->first_visible_x
19869 && (move_result
== MOVE_NEWLINE_OR_CR
19870 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19871 it
->current_x
= it
->first_visible_x
;
19873 /* Record the smallest positions seen while we moved over
19874 display elements that are not visible. This is needed by
19875 redisplay_internal for optimizing the case where the cursor
19876 stays inside the same line. The rest of this function only
19877 considers positions that are actually displayed, so
19878 RECORD_MAX_MIN_POS will not otherwise record positions that
19879 are hscrolled to the left of the left edge of the window. */
19880 min_pos
= CHARPOS (this_line_min_pos
);
19881 min_bpos
= BYTEPOS (this_line_min_pos
);
19885 /* We only do this when not calling `move_it_in_display_line_to'
19886 above, because move_it_in_display_line_to calls
19887 handle_line_prefix itself. */
19888 handle_line_prefix (it
);
19891 /* Get the initial row height. This is either the height of the
19892 text hscrolled, if there is any, or zero. */
19893 row
->ascent
= it
->max_ascent
;
19894 row
->height
= it
->max_ascent
+ it
->max_descent
;
19895 row
->phys_ascent
= it
->max_phys_ascent
;
19896 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19897 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19899 /* Utility macro to record max and min buffer positions seen until now. */
19900 #define RECORD_MAX_MIN_POS(IT) \
19903 int composition_p = !STRINGP ((IT)->string) \
19904 && ((IT)->what == IT_COMPOSITION); \
19905 ptrdiff_t current_pos = \
19906 composition_p ? (IT)->cmp_it.charpos \
19907 : IT_CHARPOS (*(IT)); \
19908 ptrdiff_t current_bpos = \
19909 composition_p ? CHAR_TO_BYTE (current_pos) \
19910 : IT_BYTEPOS (*(IT)); \
19911 if (current_pos < min_pos) \
19913 min_pos = current_pos; \
19914 min_bpos = current_bpos; \
19916 if (IT_CHARPOS (*it) > max_pos) \
19918 max_pos = IT_CHARPOS (*it); \
19919 max_bpos = IT_BYTEPOS (*it); \
19924 /* Loop generating characters. The loop is left with IT on the next
19925 character to display. */
19928 int n_glyphs_before
, hpos_before
, x_before
;
19930 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19932 /* Retrieve the next thing to display. Value is zero if end of
19934 if (!get_next_display_element (it
))
19936 /* Maybe add a space at the end of this line that is used to
19937 display the cursor there under X. Set the charpos of the
19938 first glyph of blank lines not corresponding to any text
19940 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19941 row
->exact_window_width_line_p
= 1;
19942 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19943 || row
->used
[TEXT_AREA
] == 0)
19945 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19946 row
->displays_text_p
= 0;
19948 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19949 && (!MINI_WINDOW_P (it
->w
)
19950 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19951 row
->indicate_empty_line_p
= 1;
19954 it
->continuation_lines_width
= 0;
19955 row
->ends_at_zv_p
= 1;
19956 /* A row that displays right-to-left text must always have
19957 its last face extended all the way to the end of line,
19958 even if this row ends in ZV, because we still write to
19959 the screen left to right. We also need to extend the
19960 last face if the default face is remapped to some
19961 different face, otherwise the functions that clear
19962 portions of the screen will clear with the default face's
19963 background color. */
19964 if (row
->reversed_p
19965 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19966 extend_face_to_end_of_line (it
);
19970 /* Now, get the metrics of what we want to display. This also
19971 generates glyphs in `row' (which is IT->glyph_row). */
19972 n_glyphs_before
= row
->used
[TEXT_AREA
];
19975 /* Remember the line height so far in case the next element doesn't
19976 fit on the line. */
19977 if (it
->line_wrap
!= TRUNCATE
)
19979 ascent
= it
->max_ascent
;
19980 descent
= it
->max_descent
;
19981 phys_ascent
= it
->max_phys_ascent
;
19982 phys_descent
= it
->max_phys_descent
;
19984 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19986 if (IT_DISPLAYING_WHITESPACE (it
))
19990 SAVE_IT (wrap_it
, *it
, wrap_data
);
19992 wrap_row_used
= row
->used
[TEXT_AREA
];
19993 wrap_row_ascent
= row
->ascent
;
19994 wrap_row_height
= row
->height
;
19995 wrap_row_phys_ascent
= row
->phys_ascent
;
19996 wrap_row_phys_height
= row
->phys_height
;
19997 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19998 wrap_row_min_pos
= min_pos
;
19999 wrap_row_min_bpos
= min_bpos
;
20000 wrap_row_max_pos
= max_pos
;
20001 wrap_row_max_bpos
= max_bpos
;
20007 PRODUCE_GLYPHS (it
);
20009 /* If this display element was in marginal areas, continue with
20011 if (it
->area
!= TEXT_AREA
)
20013 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20014 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20015 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20016 row
->phys_height
= max (row
->phys_height
,
20017 it
->max_phys_ascent
+ it
->max_phys_descent
);
20018 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20019 it
->max_extra_line_spacing
);
20020 set_iterator_to_next (it
, 1);
20024 /* Does the display element fit on the line? If we truncate
20025 lines, we should draw past the right edge of the window. If
20026 we don't truncate, we want to stop so that we can display the
20027 continuation glyph before the right margin. If lines are
20028 continued, there are two possible strategies for characters
20029 resulting in more than 1 glyph (e.g. tabs): Display as many
20030 glyphs as possible in this line and leave the rest for the
20031 continuation line, or display the whole element in the next
20032 line. Original redisplay did the former, so we do it also. */
20033 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20034 hpos_before
= it
->hpos
;
20037 if (/* Not a newline. */
20039 /* Glyphs produced fit entirely in the line. */
20040 && it
->current_x
< it
->last_visible_x
)
20042 it
->hpos
+= nglyphs
;
20043 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20044 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20045 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20046 row
->phys_height
= max (row
->phys_height
,
20047 it
->max_phys_ascent
+ it
->max_phys_descent
);
20048 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20049 it
->max_extra_line_spacing
);
20050 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20051 row
->x
= x
- it
->first_visible_x
;
20052 /* Record the maximum and minimum buffer positions seen so
20053 far in glyphs that will be displayed by this row. */
20055 RECORD_MAX_MIN_POS (it
);
20060 struct glyph
*glyph
;
20062 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20064 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20065 new_x
= x
+ glyph
->pixel_width
;
20067 if (/* Lines are continued. */
20068 it
->line_wrap
!= TRUNCATE
20069 && (/* Glyph doesn't fit on the line. */
20070 new_x
> it
->last_visible_x
20071 /* Or it fits exactly on a window system frame. */
20072 || (new_x
== it
->last_visible_x
20073 && FRAME_WINDOW_P (it
->f
)
20074 && (row
->reversed_p
20075 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20076 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20078 /* End of a continued line. */
20081 || (new_x
== it
->last_visible_x
20082 && FRAME_WINDOW_P (it
->f
)
20083 && (row
->reversed_p
20084 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20085 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20087 /* Current glyph is the only one on the line or
20088 fits exactly on the line. We must continue
20089 the line because we can't draw the cursor
20090 after the glyph. */
20091 row
->continued_p
= 1;
20092 it
->current_x
= new_x
;
20093 it
->continuation_lines_width
+= new_x
;
20095 if (i
== nglyphs
- 1)
20097 /* If line-wrap is on, check if a previous
20098 wrap point was found. */
20099 if (wrap_row_used
> 0
20100 /* Even if there is a previous wrap
20101 point, continue the line here as
20102 usual, if (i) the previous character
20103 was a space or tab AND (ii) the
20104 current character is not. */
20106 || IT_DISPLAYING_WHITESPACE (it
)))
20109 /* Record the maximum and minimum buffer
20110 positions seen so far in glyphs that will be
20111 displayed by this row. */
20113 RECORD_MAX_MIN_POS (it
);
20114 set_iterator_to_next (it
, 1);
20115 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20117 if (!get_next_display_element (it
))
20119 row
->exact_window_width_line_p
= 1;
20120 it
->continuation_lines_width
= 0;
20121 row
->continued_p
= 0;
20122 row
->ends_at_zv_p
= 1;
20124 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20126 row
->continued_p
= 0;
20127 row
->exact_window_width_line_p
= 1;
20131 else if (it
->bidi_p
)
20132 RECORD_MAX_MIN_POS (it
);
20133 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20134 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20135 extend_face_to_end_of_line (it
);
20137 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20138 && !FRAME_WINDOW_P (it
->f
))
20140 /* A padding glyph that doesn't fit on this line.
20141 This means the whole character doesn't fit
20143 if (row
->reversed_p
)
20144 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20145 - n_glyphs_before
);
20146 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20148 /* Fill the rest of the row with continuation
20149 glyphs like in 20.x. */
20150 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20151 < row
->glyphs
[1 + TEXT_AREA
])
20152 produce_special_glyphs (it
, IT_CONTINUATION
);
20154 row
->continued_p
= 1;
20155 it
->current_x
= x_before
;
20156 it
->continuation_lines_width
+= x_before
;
20158 /* Restore the height to what it was before the
20159 element not fitting on the line. */
20160 it
->max_ascent
= ascent
;
20161 it
->max_descent
= descent
;
20162 it
->max_phys_ascent
= phys_ascent
;
20163 it
->max_phys_descent
= phys_descent
;
20164 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20165 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20166 extend_face_to_end_of_line (it
);
20168 else if (wrap_row_used
> 0)
20171 if (row
->reversed_p
)
20172 unproduce_glyphs (it
,
20173 row
->used
[TEXT_AREA
] - wrap_row_used
);
20174 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20175 it
->continuation_lines_width
+= wrap_x
;
20176 row
->used
[TEXT_AREA
] = wrap_row_used
;
20177 row
->ascent
= wrap_row_ascent
;
20178 row
->height
= wrap_row_height
;
20179 row
->phys_ascent
= wrap_row_phys_ascent
;
20180 row
->phys_height
= wrap_row_phys_height
;
20181 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20182 min_pos
= wrap_row_min_pos
;
20183 min_bpos
= wrap_row_min_bpos
;
20184 max_pos
= wrap_row_max_pos
;
20185 max_bpos
= wrap_row_max_bpos
;
20186 row
->continued_p
= 1;
20187 row
->ends_at_zv_p
= 0;
20188 row
->exact_window_width_line_p
= 0;
20189 it
->continuation_lines_width
+= x
;
20191 /* Make sure that a non-default face is extended
20192 up to the right margin of the window. */
20193 extend_face_to_end_of_line (it
);
20195 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20197 /* A TAB that extends past the right edge of the
20198 window. This produces a single glyph on
20199 window system frames. We leave the glyph in
20200 this row and let it fill the row, but don't
20201 consume the TAB. */
20202 if ((row
->reversed_p
20203 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20204 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20205 produce_special_glyphs (it
, IT_CONTINUATION
);
20206 it
->continuation_lines_width
+= it
->last_visible_x
;
20207 row
->ends_in_middle_of_char_p
= 1;
20208 row
->continued_p
= 1;
20209 glyph
->pixel_width
= it
->last_visible_x
- x
;
20210 it
->starts_in_middle_of_char_p
= 1;
20211 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20212 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20213 extend_face_to_end_of_line (it
);
20217 /* Something other than a TAB that draws past
20218 the right edge of the window. Restore
20219 positions to values before the element. */
20220 if (row
->reversed_p
)
20221 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20222 - (n_glyphs_before
+ i
));
20223 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20225 /* Display continuation glyphs. */
20226 it
->current_x
= x_before
;
20227 it
->continuation_lines_width
+= x
;
20228 if (!FRAME_WINDOW_P (it
->f
)
20229 || (row
->reversed_p
20230 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20231 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20232 produce_special_glyphs (it
, IT_CONTINUATION
);
20233 row
->continued_p
= 1;
20235 extend_face_to_end_of_line (it
);
20237 if (nglyphs
> 1 && i
> 0)
20239 row
->ends_in_middle_of_char_p
= 1;
20240 it
->starts_in_middle_of_char_p
= 1;
20243 /* Restore the height to what it was before the
20244 element not fitting on the line. */
20245 it
->max_ascent
= ascent
;
20246 it
->max_descent
= descent
;
20247 it
->max_phys_ascent
= phys_ascent
;
20248 it
->max_phys_descent
= phys_descent
;
20253 else if (new_x
> it
->first_visible_x
)
20255 /* Increment number of glyphs actually displayed. */
20258 /* Record the maximum and minimum buffer positions
20259 seen so far in glyphs that will be displayed by
20262 RECORD_MAX_MIN_POS (it
);
20264 if (x
< it
->first_visible_x
)
20265 /* Glyph is partially visible, i.e. row starts at
20266 negative X position. */
20267 row
->x
= x
- it
->first_visible_x
;
20271 /* Glyph is completely off the left margin of the
20272 window. This should not happen because of the
20273 move_it_in_display_line at the start of this
20274 function, unless the text display area of the
20275 window is empty. */
20276 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20279 /* Even if this display element produced no glyphs at all,
20280 we want to record its position. */
20281 if (it
->bidi_p
&& nglyphs
== 0)
20282 RECORD_MAX_MIN_POS (it
);
20284 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20285 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20286 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20287 row
->phys_height
= max (row
->phys_height
,
20288 it
->max_phys_ascent
+ it
->max_phys_descent
);
20289 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20290 it
->max_extra_line_spacing
);
20292 /* End of this display line if row is continued. */
20293 if (row
->continued_p
|| row
->ends_at_zv_p
)
20298 /* Is this a line end? If yes, we're also done, after making
20299 sure that a non-default face is extended up to the right
20300 margin of the window. */
20301 if (ITERATOR_AT_END_OF_LINE_P (it
))
20303 int used_before
= row
->used
[TEXT_AREA
];
20305 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20307 /* Add a space at the end of the line that is used to
20308 display the cursor there. */
20309 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20310 append_space_for_newline (it
, 0);
20312 /* Extend the face to the end of the line. */
20313 extend_face_to_end_of_line (it
);
20315 /* Make sure we have the position. */
20316 if (used_before
== 0)
20317 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20319 /* Record the position of the newline, for use in
20321 it
->eol_pos
= it
->current
.pos
;
20323 /* Consume the line end. This skips over invisible lines. */
20324 set_iterator_to_next (it
, 1);
20325 it
->continuation_lines_width
= 0;
20329 /* Proceed with next display element. Note that this skips
20330 over lines invisible because of selective display. */
20331 set_iterator_to_next (it
, 1);
20333 /* If we truncate lines, we are done when the last displayed
20334 glyphs reach past the right margin of the window. */
20335 if (it
->line_wrap
== TRUNCATE
20336 && ((FRAME_WINDOW_P (it
->f
)
20337 /* Images are preprocessed in produce_image_glyph such
20338 that they are cropped at the right edge of the
20339 window, so an image glyph will always end exactly at
20340 last_visible_x, even if there's no right fringe. */
20341 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20342 ? (it
->current_x
>= it
->last_visible_x
)
20343 : (it
->current_x
> it
->last_visible_x
)))
20345 /* Maybe add truncation glyphs. */
20346 if (!FRAME_WINDOW_P (it
->f
)
20347 || (row
->reversed_p
20348 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20349 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20353 if (!row
->reversed_p
)
20355 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20356 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20361 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20362 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20364 /* Remove any padding glyphs at the front of ROW, to
20365 make room for the truncation glyphs we will be
20366 adding below. The loop below always inserts at
20367 least one truncation glyph, so also remove the
20368 last glyph added to ROW. */
20369 unproduce_glyphs (it
, i
+ 1);
20370 /* Adjust i for the loop below. */
20371 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20374 /* produce_special_glyphs overwrites the last glyph, so
20375 we don't want that if we want to keep that last
20376 glyph, which means it's an image. */
20377 if (it
->current_x
> it
->last_visible_x
)
20379 it
->current_x
= x_before
;
20380 if (!FRAME_WINDOW_P (it
->f
))
20382 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20384 row
->used
[TEXT_AREA
] = i
;
20385 produce_special_glyphs (it
, IT_TRUNCATION
);
20390 row
->used
[TEXT_AREA
] = i
;
20391 produce_special_glyphs (it
, IT_TRUNCATION
);
20393 it
->hpos
= hpos_before
;
20396 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20398 /* Don't truncate if we can overflow newline into fringe. */
20399 if (!get_next_display_element (it
))
20401 it
->continuation_lines_width
= 0;
20402 row
->ends_at_zv_p
= 1;
20403 row
->exact_window_width_line_p
= 1;
20406 if (ITERATOR_AT_END_OF_LINE_P (it
))
20408 row
->exact_window_width_line_p
= 1;
20409 goto at_end_of_line
;
20411 it
->current_x
= x_before
;
20412 it
->hpos
= hpos_before
;
20415 row
->truncated_on_right_p
= 1;
20416 it
->continuation_lines_width
= 0;
20417 reseat_at_next_visible_line_start (it
, 0);
20418 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20424 bidi_unshelve_cache (wrap_data
, 1);
20426 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20427 at the left window margin. */
20428 if (it
->first_visible_x
20429 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20431 if (!FRAME_WINDOW_P (it
->f
)
20432 || (((row
->reversed_p
20433 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20434 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20435 /* Don't let insert_left_trunc_glyphs overwrite the
20436 first glyph of the row if it is an image. */
20437 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20438 insert_left_trunc_glyphs (it
);
20439 row
->truncated_on_left_p
= 1;
20442 /* Remember the position at which this line ends.
20444 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20445 cannot be before the call to find_row_edges below, since that is
20446 where these positions are determined. */
20447 row
->end
= it
->current
;
20450 row
->minpos
= row
->start
.pos
;
20451 row
->maxpos
= row
->end
.pos
;
20455 /* ROW->minpos and ROW->maxpos must be the smallest and
20456 `1 + the largest' buffer positions in ROW. But if ROW was
20457 bidi-reordered, these two positions can be anywhere in the
20458 row, so we must determine them now. */
20459 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20462 /* If the start of this line is the overlay arrow-position, then
20463 mark this glyph row as the one containing the overlay arrow.
20464 This is clearly a mess with variable size fonts. It would be
20465 better to let it be displayed like cursors under X. */
20466 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20467 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20468 !NILP (overlay_arrow_string
)))
20470 /* Overlay arrow in window redisplay is a fringe bitmap. */
20471 if (STRINGP (overlay_arrow_string
))
20473 struct glyph_row
*arrow_row
20474 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20475 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20476 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20477 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20478 struct glyph
*p2
, *end
;
20480 /* Copy the arrow glyphs. */
20481 while (glyph
< arrow_end
)
20484 /* Throw away padding glyphs. */
20486 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20487 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20493 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20498 eassert (INTEGERP (overlay_arrow_string
));
20499 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20501 overlay_arrow_seen
= 1;
20504 /* Highlight trailing whitespace. */
20505 if (!NILP (Vshow_trailing_whitespace
))
20506 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20508 /* Compute pixel dimensions of this line. */
20509 compute_line_metrics (it
);
20511 /* Implementation note: No changes in the glyphs of ROW or in their
20512 faces can be done past this point, because compute_line_metrics
20513 computes ROW's hash value and stores it within the glyph_row
20516 /* Record whether this row ends inside an ellipsis. */
20517 row
->ends_in_ellipsis_p
20518 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20519 && it
->ellipsis_p
);
20521 /* Save fringe bitmaps in this row. */
20522 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20523 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20524 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20525 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20527 it
->left_user_fringe_bitmap
= 0;
20528 it
->left_user_fringe_face_id
= 0;
20529 it
->right_user_fringe_bitmap
= 0;
20530 it
->right_user_fringe_face_id
= 0;
20532 /* Maybe set the cursor. */
20533 cvpos
= it
->w
->cursor
.vpos
;
20535 /* In bidi-reordered rows, keep checking for proper cursor
20536 position even if one has been found already, because buffer
20537 positions in such rows change non-linearly with ROW->VPOS,
20538 when a line is continued. One exception: when we are at ZV,
20539 display cursor on the first suitable glyph row, since all
20540 the empty rows after that also have their position set to ZV. */
20541 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20542 lines' rows is implemented for bidi-reordered rows. */
20544 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20545 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20546 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20547 && cursor_row_p (row
))
20548 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20550 /* Prepare for the next line. This line starts horizontally at (X
20551 HPOS) = (0 0). Vertical positions are incremented. As a
20552 convenience for the caller, IT->glyph_row is set to the next
20554 it
->current_x
= it
->hpos
= 0;
20555 it
->current_y
+= row
->height
;
20556 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20559 /* The next row should by default use the same value of the
20560 reversed_p flag as this one. set_iterator_to_next decides when
20561 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20562 the flag accordingly. */
20563 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20564 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20565 it
->start
= row
->end
;
20566 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20568 #undef RECORD_MAX_MIN_POS
20571 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20572 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20573 doc
: /* Return paragraph direction at point in BUFFER.
20574 Value is either `left-to-right' or `right-to-left'.
20575 If BUFFER is omitted or nil, it defaults to the current buffer.
20577 Paragraph direction determines how the text in the paragraph is displayed.
20578 In left-to-right paragraphs, text begins at the left margin of the window
20579 and the reading direction is generally left to right. In right-to-left
20580 paragraphs, text begins at the right margin and is read from right to left.
20582 See also `bidi-paragraph-direction'. */)
20583 (Lisp_Object buffer
)
20585 struct buffer
*buf
= current_buffer
;
20586 struct buffer
*old
= buf
;
20588 if (! NILP (buffer
))
20590 CHECK_BUFFER (buffer
);
20591 buf
= XBUFFER (buffer
);
20594 if (NILP (BVAR (buf
, bidi_display_reordering
))
20595 || NILP (BVAR (buf
, enable_multibyte_characters
))
20596 /* When we are loading loadup.el, the character property tables
20597 needed for bidi iteration are not yet available. */
20598 || !NILP (Vpurify_flag
))
20599 return Qleft_to_right
;
20600 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20601 return BVAR (buf
, bidi_paragraph_direction
);
20604 /* Determine the direction from buffer text. We could try to
20605 use current_matrix if it is up to date, but this seems fast
20606 enough as it is. */
20607 struct bidi_it itb
;
20608 ptrdiff_t pos
= BUF_PT (buf
);
20609 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20611 void *itb_data
= bidi_shelve_cache ();
20613 set_buffer_temp (buf
);
20614 /* bidi_paragraph_init finds the base direction of the paragraph
20615 by searching forward from paragraph start. We need the base
20616 direction of the current or _previous_ paragraph, so we need
20617 to make sure we are within that paragraph. To that end, find
20618 the previous non-empty line. */
20619 if (pos
>= ZV
&& pos
> BEGV
)
20620 DEC_BOTH (pos
, bytepos
);
20621 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20622 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20624 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20625 || c
== ' ' || c
== '\t' || c
== '\f')
20627 if (bytepos
<= BEGV_BYTE
)
20632 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20635 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20636 itb
.paragraph_dir
= NEUTRAL_DIR
;
20637 itb
.string
.s
= NULL
;
20638 itb
.string
.lstring
= Qnil
;
20639 itb
.string
.bufpos
= 0;
20640 itb
.string
.from_disp_str
= 0;
20641 itb
.string
.unibyte
= 0;
20642 /* We have no window to use here for ignoring window-specific
20643 overlays. Using NULL for window pointer will cause
20644 compute_display_string_pos to use the current buffer. */
20646 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20647 bidi_unshelve_cache (itb_data
, 0);
20648 set_buffer_temp (old
);
20649 switch (itb
.paragraph_dir
)
20652 return Qleft_to_right
;
20655 return Qright_to_left
;
20663 DEFUN ("move-point-visually", Fmove_point_visually
,
20664 Smove_point_visually
, 1, 1, 0,
20665 doc
: /* Move point in the visual order in the specified DIRECTION.
20666 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20669 Value is the new character position of point. */)
20670 (Lisp_Object direction
)
20672 struct window
*w
= XWINDOW (selected_window
);
20673 struct buffer
*b
= XBUFFER (w
->contents
);
20674 struct glyph_row
*row
;
20676 Lisp_Object paragraph_dir
;
20678 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20679 (!(ROW)->continued_p \
20680 && INTEGERP ((GLYPH)->object) \
20681 && (GLYPH)->type == CHAR_GLYPH \
20682 && (GLYPH)->u.ch == ' ' \
20683 && (GLYPH)->charpos >= 0 \
20684 && !(GLYPH)->avoid_cursor_p)
20686 CHECK_NUMBER (direction
);
20687 dir
= XINT (direction
);
20693 /* If current matrix is up-to-date, we can use the information
20694 recorded in the glyphs, at least as long as the goal is on the
20696 if (w
->window_end_valid
20697 && !windows_or_buffers_changed
20699 && !b
->clip_changed
20700 && !b
->prevent_redisplay_optimizations_p
20701 && !window_outdated (w
)
20702 && w
->cursor
.vpos
>= 0
20703 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20704 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20706 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20707 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20708 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20710 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20712 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20714 SET_PT (g
->charpos
);
20715 w
->cursor
.vpos
= -1;
20716 return make_number (PT
);
20718 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20722 if (BUFFERP (gpt
->object
))
20725 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20726 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20728 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20730 else if (BUFFERP (g
->object
))
20731 new_pos
= g
->charpos
;
20735 w
->cursor
.vpos
= -1;
20736 return make_number (PT
);
20738 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20740 /* Glyphs inserted at the end of a non-empty line for
20741 positioning the cursor have zero charpos, so we must
20742 deduce the value of point by other means. */
20743 if (g
->charpos
> 0)
20744 SET_PT (g
->charpos
);
20745 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20747 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20748 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20751 w
->cursor
.vpos
= -1;
20752 return make_number (PT
);
20755 if (g
== e
|| INTEGERP (g
->object
))
20757 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20758 goto simulate_display
;
20759 if (!row
->reversed_p
)
20763 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20764 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20765 goto simulate_display
;
20769 if (row
->reversed_p
&& !row
->continued_p
)
20771 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20772 w
->cursor
.vpos
= -1;
20773 return make_number (PT
);
20775 g
= row
->glyphs
[TEXT_AREA
];
20776 e
= g
+ row
->used
[TEXT_AREA
];
20777 for ( ; g
< e
; g
++)
20779 if (BUFFERP (g
->object
)
20780 /* Empty lines have only one glyph, which stands
20781 for the newline, and whose charpos is the
20782 buffer position of the newline. */
20783 || ROW_GLYPH_NEWLINE_P (row
, g
)
20784 /* When the buffer ends in a newline, the line at
20785 EOB also has one glyph, but its charpos is -1. */
20786 || (row
->ends_at_zv_p
20787 && !row
->reversed_p
20788 && INTEGERP (g
->object
)
20789 && g
->type
== CHAR_GLYPH
20790 && g
->u
.ch
== ' '))
20792 if (g
->charpos
> 0)
20793 SET_PT (g
->charpos
);
20794 else if (!row
->reversed_p
20795 && row
->ends_at_zv_p
20800 w
->cursor
.vpos
= -1;
20801 return make_number (PT
);
20807 if (!row
->reversed_p
&& !row
->continued_p
)
20809 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20810 w
->cursor
.vpos
= -1;
20811 return make_number (PT
);
20813 e
= row
->glyphs
[TEXT_AREA
];
20814 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20815 for ( ; g
>= e
; g
--)
20817 if (BUFFERP (g
->object
)
20818 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20820 /* Empty R2L lines on GUI frames have the buffer
20821 position of the newline stored in the stretch
20823 || g
->type
== STRETCH_GLYPH
20824 || (row
->ends_at_zv_p
20826 && INTEGERP (g
->object
)
20827 && g
->type
== CHAR_GLYPH
20828 && g
->u
.ch
== ' '))
20830 if (g
->charpos
> 0)
20831 SET_PT (g
->charpos
);
20832 else if (row
->reversed_p
20833 && row
->ends_at_zv_p
20838 w
->cursor
.vpos
= -1;
20839 return make_number (PT
);
20848 /* If we wind up here, we failed to move by using the glyphs, so we
20849 need to simulate display instead. */
20852 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20854 paragraph_dir
= Qleft_to_right
;
20855 if (EQ (paragraph_dir
, Qright_to_left
))
20857 if (PT
<= BEGV
&& dir
< 0)
20858 xsignal0 (Qbeginning_of_buffer
);
20859 else if (PT
>= ZV
&& dir
> 0)
20860 xsignal0 (Qend_of_buffer
);
20863 struct text_pos pt
;
20865 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20867 bool overshoot_expected
= false;
20868 bool target_is_eol_p
= false;
20870 /* Setup the arena. */
20871 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20872 start_display (&it
, w
, pt
);
20874 if (it
.cmp_it
.id
< 0
20875 && it
.method
== GET_FROM_STRING
20876 && it
.area
== TEXT_AREA
20877 && it
.string_from_display_prop_p
20878 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20879 overshoot_expected
= true;
20881 /* Find the X coordinate of point. We start from the beginning
20882 of this or previous line to make sure we are before point in
20883 the logical order (since the move_it_* functions can only
20886 reseat_at_previous_visible_line_start (&it
);
20887 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20888 if (IT_CHARPOS (it
) != PT
)
20890 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20891 -1, -1, -1, MOVE_TO_POS
);
20892 /* If we missed point because the character there is
20893 displayed out of a display vector that has more than one
20894 glyph, retry expecting overshoot. */
20895 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20896 && it
.current
.dpvec_index
> 0
20897 && !overshoot_expected
)
20899 overshoot_expected
= true;
20902 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20903 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20905 pt_x
= it
.current_x
;
20907 if (dir
> 0 || overshoot_expected
)
20909 struct glyph_row
*row
= it
.glyph_row
;
20911 /* When point is at beginning of line, we don't have
20912 information about the glyph there loaded into struct
20913 it. Calling get_next_display_element fixes that. */
20915 get_next_display_element (&it
);
20916 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20917 it
.glyph_row
= NULL
;
20918 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
20919 it
.glyph_row
= row
;
20920 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20921 it, lest it will become out of sync with it's buffer
20923 it
.current_x
= pt_x
;
20926 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20927 pixel_width
= it
.pixel_width
;
20928 if (overshoot_expected
&& at_eol_p
)
20930 else if (pixel_width
<= 0)
20933 /* If there's a display string (or something similar) at point,
20934 we are actually at the glyph to the left of point, so we need
20935 to correct the X coordinate. */
20936 if (overshoot_expected
)
20939 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
20941 pt_x
+= pixel_width
;
20944 /* Compute target X coordinate, either to the left or to the
20945 right of point. On TTY frames, all characters have the same
20946 pixel width of 1, so we can use that. On GUI frames we don't
20947 have an easy way of getting at the pixel width of the
20948 character to the left of point, so we use a different method
20949 of getting to that place. */
20951 target_x
= pt_x
+ pixel_width
;
20953 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
20955 /* Target X coordinate could be one line above or below the line
20956 of point, in which case we need to adjust the target X
20957 coordinate. Also, if moving to the left, we need to begin at
20958 the left edge of the point's screen line. */
20963 start_display (&it
, w
, pt
);
20964 reseat_at_previous_visible_line_start (&it
);
20965 it
.current_x
= it
.current_y
= it
.hpos
= 0;
20967 move_it_by_lines (&it
, pt_vpos
);
20971 move_it_by_lines (&it
, -1);
20972 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
20973 target_is_eol_p
= true;
20974 /* Under word-wrap, we don't know the x coordinate of
20975 the last character displayed on the previous line,
20976 which immediately precedes the wrap point. To find
20977 out its x coordinate, we try moving to the right
20978 margin of the window, which will stop at the wrap
20979 point, and then reset target_x to point at the
20980 character that precedes the wrap point. This is not
20981 needed on GUI frames, because (see below) there we
20982 move from the left margin one grapheme cluster at a
20983 time, and stop when we hit the wrap point. */
20984 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
20986 void *it_data
= NULL
;
20989 SAVE_IT (it2
, it
, it_data
);
20990 move_it_in_display_line_to (&it
, ZV
, target_x
,
20991 MOVE_TO_POS
| MOVE_TO_X
);
20992 /* If we arrived at target_x, that _is_ the last
20993 character on the previous line. */
20994 if (it
.current_x
!= target_x
)
20995 target_x
= it
.current_x
- 1;
20996 RESTORE_IT (&it
, &it2
, it_data
);
21003 || (target_x
>= it
.last_visible_x
21004 && it
.line_wrap
!= TRUNCATE
))
21007 move_it_by_lines (&it
, 0);
21008 move_it_by_lines (&it
, 1);
21013 /* Move to the target X coordinate. */
21014 #ifdef HAVE_WINDOW_SYSTEM
21015 /* On GUI frames, as we don't know the X coordinate of the
21016 character to the left of point, moving point to the left
21017 requires walking, one grapheme cluster at a time, until we
21018 find ourself at a place immediately to the left of the
21019 character at point. */
21020 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21022 struct text_pos new_pos
;
21023 enum move_it_result rc
= MOVE_X_REACHED
;
21025 if (it
.current_x
== 0)
21026 get_next_display_element (&it
);
21027 if (it
.what
== IT_COMPOSITION
)
21029 new_pos
.charpos
= it
.cmp_it
.charpos
;
21030 new_pos
.bytepos
= -1;
21033 new_pos
= it
.current
.pos
;
21035 while (it
.current_x
+ it
.pixel_width
<= target_x
21036 && (rc
== MOVE_X_REACHED
21037 /* Under word-wrap, move_it_in_display_line_to
21038 stops at correct coordinates, but sometimes
21039 returns MOVE_POS_MATCH_OR_ZV. */
21040 || (it
.line_wrap
== WORD_WRAP
21041 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21043 int new_x
= it
.current_x
+ it
.pixel_width
;
21045 /* For composed characters, we want the position of the
21046 first character in the grapheme cluster (usually, the
21047 composition's base character), whereas it.current
21048 might give us the position of the _last_ one, e.g. if
21049 the composition is rendered in reverse due to bidi
21051 if (it
.what
== IT_COMPOSITION
)
21053 new_pos
.charpos
= it
.cmp_it
.charpos
;
21054 new_pos
.bytepos
= -1;
21057 new_pos
= it
.current
.pos
;
21058 if (new_x
== it
.current_x
)
21060 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21061 MOVE_TO_POS
| MOVE_TO_X
);
21062 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21065 /* The previous position we saw in the loop is the one we
21067 if (new_pos
.bytepos
== -1)
21068 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21069 it
.current
.pos
= new_pos
;
21073 if (it
.current_x
!= target_x
)
21074 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21076 /* When lines are truncated, the above loop will stop at the
21077 window edge. But we want to get to the end of line, even if
21078 it is beyond the window edge; automatic hscroll will then
21079 scroll the window to show point as appropriate. */
21080 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21081 && get_next_display_element (&it
))
21083 struct text_pos new_pos
= it
.current
.pos
;
21085 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21087 set_iterator_to_next (&it
, 0);
21088 if (it
.method
== GET_FROM_BUFFER
)
21089 new_pos
= it
.current
.pos
;
21090 if (!get_next_display_element (&it
))
21094 it
.current
.pos
= new_pos
;
21097 /* If we ended up in a display string that covers point, move to
21098 buffer position to the right in the visual order. */
21101 while (IT_CHARPOS (it
) == PT
)
21103 set_iterator_to_next (&it
, 0);
21104 if (!get_next_display_element (&it
))
21109 /* Move point to that position. */
21110 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21113 return make_number (PT
);
21115 #undef ROW_GLYPH_NEWLINE_P
21119 /***********************************************************************
21121 ***********************************************************************/
21123 /* Redisplay the menu bar in the frame for window W.
21125 The menu bar of X frames that don't have X toolkit support is
21126 displayed in a special window W->frame->menu_bar_window.
21128 The menu bar of terminal frames is treated specially as far as
21129 glyph matrices are concerned. Menu bar lines are not part of
21130 windows, so the update is done directly on the frame matrix rows
21131 for the menu bar. */
21134 display_menu_bar (struct window
*w
)
21136 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21141 /* Don't do all this for graphical frames. */
21143 if (FRAME_W32_P (f
))
21146 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21152 if (FRAME_NS_P (f
))
21154 #endif /* HAVE_NS */
21156 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21157 eassert (!FRAME_WINDOW_P (f
));
21158 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21159 it
.first_visible_x
= 0;
21160 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21161 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21162 if (FRAME_WINDOW_P (f
))
21164 /* Menu bar lines are displayed in the desired matrix of the
21165 dummy window menu_bar_window. */
21166 struct window
*menu_w
;
21167 menu_w
= XWINDOW (f
->menu_bar_window
);
21168 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21170 it
.first_visible_x
= 0;
21171 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21174 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21176 /* This is a TTY frame, i.e. character hpos/vpos are used as
21178 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21180 it
.first_visible_x
= 0;
21181 it
.last_visible_x
= FRAME_COLS (f
);
21184 /* FIXME: This should be controlled by a user option. See the
21185 comments in redisplay_tool_bar and display_mode_line about
21187 it
.paragraph_embedding
= L2R
;
21189 /* Clear all rows of the menu bar. */
21190 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21192 struct glyph_row
*row
= it
.glyph_row
+ i
;
21193 clear_glyph_row (row
);
21194 row
->enabled_p
= true;
21195 row
->full_width_p
= 1;
21198 /* Display all items of the menu bar. */
21199 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21200 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21202 Lisp_Object string
;
21204 /* Stop at nil string. */
21205 string
= AREF (items
, i
+ 1);
21209 /* Remember where item was displayed. */
21210 ASET (items
, i
+ 3, make_number (it
.hpos
));
21212 /* Display the item, pad with one space. */
21213 if (it
.current_x
< it
.last_visible_x
)
21214 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21215 SCHARS (string
) + 1, 0, 0, -1);
21218 /* Fill out the line with spaces. */
21219 if (it
.current_x
< it
.last_visible_x
)
21220 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21222 /* Compute the total height of the lines. */
21223 compute_line_metrics (&it
);
21226 /* Deep copy of a glyph row, including the glyphs. */
21228 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21230 struct glyph
*pointers
[1 + LAST_AREA
];
21231 int to_used
= to
->used
[TEXT_AREA
];
21233 /* Save glyph pointers of TO. */
21234 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21236 /* Do a structure assignment. */
21239 /* Restore original glyph pointers of TO. */
21240 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21242 /* Copy the glyphs. */
21243 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21244 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21246 /* If we filled only part of the TO row, fill the rest with
21247 space_glyph (which will display as empty space). */
21248 if (to_used
> from
->used
[TEXT_AREA
])
21249 fill_up_frame_row_with_spaces (to
, to_used
);
21252 /* Display one menu item on a TTY, by overwriting the glyphs in the
21253 frame F's desired glyph matrix with glyphs produced from the menu
21254 item text. Called from term.c to display TTY drop-down menus one
21257 ITEM_TEXT is the menu item text as a C string.
21259 FACE_ID is the face ID to be used for this menu item. FACE_ID
21260 could specify one of 3 faces: a face for an enabled item, a face
21261 for a disabled item, or a face for a selected item.
21263 X and Y are coordinates of the first glyph in the frame's desired
21264 matrix to be overwritten by the menu item. Since this is a TTY, Y
21265 is the zero-based number of the glyph row and X is the zero-based
21266 glyph number in the row, starting from left, where to start
21267 displaying the item.
21269 SUBMENU non-zero means this menu item drops down a submenu, which
21270 should be indicated by displaying a proper visual cue after the
21274 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21275 int x
, int y
, int submenu
)
21278 struct frame
*f
= SELECTED_FRAME ();
21279 struct window
*w
= XWINDOW (f
->selected_window
);
21280 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21281 struct glyph_row
*row
;
21282 size_t item_len
= strlen (item_text
);
21284 eassert (FRAME_TERMCAP_P (f
));
21286 /* Don't write beyond the matrix's last row. This can happen for
21287 TTY screens that are not high enough to show the entire menu.
21288 (This is actually a bit of defensive programming, as
21289 tty_menu_display already limits the number of menu items to one
21290 less than the number of screen lines.) */
21291 if (y
>= f
->desired_matrix
->nrows
)
21294 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21295 it
.first_visible_x
= 0;
21296 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21297 row
= it
.glyph_row
;
21298 /* Start with the row contents from the current matrix. */
21299 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21300 saved_width
= row
->full_width_p
;
21301 row
->full_width_p
= 1;
21302 saved_reversed
= row
->reversed_p
;
21303 row
->reversed_p
= 0;
21304 row
->enabled_p
= true;
21306 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21308 eassert (x
< f
->desired_matrix
->matrix_w
);
21309 it
.current_x
= it
.hpos
= x
;
21310 it
.current_y
= it
.vpos
= y
;
21311 saved_used
= row
->used
[TEXT_AREA
];
21312 saved_truncated
= row
->truncated_on_right_p
;
21313 row
->used
[TEXT_AREA
] = x
;
21314 it
.face_id
= face_id
;
21315 it
.line_wrap
= TRUNCATE
;
21317 /* FIXME: This should be controlled by a user option. See the
21318 comments in redisplay_tool_bar and display_mode_line about this.
21319 Also, if paragraph_embedding could ever be R2L, changes will be
21320 needed to avoid shifting to the right the row characters in
21321 term.c:append_glyph. */
21322 it
.paragraph_embedding
= L2R
;
21324 /* Pad with a space on the left. */
21325 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21327 /* Display the menu item, pad with spaces to WIDTH. */
21330 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21331 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21333 /* Indicate with " >" that there's a submenu. */
21334 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21335 FRAME_COLS (f
) - 1, -1);
21338 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21339 width
, 0, FRAME_COLS (f
) - 1, -1);
21341 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21342 row
->truncated_on_right_p
= saved_truncated
;
21343 row
->hash
= row_hash (row
);
21344 row
->full_width_p
= saved_width
;
21345 row
->reversed_p
= saved_reversed
;
21348 /***********************************************************************
21350 ***********************************************************************/
21352 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21353 FORCE is non-zero, redisplay mode lines unconditionally.
21354 Otherwise, redisplay only mode lines that are garbaged. Value is
21355 the number of windows whose mode lines were redisplayed. */
21358 redisplay_mode_lines (Lisp_Object window
, bool force
)
21362 while (!NILP (window
))
21364 struct window
*w
= XWINDOW (window
);
21366 if (WINDOWP (w
->contents
))
21367 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21369 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21370 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21372 struct text_pos lpoint
;
21373 struct buffer
*old
= current_buffer
;
21375 /* Set the window's buffer for the mode line display. */
21376 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21377 set_buffer_internal_1 (XBUFFER (w
->contents
));
21379 /* Point refers normally to the selected window. For any
21380 other window, set up appropriate value. */
21381 if (!EQ (window
, selected_window
))
21383 struct text_pos pt
;
21385 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21386 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21389 /* Display mode lines. */
21390 clear_glyph_matrix (w
->desired_matrix
);
21391 if (display_mode_lines (w
))
21394 /* Restore old settings. */
21395 set_buffer_internal_1 (old
);
21396 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21406 /* Display the mode and/or header line of window W. Value is the
21407 sum number of mode lines and header lines displayed. */
21410 display_mode_lines (struct window
*w
)
21412 Lisp_Object old_selected_window
= selected_window
;
21413 Lisp_Object old_selected_frame
= selected_frame
;
21414 Lisp_Object new_frame
= w
->frame
;
21415 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21418 selected_frame
= new_frame
;
21419 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21420 or window's point, then we'd need select_window_1 here as well. */
21421 XSETWINDOW (selected_window
, w
);
21422 XFRAME (new_frame
)->selected_window
= selected_window
;
21424 /* These will be set while the mode line specs are processed. */
21425 line_number_displayed
= 0;
21426 w
->column_number_displayed
= -1;
21428 if (WINDOW_WANTS_MODELINE_P (w
))
21430 struct window
*sel_w
= XWINDOW (old_selected_window
);
21432 /* Select mode line face based on the real selected window. */
21433 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21434 BVAR (current_buffer
, mode_line_format
));
21438 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21440 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21441 BVAR (current_buffer
, header_line_format
));
21445 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21446 selected_frame
= old_selected_frame
;
21447 selected_window
= old_selected_window
;
21449 w
->must_be_updated_p
= true;
21454 /* Display mode or header line of window W. FACE_ID specifies which
21455 line to display; it is either MODE_LINE_FACE_ID or
21456 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21457 display. Value is the pixel height of the mode/header line
21461 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21465 ptrdiff_t count
= SPECPDL_INDEX ();
21467 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21468 /* Don't extend on a previously drawn mode-line.
21469 This may happen if called from pos_visible_p. */
21470 it
.glyph_row
->enabled_p
= false;
21471 prepare_desired_row (it
.glyph_row
);
21473 it
.glyph_row
->mode_line_p
= 1;
21475 /* FIXME: This should be controlled by a user option. But
21476 supporting such an option is not trivial, since the mode line is
21477 made up of many separate strings. */
21478 it
.paragraph_embedding
= L2R
;
21480 record_unwind_protect (unwind_format_mode_line
,
21481 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21483 mode_line_target
= MODE_LINE_DISPLAY
;
21485 /* Temporarily make frame's keyboard the current kboard so that
21486 kboard-local variables in the mode_line_format will get the right
21488 push_kboard (FRAME_KBOARD (it
.f
));
21489 record_unwind_save_match_data ();
21490 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21493 unbind_to (count
, Qnil
);
21495 /* Fill up with spaces. */
21496 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21498 compute_line_metrics (&it
);
21499 it
.glyph_row
->full_width_p
= 1;
21500 it
.glyph_row
->continued_p
= 0;
21501 it
.glyph_row
->truncated_on_left_p
= 0;
21502 it
.glyph_row
->truncated_on_right_p
= 0;
21504 /* Make a 3D mode-line have a shadow at its right end. */
21505 face
= FACE_FROM_ID (it
.f
, face_id
);
21506 extend_face_to_end_of_line (&it
);
21507 if (face
->box
!= FACE_NO_BOX
)
21509 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21510 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21511 last
->right_box_line_p
= 1;
21514 return it
.glyph_row
->height
;
21517 /* Move element ELT in LIST to the front of LIST.
21518 Return the updated list. */
21521 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21523 register Lisp_Object tail
, prev
;
21524 register Lisp_Object tem
;
21528 while (CONSP (tail
))
21534 /* Splice out the link TAIL. */
21536 list
= XCDR (tail
);
21538 Fsetcdr (prev
, XCDR (tail
));
21540 /* Now make it the first. */
21541 Fsetcdr (tail
, list
);
21546 tail
= XCDR (tail
);
21550 /* Not found--return unchanged LIST. */
21554 /* Contribute ELT to the mode line for window IT->w. How it
21555 translates into text depends on its data type.
21557 IT describes the display environment in which we display, as usual.
21559 DEPTH is the depth in recursion. It is used to prevent
21560 infinite recursion here.
21562 FIELD_WIDTH is the number of characters the display of ELT should
21563 occupy in the mode line, and PRECISION is the maximum number of
21564 characters to display from ELT's representation. See
21565 display_string for details.
21567 Returns the hpos of the end of the text generated by ELT.
21569 PROPS is a property list to add to any string we encounter.
21571 If RISKY is nonzero, remove (disregard) any properties in any string
21572 we encounter, and ignore :eval and :propertize.
21574 The global variable `mode_line_target' determines whether the
21575 output is passed to `store_mode_line_noprop',
21576 `store_mode_line_string', or `display_string'. */
21579 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21580 Lisp_Object elt
, Lisp_Object props
, int risky
)
21582 int n
= 0, field
, prec
;
21587 elt
= build_string ("*too-deep*");
21591 switch (XTYPE (elt
))
21595 /* A string: output it and check for %-constructs within it. */
21597 ptrdiff_t offset
= 0;
21599 if (SCHARS (elt
) > 0
21600 && (!NILP (props
) || risky
))
21602 Lisp_Object oprops
, aelt
;
21603 oprops
= Ftext_properties_at (make_number (0), elt
);
21605 /* If the starting string's properties are not what
21606 we want, translate the string. Also, if the string
21607 is risky, do that anyway. */
21609 if (NILP (Fequal (props
, oprops
)) || risky
)
21611 /* If the starting string has properties,
21612 merge the specified ones onto the existing ones. */
21613 if (! NILP (oprops
) && !risky
)
21617 oprops
= Fcopy_sequence (oprops
);
21619 while (CONSP (tem
))
21621 oprops
= Fplist_put (oprops
, XCAR (tem
),
21622 XCAR (XCDR (tem
)));
21623 tem
= XCDR (XCDR (tem
));
21628 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21629 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21631 /* AELT is what we want. Move it to the front
21632 without consing. */
21634 mode_line_proptrans_alist
21635 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21641 /* If AELT has the wrong props, it is useless.
21642 so get rid of it. */
21644 mode_line_proptrans_alist
21645 = Fdelq (aelt
, mode_line_proptrans_alist
);
21647 elt
= Fcopy_sequence (elt
);
21648 Fset_text_properties (make_number (0), Flength (elt
),
21650 /* Add this item to mode_line_proptrans_alist. */
21651 mode_line_proptrans_alist
21652 = Fcons (Fcons (elt
, props
),
21653 mode_line_proptrans_alist
);
21654 /* Truncate mode_line_proptrans_alist
21655 to at most 50 elements. */
21656 tem
= Fnthcdr (make_number (50),
21657 mode_line_proptrans_alist
);
21659 XSETCDR (tem
, Qnil
);
21668 prec
= precision
- n
;
21669 switch (mode_line_target
)
21671 case MODE_LINE_NOPROP
:
21672 case MODE_LINE_TITLE
:
21673 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21675 case MODE_LINE_STRING
:
21676 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21678 case MODE_LINE_DISPLAY
:
21679 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21680 0, prec
, 0, STRING_MULTIBYTE (elt
));
21687 /* Handle the non-literal case. */
21689 while ((precision
<= 0 || n
< precision
)
21690 && SREF (elt
, offset
) != 0
21691 && (mode_line_target
!= MODE_LINE_DISPLAY
21692 || it
->current_x
< it
->last_visible_x
))
21694 ptrdiff_t last_offset
= offset
;
21696 /* Advance to end of string or next format specifier. */
21697 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21700 if (offset
- 1 != last_offset
)
21702 ptrdiff_t nchars
, nbytes
;
21704 /* Output to end of string or up to '%'. Field width
21705 is length of string. Don't output more than
21706 PRECISION allows us. */
21709 prec
= c_string_width (SDATA (elt
) + last_offset
,
21710 offset
- last_offset
, precision
- n
,
21713 switch (mode_line_target
)
21715 case MODE_LINE_NOPROP
:
21716 case MODE_LINE_TITLE
:
21717 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21719 case MODE_LINE_STRING
:
21721 ptrdiff_t bytepos
= last_offset
;
21722 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21723 ptrdiff_t endpos
= (precision
<= 0
21724 ? string_byte_to_char (elt
, offset
)
21725 : charpos
+ nchars
);
21727 n
+= store_mode_line_string (NULL
,
21728 Fsubstring (elt
, make_number (charpos
),
21729 make_number (endpos
)),
21733 case MODE_LINE_DISPLAY
:
21735 ptrdiff_t bytepos
= last_offset
;
21736 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21738 if (precision
<= 0)
21739 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21740 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21742 STRING_MULTIBYTE (elt
));
21747 else /* c == '%' */
21749 ptrdiff_t percent_position
= offset
;
21751 /* Get the specified minimum width. Zero means
21754 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21755 field
= field
* 10 + c
- '0';
21757 /* Don't pad beyond the total padding allowed. */
21758 if (field_width
- n
> 0 && field
> field_width
- n
)
21759 field
= field_width
- n
;
21761 /* Note that either PRECISION <= 0 or N < PRECISION. */
21762 prec
= precision
- n
;
21765 n
+= display_mode_element (it
, depth
, field
, prec
,
21766 Vglobal_mode_string
, props
,
21771 ptrdiff_t bytepos
, charpos
;
21773 Lisp_Object string
;
21775 bytepos
= percent_position
;
21776 charpos
= (STRING_MULTIBYTE (elt
)
21777 ? string_byte_to_char (elt
, bytepos
)
21779 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21780 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21782 switch (mode_line_target
)
21784 case MODE_LINE_NOPROP
:
21785 case MODE_LINE_TITLE
:
21786 n
+= store_mode_line_noprop (spec
, field
, prec
);
21788 case MODE_LINE_STRING
:
21790 Lisp_Object tem
= build_string (spec
);
21791 props
= Ftext_properties_at (make_number (charpos
), elt
);
21792 /* Should only keep face property in props */
21793 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21796 case MODE_LINE_DISPLAY
:
21798 int nglyphs_before
, nwritten
;
21800 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21801 nwritten
= display_string (spec
, string
, elt
,
21806 /* Assign to the glyphs written above the
21807 string where the `%x' came from, position
21811 struct glyph
*glyph
21812 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21816 for (i
= 0; i
< nwritten
; ++i
)
21818 glyph
[i
].object
= elt
;
21819 glyph
[i
].charpos
= charpos
;
21836 /* A symbol: process the value of the symbol recursively
21837 as if it appeared here directly. Avoid error if symbol void.
21838 Special case: if value of symbol is a string, output the string
21841 register Lisp_Object tem
;
21843 /* If the variable is not marked as risky to set
21844 then its contents are risky to use. */
21845 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21848 tem
= Fboundp (elt
);
21851 tem
= Fsymbol_value (elt
);
21852 /* If value is a string, output that string literally:
21853 don't check for % within it. */
21857 if (!EQ (tem
, elt
))
21859 /* Give up right away for nil or t. */
21869 register Lisp_Object car
, tem
;
21871 /* A cons cell: five distinct cases.
21872 If first element is :eval or :propertize, do something special.
21873 If first element is a string or a cons, process all the elements
21874 and effectively concatenate them.
21875 If first element is a negative number, truncate displaying cdr to
21876 at most that many characters. If positive, pad (with spaces)
21877 to at least that many characters.
21878 If first element is a symbol, process the cadr or caddr recursively
21879 according to whether the symbol's value is non-nil or nil. */
21881 if (EQ (car
, QCeval
))
21883 /* An element of the form (:eval FORM) means evaluate FORM
21884 and use the result as mode line elements. */
21889 if (CONSP (XCDR (elt
)))
21892 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21893 n
+= display_mode_element (it
, depth
, field_width
- n
,
21894 precision
- n
, spec
, props
,
21898 else if (EQ (car
, QCpropertize
))
21900 /* An element of the form (:propertize ELT PROPS...)
21901 means display ELT but applying properties PROPS. */
21906 if (CONSP (XCDR (elt
)))
21907 n
+= display_mode_element (it
, depth
, field_width
- n
,
21908 precision
- n
, XCAR (XCDR (elt
)),
21909 XCDR (XCDR (elt
)), risky
);
21911 else if (SYMBOLP (car
))
21913 tem
= Fboundp (car
);
21917 /* elt is now the cdr, and we know it is a cons cell.
21918 Use its car if CAR has a non-nil value. */
21921 tem
= Fsymbol_value (car
);
21928 /* Symbol's value is nil (or symbol is unbound)
21929 Get the cddr of the original list
21930 and if possible find the caddr and use that. */
21934 else if (!CONSP (elt
))
21939 else if (INTEGERP (car
))
21941 register int lim
= XINT (car
);
21945 /* Negative int means reduce maximum width. */
21946 if (precision
<= 0)
21949 precision
= min (precision
, -lim
);
21953 /* Padding specified. Don't let it be more than
21954 current maximum. */
21956 lim
= min (precision
, lim
);
21958 /* If that's more padding than already wanted, queue it.
21959 But don't reduce padding already specified even if
21960 that is beyond the current truncation point. */
21961 field_width
= max (lim
, field_width
);
21965 else if (STRINGP (car
) || CONSP (car
))
21967 Lisp_Object halftail
= elt
;
21971 && (precision
<= 0 || n
< precision
))
21973 n
+= display_mode_element (it
, depth
,
21974 /* Do padding only after the last
21975 element in the list. */
21976 (! CONSP (XCDR (elt
))
21979 precision
- n
, XCAR (elt
),
21983 if ((len
& 1) == 0)
21984 halftail
= XCDR (halftail
);
21985 /* Check for cycle. */
21986 if (EQ (halftail
, elt
))
21995 elt
= build_string ("*invalid*");
21999 /* Pad to FIELD_WIDTH. */
22000 if (field_width
> 0 && n
< field_width
)
22002 switch (mode_line_target
)
22004 case MODE_LINE_NOPROP
:
22005 case MODE_LINE_TITLE
:
22006 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22008 case MODE_LINE_STRING
:
22009 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22011 case MODE_LINE_DISPLAY
:
22012 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22021 /* Store a mode-line string element in mode_line_string_list.
22023 If STRING is non-null, display that C string. Otherwise, the Lisp
22024 string LISP_STRING is displayed.
22026 FIELD_WIDTH is the minimum number of output glyphs to produce.
22027 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22028 with spaces. FIELD_WIDTH <= 0 means don't pad.
22030 PRECISION is the maximum number of characters to output from
22031 STRING. PRECISION <= 0 means don't truncate the string.
22033 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22034 properties to the string.
22036 PROPS are the properties to add to the string.
22037 The mode_line_string_face face property is always added to the string.
22041 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22042 int field_width
, int precision
, Lisp_Object props
)
22047 if (string
!= NULL
)
22049 len
= strlen (string
);
22050 if (precision
> 0 && len
> precision
)
22052 lisp_string
= make_string (string
, len
);
22054 props
= mode_line_string_face_prop
;
22055 else if (!NILP (mode_line_string_face
))
22057 Lisp_Object face
= Fplist_get (props
, Qface
);
22058 props
= Fcopy_sequence (props
);
22060 face
= mode_line_string_face
;
22062 face
= list2 (face
, mode_line_string_face
);
22063 props
= Fplist_put (props
, Qface
, face
);
22065 Fadd_text_properties (make_number (0), make_number (len
),
22066 props
, lisp_string
);
22070 len
= XFASTINT (Flength (lisp_string
));
22071 if (precision
> 0 && len
> precision
)
22074 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22077 if (!NILP (mode_line_string_face
))
22081 props
= Ftext_properties_at (make_number (0), lisp_string
);
22082 face
= Fplist_get (props
, Qface
);
22084 face
= mode_line_string_face
;
22086 face
= list2 (face
, mode_line_string_face
);
22087 props
= list2 (Qface
, face
);
22089 lisp_string
= Fcopy_sequence (lisp_string
);
22092 Fadd_text_properties (make_number (0), make_number (len
),
22093 props
, lisp_string
);
22098 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22102 if (field_width
> len
)
22104 field_width
-= len
;
22105 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22107 Fadd_text_properties (make_number (0), make_number (field_width
),
22108 props
, lisp_string
);
22109 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22117 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22119 doc
: /* Format a string out of a mode line format specification.
22120 First arg FORMAT specifies the mode line format (see `mode-line-format'
22121 for details) to use.
22123 By default, the format is evaluated for the currently selected window.
22125 Optional second arg FACE specifies the face property to put on all
22126 characters for which no face is specified. The value nil means the
22127 default face. The value t means whatever face the window's mode line
22128 currently uses (either `mode-line' or `mode-line-inactive',
22129 depending on whether the window is the selected window or not).
22130 An integer value means the value string has no text
22133 Optional third and fourth args WINDOW and BUFFER specify the window
22134 and buffer to use as the context for the formatting (defaults
22135 are the selected window and the WINDOW's buffer). */)
22136 (Lisp_Object format
, Lisp_Object face
,
22137 Lisp_Object window
, Lisp_Object buffer
)
22142 struct buffer
*old_buffer
= NULL
;
22144 int no_props
= INTEGERP (face
);
22145 ptrdiff_t count
= SPECPDL_INDEX ();
22147 int string_start
= 0;
22149 w
= decode_any_window (window
);
22150 XSETWINDOW (window
, w
);
22153 buffer
= w
->contents
;
22154 CHECK_BUFFER (buffer
);
22156 /* Make formatting the modeline a non-op when noninteractive, otherwise
22157 there will be problems later caused by a partially initialized frame. */
22158 if (NILP (format
) || noninteractive
)
22159 return empty_unibyte_string
;
22164 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22165 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22166 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22167 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22168 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22169 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22170 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22173 old_buffer
= current_buffer
;
22175 /* Save things including mode_line_proptrans_alist,
22176 and set that to nil so that we don't alter the outer value. */
22177 record_unwind_protect (unwind_format_mode_line
,
22178 format_mode_line_unwind_data
22179 (XFRAME (WINDOW_FRAME (w
)),
22180 old_buffer
, selected_window
, 1));
22181 mode_line_proptrans_alist
= Qnil
;
22183 Fselect_window (window
, Qt
);
22184 set_buffer_internal_1 (XBUFFER (buffer
));
22186 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22190 mode_line_target
= MODE_LINE_NOPROP
;
22191 mode_line_string_face_prop
= Qnil
;
22192 mode_line_string_list
= Qnil
;
22193 string_start
= MODE_LINE_NOPROP_LEN (0);
22197 mode_line_target
= MODE_LINE_STRING
;
22198 mode_line_string_list
= Qnil
;
22199 mode_line_string_face
= face
;
22200 mode_line_string_face_prop
22201 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22204 push_kboard (FRAME_KBOARD (it
.f
));
22205 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22210 len
= MODE_LINE_NOPROP_LEN (string_start
);
22211 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22215 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22216 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22217 empty_unibyte_string
);
22220 unbind_to (count
, Qnil
);
22224 /* Write a null-terminated, right justified decimal representation of
22225 the positive integer D to BUF using a minimal field width WIDTH. */
22228 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22230 register char *p
= buf
;
22238 *p
++ = d
% 10 + '0';
22243 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22254 /* Write a null-terminated, right justified decimal and "human
22255 readable" representation of the nonnegative integer D to BUF using
22256 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22258 static const char power_letter
[] =
22272 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22274 /* We aim to represent the nonnegative integer D as
22275 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22276 ptrdiff_t quotient
= d
;
22278 /* -1 means: do not use TENTHS. */
22282 /* Length of QUOTIENT.TENTHS as a string. */
22288 if (quotient
>= 1000)
22290 /* Scale to the appropriate EXPONENT. */
22293 remainder
= quotient
% 1000;
22297 while (quotient
>= 1000);
22299 /* Round to nearest and decide whether to use TENTHS or not. */
22302 tenths
= remainder
/ 100;
22303 if (remainder
% 100 >= 50)
22310 if (quotient
== 10)
22318 if (remainder
>= 500)
22320 if (quotient
< 999)
22331 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22332 if (tenths
== -1 && quotient
<= 99)
22339 p
= psuffix
= buf
+ max (width
, length
);
22341 /* Print EXPONENT. */
22342 *psuffix
++ = power_letter
[exponent
];
22345 /* Print TENTHS. */
22348 *--p
= '0' + tenths
;
22352 /* Print QUOTIENT. */
22355 int digit
= quotient
% 10;
22356 *--p
= '0' + digit
;
22358 while ((quotient
/= 10) != 0);
22360 /* Print leading spaces. */
22365 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22366 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22367 type of CODING_SYSTEM. Return updated pointer into BUF. */
22369 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22372 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22375 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22376 const unsigned char *eol_str
;
22378 /* The EOL conversion we are using. */
22379 Lisp_Object eoltype
;
22381 val
= CODING_SYSTEM_SPEC (coding_system
);
22384 if (!VECTORP (val
)) /* Not yet decided. */
22386 *buf
++ = multibyte
? '-' : ' ';
22388 eoltype
= eol_mnemonic_undecided
;
22389 /* Don't mention EOL conversion if it isn't decided. */
22394 Lisp_Object eolvalue
;
22396 attrs
= AREF (val
, 0);
22397 eolvalue
= AREF (val
, 2);
22400 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22405 /* The EOL conversion that is normal on this system. */
22407 if (NILP (eolvalue
)) /* Not yet decided. */
22408 eoltype
= eol_mnemonic_undecided
;
22409 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22410 eoltype
= eol_mnemonic_undecided
;
22411 else /* eolvalue is Qunix, Qdos, or Qmac. */
22412 eoltype
= (EQ (eolvalue
, Qunix
)
22413 ? eol_mnemonic_unix
22414 : (EQ (eolvalue
, Qdos
) == 1
22415 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22421 /* Mention the EOL conversion if it is not the usual one. */
22422 if (STRINGP (eoltype
))
22424 eol_str
= SDATA (eoltype
);
22425 eol_str_len
= SBYTES (eoltype
);
22427 else if (CHARACTERP (eoltype
))
22429 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22430 int c
= XFASTINT (eoltype
);
22431 eol_str_len
= CHAR_STRING (c
, tmp
);
22436 eol_str
= invalid_eol_type
;
22437 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22439 memcpy (buf
, eol_str
, eol_str_len
);
22440 buf
+= eol_str_len
;
22446 /* Return a string for the output of a mode line %-spec for window W,
22447 generated by character C. FIELD_WIDTH > 0 means pad the string
22448 returned with spaces to that value. Return a Lisp string in
22449 *STRING if the resulting string is taken from that Lisp string.
22451 Note we operate on the current buffer for most purposes. */
22453 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22455 static const char *
22456 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22457 Lisp_Object
*string
)
22460 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22461 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22462 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22463 produce strings from numerical values, so limit preposterously
22464 large values of FIELD_WIDTH to avoid overrunning the buffer's
22465 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22466 bytes plus the terminating null. */
22467 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22468 struct buffer
*b
= current_buffer
;
22476 if (!NILP (BVAR (b
, read_only
)))
22478 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22483 /* This differs from %* only for a modified read-only buffer. */
22484 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22486 if (!NILP (BVAR (b
, read_only
)))
22491 /* This differs from %* in ignoring read-only-ness. */
22492 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22504 if (command_loop_level
> 5)
22506 p
= decode_mode_spec_buf
;
22507 for (i
= 0; i
< command_loop_level
; i
++)
22510 return decode_mode_spec_buf
;
22518 if (command_loop_level
> 5)
22520 p
= decode_mode_spec_buf
;
22521 for (i
= 0; i
< command_loop_level
; i
++)
22524 return decode_mode_spec_buf
;
22531 /* Let lots_of_dashes be a string of infinite length. */
22532 if (mode_line_target
== MODE_LINE_NOPROP
22533 || mode_line_target
== MODE_LINE_STRING
)
22535 if (field_width
<= 0
22536 || field_width
> sizeof (lots_of_dashes
))
22538 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22539 decode_mode_spec_buf
[i
] = '-';
22540 decode_mode_spec_buf
[i
] = '\0';
22541 return decode_mode_spec_buf
;
22544 return lots_of_dashes
;
22548 obj
= BVAR (b
, name
);
22552 /* %c and %l are ignored in `frame-title-format'.
22553 (In redisplay_internal, the frame title is drawn _before_ the
22554 windows are updated, so the stuff which depends on actual
22555 window contents (such as %l) may fail to render properly, or
22556 even crash emacs.) */
22557 if (mode_line_target
== MODE_LINE_TITLE
)
22561 ptrdiff_t col
= current_column ();
22562 w
->column_number_displayed
= col
;
22563 pint2str (decode_mode_spec_buf
, width
, col
);
22564 return decode_mode_spec_buf
;
22568 #ifndef SYSTEM_MALLOC
22570 if (NILP (Vmemory_full
))
22573 return "!MEM FULL! ";
22580 /* %F displays the frame name. */
22581 if (!NILP (f
->title
))
22582 return SSDATA (f
->title
);
22583 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22584 return SSDATA (f
->name
);
22588 obj
= BVAR (b
, filename
);
22593 ptrdiff_t size
= ZV
- BEGV
;
22594 pint2str (decode_mode_spec_buf
, width
, size
);
22595 return decode_mode_spec_buf
;
22600 ptrdiff_t size
= ZV
- BEGV
;
22601 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22602 return decode_mode_spec_buf
;
22607 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22608 ptrdiff_t topline
, nlines
, height
;
22611 /* %c and %l are ignored in `frame-title-format'. */
22612 if (mode_line_target
== MODE_LINE_TITLE
)
22615 startpos
= marker_position (w
->start
);
22616 startpos_byte
= marker_byte_position (w
->start
);
22617 height
= WINDOW_TOTAL_LINES (w
);
22619 /* If we decided that this buffer isn't suitable for line numbers,
22620 don't forget that too fast. */
22621 if (w
->base_line_pos
== -1)
22624 /* If the buffer is very big, don't waste time. */
22625 if (INTEGERP (Vline_number_display_limit
)
22626 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22628 w
->base_line_pos
= 0;
22629 w
->base_line_number
= 0;
22633 if (w
->base_line_number
> 0
22634 && w
->base_line_pos
> 0
22635 && w
->base_line_pos
<= startpos
)
22637 line
= w
->base_line_number
;
22638 linepos
= w
->base_line_pos
;
22639 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22644 linepos
= BUF_BEGV (b
);
22645 linepos_byte
= BUF_BEGV_BYTE (b
);
22648 /* Count lines from base line to window start position. */
22649 nlines
= display_count_lines (linepos_byte
,
22653 topline
= nlines
+ line
;
22655 /* Determine a new base line, if the old one is too close
22656 or too far away, or if we did not have one.
22657 "Too close" means it's plausible a scroll-down would
22658 go back past it. */
22659 if (startpos
== BUF_BEGV (b
))
22661 w
->base_line_number
= topline
;
22662 w
->base_line_pos
= BUF_BEGV (b
);
22664 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22665 || linepos
== BUF_BEGV (b
))
22667 ptrdiff_t limit
= BUF_BEGV (b
);
22668 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22669 ptrdiff_t position
;
22670 ptrdiff_t distance
=
22671 (height
* 2 + 30) * line_number_display_limit_width
;
22673 if (startpos
- distance
> limit
)
22675 limit
= startpos
- distance
;
22676 limit_byte
= CHAR_TO_BYTE (limit
);
22679 nlines
= display_count_lines (startpos_byte
,
22681 - (height
* 2 + 30),
22683 /* If we couldn't find the lines we wanted within
22684 line_number_display_limit_width chars per line,
22685 give up on line numbers for this window. */
22686 if (position
== limit_byte
&& limit
== startpos
- distance
)
22688 w
->base_line_pos
= -1;
22689 w
->base_line_number
= 0;
22693 w
->base_line_number
= topline
- nlines
;
22694 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22697 /* Now count lines from the start pos to point. */
22698 nlines
= display_count_lines (startpos_byte
,
22699 PT_BYTE
, PT
, &junk
);
22701 /* Record that we did display the line number. */
22702 line_number_displayed
= 1;
22704 /* Make the string to show. */
22705 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22706 return decode_mode_spec_buf
;
22709 char *p
= decode_mode_spec_buf
;
22710 int pad
= width
- 2;
22716 return decode_mode_spec_buf
;
22722 obj
= BVAR (b
, mode_name
);
22726 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22732 ptrdiff_t pos
= marker_position (w
->start
);
22733 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22735 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22737 if (pos
<= BUF_BEGV (b
))
22742 else if (pos
<= BUF_BEGV (b
))
22746 if (total
> 1000000)
22747 /* Do it differently for a large value, to avoid overflow. */
22748 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22750 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22751 /* We can't normally display a 3-digit number,
22752 so get us a 2-digit number that is close. */
22755 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22756 return decode_mode_spec_buf
;
22760 /* Display percentage of size above the bottom of the screen. */
22763 ptrdiff_t toppos
= marker_position (w
->start
);
22764 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22765 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22767 if (botpos
>= BUF_ZV (b
))
22769 if (toppos
<= BUF_BEGV (b
))
22776 if (total
> 1000000)
22777 /* Do it differently for a large value, to avoid overflow. */
22778 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22780 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22781 /* We can't normally display a 3-digit number,
22782 so get us a 2-digit number that is close. */
22785 if (toppos
<= BUF_BEGV (b
))
22786 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22788 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22789 return decode_mode_spec_buf
;
22794 /* status of process */
22795 obj
= Fget_buffer_process (Fcurrent_buffer ());
22797 return "no process";
22799 obj
= Fsymbol_name (Fprocess_status (obj
));
22805 ptrdiff_t count
= inhibit_garbage_collection ();
22806 Lisp_Object val
= call1 (intern ("file-remote-p"),
22807 BVAR (current_buffer
, directory
));
22808 unbind_to (count
, Qnil
);
22817 /* coding-system (not including end-of-line format) */
22819 /* coding-system (including end-of-line type) */
22821 int eol_flag
= (c
== 'Z');
22822 char *p
= decode_mode_spec_buf
;
22824 if (! FRAME_WINDOW_P (f
))
22826 /* No need to mention EOL here--the terminal never needs
22827 to do EOL conversion. */
22828 p
= decode_mode_spec_coding (CODING_ID_NAME
22829 (FRAME_KEYBOARD_CODING (f
)->id
),
22831 p
= decode_mode_spec_coding (CODING_ID_NAME
22832 (FRAME_TERMINAL_CODING (f
)->id
),
22835 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22838 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22839 #ifdef subprocesses
22840 obj
= Fget_buffer_process (Fcurrent_buffer ());
22841 if (PROCESSP (obj
))
22843 p
= decode_mode_spec_coding
22844 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22845 p
= decode_mode_spec_coding
22846 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22848 #endif /* subprocesses */
22851 return decode_mode_spec_buf
;
22858 return SSDATA (obj
);
22865 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22866 means count lines back from START_BYTE. But don't go beyond
22867 LIMIT_BYTE. Return the number of lines thus found (always
22870 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22871 either the position COUNT lines after/before START_BYTE, if we
22872 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22876 display_count_lines (ptrdiff_t start_byte
,
22877 ptrdiff_t limit_byte
, ptrdiff_t count
,
22878 ptrdiff_t *byte_pos_ptr
)
22880 register unsigned char *cursor
;
22881 unsigned char *base
;
22883 register ptrdiff_t ceiling
;
22884 register unsigned char *ceiling_addr
;
22885 ptrdiff_t orig_count
= count
;
22887 /* If we are not in selective display mode,
22888 check only for newlines. */
22889 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22890 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22894 while (start_byte
< limit_byte
)
22896 ceiling
= BUFFER_CEILING_OF (start_byte
);
22897 ceiling
= min (limit_byte
- 1, ceiling
);
22898 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22899 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22903 if (selective_display
)
22905 while (*cursor
!= '\n' && *cursor
!= 015
22906 && ++cursor
!= ceiling_addr
)
22908 if (cursor
== ceiling_addr
)
22913 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
22922 start_byte
+= cursor
- base
;
22923 *byte_pos_ptr
= start_byte
;
22927 while (cursor
< ceiling_addr
);
22929 start_byte
+= ceiling_addr
- base
;
22934 while (start_byte
> limit_byte
)
22936 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
22937 ceiling
= max (limit_byte
, ceiling
);
22938 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
22939 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
22942 if (selective_display
)
22944 while (--cursor
>= ceiling_addr
22945 && *cursor
!= '\n' && *cursor
!= 015)
22947 if (cursor
< ceiling_addr
)
22952 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
22959 start_byte
+= cursor
- base
+ 1;
22960 *byte_pos_ptr
= start_byte
;
22961 /* When scanning backwards, we should
22962 not count the newline posterior to which we stop. */
22963 return - orig_count
- 1;
22966 start_byte
+= ceiling_addr
- base
;
22970 *byte_pos_ptr
= limit_byte
;
22973 return - orig_count
+ count
;
22974 return orig_count
- count
;
22980 /***********************************************************************
22982 ***********************************************************************/
22984 /* Display a NUL-terminated string, starting with index START.
22986 If STRING is non-null, display that C string. Otherwise, the Lisp
22987 string LISP_STRING is displayed. There's a case that STRING is
22988 non-null and LISP_STRING is not nil. It means STRING is a string
22989 data of LISP_STRING. In that case, we display LISP_STRING while
22990 ignoring its text properties.
22992 If FACE_STRING is not nil, FACE_STRING_POS is a position in
22993 FACE_STRING. Display STRING or LISP_STRING with the face at
22994 FACE_STRING_POS in FACE_STRING:
22996 Display the string in the environment given by IT, but use the
22997 standard display table, temporarily.
22999 FIELD_WIDTH is the minimum number of output glyphs to produce.
23000 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23001 with spaces. If STRING has more characters, more than FIELD_WIDTH
23002 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23004 PRECISION is the maximum number of characters to output from
23005 STRING. PRECISION < 0 means don't truncate the string.
23007 This is roughly equivalent to printf format specifiers:
23009 FIELD_WIDTH PRECISION PRINTF
23010 ----------------------------------------
23016 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23017 display them, and < 0 means obey the current buffer's value of
23018 enable_multibyte_characters.
23020 Value is the number of columns displayed. */
23023 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23024 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23025 int field_width
, int precision
, int max_x
, int multibyte
)
23027 int hpos_at_start
= it
->hpos
;
23028 int saved_face_id
= it
->face_id
;
23029 struct glyph_row
*row
= it
->glyph_row
;
23030 ptrdiff_t it_charpos
;
23032 /* Initialize the iterator IT for iteration over STRING beginning
23033 with index START. */
23034 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23035 precision
, field_width
, multibyte
);
23036 if (string
&& STRINGP (lisp_string
))
23037 /* LISP_STRING is the one returned by decode_mode_spec. We should
23038 ignore its text properties. */
23039 it
->stop_charpos
= it
->end_charpos
;
23041 /* If displaying STRING, set up the face of the iterator from
23042 FACE_STRING, if that's given. */
23043 if (STRINGP (face_string
))
23049 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23050 0, &endptr
, it
->base_face_id
, 0);
23051 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23052 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23055 /* Set max_x to the maximum allowed X position. Don't let it go
23056 beyond the right edge of the window. */
23058 max_x
= it
->last_visible_x
;
23060 max_x
= min (max_x
, it
->last_visible_x
);
23062 /* Skip over display elements that are not visible. because IT->w is
23064 if (it
->current_x
< it
->first_visible_x
)
23065 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23066 MOVE_TO_POS
| MOVE_TO_X
);
23068 row
->ascent
= it
->max_ascent
;
23069 row
->height
= it
->max_ascent
+ it
->max_descent
;
23070 row
->phys_ascent
= it
->max_phys_ascent
;
23071 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23072 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23074 if (STRINGP (it
->string
))
23075 it_charpos
= IT_STRING_CHARPOS (*it
);
23077 it_charpos
= IT_CHARPOS (*it
);
23079 /* This condition is for the case that we are called with current_x
23080 past last_visible_x. */
23081 while (it
->current_x
< max_x
)
23083 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23085 /* Get the next display element. */
23086 if (!get_next_display_element (it
))
23089 /* Produce glyphs. */
23090 x_before
= it
->current_x
;
23091 n_glyphs_before
= row
->used
[TEXT_AREA
];
23092 PRODUCE_GLYPHS (it
);
23094 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23097 while (i
< nglyphs
)
23099 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23101 if (it
->line_wrap
!= TRUNCATE
23102 && x
+ glyph
->pixel_width
> max_x
)
23104 /* End of continued line or max_x reached. */
23105 if (CHAR_GLYPH_PADDING_P (*glyph
))
23107 /* A wide character is unbreakable. */
23108 if (row
->reversed_p
)
23109 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23110 - n_glyphs_before
);
23111 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23112 it
->current_x
= x_before
;
23116 if (row
->reversed_p
)
23117 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23118 - (n_glyphs_before
+ i
));
23119 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23124 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23126 /* Glyph is at least partially visible. */
23128 if (x
< it
->first_visible_x
)
23129 row
->x
= x
- it
->first_visible_x
;
23133 /* Glyph is off the left margin of the display area.
23134 Should not happen. */
23138 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23139 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23140 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23141 row
->phys_height
= max (row
->phys_height
,
23142 it
->max_phys_ascent
+ it
->max_phys_descent
);
23143 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23144 it
->max_extra_line_spacing
);
23145 x
+= glyph
->pixel_width
;
23149 /* Stop if max_x reached. */
23153 /* Stop at line ends. */
23154 if (ITERATOR_AT_END_OF_LINE_P (it
))
23156 it
->continuation_lines_width
= 0;
23160 set_iterator_to_next (it
, 1);
23161 if (STRINGP (it
->string
))
23162 it_charpos
= IT_STRING_CHARPOS (*it
);
23164 it_charpos
= IT_CHARPOS (*it
);
23166 /* Stop if truncating at the right edge. */
23167 if (it
->line_wrap
== TRUNCATE
23168 && it
->current_x
>= it
->last_visible_x
)
23170 /* Add truncation mark, but don't do it if the line is
23171 truncated at a padding space. */
23172 if (it_charpos
< it
->string_nchars
)
23174 if (!FRAME_WINDOW_P (it
->f
))
23178 if (it
->current_x
> it
->last_visible_x
)
23180 if (!row
->reversed_p
)
23182 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23183 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23188 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23189 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23191 unproduce_glyphs (it
, ii
+ 1);
23192 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23194 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23196 row
->used
[TEXT_AREA
] = ii
;
23197 produce_special_glyphs (it
, IT_TRUNCATION
);
23200 produce_special_glyphs (it
, IT_TRUNCATION
);
23202 row
->truncated_on_right_p
= 1;
23208 /* Maybe insert a truncation at the left. */
23209 if (it
->first_visible_x
23212 if (!FRAME_WINDOW_P (it
->f
)
23213 || (row
->reversed_p
23214 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23215 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23216 insert_left_trunc_glyphs (it
);
23217 row
->truncated_on_left_p
= 1;
23220 it
->face_id
= saved_face_id
;
23222 /* Value is number of columns displayed. */
23223 return it
->hpos
- hpos_at_start
;
23228 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23229 appears as an element of LIST or as the car of an element of LIST.
23230 If PROPVAL is a list, compare each element against LIST in that
23231 way, and return 1/2 if any element of PROPVAL is found in LIST.
23232 Otherwise return 0. This function cannot quit.
23233 The return value is 2 if the text is invisible but with an ellipsis
23234 and 1 if it's invisible and without an ellipsis. */
23237 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23239 register Lisp_Object tail
, proptail
;
23241 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23243 register Lisp_Object tem
;
23245 if (EQ (propval
, tem
))
23247 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23248 return NILP (XCDR (tem
)) ? 1 : 2;
23251 if (CONSP (propval
))
23253 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23255 Lisp_Object propelt
;
23256 propelt
= XCAR (proptail
);
23257 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23259 register Lisp_Object tem
;
23261 if (EQ (propelt
, tem
))
23263 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23264 return NILP (XCDR (tem
)) ? 1 : 2;
23272 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23273 doc
: /* Non-nil if the property makes the text invisible.
23274 POS-OR-PROP can be a marker or number, in which case it is taken to be
23275 a position in the current buffer and the value of the `invisible' property
23276 is checked; or it can be some other value, which is then presumed to be the
23277 value of the `invisible' property of the text of interest.
23278 The non-nil value returned can be t for truly invisible text or something
23279 else if the text is replaced by an ellipsis. */)
23280 (Lisp_Object pos_or_prop
)
23283 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23284 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23286 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23287 return (invis
== 0 ? Qnil
23289 : make_number (invis
));
23292 /* Calculate a width or height in pixels from a specification using
23293 the following elements:
23296 NUM - a (fractional) multiple of the default font width/height
23297 (NUM) - specifies exactly NUM pixels
23298 UNIT - a fixed number of pixels, see below.
23299 ELEMENT - size of a display element in pixels, see below.
23300 (NUM . SPEC) - equals NUM * SPEC
23301 (+ SPEC SPEC ...) - add pixel values
23302 (- SPEC SPEC ...) - subtract pixel values
23303 (- SPEC) - negate pixel value
23306 INT or FLOAT - a number constant
23307 SYMBOL - use symbol's (buffer local) variable binding.
23310 in - pixels per inch *)
23311 mm - pixels per 1/1000 meter *)
23312 cm - pixels per 1/100 meter *)
23313 width - width of current font in pixels.
23314 height - height of current font in pixels.
23316 *) using the ratio(s) defined in display-pixels-per-inch.
23320 left-fringe - left fringe width in pixels
23321 right-fringe - right fringe width in pixels
23323 left-margin - left margin width in pixels
23324 right-margin - right margin width in pixels
23326 scroll-bar - scroll-bar area width in pixels
23330 Pixels corresponding to 5 inches:
23333 Total width of non-text areas on left side of window (if scroll-bar is on left):
23334 '(space :width (+ left-fringe left-margin scroll-bar))
23336 Align to first text column (in header line):
23337 '(space :align-to 0)
23339 Align to middle of text area minus half the width of variable `my-image'
23340 containing a loaded image:
23341 '(space :align-to (0.5 . (- text my-image)))
23343 Width of left margin minus width of 1 character in the default font:
23344 '(space :width (- left-margin 1))
23346 Width of left margin minus width of 2 characters in the current font:
23347 '(space :width (- left-margin (2 . width)))
23349 Center 1 character over left-margin (in header line):
23350 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23352 Different ways to express width of left fringe plus left margin minus one pixel:
23353 '(space :width (- (+ left-fringe left-margin) (1)))
23354 '(space :width (+ left-fringe left-margin (- (1))))
23355 '(space :width (+ left-fringe left-margin (-1)))
23360 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23361 struct font
*font
, int width_p
, int *align_to
)
23365 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23366 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23369 return OK_PIXELS (0);
23371 eassert (FRAME_LIVE_P (it
->f
));
23373 if (SYMBOLP (prop
))
23375 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23377 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23379 if (unit
[0] == 'i' && unit
[1] == 'n')
23381 else if (unit
[0] == 'm' && unit
[1] == 'm')
23383 else if (unit
[0] == 'c' && unit
[1] == 'm')
23389 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23390 : FRAME_RES_Y (it
->f
));
23393 return OK_PIXELS (ppi
/ pixels
);
23398 #ifdef HAVE_WINDOW_SYSTEM
23399 if (EQ (prop
, Qheight
))
23400 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23401 if (EQ (prop
, Qwidth
))
23402 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23404 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23405 return OK_PIXELS (1);
23408 if (EQ (prop
, Qtext
))
23409 return OK_PIXELS (width_p
23410 ? window_box_width (it
->w
, TEXT_AREA
)
23411 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23413 if (align_to
&& *align_to
< 0)
23416 if (EQ (prop
, Qleft
))
23417 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23418 if (EQ (prop
, Qright
))
23419 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23420 if (EQ (prop
, Qcenter
))
23421 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23422 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23423 if (EQ (prop
, Qleft_fringe
))
23424 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23425 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23426 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23427 if (EQ (prop
, Qright_fringe
))
23428 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23429 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23430 : window_box_right_offset (it
->w
, TEXT_AREA
));
23431 if (EQ (prop
, Qleft_margin
))
23432 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23433 if (EQ (prop
, Qright_margin
))
23434 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23435 if (EQ (prop
, Qscroll_bar
))
23436 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23438 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23439 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23440 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23445 if (EQ (prop
, Qleft_fringe
))
23446 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23447 if (EQ (prop
, Qright_fringe
))
23448 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23449 if (EQ (prop
, Qleft_margin
))
23450 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23451 if (EQ (prop
, Qright_margin
))
23452 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23453 if (EQ (prop
, Qscroll_bar
))
23454 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23457 prop
= buffer_local_value (prop
, it
->w
->contents
);
23458 if (EQ (prop
, Qunbound
))
23462 if (INTEGERP (prop
) || FLOATP (prop
))
23464 int base_unit
= (width_p
23465 ? FRAME_COLUMN_WIDTH (it
->f
)
23466 : FRAME_LINE_HEIGHT (it
->f
));
23467 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23472 Lisp_Object car
= XCAR (prop
);
23473 Lisp_Object cdr
= XCDR (prop
);
23477 #ifdef HAVE_WINDOW_SYSTEM
23478 if (FRAME_WINDOW_P (it
->f
)
23479 && valid_image_p (prop
))
23481 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23482 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23484 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23487 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23493 while (CONSP (cdr
))
23495 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23496 font
, width_p
, align_to
))
23499 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23504 if (EQ (car
, Qminus
))
23506 return OK_PIXELS (pixels
);
23509 car
= buffer_local_value (car
, it
->w
->contents
);
23510 if (EQ (car
, Qunbound
))
23514 if (INTEGERP (car
) || FLOATP (car
))
23517 pixels
= XFLOATINT (car
);
23519 return OK_PIXELS (pixels
);
23520 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23521 font
, width_p
, align_to
))
23522 return OK_PIXELS (pixels
* fact
);
23533 /***********************************************************************
23535 ***********************************************************************/
23537 #ifdef HAVE_WINDOW_SYSTEM
23542 dump_glyph_string (struct glyph_string
*s
)
23544 fprintf (stderr
, "glyph string\n");
23545 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23546 s
->x
, s
->y
, s
->width
, s
->height
);
23547 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23548 fprintf (stderr
, " hl = %d\n", s
->hl
);
23549 fprintf (stderr
, " left overhang = %d, right = %d\n",
23550 s
->left_overhang
, s
->right_overhang
);
23551 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23552 fprintf (stderr
, " extends to end of line = %d\n",
23553 s
->extends_to_end_of_line_p
);
23554 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23555 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23558 #endif /* GLYPH_DEBUG */
23560 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23561 of XChar2b structures for S; it can't be allocated in
23562 init_glyph_string because it must be allocated via `alloca'. W
23563 is the window on which S is drawn. ROW and AREA are the glyph row
23564 and area within the row from which S is constructed. START is the
23565 index of the first glyph structure covered by S. HL is a
23566 face-override for drawing S. */
23569 #define OPTIONAL_HDC(hdc) HDC hdc,
23570 #define DECLARE_HDC(hdc) HDC hdc;
23571 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23572 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23575 #ifndef OPTIONAL_HDC
23576 #define OPTIONAL_HDC(hdc)
23577 #define DECLARE_HDC(hdc)
23578 #define ALLOCATE_HDC(hdc, f)
23579 #define RELEASE_HDC(hdc, f)
23583 init_glyph_string (struct glyph_string
*s
,
23585 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23586 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23588 memset (s
, 0, sizeof *s
);
23590 s
->f
= XFRAME (w
->frame
);
23594 s
->display
= FRAME_X_DISPLAY (s
->f
);
23595 s
->window
= FRAME_X_WINDOW (s
->f
);
23596 s
->char2b
= char2b
;
23600 s
->first_glyph
= row
->glyphs
[area
] + start
;
23601 s
->height
= row
->height
;
23602 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23603 s
->ybase
= s
->y
+ row
->ascent
;
23607 /* Append the list of glyph strings with head H and tail T to the list
23608 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23611 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23612 struct glyph_string
*h
, struct glyph_string
*t
)
23626 /* Prepend the list of glyph strings with head H and tail T to the
23627 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23631 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23632 struct glyph_string
*h
, struct glyph_string
*t
)
23646 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23647 Set *HEAD and *TAIL to the resulting list. */
23650 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23651 struct glyph_string
*s
)
23653 s
->next
= s
->prev
= NULL
;
23654 append_glyph_string_lists (head
, tail
, s
, s
);
23658 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23659 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23660 make sure that X resources for the face returned are allocated.
23661 Value is a pointer to a realized face that is ready for display if
23662 DISPLAY_P is non-zero. */
23664 static struct face
*
23665 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23666 XChar2b
*char2b
, int display_p
)
23668 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23673 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23675 if (code
== FONT_INVALID_CODE
)
23678 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23680 /* Make sure X resources of the face are allocated. */
23681 #ifdef HAVE_X_WINDOWS
23685 eassert (face
!= NULL
);
23686 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23693 /* Get face and two-byte form of character glyph GLYPH on frame F.
23694 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23695 a pointer to a realized face that is ready for display. */
23697 static struct face
*
23698 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23699 XChar2b
*char2b
, int *two_byte_p
)
23704 eassert (glyph
->type
== CHAR_GLYPH
);
23705 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23707 /* Make sure X resources of the face are allocated. */
23708 eassert (face
!= NULL
);
23709 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23716 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23717 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23719 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23721 if (code
== FONT_INVALID_CODE
)
23725 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23730 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23731 Return 1 if FONT has a glyph for C, otherwise return 0. */
23734 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23738 if (CHAR_BYTE8_P (c
))
23739 code
= CHAR_TO_BYTE8 (c
);
23741 code
= font
->driver
->encode_char (font
, c
);
23743 if (code
== FONT_INVALID_CODE
)
23745 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23750 /* Fill glyph string S with composition components specified by S->cmp.
23752 BASE_FACE is the base face of the composition.
23753 S->cmp_from is the index of the first component for S.
23755 OVERLAPS non-zero means S should draw the foreground only, and use
23756 its physical height for clipping. See also draw_glyphs.
23758 Value is the index of a component not in S. */
23761 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23765 /* For all glyphs of this composition, starting at the offset
23766 S->cmp_from, until we reach the end of the definition or encounter a
23767 glyph that requires the different face, add it to S. */
23772 s
->for_overlaps
= overlaps
;
23775 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23777 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23779 /* TAB in a composition means display glyphs with padding space
23780 on the left or right. */
23783 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23786 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23793 s
->font
= s
->face
->font
;
23795 else if (s
->face
!= face
)
23803 if (s
->face
== NULL
)
23805 s
->face
= base_face
->ascii_face
;
23806 s
->font
= s
->face
->font
;
23809 /* All glyph strings for the same composition has the same width,
23810 i.e. the width set for the first component of the composition. */
23811 s
->width
= s
->first_glyph
->pixel_width
;
23813 /* If the specified font could not be loaded, use the frame's
23814 default font, but record the fact that we couldn't load it in
23815 the glyph string so that we can draw rectangles for the
23816 characters of the glyph string. */
23817 if (s
->font
== NULL
)
23819 s
->font_not_found_p
= 1;
23820 s
->font
= FRAME_FONT (s
->f
);
23823 /* Adjust base line for subscript/superscript text. */
23824 s
->ybase
+= s
->first_glyph
->voffset
;
23826 /* This glyph string must always be drawn with 16-bit functions. */
23833 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23834 int start
, int end
, int overlaps
)
23836 struct glyph
*glyph
, *last
;
23837 Lisp_Object lgstring
;
23840 s
->for_overlaps
= overlaps
;
23841 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23842 last
= s
->row
->glyphs
[s
->area
] + end
;
23843 s
->cmp_id
= glyph
->u
.cmp
.id
;
23844 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23845 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23846 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23847 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23848 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23850 while (glyph
< last
23851 && glyph
->u
.cmp
.automatic
23852 && glyph
->u
.cmp
.id
== s
->cmp_id
23853 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23854 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23856 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23858 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23859 unsigned code
= LGLYPH_CODE (lglyph
);
23861 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23863 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23864 return glyph
- s
->row
->glyphs
[s
->area
];
23868 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23869 See the comment of fill_glyph_string for arguments.
23870 Value is the index of the first glyph not in S. */
23874 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23875 int start
, int end
, int overlaps
)
23877 struct glyph
*glyph
, *last
;
23880 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23881 s
->for_overlaps
= overlaps
;
23882 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23883 last
= s
->row
->glyphs
[s
->area
] + end
;
23884 voffset
= glyph
->voffset
;
23885 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23886 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23888 s
->width
= glyph
->pixel_width
;
23890 while (glyph
< last
23891 && glyph
->type
== GLYPHLESS_GLYPH
23892 && glyph
->voffset
== voffset
23893 && glyph
->face_id
== face_id
)
23896 s
->width
+= glyph
->pixel_width
;
23899 s
->ybase
+= voffset
;
23900 return glyph
- s
->row
->glyphs
[s
->area
];
23904 /* Fill glyph string S from a sequence of character glyphs.
23906 FACE_ID is the face id of the string. START is the index of the
23907 first glyph to consider, END is the index of the last + 1.
23908 OVERLAPS non-zero means S should draw the foreground only, and use
23909 its physical height for clipping. See also draw_glyphs.
23911 Value is the index of the first glyph not in S. */
23914 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23915 int start
, int end
, int overlaps
)
23917 struct glyph
*glyph
, *last
;
23919 int glyph_not_available_p
;
23921 eassert (s
->f
== XFRAME (s
->w
->frame
));
23922 eassert (s
->nchars
== 0);
23923 eassert (start
>= 0 && end
> start
);
23925 s
->for_overlaps
= overlaps
;
23926 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23927 last
= s
->row
->glyphs
[s
->area
] + end
;
23928 voffset
= glyph
->voffset
;
23929 s
->padding_p
= glyph
->padding_p
;
23930 glyph_not_available_p
= glyph
->glyph_not_available_p
;
23932 while (glyph
< last
23933 && glyph
->type
== CHAR_GLYPH
23934 && glyph
->voffset
== voffset
23935 /* Same face id implies same font, nowadays. */
23936 && glyph
->face_id
== face_id
23937 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
23941 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
23942 s
->char2b
+ s
->nchars
,
23944 s
->two_byte_p
= two_byte_p
;
23946 eassert (s
->nchars
<= end
- start
);
23947 s
->width
+= glyph
->pixel_width
;
23948 if (glyph
++->padding_p
!= s
->padding_p
)
23952 s
->font
= s
->face
->font
;
23954 /* If the specified font could not be loaded, use the frame's font,
23955 but record the fact that we couldn't load it in
23956 S->font_not_found_p so that we can draw rectangles for the
23957 characters of the glyph string. */
23958 if (s
->font
== NULL
|| glyph_not_available_p
)
23960 s
->font_not_found_p
= 1;
23961 s
->font
= FRAME_FONT (s
->f
);
23964 /* Adjust base line for subscript/superscript text. */
23965 s
->ybase
+= voffset
;
23967 eassert (s
->face
&& s
->face
->gc
);
23968 return glyph
- s
->row
->glyphs
[s
->area
];
23972 /* Fill glyph string S from image glyph S->first_glyph. */
23975 fill_image_glyph_string (struct glyph_string
*s
)
23977 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
23978 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
23980 s
->slice
= s
->first_glyph
->slice
.img
;
23981 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23982 s
->font
= s
->face
->font
;
23983 s
->width
= s
->first_glyph
->pixel_width
;
23985 /* Adjust base line for subscript/superscript text. */
23986 s
->ybase
+= s
->first_glyph
->voffset
;
23990 /* Fill glyph string S from a sequence of stretch glyphs.
23992 START is the index of the first glyph to consider,
23993 END is the index of the last + 1.
23995 Value is the index of the first glyph not in S. */
23998 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24000 struct glyph
*glyph
, *last
;
24001 int voffset
, face_id
;
24003 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24005 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24006 last
= s
->row
->glyphs
[s
->area
] + end
;
24007 face_id
= glyph
->face_id
;
24008 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24009 s
->font
= s
->face
->font
;
24010 s
->width
= glyph
->pixel_width
;
24012 voffset
= glyph
->voffset
;
24016 && glyph
->type
== STRETCH_GLYPH
24017 && glyph
->voffset
== voffset
24018 && glyph
->face_id
== face_id
);
24020 s
->width
+= glyph
->pixel_width
;
24022 /* Adjust base line for subscript/superscript text. */
24023 s
->ybase
+= voffset
;
24025 /* The case that face->gc == 0 is handled when drawing the glyph
24026 string by calling PREPARE_FACE_FOR_DISPLAY. */
24028 return glyph
- s
->row
->glyphs
[s
->area
];
24031 static struct font_metrics
*
24032 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24034 static struct font_metrics metrics
;
24039 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24040 if (code
== FONT_INVALID_CODE
)
24042 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24047 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24048 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24049 assumed to be zero. */
24052 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24054 *left
= *right
= 0;
24056 if (glyph
->type
== CHAR_GLYPH
)
24060 struct font_metrics
*pcm
;
24062 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24063 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24065 if (pcm
->rbearing
> pcm
->width
)
24066 *right
= pcm
->rbearing
- pcm
->width
;
24067 if (pcm
->lbearing
< 0)
24068 *left
= -pcm
->lbearing
;
24071 else if (glyph
->type
== COMPOSITE_GLYPH
)
24073 if (! glyph
->u
.cmp
.automatic
)
24075 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24077 if (cmp
->rbearing
> cmp
->pixel_width
)
24078 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24079 if (cmp
->lbearing
< 0)
24080 *left
= - cmp
->lbearing
;
24084 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24085 struct font_metrics metrics
;
24087 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24088 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24089 if (metrics
.rbearing
> metrics
.width
)
24090 *right
= metrics
.rbearing
- metrics
.width
;
24091 if (metrics
.lbearing
< 0)
24092 *left
= - metrics
.lbearing
;
24098 /* Return the index of the first glyph preceding glyph string S that
24099 is overwritten by S because of S's left overhang. Value is -1
24100 if no glyphs are overwritten. */
24103 left_overwritten (struct glyph_string
*s
)
24107 if (s
->left_overhang
)
24110 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24111 int first
= s
->first_glyph
- glyphs
;
24113 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24114 x
-= glyphs
[i
].pixel_width
;
24125 /* Return the index of the first glyph preceding glyph string S that
24126 is overwriting S because of its right overhang. Value is -1 if no
24127 glyph in front of S overwrites S. */
24130 left_overwriting (struct glyph_string
*s
)
24133 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24134 int first
= s
->first_glyph
- glyphs
;
24138 for (i
= first
- 1; i
>= 0; --i
)
24141 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24144 x
-= glyphs
[i
].pixel_width
;
24151 /* Return the index of the last glyph following glyph string S that is
24152 overwritten by S because of S's right overhang. Value is -1 if
24153 no such glyph is found. */
24156 right_overwritten (struct glyph_string
*s
)
24160 if (s
->right_overhang
)
24163 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24164 int first
= (s
->first_glyph
- glyphs
24165 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24166 int end
= s
->row
->used
[s
->area
];
24168 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24169 x
+= glyphs
[i
].pixel_width
;
24178 /* Return the index of the last glyph following glyph string S that
24179 overwrites S because of its left overhang. Value is negative
24180 if no such glyph is found. */
24183 right_overwriting (struct glyph_string
*s
)
24186 int end
= s
->row
->used
[s
->area
];
24187 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24188 int first
= (s
->first_glyph
- glyphs
24189 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24193 for (i
= first
; i
< end
; ++i
)
24196 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24199 x
+= glyphs
[i
].pixel_width
;
24206 /* Set background width of glyph string S. START is the index of the
24207 first glyph following S. LAST_X is the right-most x-position + 1
24208 in the drawing area. */
24211 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24213 /* If the face of this glyph string has to be drawn to the end of
24214 the drawing area, set S->extends_to_end_of_line_p. */
24216 if (start
== s
->row
->used
[s
->area
]
24217 && ((s
->row
->fill_line_p
24218 && (s
->hl
== DRAW_NORMAL_TEXT
24219 || s
->hl
== DRAW_IMAGE_RAISED
24220 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24221 || s
->hl
== DRAW_MOUSE_FACE
))
24222 s
->extends_to_end_of_line_p
= 1;
24224 /* If S extends its face to the end of the line, set its
24225 background_width to the distance to the right edge of the drawing
24227 if (s
->extends_to_end_of_line_p
)
24228 s
->background_width
= last_x
- s
->x
+ 1;
24230 s
->background_width
= s
->width
;
24234 /* Compute overhangs and x-positions for glyph string S and its
24235 predecessors, or successors. X is the starting x-position for S.
24236 BACKWARD_P non-zero means process predecessors. */
24239 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24245 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24246 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24256 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24257 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24267 /* The following macros are only called from draw_glyphs below.
24268 They reference the following parameters of that function directly:
24269 `w', `row', `area', and `overlap_p'
24270 as well as the following local variables:
24271 `s', `f', and `hdc' (in W32) */
24274 /* On W32, silently add local `hdc' variable to argument list of
24275 init_glyph_string. */
24276 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24277 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24279 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24280 init_glyph_string (s, char2b, w, row, area, start, hl)
24283 /* Add a glyph string for a stretch glyph to the list of strings
24284 between HEAD and TAIL. START is the index of the stretch glyph in
24285 row area AREA of glyph row ROW. END is the index of the last glyph
24286 in that glyph row area. X is the current output position assigned
24287 to the new glyph string constructed. HL overrides that face of the
24288 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24289 is the right-most x-position of the drawing area. */
24291 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24292 and below -- keep them on one line. */
24293 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24296 s = alloca (sizeof *s); \
24297 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24298 START = fill_stretch_glyph_string (s, START, END); \
24299 append_glyph_string (&HEAD, &TAIL, s); \
24305 /* Add a glyph string for an image glyph to the list of strings
24306 between HEAD and TAIL. START is the index of the image glyph in
24307 row area AREA of glyph row ROW. END is the index of the last glyph
24308 in that glyph row area. X is the current output position assigned
24309 to the new glyph string constructed. HL overrides that face of the
24310 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24311 is the right-most x-position of the drawing area. */
24313 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24316 s = alloca (sizeof *s); \
24317 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24318 fill_image_glyph_string (s); \
24319 append_glyph_string (&HEAD, &TAIL, s); \
24326 /* Add a glyph string for a sequence of character glyphs to the list
24327 of strings between HEAD and TAIL. START is the index of the first
24328 glyph in row area AREA of glyph row ROW that is part of the new
24329 glyph string. END is the index of the last glyph in that glyph row
24330 area. X is the current output position assigned to the new glyph
24331 string constructed. HL overrides that face of the glyph; e.g. it
24332 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24333 right-most x-position of the drawing area. */
24335 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24341 face_id = (row)->glyphs[area][START].face_id; \
24343 s = alloca (sizeof *s); \
24344 char2b = alloca ((END - START) * sizeof *char2b); \
24345 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24346 append_glyph_string (&HEAD, &TAIL, s); \
24348 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24353 /* Add a glyph string for a composite sequence to the list of strings
24354 between HEAD and TAIL. START is the index of the first glyph in
24355 row area AREA of glyph row ROW that is part of the new glyph
24356 string. END is the index of the last glyph in that glyph row area.
24357 X is the current output position assigned to the new glyph string
24358 constructed. HL overrides that face of the glyph; e.g. it is
24359 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24360 x-position of the drawing area. */
24362 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24364 int face_id = (row)->glyphs[area][START].face_id; \
24365 struct face *base_face = FACE_FROM_ID (f, face_id); \
24366 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24367 struct composition *cmp = composition_table[cmp_id]; \
24369 struct glyph_string *first_s = NULL; \
24372 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24374 /* Make glyph_strings for each glyph sequence that is drawable by \
24375 the same face, and append them to HEAD/TAIL. */ \
24376 for (n = 0; n < cmp->glyph_len;) \
24378 s = alloca (sizeof *s); \
24379 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24380 append_glyph_string (&(HEAD), &(TAIL), s); \
24386 n = fill_composite_glyph_string (s, base_face, overlaps); \
24394 /* Add a glyph string for a glyph-string sequence to the list of strings
24395 between HEAD and TAIL. */
24397 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24401 Lisp_Object gstring; \
24403 face_id = (row)->glyphs[area][START].face_id; \
24404 gstring = (composition_gstring_from_id \
24405 ((row)->glyphs[area][START].u.cmp.id)); \
24406 s = alloca (sizeof *s); \
24407 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24408 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24409 append_glyph_string (&(HEAD), &(TAIL), s); \
24411 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24415 /* Add a glyph string for a sequence of glyphless character's glyphs
24416 to the list of strings between HEAD and TAIL. The meanings of
24417 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24419 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24424 face_id = (row)->glyphs[area][START].face_id; \
24426 s = alloca (sizeof *s); \
24427 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24428 append_glyph_string (&HEAD, &TAIL, s); \
24430 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24436 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24437 of AREA of glyph row ROW on window W between indices START and END.
24438 HL overrides the face for drawing glyph strings, e.g. it is
24439 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24440 x-positions of the drawing area.
24442 This is an ugly monster macro construct because we must use alloca
24443 to allocate glyph strings (because draw_glyphs can be called
24444 asynchronously). */
24446 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24449 HEAD = TAIL = NULL; \
24450 while (START < END) \
24452 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24453 switch (first_glyph->type) \
24456 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24460 case COMPOSITE_GLYPH: \
24461 if (first_glyph->u.cmp.automatic) \
24462 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24465 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24469 case STRETCH_GLYPH: \
24470 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24474 case IMAGE_GLYPH: \
24475 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24479 case GLYPHLESS_GLYPH: \
24480 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24490 set_glyph_string_background_width (s, START, LAST_X); \
24497 /* Draw glyphs between START and END in AREA of ROW on window W,
24498 starting at x-position X. X is relative to AREA in W. HL is a
24499 face-override with the following meaning:
24501 DRAW_NORMAL_TEXT draw normally
24502 DRAW_CURSOR draw in cursor face
24503 DRAW_MOUSE_FACE draw in mouse face.
24504 DRAW_INVERSE_VIDEO draw in mode line face
24505 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24506 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24508 If OVERLAPS is non-zero, draw only the foreground of characters and
24509 clip to the physical height of ROW. Non-zero value also defines
24510 the overlapping part to be drawn:
24512 OVERLAPS_PRED overlap with preceding rows
24513 OVERLAPS_SUCC overlap with succeeding rows
24514 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24515 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24517 Value is the x-position reached, relative to AREA of W. */
24520 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24521 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24522 enum draw_glyphs_face hl
, int overlaps
)
24524 struct glyph_string
*head
, *tail
;
24525 struct glyph_string
*s
;
24526 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24527 int i
, j
, x_reached
, last_x
, area_left
= 0;
24528 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24531 ALLOCATE_HDC (hdc
, f
);
24533 /* Let's rather be paranoid than getting a SEGV. */
24534 end
= min (end
, row
->used
[area
]);
24535 start
= clip_to_bounds (0, start
, end
);
24537 /* Translate X to frame coordinates. Set last_x to the right
24538 end of the drawing area. */
24539 if (row
->full_width_p
)
24541 /* X is relative to the left edge of W, without scroll bars
24543 area_left
= WINDOW_LEFT_EDGE_X (w
);
24544 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24545 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24549 area_left
= window_box_left (w
, area
);
24550 last_x
= area_left
+ window_box_width (w
, area
);
24554 /* Build a doubly-linked list of glyph_string structures between
24555 head and tail from what we have to draw. Note that the macro
24556 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24557 the reason we use a separate variable `i'. */
24559 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24561 x_reached
= tail
->x
+ tail
->background_width
;
24565 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24566 the row, redraw some glyphs in front or following the glyph
24567 strings built above. */
24568 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24570 struct glyph_string
*h
, *t
;
24571 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24572 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24573 int check_mouse_face
= 0;
24576 /* If mouse highlighting is on, we may need to draw adjacent
24577 glyphs using mouse-face highlighting. */
24578 if (area
== TEXT_AREA
&& row
->mouse_face_p
24579 && hlinfo
->mouse_face_beg_row
>= 0
24580 && hlinfo
->mouse_face_end_row
>= 0)
24582 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24584 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24585 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24587 check_mouse_face
= 1;
24588 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24589 ? hlinfo
->mouse_face_beg_col
: 0;
24590 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24591 ? hlinfo
->mouse_face_end_col
24592 : row
->used
[TEXT_AREA
];
24596 /* Compute overhangs for all glyph strings. */
24597 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24598 for (s
= head
; s
; s
= s
->next
)
24599 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24601 /* Prepend glyph strings for glyphs in front of the first glyph
24602 string that are overwritten because of the first glyph
24603 string's left overhang. The background of all strings
24604 prepended must be drawn because the first glyph string
24606 i
= left_overwritten (head
);
24609 enum draw_glyphs_face overlap_hl
;
24611 /* If this row contains mouse highlighting, attempt to draw
24612 the overlapped glyphs with the correct highlight. This
24613 code fails if the overlap encompasses more than one glyph
24614 and mouse-highlight spans only some of these glyphs.
24615 However, making it work perfectly involves a lot more
24616 code, and I don't know if the pathological case occurs in
24617 practice, so we'll stick to this for now. --- cyd */
24618 if (check_mouse_face
24619 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24620 overlap_hl
= DRAW_MOUSE_FACE
;
24622 overlap_hl
= DRAW_NORMAL_TEXT
;
24624 if (hl
!= overlap_hl
)
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
);
24632 if (clip_head
== NULL
)
24636 /* Prepend glyph strings for glyphs in front of the first glyph
24637 string that overwrite that glyph string because of their
24638 right overhang. For these strings, only the foreground must
24639 be drawn, because it draws over the glyph string at `head'.
24640 The background must not be drawn because this would overwrite
24641 right overhangs of preceding glyphs for which no glyph
24643 i
= left_overwriting (head
);
24646 enum draw_glyphs_face overlap_hl
;
24648 if (check_mouse_face
24649 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24650 overlap_hl
= DRAW_MOUSE_FACE
;
24652 overlap_hl
= DRAW_NORMAL_TEXT
;
24654 if (hl
== overlap_hl
|| clip_head
== NULL
)
24656 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24657 overlap_hl
, dummy_x
, last_x
);
24658 for (s
= h
; s
; s
= s
->next
)
24659 s
->background_filled_p
= 1;
24660 compute_overhangs_and_x (t
, head
->x
, 1);
24661 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24664 /* Append glyphs strings for glyphs following the last glyph
24665 string tail that are overwritten by tail. The background of
24666 these strings has to be drawn because tail's foreground draws
24668 i
= right_overwritten (tail
);
24671 enum draw_glyphs_face overlap_hl
;
24673 if (check_mouse_face
24674 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24675 overlap_hl
= DRAW_MOUSE_FACE
;
24677 overlap_hl
= DRAW_NORMAL_TEXT
;
24679 if (hl
!= overlap_hl
)
24681 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24682 overlap_hl
, x
, last_x
);
24683 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24684 we don't have `end = i;' here. */
24685 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24686 append_glyph_string_lists (&head
, &tail
, h
, t
);
24687 if (clip_tail
== NULL
)
24691 /* Append glyph strings for glyphs following the last glyph
24692 string tail that overwrite tail. The foreground of such
24693 glyphs has to be drawn because it writes into the background
24694 of tail. The background must not be drawn because it could
24695 paint over the foreground of following glyphs. */
24696 i
= right_overwriting (tail
);
24699 enum draw_glyphs_face overlap_hl
;
24700 if (check_mouse_face
24701 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24702 overlap_hl
= DRAW_MOUSE_FACE
;
24704 overlap_hl
= DRAW_NORMAL_TEXT
;
24706 if (hl
== overlap_hl
|| clip_tail
== NULL
)
24708 i
++; /* We must include the Ith glyph. */
24709 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24710 overlap_hl
, x
, last_x
);
24711 for (s
= h
; s
; s
= s
->next
)
24712 s
->background_filled_p
= 1;
24713 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24714 append_glyph_string_lists (&head
, &tail
, h
, t
);
24716 if (clip_head
|| clip_tail
)
24717 for (s
= head
; s
; s
= s
->next
)
24719 s
->clip_head
= clip_head
;
24720 s
->clip_tail
= clip_tail
;
24724 /* Draw all strings. */
24725 for (s
= head
; s
; s
= s
->next
)
24726 FRAME_RIF (f
)->draw_glyph_string (s
);
24729 /* When focus a sole frame and move horizontally, this sets on_p to 0
24730 causing a failure to erase prev cursor position. */
24731 if (area
== TEXT_AREA
24732 && !row
->full_width_p
24733 /* When drawing overlapping rows, only the glyph strings'
24734 foreground is drawn, which doesn't erase a cursor
24738 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24739 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24740 : (tail
? tail
->x
+ tail
->background_width
: x
));
24744 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24745 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24749 /* Value is the x-position up to which drawn, relative to AREA of W.
24750 This doesn't include parts drawn because of overhangs. */
24751 if (row
->full_width_p
)
24752 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24754 x_reached
-= area_left
;
24756 RELEASE_HDC (hdc
, f
);
24761 /* Expand row matrix if too narrow. Don't expand if area
24764 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24766 if (!it->f->fonts_changed \
24767 && (it->glyph_row->glyphs[area] \
24768 < it->glyph_row->glyphs[area + 1])) \
24770 it->w->ncols_scale_factor++; \
24771 it->f->fonts_changed = 1; \
24775 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24776 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24779 append_glyph (struct it
*it
)
24781 struct glyph
*glyph
;
24782 enum glyph_row_area area
= it
->area
;
24784 eassert (it
->glyph_row
);
24785 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24787 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24788 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24790 /* If the glyph row is reversed, we need to prepend the glyph
24791 rather than append it. */
24792 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24796 /* Make room for the additional glyph. */
24797 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24799 glyph
= it
->glyph_row
->glyphs
[area
];
24801 glyph
->charpos
= CHARPOS (it
->position
);
24802 glyph
->object
= it
->object
;
24803 if (it
->pixel_width
> 0)
24805 glyph
->pixel_width
= it
->pixel_width
;
24806 glyph
->padding_p
= 0;
24810 /* Assure at least 1-pixel width. Otherwise, cursor can't
24811 be displayed correctly. */
24812 glyph
->pixel_width
= 1;
24813 glyph
->padding_p
= 1;
24815 glyph
->ascent
= it
->ascent
;
24816 glyph
->descent
= it
->descent
;
24817 glyph
->voffset
= it
->voffset
;
24818 glyph
->type
= CHAR_GLYPH
;
24819 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24820 glyph
->multibyte_p
= it
->multibyte_p
;
24821 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24823 /* In R2L rows, the left and the right box edges need to be
24824 drawn in reverse direction. */
24825 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24826 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24830 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24831 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24833 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24834 || it
->phys_descent
> it
->descent
);
24835 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24836 glyph
->face_id
= it
->face_id
;
24837 glyph
->u
.ch
= it
->char_to_display
;
24838 glyph
->slice
.img
= null_glyph_slice
;
24839 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24842 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24843 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24845 glyph
->bidi_type
= it
->bidi_it
.type
;
24849 glyph
->resolved_level
= 0;
24850 glyph
->bidi_type
= UNKNOWN_BT
;
24852 ++it
->glyph_row
->used
[area
];
24855 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24858 /* Store one glyph for the composition IT->cmp_it.id in
24859 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24863 append_composite_glyph (struct it
*it
)
24865 struct glyph
*glyph
;
24866 enum glyph_row_area area
= it
->area
;
24868 eassert (it
->glyph_row
);
24870 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24871 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24873 /* If the glyph row is reversed, we need to prepend the glyph
24874 rather than append it. */
24875 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24879 /* Make room for the new glyph. */
24880 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24882 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24884 glyph
->charpos
= it
->cmp_it
.charpos
;
24885 glyph
->object
= it
->object
;
24886 glyph
->pixel_width
= it
->pixel_width
;
24887 glyph
->ascent
= it
->ascent
;
24888 glyph
->descent
= it
->descent
;
24889 glyph
->voffset
= it
->voffset
;
24890 glyph
->type
= COMPOSITE_GLYPH
;
24891 if (it
->cmp_it
.ch
< 0)
24893 glyph
->u
.cmp
.automatic
= 0;
24894 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24895 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24899 glyph
->u
.cmp
.automatic
= 1;
24900 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24901 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24902 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24904 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24905 glyph
->multibyte_p
= it
->multibyte_p
;
24906 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24908 /* In R2L rows, the left and the right box edges need to be
24909 drawn in reverse direction. */
24910 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24911 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24915 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24916 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24918 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24919 || it
->phys_descent
> it
->descent
);
24920 glyph
->padding_p
= 0;
24921 glyph
->glyph_not_available_p
= 0;
24922 glyph
->face_id
= it
->face_id
;
24923 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24926 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24927 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24929 glyph
->bidi_type
= it
->bidi_it
.type
;
24931 ++it
->glyph_row
->used
[area
];
24934 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24938 /* Change IT->ascent and IT->height according to the setting of
24942 take_vertical_position_into_account (struct it
*it
)
24946 if (it
->voffset
< 0)
24947 /* Increase the ascent so that we can display the text higher
24949 it
->ascent
-= it
->voffset
;
24951 /* Increase the descent so that we can display the text lower
24953 it
->descent
+= it
->voffset
;
24958 /* Produce glyphs/get display metrics for the image IT is loaded with.
24959 See the description of struct display_iterator in dispextern.h for
24960 an overview of struct display_iterator. */
24963 produce_image_glyph (struct it
*it
)
24967 int glyph_ascent
, crop
;
24968 struct glyph_slice slice
;
24970 eassert (it
->what
== IT_IMAGE
);
24972 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24974 /* Make sure X resources of the face is loaded. */
24975 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24977 if (it
->image_id
< 0)
24979 /* Fringe bitmap. */
24980 it
->ascent
= it
->phys_ascent
= 0;
24981 it
->descent
= it
->phys_descent
= 0;
24982 it
->pixel_width
= 0;
24987 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24989 /* Make sure X resources of the image is loaded. */
24990 prepare_image_for_display (it
->f
, img
);
24992 slice
.x
= slice
.y
= 0;
24993 slice
.width
= img
->width
;
24994 slice
.height
= img
->height
;
24996 if (INTEGERP (it
->slice
.x
))
24997 slice
.x
= XINT (it
->slice
.x
);
24998 else if (FLOATP (it
->slice
.x
))
24999 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25001 if (INTEGERP (it
->slice
.y
))
25002 slice
.y
= XINT (it
->slice
.y
);
25003 else if (FLOATP (it
->slice
.y
))
25004 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25006 if (INTEGERP (it
->slice
.width
))
25007 slice
.width
= XINT (it
->slice
.width
);
25008 else if (FLOATP (it
->slice
.width
))
25009 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25011 if (INTEGERP (it
->slice
.height
))
25012 slice
.height
= XINT (it
->slice
.height
);
25013 else if (FLOATP (it
->slice
.height
))
25014 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25016 if (slice
.x
>= img
->width
)
25017 slice
.x
= img
->width
;
25018 if (slice
.y
>= img
->height
)
25019 slice
.y
= img
->height
;
25020 if (slice
.x
+ slice
.width
>= img
->width
)
25021 slice
.width
= img
->width
- slice
.x
;
25022 if (slice
.y
+ slice
.height
> img
->height
)
25023 slice
.height
= img
->height
- slice
.y
;
25025 if (slice
.width
== 0 || slice
.height
== 0)
25028 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25030 it
->descent
= slice
.height
- glyph_ascent
;
25032 it
->descent
+= img
->vmargin
;
25033 if (slice
.y
+ slice
.height
== img
->height
)
25034 it
->descent
+= img
->vmargin
;
25035 it
->phys_descent
= it
->descent
;
25037 it
->pixel_width
= slice
.width
;
25039 it
->pixel_width
+= img
->hmargin
;
25040 if (slice
.x
+ slice
.width
== img
->width
)
25041 it
->pixel_width
+= img
->hmargin
;
25043 /* It's quite possible for images to have an ascent greater than
25044 their height, so don't get confused in that case. */
25045 if (it
->descent
< 0)
25050 if (face
->box
!= FACE_NO_BOX
)
25052 if (face
->box_line_width
> 0)
25055 it
->ascent
+= face
->box_line_width
;
25056 if (slice
.y
+ slice
.height
== img
->height
)
25057 it
->descent
+= face
->box_line_width
;
25060 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25061 it
->pixel_width
+= eabs (face
->box_line_width
);
25062 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25063 it
->pixel_width
+= eabs (face
->box_line_width
);
25066 take_vertical_position_into_account (it
);
25068 /* Automatically crop wide image glyphs at right edge so we can
25069 draw the cursor on same display row. */
25070 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25071 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25073 it
->pixel_width
-= crop
;
25074 slice
.width
-= crop
;
25079 struct glyph
*glyph
;
25080 enum glyph_row_area area
= it
->area
;
25082 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25083 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25085 glyph
->charpos
= CHARPOS (it
->position
);
25086 glyph
->object
= it
->object
;
25087 glyph
->pixel_width
= it
->pixel_width
;
25088 glyph
->ascent
= glyph_ascent
;
25089 glyph
->descent
= it
->descent
;
25090 glyph
->voffset
= it
->voffset
;
25091 glyph
->type
= IMAGE_GLYPH
;
25092 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25093 glyph
->multibyte_p
= it
->multibyte_p
;
25094 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25096 /* In R2L rows, the left and the right box edges need to be
25097 drawn in reverse direction. */
25098 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25099 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25103 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25104 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25106 glyph
->overlaps_vertically_p
= 0;
25107 glyph
->padding_p
= 0;
25108 glyph
->glyph_not_available_p
= 0;
25109 glyph
->face_id
= it
->face_id
;
25110 glyph
->u
.img_id
= img
->id
;
25111 glyph
->slice
.img
= slice
;
25112 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25115 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25116 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25118 glyph
->bidi_type
= it
->bidi_it
.type
;
25120 ++it
->glyph_row
->used
[area
];
25123 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25128 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25129 of the glyph, WIDTH and HEIGHT are the width and height of the
25130 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25133 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25134 int width
, int height
, int ascent
)
25136 struct glyph
*glyph
;
25137 enum glyph_row_area area
= it
->area
;
25139 eassert (ascent
>= 0 && ascent
<= height
);
25141 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25142 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25144 /* If the glyph row is reversed, we need to prepend the glyph
25145 rather than append it. */
25146 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25150 /* Make room for the additional glyph. */
25151 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25153 glyph
= it
->glyph_row
->glyphs
[area
];
25155 glyph
->charpos
= CHARPOS (it
->position
);
25156 glyph
->object
= object
;
25157 glyph
->pixel_width
= width
;
25158 glyph
->ascent
= ascent
;
25159 glyph
->descent
= height
- ascent
;
25160 glyph
->voffset
= it
->voffset
;
25161 glyph
->type
= STRETCH_GLYPH
;
25162 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25163 glyph
->multibyte_p
= it
->multibyte_p
;
25164 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25166 /* In R2L rows, the left and the right box edges need to be
25167 drawn in reverse direction. */
25168 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25169 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25173 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25174 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25176 glyph
->overlaps_vertically_p
= 0;
25177 glyph
->padding_p
= 0;
25178 glyph
->glyph_not_available_p
= 0;
25179 glyph
->face_id
= it
->face_id
;
25180 glyph
->u
.stretch
.ascent
= ascent
;
25181 glyph
->u
.stretch
.height
= height
;
25182 glyph
->slice
.img
= null_glyph_slice
;
25183 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25186 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25187 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25189 glyph
->bidi_type
= it
->bidi_it
.type
;
25193 glyph
->resolved_level
= 0;
25194 glyph
->bidi_type
= UNKNOWN_BT
;
25196 ++it
->glyph_row
->used
[area
];
25199 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25202 #endif /* HAVE_WINDOW_SYSTEM */
25204 /* Produce a stretch glyph for iterator IT. IT->object is the value
25205 of the glyph property displayed. The value must be a list
25206 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25209 1. `:width WIDTH' specifies that the space should be WIDTH *
25210 canonical char width wide. WIDTH may be an integer or floating
25213 2. `:relative-width FACTOR' specifies that the width of the stretch
25214 should be computed from the width of the first character having the
25215 `glyph' property, and should be FACTOR times that width.
25217 3. `:align-to HPOS' specifies that the space should be wide enough
25218 to reach HPOS, a value in canonical character units.
25220 Exactly one of the above pairs must be present.
25222 4. `:height HEIGHT' specifies that the height of the stretch produced
25223 should be HEIGHT, measured in canonical character units.
25225 5. `:relative-height FACTOR' specifies that the height of the
25226 stretch should be FACTOR times the height of the characters having
25227 the glyph property.
25229 Either none or exactly one of 4 or 5 must be present.
25231 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25232 of the stretch should be used for the ascent of the stretch.
25233 ASCENT must be in the range 0 <= ASCENT <= 100. */
25236 produce_stretch_glyph (struct it
*it
)
25238 /* (space :width WIDTH :height HEIGHT ...) */
25239 Lisp_Object prop
, plist
;
25240 int width
= 0, height
= 0, align_to
= -1;
25241 int zero_width_ok_p
= 0;
25243 struct font
*font
= NULL
;
25245 #ifdef HAVE_WINDOW_SYSTEM
25247 int zero_height_ok_p
= 0;
25249 if (FRAME_WINDOW_P (it
->f
))
25251 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25252 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25253 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25257 /* List should start with `space'. */
25258 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25259 plist
= XCDR (it
->object
);
25261 /* Compute the width of the stretch. */
25262 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25263 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25265 /* Absolute width `:width WIDTH' specified and valid. */
25266 zero_width_ok_p
= 1;
25269 #ifdef HAVE_WINDOW_SYSTEM
25270 else if (FRAME_WINDOW_P (it
->f
)
25271 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25273 /* Relative width `:relative-width FACTOR' specified and valid.
25274 Compute the width of the characters having the `glyph'
25277 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25280 if (it
->multibyte_p
)
25281 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25284 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25285 if (! ASCII_CHAR_P (it2
.c
))
25286 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25289 it2
.glyph_row
= NULL
;
25290 it2
.what
= IT_CHARACTER
;
25291 x_produce_glyphs (&it2
);
25292 width
= NUMVAL (prop
) * it2
.pixel_width
;
25294 #endif /* HAVE_WINDOW_SYSTEM */
25295 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25296 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25298 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25299 align_to
= (align_to
< 0
25301 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25302 else if (align_to
< 0)
25303 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25304 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25305 zero_width_ok_p
= 1;
25308 /* Nothing specified -> width defaults to canonical char width. */
25309 width
= FRAME_COLUMN_WIDTH (it
->f
);
25311 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25314 #ifdef HAVE_WINDOW_SYSTEM
25315 /* Compute height. */
25316 if (FRAME_WINDOW_P (it
->f
))
25318 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25319 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25322 zero_height_ok_p
= 1;
25324 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25326 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25328 height
= FONT_HEIGHT (font
);
25330 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25333 /* Compute percentage of height used for ascent. If
25334 `:ascent ASCENT' is present and valid, use that. Otherwise,
25335 derive the ascent from the font in use. */
25336 if (prop
= Fplist_get (plist
, QCascent
),
25337 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25338 ascent
= height
* NUMVAL (prop
) / 100.0;
25339 else if (!NILP (prop
)
25340 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25341 ascent
= min (max (0, (int)tem
), height
);
25343 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25346 #endif /* HAVE_WINDOW_SYSTEM */
25349 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25350 && it
->current_x
+ width
> it
->last_visible_x
)
25352 width
= it
->last_visible_x
- it
->current_x
;
25353 #ifdef HAVE_WINDOW_SYSTEM
25354 /* Subtract one more pixel from the stretch width, but only on
25355 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25356 width
-= FRAME_WINDOW_P (it
->f
);
25360 if (width
> 0 && height
> 0 && it
->glyph_row
)
25362 Lisp_Object o_object
= it
->object
;
25363 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25366 if (!STRINGP (object
))
25367 object
= it
->w
->contents
;
25368 #ifdef HAVE_WINDOW_SYSTEM
25369 if (FRAME_WINDOW_P (it
->f
))
25370 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25374 it
->object
= object
;
25375 it
->char_to_display
= ' ';
25376 it
->pixel_width
= it
->len
= 1;
25378 tty_append_glyph (it
);
25379 it
->object
= o_object
;
25383 it
->pixel_width
= width
;
25384 #ifdef HAVE_WINDOW_SYSTEM
25385 if (FRAME_WINDOW_P (it
->f
))
25387 it
->ascent
= it
->phys_ascent
= ascent
;
25388 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25389 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25390 take_vertical_position_into_account (it
);
25394 it
->nglyphs
= width
;
25397 /* Get information about special display element WHAT in an
25398 environment described by IT. WHAT is one of IT_TRUNCATION or
25399 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25400 non-null glyph_row member. This function ensures that fields like
25401 face_id, c, len of IT are left untouched. */
25404 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25411 temp_it
.object
= make_number (0);
25412 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25414 if (what
== IT_CONTINUATION
)
25416 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25417 if (it
->bidi_it
.paragraph_dir
== R2L
)
25418 SET_GLYPH_FROM_CHAR (glyph
, '/');
25420 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25422 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25424 /* FIXME: Should we mirror GC for R2L lines? */
25425 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25426 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25429 else if (what
== IT_TRUNCATION
)
25431 /* Truncation glyph. */
25432 SET_GLYPH_FROM_CHAR (glyph
, '$');
25434 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25436 /* FIXME: Should we mirror GC for R2L lines? */
25437 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25438 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25444 #ifdef HAVE_WINDOW_SYSTEM
25445 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25446 is turned off, we precede the truncation/continuation glyphs by a
25447 stretch glyph whose width is computed such that these special
25448 glyphs are aligned at the window margin, even when very different
25449 fonts are used in different glyph rows. */
25450 if (FRAME_WINDOW_P (temp_it
.f
)
25451 /* init_iterator calls this with it->glyph_row == NULL, and it
25452 wants only the pixel width of the truncation/continuation
25454 && temp_it
.glyph_row
25455 /* insert_left_trunc_glyphs calls us at the beginning of the
25456 row, and it has its own calculation of the stretch glyph
25458 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25459 && (temp_it
.glyph_row
->reversed_p
25460 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25461 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25463 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25465 if (stretch_width
> 0)
25467 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25468 struct font
*font
=
25469 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25470 int stretch_ascent
=
25471 (((temp_it
.ascent
+ temp_it
.descent
)
25472 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25474 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25475 temp_it
.ascent
+ temp_it
.descent
,
25482 temp_it
.what
= IT_CHARACTER
;
25484 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25485 temp_it
.face_id
= GLYPH_FACE (glyph
);
25486 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25488 PRODUCE_GLYPHS (&temp_it
);
25489 it
->pixel_width
= temp_it
.pixel_width
;
25490 it
->nglyphs
= temp_it
.pixel_width
;
25493 #ifdef HAVE_WINDOW_SYSTEM
25495 /* Calculate line-height and line-spacing properties.
25496 An integer value specifies explicit pixel value.
25497 A float value specifies relative value to current face height.
25498 A cons (float . face-name) specifies relative value to
25499 height of specified face font.
25501 Returns height in pixels, or nil. */
25505 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25506 int boff
, int override
)
25508 Lisp_Object face_name
= Qnil
;
25509 int ascent
, descent
, height
;
25511 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25516 face_name
= XCAR (val
);
25518 if (!NUMBERP (val
))
25519 val
= make_number (1);
25520 if (NILP (face_name
))
25522 height
= it
->ascent
+ it
->descent
;
25527 if (NILP (face_name
))
25529 font
= FRAME_FONT (it
->f
);
25530 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25532 else if (EQ (face_name
, Qt
))
25541 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25543 return make_number (-1);
25545 face
= FACE_FROM_ID (it
->f
, face_id
);
25548 return make_number (-1);
25549 boff
= font
->baseline_offset
;
25550 if (font
->vertical_centering
)
25551 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25554 ascent
= FONT_BASE (font
) + boff
;
25555 descent
= FONT_DESCENT (font
) - boff
;
25559 it
->override_ascent
= ascent
;
25560 it
->override_descent
= descent
;
25561 it
->override_boff
= boff
;
25564 height
= ascent
+ descent
;
25568 height
= (int)(XFLOAT_DATA (val
) * height
);
25569 else if (INTEGERP (val
))
25570 height
*= XINT (val
);
25572 return make_number (height
);
25576 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25577 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25578 and only if this is for a character for which no font was found.
25580 If the display method (it->glyphless_method) is
25581 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25582 length of the acronym or the hexadecimal string, UPPER_XOFF and
25583 UPPER_YOFF are pixel offsets for the upper part of the string,
25584 LOWER_XOFF and LOWER_YOFF are for the lower part.
25586 For the other display methods, LEN through LOWER_YOFF are zero. */
25589 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25590 short upper_xoff
, short upper_yoff
,
25591 short lower_xoff
, short lower_yoff
)
25593 struct glyph
*glyph
;
25594 enum glyph_row_area area
= it
->area
;
25596 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25597 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25599 /* If the glyph row is reversed, we need to prepend the glyph
25600 rather than append it. */
25601 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25605 /* Make room for the additional glyph. */
25606 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25608 glyph
= it
->glyph_row
->glyphs
[area
];
25610 glyph
->charpos
= CHARPOS (it
->position
);
25611 glyph
->object
= it
->object
;
25612 glyph
->pixel_width
= it
->pixel_width
;
25613 glyph
->ascent
= it
->ascent
;
25614 glyph
->descent
= it
->descent
;
25615 glyph
->voffset
= it
->voffset
;
25616 glyph
->type
= GLYPHLESS_GLYPH
;
25617 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25618 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25619 glyph
->u
.glyphless
.len
= len
;
25620 glyph
->u
.glyphless
.ch
= it
->c
;
25621 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25622 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25623 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25624 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25625 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25626 glyph
->multibyte_p
= it
->multibyte_p
;
25627 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25629 /* In R2L rows, the left and the right box edges need to be
25630 drawn in reverse direction. */
25631 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25632 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25636 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25637 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25639 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25640 || it
->phys_descent
> it
->descent
);
25641 glyph
->padding_p
= 0;
25642 glyph
->glyph_not_available_p
= 0;
25643 glyph
->face_id
= face_id
;
25644 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25647 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25648 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25650 glyph
->bidi_type
= it
->bidi_it
.type
;
25652 ++it
->glyph_row
->used
[area
];
25655 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25659 /* Produce a glyph for a glyphless character for iterator IT.
25660 IT->glyphless_method specifies which method to use for displaying
25661 the character. See the description of enum
25662 glyphless_display_method in dispextern.h for the detail.
25664 FOR_NO_FONT is nonzero if and only if this is for a character for
25665 which no font was found. ACRONYM, if non-nil, is an acronym string
25666 for the character. */
25669 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25674 int base_width
, base_height
, width
, height
;
25675 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25678 /* Get the metrics of the base font. We always refer to the current
25680 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25681 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25682 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25683 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25684 base_height
= it
->ascent
+ it
->descent
;
25685 base_width
= font
->average_width
;
25687 face_id
= merge_glyphless_glyph_face (it
);
25689 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25691 it
->pixel_width
= THIN_SPACE_WIDTH
;
25693 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25695 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25697 width
= CHAR_WIDTH (it
->c
);
25700 else if (width
> 4)
25702 it
->pixel_width
= base_width
* width
;
25704 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25710 unsigned int code
[6];
25712 int ascent
, descent
;
25713 struct font_metrics metrics_upper
, metrics_lower
;
25715 face
= FACE_FROM_ID (it
->f
, face_id
);
25716 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25717 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25719 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25721 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25722 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25723 if (CONSP (acronym
))
25724 acronym
= XCAR (acronym
);
25725 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25729 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25730 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25733 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25734 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25735 upper_len
= (len
+ 1) / 2;
25736 font
->driver
->text_extents (font
, code
, upper_len
,
25738 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25743 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25744 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25745 upper_xoff
= upper_yoff
= 2; /* the typical case */
25746 if (base_width
>= width
)
25748 /* Align the upper to the left, the lower to the right. */
25749 it
->pixel_width
= base_width
;
25750 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25754 /* Center the shorter one. */
25755 it
->pixel_width
= width
;
25756 if (metrics_upper
.width
>= metrics_lower
.width
)
25757 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25760 /* FIXME: This code doesn't look right. It formerly was
25761 missing the "lower_xoff = 0;", which couldn't have
25762 been right since it left lower_xoff uninitialized. */
25764 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25768 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25769 top, bottom, and between upper and lower strings. */
25770 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25771 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25772 /* Center vertically.
25773 H:base_height, D:base_descent
25774 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25776 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25777 descent = D - H/2 + h/2;
25778 lower_yoff = descent - 2 - ld;
25779 upper_yoff = lower_yoff - la - 1 - ud; */
25780 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25781 descent
= it
->descent
- (base_height
- height
) / 2;
25782 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25783 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25784 - metrics_upper
.descent
);
25785 /* Don't make the height shorter than the base height. */
25786 if (height
> base_height
)
25788 it
->ascent
= ascent
;
25789 it
->descent
= descent
;
25793 it
->phys_ascent
= it
->ascent
;
25794 it
->phys_descent
= it
->descent
;
25796 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25797 upper_xoff
, upper_yoff
,
25798 lower_xoff
, lower_yoff
);
25800 take_vertical_position_into_account (it
);
25805 Produce glyphs/get display metrics for the display element IT is
25806 loaded with. See the description of struct it in dispextern.h
25807 for an overview of struct it. */
25810 x_produce_glyphs (struct it
*it
)
25812 int extra_line_spacing
= it
->extra_line_spacing
;
25814 it
->glyph_not_available_p
= 0;
25816 if (it
->what
== IT_CHARACTER
)
25819 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25820 struct font
*font
= face
->font
;
25821 struct font_metrics
*pcm
= NULL
;
25822 int boff
; /* Baseline offset. */
25826 /* When no suitable font is found, display this character by
25827 the method specified in the first extra slot of
25828 Vglyphless_char_display. */
25829 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25831 eassert (it
->what
== IT_GLYPHLESS
);
25832 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25836 boff
= font
->baseline_offset
;
25837 if (font
->vertical_centering
)
25838 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25840 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25846 if (it
->override_ascent
>= 0)
25848 it
->ascent
= it
->override_ascent
;
25849 it
->descent
= it
->override_descent
;
25850 boff
= it
->override_boff
;
25854 it
->ascent
= FONT_BASE (font
) + boff
;
25855 it
->descent
= FONT_DESCENT (font
) - boff
;
25858 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25860 pcm
= get_per_char_metric (font
, &char2b
);
25861 if (pcm
->width
== 0
25862 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25868 it
->phys_ascent
= pcm
->ascent
+ boff
;
25869 it
->phys_descent
= pcm
->descent
- boff
;
25870 it
->pixel_width
= pcm
->width
;
25874 it
->glyph_not_available_p
= 1;
25875 it
->phys_ascent
= it
->ascent
;
25876 it
->phys_descent
= it
->descent
;
25877 it
->pixel_width
= font
->space_width
;
25880 if (it
->constrain_row_ascent_descent_p
)
25882 if (it
->descent
> it
->max_descent
)
25884 it
->ascent
+= it
->descent
- it
->max_descent
;
25885 it
->descent
= it
->max_descent
;
25887 if (it
->ascent
> it
->max_ascent
)
25889 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25890 it
->ascent
= it
->max_ascent
;
25892 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25893 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25894 extra_line_spacing
= 0;
25897 /* If this is a space inside a region of text with
25898 `space-width' property, change its width. */
25899 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25901 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25903 /* If face has a box, add the box thickness to the character
25904 height. If character has a box line to the left and/or
25905 right, add the box line width to the character's width. */
25906 if (face
->box
!= FACE_NO_BOX
)
25908 int thick
= face
->box_line_width
;
25912 it
->ascent
+= thick
;
25913 it
->descent
+= thick
;
25918 if (it
->start_of_box_run_p
)
25919 it
->pixel_width
+= thick
;
25920 if (it
->end_of_box_run_p
)
25921 it
->pixel_width
+= thick
;
25924 /* If face has an overline, add the height of the overline
25925 (1 pixel) and a 1 pixel margin to the character height. */
25926 if (face
->overline_p
)
25927 it
->ascent
+= overline_margin
;
25929 if (it
->constrain_row_ascent_descent_p
)
25931 if (it
->ascent
> it
->max_ascent
)
25932 it
->ascent
= it
->max_ascent
;
25933 if (it
->descent
> it
->max_descent
)
25934 it
->descent
= it
->max_descent
;
25937 take_vertical_position_into_account (it
);
25939 /* If we have to actually produce glyphs, do it. */
25944 /* Translate a space with a `space-width' property
25945 into a stretch glyph. */
25946 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25947 / FONT_HEIGHT (font
));
25948 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25949 it
->ascent
+ it
->descent
, ascent
);
25954 /* If characters with lbearing or rbearing are displayed
25955 in this line, record that fact in a flag of the
25956 glyph row. This is used to optimize X output code. */
25957 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25958 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25960 if (! stretched_p
&& it
->pixel_width
== 0)
25961 /* We assure that all visible glyphs have at least 1-pixel
25963 it
->pixel_width
= 1;
25965 else if (it
->char_to_display
== '\n')
25967 /* A newline has no width, but we need the height of the
25968 line. But if previous part of the line sets a height,
25969 don't increase that height. */
25971 Lisp_Object height
;
25972 Lisp_Object total_height
= Qnil
;
25974 it
->override_ascent
= -1;
25975 it
->pixel_width
= 0;
25978 height
= get_it_property (it
, Qline_height
);
25979 /* Split (line-height total-height) list. */
25981 && CONSP (XCDR (height
))
25982 && NILP (XCDR (XCDR (height
))))
25984 total_height
= XCAR (XCDR (height
));
25985 height
= XCAR (height
);
25987 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25989 if (it
->override_ascent
>= 0)
25991 it
->ascent
= it
->override_ascent
;
25992 it
->descent
= it
->override_descent
;
25993 boff
= it
->override_boff
;
25997 it
->ascent
= FONT_BASE (font
) + boff
;
25998 it
->descent
= FONT_DESCENT (font
) - boff
;
26001 if (EQ (height
, Qt
))
26003 if (it
->descent
> it
->max_descent
)
26005 it
->ascent
+= it
->descent
- it
->max_descent
;
26006 it
->descent
= it
->max_descent
;
26008 if (it
->ascent
> it
->max_ascent
)
26010 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26011 it
->ascent
= it
->max_ascent
;
26013 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26014 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26015 it
->constrain_row_ascent_descent_p
= 1;
26016 extra_line_spacing
= 0;
26020 Lisp_Object spacing
;
26022 it
->phys_ascent
= it
->ascent
;
26023 it
->phys_descent
= it
->descent
;
26025 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26026 && face
->box
!= FACE_NO_BOX
26027 && face
->box_line_width
> 0)
26029 it
->ascent
+= face
->box_line_width
;
26030 it
->descent
+= face
->box_line_width
;
26033 && XINT (height
) > it
->ascent
+ it
->descent
)
26034 it
->ascent
= XINT (height
) - it
->descent
;
26036 if (!NILP (total_height
))
26037 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26040 spacing
= get_it_property (it
, Qline_spacing
);
26041 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26043 if (INTEGERP (spacing
))
26045 extra_line_spacing
= XINT (spacing
);
26046 if (!NILP (total_height
))
26047 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26051 else /* i.e. (it->char_to_display == '\t') */
26053 if (font
->space_width
> 0)
26055 int tab_width
= it
->tab_width
* font
->space_width
;
26056 int x
= it
->current_x
+ it
->continuation_lines_width
;
26057 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26059 /* If the distance from the current position to the next tab
26060 stop is less than a space character width, use the
26061 tab stop after that. */
26062 if (next_tab_x
- x
< font
->space_width
)
26063 next_tab_x
+= tab_width
;
26065 it
->pixel_width
= next_tab_x
- x
;
26067 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26068 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26072 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26073 it
->ascent
+ it
->descent
, it
->ascent
);
26078 it
->pixel_width
= 0;
26083 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26085 /* A static composition.
26087 Note: A composition is represented as one glyph in the
26088 glyph matrix. There are no padding glyphs.
26090 Important note: pixel_width, ascent, and descent are the
26091 values of what is drawn by draw_glyphs (i.e. the values of
26092 the overall glyphs composed). */
26093 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26094 int boff
; /* baseline offset */
26095 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26096 int glyph_len
= cmp
->glyph_len
;
26097 struct font
*font
= face
->font
;
26101 /* If we have not yet calculated pixel size data of glyphs of
26102 the composition for the current face font, calculate them
26103 now. Theoretically, we have to check all fonts for the
26104 glyphs, but that requires much time and memory space. So,
26105 here we check only the font of the first glyph. This may
26106 lead to incorrect display, but it's very rare, and C-l
26107 (recenter-top-bottom) can correct the display anyway. */
26108 if (! cmp
->font
|| cmp
->font
!= font
)
26110 /* Ascent and descent of the font of the first character
26111 of this composition (adjusted by baseline offset).
26112 Ascent and descent of overall glyphs should not be less
26113 than these, respectively. */
26114 int font_ascent
, font_descent
, font_height
;
26115 /* Bounding box of the overall glyphs. */
26116 int leftmost
, rightmost
, lowest
, highest
;
26117 int lbearing
, rbearing
;
26118 int i
, width
, ascent
, descent
;
26119 int left_padded
= 0, right_padded
= 0;
26120 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26122 struct font_metrics
*pcm
;
26123 int font_not_found_p
;
26126 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26127 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26129 if (glyph_len
< cmp
->glyph_len
)
26131 for (i
= 0; i
< glyph_len
; i
++)
26133 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26135 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26140 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26141 : IT_CHARPOS (*it
));
26142 /* If no suitable font is found, use the default font. */
26143 font_not_found_p
= font
== NULL
;
26144 if (font_not_found_p
)
26146 face
= face
->ascii_face
;
26149 boff
= font
->baseline_offset
;
26150 if (font
->vertical_centering
)
26151 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26152 font_ascent
= FONT_BASE (font
) + boff
;
26153 font_descent
= FONT_DESCENT (font
) - boff
;
26154 font_height
= FONT_HEIGHT (font
);
26159 if (! font_not_found_p
)
26161 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26163 pcm
= get_per_char_metric (font
, &char2b
);
26166 /* Initialize the bounding box. */
26169 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26170 ascent
= pcm
->ascent
;
26171 descent
= pcm
->descent
;
26172 lbearing
= pcm
->lbearing
;
26173 rbearing
= pcm
->rbearing
;
26177 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26178 ascent
= FONT_BASE (font
);
26179 descent
= FONT_DESCENT (font
);
26186 lowest
= - descent
+ boff
;
26187 highest
= ascent
+ boff
;
26189 if (! font_not_found_p
26190 && font
->default_ascent
26191 && CHAR_TABLE_P (Vuse_default_ascent
)
26192 && !NILP (Faref (Vuse_default_ascent
,
26193 make_number (it
->char_to_display
))))
26194 highest
= font
->default_ascent
+ boff
;
26196 /* Draw the first glyph at the normal position. It may be
26197 shifted to right later if some other glyphs are drawn
26199 cmp
->offsets
[i
* 2] = 0;
26200 cmp
->offsets
[i
* 2 + 1] = boff
;
26201 cmp
->lbearing
= lbearing
;
26202 cmp
->rbearing
= rbearing
;
26204 /* Set cmp->offsets for the remaining glyphs. */
26205 for (i
++; i
< glyph_len
; i
++)
26207 int left
, right
, btm
, top
;
26208 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26210 struct face
*this_face
;
26214 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26215 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26216 font
= this_face
->font
;
26222 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26224 pcm
= get_per_char_metric (font
, &char2b
);
26227 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26230 width
= pcm
->width
;
26231 ascent
= pcm
->ascent
;
26232 descent
= pcm
->descent
;
26233 lbearing
= pcm
->lbearing
;
26234 rbearing
= pcm
->rbearing
;
26235 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26237 /* Relative composition with or without
26238 alternate chars. */
26239 left
= (leftmost
+ rightmost
- width
) / 2;
26240 btm
= - descent
+ boff
;
26241 if (font
->relative_compose
26242 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26243 || NILP (Faref (Vignore_relative_composition
,
26244 make_number (ch
)))))
26247 if (- descent
>= font
->relative_compose
)
26248 /* One extra pixel between two glyphs. */
26250 else if (ascent
<= 0)
26251 /* One extra pixel between two glyphs. */
26252 btm
= lowest
- 1 - ascent
- descent
;
26257 /* A composition rule is specified by an integer
26258 value that encodes global and new reference
26259 points (GREF and NREF). GREF and NREF are
26260 specified by numbers as below:
26262 0---1---2 -- ascent
26266 9--10--11 -- center
26268 ---3---4---5--- baseline
26270 6---7---8 -- descent
26272 int rule
= COMPOSITION_RULE (cmp
, i
);
26273 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26275 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26276 grefx
= gref
% 3, nrefx
= nref
% 3;
26277 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26279 xoff
= font_height
* (xoff
- 128) / 256;
26281 yoff
= font_height
* (yoff
- 128) / 256;
26284 + grefx
* (rightmost
- leftmost
) / 2
26285 - nrefx
* width
/ 2
26288 btm
= ((grefy
== 0 ? highest
26290 : grefy
== 2 ? lowest
26291 : (highest
+ lowest
) / 2)
26292 - (nrefy
== 0 ? ascent
+ descent
26293 : nrefy
== 1 ? descent
- boff
26295 : (ascent
+ descent
) / 2)
26299 cmp
->offsets
[i
* 2] = left
;
26300 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26302 /* Update the bounding box of the overall glyphs. */
26305 right
= left
+ width
;
26306 if (left
< leftmost
)
26308 if (right
> rightmost
)
26311 top
= btm
+ descent
+ ascent
;
26317 if (cmp
->lbearing
> left
+ lbearing
)
26318 cmp
->lbearing
= left
+ lbearing
;
26319 if (cmp
->rbearing
< left
+ rbearing
)
26320 cmp
->rbearing
= left
+ rbearing
;
26324 /* If there are glyphs whose x-offsets are negative,
26325 shift all glyphs to the right and make all x-offsets
26329 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26330 cmp
->offsets
[i
* 2] -= leftmost
;
26331 rightmost
-= leftmost
;
26332 cmp
->lbearing
-= leftmost
;
26333 cmp
->rbearing
-= leftmost
;
26336 if (left_padded
&& cmp
->lbearing
< 0)
26338 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26339 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26340 rightmost
-= cmp
->lbearing
;
26341 cmp
->rbearing
-= cmp
->lbearing
;
26344 if (right_padded
&& rightmost
< cmp
->rbearing
)
26346 rightmost
= cmp
->rbearing
;
26349 cmp
->pixel_width
= rightmost
;
26350 cmp
->ascent
= highest
;
26351 cmp
->descent
= - lowest
;
26352 if (cmp
->ascent
< font_ascent
)
26353 cmp
->ascent
= font_ascent
;
26354 if (cmp
->descent
< font_descent
)
26355 cmp
->descent
= font_descent
;
26359 && (cmp
->lbearing
< 0
26360 || cmp
->rbearing
> cmp
->pixel_width
))
26361 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26363 it
->pixel_width
= cmp
->pixel_width
;
26364 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26365 it
->descent
= it
->phys_descent
= cmp
->descent
;
26366 if (face
->box
!= FACE_NO_BOX
)
26368 int thick
= face
->box_line_width
;
26372 it
->ascent
+= thick
;
26373 it
->descent
+= thick
;
26378 if (it
->start_of_box_run_p
)
26379 it
->pixel_width
+= thick
;
26380 if (it
->end_of_box_run_p
)
26381 it
->pixel_width
+= thick
;
26384 /* If face has an overline, add the height of the overline
26385 (1 pixel) and a 1 pixel margin to the character height. */
26386 if (face
->overline_p
)
26387 it
->ascent
+= overline_margin
;
26389 take_vertical_position_into_account (it
);
26390 if (it
->ascent
< 0)
26392 if (it
->descent
< 0)
26395 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26396 append_composite_glyph (it
);
26398 else if (it
->what
== IT_COMPOSITION
)
26400 /* A dynamic (automatic) composition. */
26401 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26402 Lisp_Object gstring
;
26403 struct font_metrics metrics
;
26407 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26409 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26412 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26413 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26414 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26415 it
->descent
= it
->phys_descent
= metrics
.descent
;
26416 if (face
->box
!= FACE_NO_BOX
)
26418 int thick
= face
->box_line_width
;
26422 it
->ascent
+= thick
;
26423 it
->descent
+= thick
;
26428 if (it
->start_of_box_run_p
)
26429 it
->pixel_width
+= thick
;
26430 if (it
->end_of_box_run_p
)
26431 it
->pixel_width
+= thick
;
26433 /* If face has an overline, add the height of the overline
26434 (1 pixel) and a 1 pixel margin to the character height. */
26435 if (face
->overline_p
)
26436 it
->ascent
+= overline_margin
;
26437 take_vertical_position_into_account (it
);
26438 if (it
->ascent
< 0)
26440 if (it
->descent
< 0)
26444 append_composite_glyph (it
);
26446 else if (it
->what
== IT_GLYPHLESS
)
26447 produce_glyphless_glyph (it
, 0, Qnil
);
26448 else if (it
->what
== IT_IMAGE
)
26449 produce_image_glyph (it
);
26450 else if (it
->what
== IT_STRETCH
)
26451 produce_stretch_glyph (it
);
26454 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26455 because this isn't true for images with `:ascent 100'. */
26456 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26457 if (it
->area
== TEXT_AREA
)
26458 it
->current_x
+= it
->pixel_width
;
26460 if (extra_line_spacing
> 0)
26462 it
->descent
+= extra_line_spacing
;
26463 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26464 it
->max_extra_line_spacing
= extra_line_spacing
;
26467 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26468 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26469 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26470 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26474 Output LEN glyphs starting at START at the nominal cursor position.
26475 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26476 being updated, and UPDATED_AREA is the area of that row being updated. */
26479 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26480 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26482 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26484 eassert (updated_row
);
26485 /* When the window is hscrolled, cursor hpos can legitimately be out
26486 of bounds, but we draw the cursor at the corresponding window
26487 margin in that case. */
26488 if (!updated_row
->reversed_p
&& chpos
< 0)
26490 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26491 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26495 /* Write glyphs. */
26497 hpos
= start
- updated_row
->glyphs
[updated_area
];
26498 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26499 updated_row
, updated_area
,
26501 DRAW_NORMAL_TEXT
, 0);
26503 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26504 if (updated_area
== TEXT_AREA
26505 && w
->phys_cursor_on_p
26506 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26508 && chpos
< hpos
+ len
)
26509 w
->phys_cursor_on_p
= 0;
26513 /* Advance the output cursor. */
26514 w
->output_cursor
.hpos
+= len
;
26515 w
->output_cursor
.x
= x
;
26520 Insert LEN glyphs from START at the nominal cursor position. */
26523 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26524 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26527 int line_height
, shift_by_width
, shifted_region_width
;
26528 struct glyph_row
*row
;
26529 struct glyph
*glyph
;
26530 int frame_x
, frame_y
;
26533 eassert (updated_row
);
26535 f
= XFRAME (WINDOW_FRAME (w
));
26537 /* Get the height of the line we are in. */
26539 line_height
= row
->height
;
26541 /* Get the width of the glyphs to insert. */
26542 shift_by_width
= 0;
26543 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26544 shift_by_width
+= glyph
->pixel_width
;
26546 /* Get the width of the region to shift right. */
26547 shifted_region_width
= (window_box_width (w
, updated_area
)
26548 - w
->output_cursor
.x
26552 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26553 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26555 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26556 line_height
, shift_by_width
);
26558 /* Write the glyphs. */
26559 hpos
= start
- row
->glyphs
[updated_area
];
26560 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26562 DRAW_NORMAL_TEXT
, 0);
26564 /* Advance the output cursor. */
26565 w
->output_cursor
.hpos
+= len
;
26566 w
->output_cursor
.x
+= shift_by_width
;
26572 Erase the current text line from the nominal cursor position
26573 (inclusive) to pixel column TO_X (exclusive). The idea is that
26574 everything from TO_X onward is already erased.
26576 TO_X is a pixel position relative to UPDATED_AREA of currently
26577 updated window W. TO_X == -1 means clear to the end of this area. */
26580 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26581 enum glyph_row_area updated_area
, int to_x
)
26584 int max_x
, min_y
, max_y
;
26585 int from_x
, from_y
, to_y
;
26587 eassert (updated_row
);
26588 f
= XFRAME (w
->frame
);
26590 if (updated_row
->full_width_p
)
26591 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26592 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26594 max_x
= window_box_width (w
, updated_area
);
26595 max_y
= window_text_bottom_y (w
);
26597 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26598 of window. For TO_X > 0, truncate to end of drawing area. */
26604 to_x
= min (to_x
, max_x
);
26606 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26608 /* Notice if the cursor will be cleared by this operation. */
26609 if (!updated_row
->full_width_p
)
26610 notice_overwritten_cursor (w
, updated_area
,
26611 w
->output_cursor
.x
, -1,
26613 MATRIX_ROW_BOTTOM_Y (updated_row
));
26615 from_x
= w
->output_cursor
.x
;
26617 /* Translate to frame coordinates. */
26618 if (updated_row
->full_width_p
)
26620 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26621 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26625 int area_left
= window_box_left (w
, updated_area
);
26626 from_x
+= area_left
;
26630 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26631 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26632 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26634 /* Prevent inadvertently clearing to end of the X window. */
26635 if (to_x
> from_x
&& to_y
> from_y
)
26638 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26639 to_x
- from_x
, to_y
- from_y
);
26644 #endif /* HAVE_WINDOW_SYSTEM */
26648 /***********************************************************************
26650 ***********************************************************************/
26652 /* Value is the internal representation of the specified cursor type
26653 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26654 of the bar cursor. */
26656 static enum text_cursor_kinds
26657 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26659 enum text_cursor_kinds type
;
26664 if (EQ (arg
, Qbox
))
26665 return FILLED_BOX_CURSOR
;
26667 if (EQ (arg
, Qhollow
))
26668 return HOLLOW_BOX_CURSOR
;
26670 if (EQ (arg
, Qbar
))
26677 && EQ (XCAR (arg
), Qbar
)
26678 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26680 *width
= XINT (XCDR (arg
));
26684 if (EQ (arg
, Qhbar
))
26687 return HBAR_CURSOR
;
26691 && EQ (XCAR (arg
), Qhbar
)
26692 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26694 *width
= XINT (XCDR (arg
));
26695 return HBAR_CURSOR
;
26698 /* Treat anything unknown as "hollow box cursor".
26699 It was bad to signal an error; people have trouble fixing
26700 .Xdefaults with Emacs, when it has something bad in it. */
26701 type
= HOLLOW_BOX_CURSOR
;
26706 /* Set the default cursor types for specified frame. */
26708 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26713 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26714 FRAME_CURSOR_WIDTH (f
) = width
;
26716 /* By default, set up the blink-off state depending on the on-state. */
26718 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26721 FRAME_BLINK_OFF_CURSOR (f
)
26722 = get_specified_cursor_type (XCDR (tem
), &width
);
26723 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26726 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26728 /* Make sure the cursor gets redrawn. */
26729 f
->cursor_type_changed
= 1;
26733 #ifdef HAVE_WINDOW_SYSTEM
26735 /* Return the cursor we want to be displayed in window W. Return
26736 width of bar/hbar cursor through WIDTH arg. Return with
26737 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26738 (i.e. if the `system caret' should track this cursor).
26740 In a mini-buffer window, we want the cursor only to appear if we
26741 are reading input from this window. For the selected window, we
26742 want the cursor type given by the frame parameter or buffer local
26743 setting of cursor-type. If explicitly marked off, draw no cursor.
26744 In all other cases, we want a hollow box cursor. */
26746 static enum text_cursor_kinds
26747 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26748 int *active_cursor
)
26750 struct frame
*f
= XFRAME (w
->frame
);
26751 struct buffer
*b
= XBUFFER (w
->contents
);
26752 int cursor_type
= DEFAULT_CURSOR
;
26753 Lisp_Object alt_cursor
;
26754 int non_selected
= 0;
26756 *active_cursor
= 1;
26759 if (cursor_in_echo_area
26760 && FRAME_HAS_MINIBUF_P (f
)
26761 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26763 if (w
== XWINDOW (echo_area_window
))
26765 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26767 *width
= FRAME_CURSOR_WIDTH (f
);
26768 return FRAME_DESIRED_CURSOR (f
);
26771 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26774 *active_cursor
= 0;
26778 /* Detect a nonselected window or nonselected frame. */
26779 else if (w
!= XWINDOW (f
->selected_window
)
26780 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26782 *active_cursor
= 0;
26784 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26790 /* Never display a cursor in a window in which cursor-type is nil. */
26791 if (NILP (BVAR (b
, cursor_type
)))
26794 /* Get the normal cursor type for this window. */
26795 if (EQ (BVAR (b
, cursor_type
), Qt
))
26797 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26798 *width
= FRAME_CURSOR_WIDTH (f
);
26801 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26803 /* Use cursor-in-non-selected-windows instead
26804 for non-selected window or frame. */
26807 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26808 if (!EQ (Qt
, alt_cursor
))
26809 return get_specified_cursor_type (alt_cursor
, width
);
26810 /* t means modify the normal cursor type. */
26811 if (cursor_type
== FILLED_BOX_CURSOR
)
26812 cursor_type
= HOLLOW_BOX_CURSOR
;
26813 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26815 return cursor_type
;
26818 /* Use normal cursor if not blinked off. */
26819 if (!w
->cursor_off_p
)
26821 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26823 if (cursor_type
== FILLED_BOX_CURSOR
)
26825 /* Using a block cursor on large images can be very annoying.
26826 So use a hollow cursor for "large" images.
26827 If image is not transparent (no mask), also use hollow cursor. */
26828 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26829 if (img
!= NULL
&& IMAGEP (img
->spec
))
26831 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26832 where N = size of default frame font size.
26833 This should cover most of the "tiny" icons people may use. */
26835 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26836 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26837 cursor_type
= HOLLOW_BOX_CURSOR
;
26840 else if (cursor_type
!= NO_CURSOR
)
26842 /* Display current only supports BOX and HOLLOW cursors for images.
26843 So for now, unconditionally use a HOLLOW cursor when cursor is
26844 not a solid box cursor. */
26845 cursor_type
= HOLLOW_BOX_CURSOR
;
26848 return cursor_type
;
26851 /* Cursor is blinked off, so determine how to "toggle" it. */
26853 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26854 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26855 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26857 /* Then see if frame has specified a specific blink off cursor type. */
26858 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26860 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26861 return FRAME_BLINK_OFF_CURSOR (f
);
26865 /* Some people liked having a permanently visible blinking cursor,
26866 while others had very strong opinions against it. So it was
26867 decided to remove it. KFS 2003-09-03 */
26869 /* Finally perform built-in cursor blinking:
26870 filled box <-> hollow box
26871 wide [h]bar <-> narrow [h]bar
26872 narrow [h]bar <-> no cursor
26873 other type <-> no cursor */
26875 if (cursor_type
== FILLED_BOX_CURSOR
)
26876 return HOLLOW_BOX_CURSOR
;
26878 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26881 return cursor_type
;
26889 /* Notice when the text cursor of window W has been completely
26890 overwritten by a drawing operation that outputs glyphs in AREA
26891 starting at X0 and ending at X1 in the line starting at Y0 and
26892 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26893 the rest of the line after X0 has been written. Y coordinates
26894 are window-relative. */
26897 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26898 int x0
, int x1
, int y0
, int y1
)
26900 int cx0
, cx1
, cy0
, cy1
;
26901 struct glyph_row
*row
;
26903 if (!w
->phys_cursor_on_p
)
26905 if (area
!= TEXT_AREA
)
26908 if (w
->phys_cursor
.vpos
< 0
26909 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26910 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26911 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26914 if (row
->cursor_in_fringe_p
)
26916 row
->cursor_in_fringe_p
= 0;
26917 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26918 w
->phys_cursor_on_p
= 0;
26922 cx0
= w
->phys_cursor
.x
;
26923 cx1
= cx0
+ w
->phys_cursor_width
;
26924 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26927 /* The cursor image will be completely removed from the
26928 screen if the output area intersects the cursor area in
26929 y-direction. When we draw in [y0 y1[, and some part of
26930 the cursor is at y < y0, that part must have been drawn
26931 before. When scrolling, the cursor is erased before
26932 actually scrolling, so we don't come here. When not
26933 scrolling, the rows above the old cursor row must have
26934 changed, and in this case these rows must have written
26935 over the cursor image.
26937 Likewise if part of the cursor is below y1, with the
26938 exception of the cursor being in the first blank row at
26939 the buffer and window end because update_text_area
26940 doesn't draw that row. (Except when it does, but
26941 that's handled in update_text_area.) */
26943 cy0
= w
->phys_cursor
.y
;
26944 cy1
= cy0
+ w
->phys_cursor_height
;
26945 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26948 w
->phys_cursor_on_p
= 0;
26951 #endif /* HAVE_WINDOW_SYSTEM */
26954 /************************************************************************
26956 ************************************************************************/
26958 #ifdef HAVE_WINDOW_SYSTEM
26961 Fix the display of area AREA of overlapping row ROW in window W
26962 with respect to the overlapping part OVERLAPS. */
26965 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26966 enum glyph_row_area area
, int overlaps
)
26973 for (i
= 0; i
< row
->used
[area
];)
26975 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26977 int start
= i
, start_x
= x
;
26981 x
+= row
->glyphs
[area
][i
].pixel_width
;
26984 while (i
< row
->used
[area
]
26985 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26987 draw_glyphs (w
, start_x
, row
, area
,
26989 DRAW_NORMAL_TEXT
, overlaps
);
26993 x
+= row
->glyphs
[area
][i
].pixel_width
;
27003 Draw the cursor glyph of window W in glyph row ROW. See the
27004 comment of draw_glyphs for the meaning of HL. */
27007 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27008 enum draw_glyphs_face hl
)
27010 /* If cursor hpos is out of bounds, don't draw garbage. This can
27011 happen in mini-buffer windows when switching between echo area
27012 glyphs and mini-buffer. */
27013 if ((row
->reversed_p
27014 ? (w
->phys_cursor
.hpos
>= 0)
27015 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27017 int on_p
= w
->phys_cursor_on_p
;
27019 int hpos
= w
->phys_cursor
.hpos
;
27021 /* When the window is hscrolled, cursor hpos can legitimately be
27022 out of bounds, but we draw the cursor at the corresponding
27023 window margin in that case. */
27024 if (!row
->reversed_p
&& hpos
< 0)
27026 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27027 hpos
= row
->used
[TEXT_AREA
] - 1;
27029 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27031 w
->phys_cursor_on_p
= on_p
;
27033 if (hl
== DRAW_CURSOR
)
27034 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27035 /* When we erase the cursor, and ROW is overlapped by other
27036 rows, make sure that these overlapping parts of other rows
27038 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27040 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27042 if (row
> w
->current_matrix
->rows
27043 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27044 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27045 OVERLAPS_ERASED_CURSOR
);
27047 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27048 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27049 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27050 OVERLAPS_ERASED_CURSOR
);
27056 /* Erase the image of a cursor of window W from the screen. */
27062 erase_phys_cursor (struct window
*w
)
27064 struct frame
*f
= XFRAME (w
->frame
);
27065 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27066 int hpos
= w
->phys_cursor
.hpos
;
27067 int vpos
= w
->phys_cursor
.vpos
;
27068 int mouse_face_here_p
= 0;
27069 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27070 struct glyph_row
*cursor_row
;
27071 struct glyph
*cursor_glyph
;
27072 enum draw_glyphs_face hl
;
27074 /* No cursor displayed or row invalidated => nothing to do on the
27076 if (w
->phys_cursor_type
== NO_CURSOR
)
27077 goto mark_cursor_off
;
27079 /* VPOS >= active_glyphs->nrows means that window has been resized.
27080 Don't bother to erase the cursor. */
27081 if (vpos
>= active_glyphs
->nrows
)
27082 goto mark_cursor_off
;
27084 /* If row containing cursor is marked invalid, there is nothing we
27086 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27087 if (!cursor_row
->enabled_p
)
27088 goto mark_cursor_off
;
27090 /* If line spacing is > 0, old cursor may only be partially visible in
27091 window after split-window. So adjust visible height. */
27092 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27093 window_text_bottom_y (w
) - cursor_row
->y
);
27095 /* If row is completely invisible, don't attempt to delete a cursor which
27096 isn't there. This can happen if cursor is at top of a window, and
27097 we switch to a buffer with a header line in that window. */
27098 if (cursor_row
->visible_height
<= 0)
27099 goto mark_cursor_off
;
27101 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27102 if (cursor_row
->cursor_in_fringe_p
)
27104 cursor_row
->cursor_in_fringe_p
= 0;
27105 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27106 goto mark_cursor_off
;
27109 /* This can happen when the new row is shorter than the old one.
27110 In this case, either draw_glyphs or clear_end_of_line
27111 should have cleared the cursor. Note that we wouldn't be
27112 able to erase the cursor in this case because we don't have a
27113 cursor glyph at hand. */
27114 if ((cursor_row
->reversed_p
27115 ? (w
->phys_cursor
.hpos
< 0)
27116 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27117 goto mark_cursor_off
;
27119 /* When the window is hscrolled, cursor hpos can legitimately be out
27120 of bounds, but we draw the cursor at the corresponding window
27121 margin in that case. */
27122 if (!cursor_row
->reversed_p
&& hpos
< 0)
27124 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27125 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27127 /* If the cursor is in the mouse face area, redisplay that when
27128 we clear the cursor. */
27129 if (! NILP (hlinfo
->mouse_face_window
)
27130 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27131 /* Don't redraw the cursor's spot in mouse face if it is at the
27132 end of a line (on a newline). The cursor appears there, but
27133 mouse highlighting does not. */
27134 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27135 mouse_face_here_p
= 1;
27137 /* Maybe clear the display under the cursor. */
27138 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27141 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27144 cursor_glyph
= get_phys_cursor_glyph (w
);
27145 if (cursor_glyph
== NULL
)
27146 goto mark_cursor_off
;
27148 width
= cursor_glyph
->pixel_width
;
27149 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27150 x
= w
->phys_cursor
.x
;
27152 width
-= left_x
- x
;
27153 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27154 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27155 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27158 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27161 /* Erase the cursor by redrawing the character underneath it. */
27162 if (mouse_face_here_p
)
27163 hl
= DRAW_MOUSE_FACE
;
27165 hl
= DRAW_NORMAL_TEXT
;
27166 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27169 w
->phys_cursor_on_p
= 0;
27170 w
->phys_cursor_type
= NO_CURSOR
;
27175 Display or clear cursor of window W. If ON is zero, clear the
27176 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27177 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27180 display_and_set_cursor (struct window
*w
, bool on
,
27181 int hpos
, int vpos
, int x
, int y
)
27183 struct frame
*f
= XFRAME (w
->frame
);
27184 int new_cursor_type
;
27185 int new_cursor_width
;
27187 struct glyph_row
*glyph_row
;
27188 struct glyph
*glyph
;
27190 /* This is pointless on invisible frames, and dangerous on garbaged
27191 windows and frames; in the latter case, the frame or window may
27192 be in the midst of changing its size, and x and y may be off the
27194 if (! FRAME_VISIBLE_P (f
)
27195 || FRAME_GARBAGED_P (f
)
27196 || vpos
>= w
->current_matrix
->nrows
27197 || hpos
>= w
->current_matrix
->matrix_w
)
27200 /* If cursor is off and we want it off, return quickly. */
27201 if (!on
&& !w
->phys_cursor_on_p
)
27204 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27205 /* If cursor row is not enabled, we don't really know where to
27206 display the cursor. */
27207 if (!glyph_row
->enabled_p
)
27209 w
->phys_cursor_on_p
= 0;
27214 if (!glyph_row
->exact_window_width_line_p
27215 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27216 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27218 eassert (input_blocked_p ());
27220 /* Set new_cursor_type to the cursor we want to be displayed. */
27221 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27222 &new_cursor_width
, &active_cursor
);
27224 /* If cursor is currently being shown and we don't want it to be or
27225 it is in the wrong place, or the cursor type is not what we want,
27227 if (w
->phys_cursor_on_p
27229 || w
->phys_cursor
.x
!= x
27230 || w
->phys_cursor
.y
!= y
27231 || new_cursor_type
!= w
->phys_cursor_type
27232 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27233 && new_cursor_width
!= w
->phys_cursor_width
)))
27234 erase_phys_cursor (w
);
27236 /* Don't check phys_cursor_on_p here because that flag is only set
27237 to zero in some cases where we know that the cursor has been
27238 completely erased, to avoid the extra work of erasing the cursor
27239 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27240 still not be visible, or it has only been partly erased. */
27243 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27244 w
->phys_cursor_height
= glyph_row
->height
;
27246 /* Set phys_cursor_.* before x_draw_.* is called because some
27247 of them may need the information. */
27248 w
->phys_cursor
.x
= x
;
27249 w
->phys_cursor
.y
= glyph_row
->y
;
27250 w
->phys_cursor
.hpos
= hpos
;
27251 w
->phys_cursor
.vpos
= vpos
;
27254 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27255 new_cursor_type
, new_cursor_width
,
27256 on
, active_cursor
);
27260 /* Switch the display of W's cursor on or off, according to the value
27264 update_window_cursor (struct window
*w
, bool on
)
27266 /* Don't update cursor in windows whose frame is in the process
27267 of being deleted. */
27268 if (w
->current_matrix
)
27270 int hpos
= w
->phys_cursor
.hpos
;
27271 int vpos
= w
->phys_cursor
.vpos
;
27272 struct glyph_row
*row
;
27274 if (vpos
>= w
->current_matrix
->nrows
27275 || hpos
>= w
->current_matrix
->matrix_w
)
27278 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27280 /* When the window is hscrolled, cursor hpos can legitimately be
27281 out of bounds, but we draw the cursor at the corresponding
27282 window margin in that case. */
27283 if (!row
->reversed_p
&& hpos
< 0)
27285 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27286 hpos
= row
->used
[TEXT_AREA
] - 1;
27289 display_and_set_cursor (w
, on
, hpos
, vpos
,
27290 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27296 /* Call update_window_cursor with parameter ON_P on all leaf windows
27297 in the window tree rooted at W. */
27300 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27304 if (WINDOWP (w
->contents
))
27305 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27307 update_window_cursor (w
, on_p
);
27309 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27315 Display the cursor on window W, or clear it, according to ON_P.
27316 Don't change the cursor's position. */
27319 x_update_cursor (struct frame
*f
, bool on_p
)
27321 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27326 Clear the cursor of window W to background color, and mark the
27327 cursor as not shown. This is used when the text where the cursor
27328 is about to be rewritten. */
27331 x_clear_cursor (struct window
*w
)
27333 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27334 update_window_cursor (w
, 0);
27337 #endif /* HAVE_WINDOW_SYSTEM */
27339 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27342 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27343 int start_hpos
, int end_hpos
,
27344 enum draw_glyphs_face draw
)
27346 #ifdef HAVE_WINDOW_SYSTEM
27347 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27349 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27353 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27354 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27358 /* Display the active region described by mouse_face_* according to DRAW. */
27361 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27363 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27364 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27366 if (/* If window is in the process of being destroyed, don't bother
27368 w
->current_matrix
!= NULL
27369 /* Don't update mouse highlight if hidden. */
27370 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27371 /* Recognize when we are called to operate on rows that don't exist
27372 anymore. This can happen when a window is split. */
27373 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27375 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27376 struct glyph_row
*row
, *first
, *last
;
27378 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27379 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27381 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27383 int start_hpos
, end_hpos
, start_x
;
27385 /* For all but the first row, the highlight starts at column 0. */
27388 /* R2L rows have BEG and END in reversed order, but the
27389 screen drawing geometry is always left to right. So
27390 we need to mirror the beginning and end of the
27391 highlighted area in R2L rows. */
27392 if (!row
->reversed_p
)
27394 start_hpos
= hlinfo
->mouse_face_beg_col
;
27395 start_x
= hlinfo
->mouse_face_beg_x
;
27397 else if (row
== last
)
27399 start_hpos
= hlinfo
->mouse_face_end_col
;
27400 start_x
= hlinfo
->mouse_face_end_x
;
27408 else if (row
->reversed_p
&& row
== last
)
27410 start_hpos
= hlinfo
->mouse_face_end_col
;
27411 start_x
= hlinfo
->mouse_face_end_x
;
27421 if (!row
->reversed_p
)
27422 end_hpos
= hlinfo
->mouse_face_end_col
;
27423 else if (row
== first
)
27424 end_hpos
= hlinfo
->mouse_face_beg_col
;
27427 end_hpos
= row
->used
[TEXT_AREA
];
27428 if (draw
== DRAW_NORMAL_TEXT
)
27429 row
->fill_line_p
= 1; /* Clear to end of line */
27432 else if (row
->reversed_p
&& row
== first
)
27433 end_hpos
= hlinfo
->mouse_face_beg_col
;
27436 end_hpos
= row
->used
[TEXT_AREA
];
27437 if (draw
== DRAW_NORMAL_TEXT
)
27438 row
->fill_line_p
= 1; /* Clear to end of line */
27441 if (end_hpos
> start_hpos
)
27443 draw_row_with_mouse_face (w
, start_x
, row
,
27444 start_hpos
, end_hpos
, draw
);
27447 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27451 #ifdef HAVE_WINDOW_SYSTEM
27452 /* When we've written over the cursor, arrange for it to
27453 be displayed again. */
27454 if (FRAME_WINDOW_P (f
)
27455 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27457 int hpos
= w
->phys_cursor
.hpos
;
27459 /* When the window is hscrolled, cursor hpos can legitimately be
27460 out of bounds, but we draw the cursor at the corresponding
27461 window margin in that case. */
27462 if (!row
->reversed_p
&& hpos
< 0)
27464 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27465 hpos
= row
->used
[TEXT_AREA
] - 1;
27468 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27469 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27472 #endif /* HAVE_WINDOW_SYSTEM */
27475 #ifdef HAVE_WINDOW_SYSTEM
27476 /* Change the mouse cursor. */
27477 if (FRAME_WINDOW_P (f
))
27479 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27480 if (draw
== DRAW_NORMAL_TEXT
27481 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27482 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27485 if (draw
== DRAW_MOUSE_FACE
)
27486 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27488 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27490 #endif /* HAVE_WINDOW_SYSTEM */
27494 Clear out the mouse-highlighted active region.
27495 Redraw it un-highlighted first. Value is non-zero if mouse
27496 face was actually drawn unhighlighted. */
27499 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27503 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27505 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27509 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27510 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27511 hlinfo
->mouse_face_window
= Qnil
;
27512 hlinfo
->mouse_face_overlay
= Qnil
;
27516 /* Return true if the coordinates HPOS and VPOS on windows W are
27517 within the mouse face on that window. */
27519 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27521 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27523 /* Quickly resolve the easy cases. */
27524 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27525 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27527 if (vpos
< hlinfo
->mouse_face_beg_row
27528 || vpos
> hlinfo
->mouse_face_end_row
)
27530 if (vpos
> hlinfo
->mouse_face_beg_row
27531 && vpos
< hlinfo
->mouse_face_end_row
)
27534 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27536 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27538 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27541 else if ((vpos
== hlinfo
->mouse_face_beg_row
27542 && hpos
>= hlinfo
->mouse_face_beg_col
)
27543 || (vpos
== hlinfo
->mouse_face_end_row
27544 && hpos
< hlinfo
->mouse_face_end_col
))
27549 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27551 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27554 else if ((vpos
== hlinfo
->mouse_face_beg_row
27555 && hpos
<= hlinfo
->mouse_face_beg_col
)
27556 || (vpos
== hlinfo
->mouse_face_end_row
27557 && hpos
> hlinfo
->mouse_face_end_col
))
27565 True if physical cursor of window W is within mouse face. */
27568 cursor_in_mouse_face_p (struct window
*w
)
27570 int hpos
= w
->phys_cursor
.hpos
;
27571 int vpos
= w
->phys_cursor
.vpos
;
27572 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27574 /* When the window is hscrolled, cursor hpos can legitimately be out
27575 of bounds, but we draw the cursor at the corresponding window
27576 margin in that case. */
27577 if (!row
->reversed_p
&& hpos
< 0)
27579 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27580 hpos
= row
->used
[TEXT_AREA
] - 1;
27582 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27587 /* Find the glyph rows START_ROW and END_ROW of window W that display
27588 characters between buffer positions START_CHARPOS and END_CHARPOS
27589 (excluding END_CHARPOS). DISP_STRING is a display string that
27590 covers these buffer positions. This is similar to
27591 row_containing_pos, but is more accurate when bidi reordering makes
27592 buffer positions change non-linearly with glyph rows. */
27594 rows_from_pos_range (struct window
*w
,
27595 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27596 Lisp_Object disp_string
,
27597 struct glyph_row
**start
, struct glyph_row
**end
)
27599 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27600 int last_y
= window_text_bottom_y (w
);
27601 struct glyph_row
*row
;
27606 while (!first
->enabled_p
27607 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27610 /* Find the START row. */
27612 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27615 /* A row can potentially be the START row if the range of the
27616 characters it displays intersects the range
27617 [START_CHARPOS..END_CHARPOS). */
27618 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27619 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27620 /* See the commentary in row_containing_pos, for the
27621 explanation of the complicated way to check whether
27622 some position is beyond the end of the characters
27623 displayed by a row. */
27624 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27625 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27626 && !row
->ends_at_zv_p
27627 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27628 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27629 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27630 && !row
->ends_at_zv_p
27631 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27633 /* Found a candidate row. Now make sure at least one of the
27634 glyphs it displays has a charpos from the range
27635 [START_CHARPOS..END_CHARPOS).
27637 This is not obvious because bidi reordering could make
27638 buffer positions of a row be 1,2,3,102,101,100, and if we
27639 want to highlight characters in [50..60), we don't want
27640 this row, even though [50..60) does intersect [1..103),
27641 the range of character positions given by the row's start
27642 and end positions. */
27643 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27644 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27648 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27649 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27650 /* A glyph that comes from DISP_STRING is by
27651 definition to be highlighted. */
27652 || EQ (g
->object
, disp_string
))
27661 /* Find the END row. */
27663 /* If the last row is partially visible, start looking for END
27664 from that row, instead of starting from FIRST. */
27665 && !(row
->enabled_p
27666 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27668 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27670 struct glyph_row
*next
= row
+ 1;
27671 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27673 if (!next
->enabled_p
27674 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27675 /* The first row >= START whose range of displayed characters
27676 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27677 is the row END + 1. */
27678 || (start_charpos
< next_start
27679 && end_charpos
< next_start
)
27680 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27681 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27682 && !next
->ends_at_zv_p
27683 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27684 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27685 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27686 && !next
->ends_at_zv_p
27687 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27694 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27695 but none of the characters it displays are in the range, it is
27697 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27698 struct glyph
*s
= g
;
27699 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27703 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27704 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27705 /* If the buffer position of the first glyph in
27706 the row is equal to END_CHARPOS, it means
27707 the last character to be highlighted is the
27708 newline of ROW, and we must consider NEXT as
27710 || (((!next
->reversed_p
&& g
== s
)
27711 || (next
->reversed_p
&& g
== e
- 1))
27712 && (g
->charpos
== end_charpos
27713 /* Special case for when NEXT is an
27714 empty line at ZV. */
27715 || (g
->charpos
== -1
27716 && !row
->ends_at_zv_p
27717 && next_start
== end_charpos
)))))
27718 /* A glyph that comes from DISP_STRING is by
27719 definition to be highlighted. */
27720 || EQ (g
->object
, disp_string
))
27729 /* The first row that ends at ZV must be the last to be
27731 else if (next
->ends_at_zv_p
)
27740 /* This function sets the mouse_face_* elements of HLINFO, assuming
27741 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27742 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27743 for the overlay or run of text properties specifying the mouse
27744 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27745 before-string and after-string that must also be highlighted.
27746 DISP_STRING, if non-nil, is a display string that may cover some
27747 or all of the highlighted text. */
27750 mouse_face_from_buffer_pos (Lisp_Object window
,
27751 Mouse_HLInfo
*hlinfo
,
27752 ptrdiff_t mouse_charpos
,
27753 ptrdiff_t start_charpos
,
27754 ptrdiff_t end_charpos
,
27755 Lisp_Object before_string
,
27756 Lisp_Object after_string
,
27757 Lisp_Object disp_string
)
27759 struct window
*w
= XWINDOW (window
);
27760 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27761 struct glyph_row
*r1
, *r2
;
27762 struct glyph
*glyph
, *end
;
27763 ptrdiff_t ignore
, pos
;
27766 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27767 eassert (NILP (before_string
) || STRINGP (before_string
));
27768 eassert (NILP (after_string
) || STRINGP (after_string
));
27770 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27771 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27773 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27774 /* If the before-string or display-string contains newlines,
27775 rows_from_pos_range skips to its last row. Move back. */
27776 if (!NILP (before_string
) || !NILP (disp_string
))
27778 struct glyph_row
*prev
;
27779 while ((prev
= r1
- 1, prev
>= first
)
27780 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27781 && prev
->used
[TEXT_AREA
] > 0)
27783 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27784 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27785 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27787 || !(EQ (glyph
->object
, before_string
)
27788 || EQ (glyph
->object
, disp_string
)))
27795 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27796 hlinfo
->mouse_face_past_end
= 1;
27798 else if (!NILP (after_string
))
27800 /* If the after-string has newlines, advance to its last row. */
27801 struct glyph_row
*next
;
27802 struct glyph_row
*last
27803 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27805 for (next
= r2
+ 1;
27807 && next
->used
[TEXT_AREA
] > 0
27808 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27812 /* The rest of the display engine assumes that mouse_face_beg_row is
27813 either above mouse_face_end_row or identical to it. But with
27814 bidi-reordered continued lines, the row for START_CHARPOS could
27815 be below the row for END_CHARPOS. If so, swap the rows and store
27816 them in correct order. */
27819 struct glyph_row
*tem
= r2
;
27825 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27826 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27828 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27829 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27830 could be anywhere in the row and in any order. The strategy
27831 below is to find the leftmost and the rightmost glyph that
27832 belongs to either of these 3 strings, or whose position is
27833 between START_CHARPOS and END_CHARPOS, and highlight all the
27834 glyphs between those two. This may cover more than just the text
27835 between START_CHARPOS and END_CHARPOS if the range of characters
27836 strides the bidi level boundary, e.g. if the beginning is in R2L
27837 text while the end is in L2R text or vice versa. */
27838 if (!r1
->reversed_p
)
27840 /* This row is in a left to right paragraph. Scan it left to
27842 glyph
= r1
->glyphs
[TEXT_AREA
];
27843 end
= glyph
+ r1
->used
[TEXT_AREA
];
27846 /* Skip truncation glyphs at the start of the glyph row. */
27847 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27849 && INTEGERP (glyph
->object
)
27850 && glyph
->charpos
< 0;
27852 x
+= glyph
->pixel_width
;
27854 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27855 or DISP_STRING, and the first glyph from buffer whose
27856 position is between START_CHARPOS and END_CHARPOS. */
27858 && !INTEGERP (glyph
->object
)
27859 && !EQ (glyph
->object
, disp_string
)
27860 && !(BUFFERP (glyph
->object
)
27861 && (glyph
->charpos
>= start_charpos
27862 && glyph
->charpos
< end_charpos
));
27865 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27866 are present at buffer positions between START_CHARPOS and
27867 END_CHARPOS, or if they come from an overlay. */
27868 if (EQ (glyph
->object
, before_string
))
27870 pos
= string_buffer_position (before_string
,
27872 /* If pos == 0, it means before_string came from an
27873 overlay, not from a buffer position. */
27874 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27877 else if (EQ (glyph
->object
, after_string
))
27879 pos
= string_buffer_position (after_string
, end_charpos
);
27880 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27883 x
+= glyph
->pixel_width
;
27885 hlinfo
->mouse_face_beg_x
= x
;
27886 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27890 /* This row is in a right to left paragraph. Scan it right to
27894 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27895 glyph
= end
+ r1
->used
[TEXT_AREA
];
27897 /* Skip truncation glyphs at the start of the glyph row. */
27898 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27900 && INTEGERP (glyph
->object
)
27901 && glyph
->charpos
< 0;
27905 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27906 or DISP_STRING, and the first glyph from buffer whose
27907 position is between START_CHARPOS and END_CHARPOS. */
27909 && !INTEGERP (glyph
->object
)
27910 && !EQ (glyph
->object
, disp_string
)
27911 && !(BUFFERP (glyph
->object
)
27912 && (glyph
->charpos
>= start_charpos
27913 && glyph
->charpos
< end_charpos
));
27916 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27917 are present at buffer positions between START_CHARPOS and
27918 END_CHARPOS, or if they come from an overlay. */
27919 if (EQ (glyph
->object
, before_string
))
27921 pos
= string_buffer_position (before_string
, start_charpos
);
27922 /* If pos == 0, it means before_string came from an
27923 overlay, not from a buffer position. */
27924 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27927 else if (EQ (glyph
->object
, after_string
))
27929 pos
= string_buffer_position (after_string
, end_charpos
);
27930 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27935 glyph
++; /* first glyph to the right of the highlighted area */
27936 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27937 x
+= g
->pixel_width
;
27938 hlinfo
->mouse_face_beg_x
= x
;
27939 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27942 /* If the highlight ends in a different row, compute GLYPH and END
27943 for the end row. Otherwise, reuse the values computed above for
27944 the row where the highlight begins. */
27947 if (!r2
->reversed_p
)
27949 glyph
= r2
->glyphs
[TEXT_AREA
];
27950 end
= glyph
+ r2
->used
[TEXT_AREA
];
27955 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27956 glyph
= end
+ r2
->used
[TEXT_AREA
];
27960 if (!r2
->reversed_p
)
27962 /* Skip truncation and continuation glyphs near the end of the
27963 row, and also blanks and stretch glyphs inserted by
27964 extend_face_to_end_of_line. */
27966 && INTEGERP ((end
- 1)->object
))
27968 /* Scan the rest of the glyph row from the end, looking for the
27969 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27970 DISP_STRING, or whose position is between START_CHARPOS
27974 && !INTEGERP (end
->object
)
27975 && !EQ (end
->object
, disp_string
)
27976 && !(BUFFERP (end
->object
)
27977 && (end
->charpos
>= start_charpos
27978 && end
->charpos
< end_charpos
));
27981 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27982 are present at buffer positions between START_CHARPOS and
27983 END_CHARPOS, or if they come from an overlay. */
27984 if (EQ (end
->object
, before_string
))
27986 pos
= string_buffer_position (before_string
, start_charpos
);
27987 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27990 else if (EQ (end
->object
, after_string
))
27992 pos
= string_buffer_position (after_string
, end_charpos
);
27993 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27997 /* Find the X coordinate of the last glyph to be highlighted. */
27998 for (; glyph
<= end
; ++glyph
)
27999 x
+= glyph
->pixel_width
;
28001 hlinfo
->mouse_face_end_x
= x
;
28002 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28006 /* Skip truncation and continuation glyphs near the end of the
28007 row, and also blanks and stretch glyphs inserted by
28008 extend_face_to_end_of_line. */
28012 && INTEGERP (end
->object
))
28014 x
+= end
->pixel_width
;
28017 /* Scan the rest of the glyph row from the end, looking for the
28018 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28019 DISP_STRING, or whose position is between START_CHARPOS
28023 && !INTEGERP (end
->object
)
28024 && !EQ (end
->object
, disp_string
)
28025 && !(BUFFERP (end
->object
)
28026 && (end
->charpos
>= start_charpos
28027 && end
->charpos
< end_charpos
));
28030 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28031 are present at buffer positions between START_CHARPOS and
28032 END_CHARPOS, or if they come from an overlay. */
28033 if (EQ (end
->object
, before_string
))
28035 pos
= string_buffer_position (before_string
, start_charpos
);
28036 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28039 else if (EQ (end
->object
, after_string
))
28041 pos
= string_buffer_position (after_string
, end_charpos
);
28042 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28045 x
+= end
->pixel_width
;
28047 /* If we exited the above loop because we arrived at the last
28048 glyph of the row, and its buffer position is still not in
28049 range, it means the last character in range is the preceding
28050 newline. Bump the end column and x values to get past the
28053 && BUFFERP (end
->object
)
28054 && (end
->charpos
< start_charpos
28055 || end
->charpos
>= end_charpos
))
28057 x
+= end
->pixel_width
;
28060 hlinfo
->mouse_face_end_x
= x
;
28061 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28064 hlinfo
->mouse_face_window
= window
;
28065 hlinfo
->mouse_face_face_id
28066 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28068 !hlinfo
->mouse_face_hidden
, -1);
28069 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28072 /* The following function is not used anymore (replaced with
28073 mouse_face_from_string_pos), but I leave it here for the time
28074 being, in case someone would. */
28076 #if 0 /* not used */
28078 /* Find the position of the glyph for position POS in OBJECT in
28079 window W's current matrix, and return in *X, *Y the pixel
28080 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28082 RIGHT_P non-zero means return the position of the right edge of the
28083 glyph, RIGHT_P zero means return the left edge position.
28085 If no glyph for POS exists in the matrix, return the position of
28086 the glyph with the next smaller position that is in the matrix, if
28087 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28088 exists in the matrix, return the position of the glyph with the
28089 next larger position in OBJECT.
28091 Value is non-zero if a glyph was found. */
28094 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28095 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28097 int yb
= window_text_bottom_y (w
);
28098 struct glyph_row
*r
;
28099 struct glyph
*best_glyph
= NULL
;
28100 struct glyph_row
*best_row
= NULL
;
28103 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28104 r
->enabled_p
&& r
->y
< yb
;
28107 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28108 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28111 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28112 if (EQ (g
->object
, object
))
28114 if (g
->charpos
== pos
)
28121 else if (best_glyph
== NULL
28122 || ((eabs (g
->charpos
- pos
)
28123 < eabs (best_glyph
->charpos
- pos
))
28126 : g
->charpos
> pos
)))
28140 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28144 *x
+= best_glyph
->pixel_width
;
28149 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28152 return best_glyph
!= NULL
;
28154 #endif /* not used */
28156 /* Find the positions of the first and the last glyphs in window W's
28157 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28158 (assumed to be a string), and return in HLINFO's mouse_face_*
28159 members the pixel and column/row coordinates of those glyphs. */
28162 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28163 Lisp_Object object
,
28164 ptrdiff_t startpos
, ptrdiff_t endpos
)
28166 int yb
= window_text_bottom_y (w
);
28167 struct glyph_row
*r
;
28168 struct glyph
*g
, *e
;
28172 /* Find the glyph row with at least one position in the range
28173 [STARTPOS..ENDPOS), and the first glyph in that row whose
28174 position belongs to that range. */
28175 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28176 r
->enabled_p
&& r
->y
< yb
;
28179 if (!r
->reversed_p
)
28181 g
= r
->glyphs
[TEXT_AREA
];
28182 e
= g
+ r
->used
[TEXT_AREA
];
28183 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28184 if (EQ (g
->object
, object
)
28185 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28187 hlinfo
->mouse_face_beg_row
28188 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28189 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28190 hlinfo
->mouse_face_beg_x
= gx
;
28199 e
= r
->glyphs
[TEXT_AREA
];
28200 g
= e
+ r
->used
[TEXT_AREA
];
28201 for ( ; g
> e
; --g
)
28202 if (EQ ((g
-1)->object
, object
)
28203 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28205 hlinfo
->mouse_face_beg_row
28206 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28207 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28208 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28209 gx
+= g1
->pixel_width
;
28210 hlinfo
->mouse_face_beg_x
= gx
;
28222 /* Starting with the next row, look for the first row which does NOT
28223 include any glyphs whose positions are in the range. */
28224 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28226 g
= r
->glyphs
[TEXT_AREA
];
28227 e
= g
+ r
->used
[TEXT_AREA
];
28229 for ( ; g
< e
; ++g
)
28230 if (EQ (g
->object
, object
)
28231 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28240 /* The highlighted region ends on the previous row. */
28243 /* Set the end row. */
28244 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28246 /* Compute and set the end column and the end column's horizontal
28247 pixel coordinate. */
28248 if (!r
->reversed_p
)
28250 g
= r
->glyphs
[TEXT_AREA
];
28251 e
= g
+ r
->used
[TEXT_AREA
];
28252 for ( ; e
> g
; --e
)
28253 if (EQ ((e
-1)->object
, object
)
28254 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28256 hlinfo
->mouse_face_end_col
= e
- g
;
28258 for (gx
= r
->x
; g
< e
; ++g
)
28259 gx
+= g
->pixel_width
;
28260 hlinfo
->mouse_face_end_x
= gx
;
28264 e
= r
->glyphs
[TEXT_AREA
];
28265 g
= e
+ r
->used
[TEXT_AREA
];
28266 for (gx
= r
->x
; e
< g
; ++e
)
28268 if (EQ (e
->object
, object
)
28269 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28271 gx
+= e
->pixel_width
;
28273 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28274 hlinfo
->mouse_face_end_x
= gx
;
28278 #ifdef HAVE_WINDOW_SYSTEM
28280 /* See if position X, Y is within a hot-spot of an image. */
28283 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28285 if (!CONSP (hot_spot
))
28288 if (EQ (XCAR (hot_spot
), Qrect
))
28290 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28291 Lisp_Object rect
= XCDR (hot_spot
);
28295 if (!CONSP (XCAR (rect
)))
28297 if (!CONSP (XCDR (rect
)))
28299 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28301 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28303 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28305 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28309 else if (EQ (XCAR (hot_spot
), Qcircle
))
28311 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28312 Lisp_Object circ
= XCDR (hot_spot
);
28313 Lisp_Object lr
, lx0
, ly0
;
28315 && CONSP (XCAR (circ
))
28316 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28317 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28318 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28320 double r
= XFLOATINT (lr
);
28321 double dx
= XINT (lx0
) - x
;
28322 double dy
= XINT (ly0
) - y
;
28323 return (dx
* dx
+ dy
* dy
<= r
* r
);
28326 else if (EQ (XCAR (hot_spot
), Qpoly
))
28328 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28329 if (VECTORP (XCDR (hot_spot
)))
28331 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28332 Lisp_Object
*poly
= v
->contents
;
28333 ptrdiff_t n
= v
->header
.size
;
28336 Lisp_Object lx
, ly
;
28339 /* Need an even number of coordinates, and at least 3 edges. */
28340 if (n
< 6 || n
& 1)
28343 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28344 If count is odd, we are inside polygon. Pixels on edges
28345 may or may not be included depending on actual geometry of the
28347 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28348 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28350 x0
= XINT (lx
), y0
= XINT (ly
);
28351 for (i
= 0; i
< n
; i
+= 2)
28353 int x1
= x0
, y1
= y0
;
28354 if ((lx
= poly
[i
], !INTEGERP (lx
))
28355 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28357 x0
= XINT (lx
), y0
= XINT (ly
);
28359 /* Does this segment cross the X line? */
28367 if (y
> y0
&& y
> y1
)
28369 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28379 find_hot_spot (Lisp_Object map
, int x
, int y
)
28381 while (CONSP (map
))
28383 if (CONSP (XCAR (map
))
28384 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28392 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28394 doc
: /* Lookup in image map MAP coordinates X and Y.
28395 An image map is an alist where each element has the format (AREA ID PLIST).
28396 An AREA is specified as either a rectangle, a circle, or a polygon:
28397 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28398 pixel coordinates of the upper left and bottom right corners.
28399 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28400 and the radius of the circle; r may be a float or integer.
28401 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28402 vector describes one corner in the polygon.
28403 Returns the alist element for the first matching AREA in MAP. */)
28404 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28412 return find_hot_spot (map
,
28413 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28414 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28418 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28420 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28422 /* Do not change cursor shape while dragging mouse. */
28423 if (!NILP (do_mouse_tracking
))
28426 if (!NILP (pointer
))
28428 if (EQ (pointer
, Qarrow
))
28429 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28430 else if (EQ (pointer
, Qhand
))
28431 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28432 else if (EQ (pointer
, Qtext
))
28433 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28434 else if (EQ (pointer
, intern ("hdrag")))
28435 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28436 else if (EQ (pointer
, intern ("nhdrag")))
28437 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28438 #ifdef HAVE_X_WINDOWS
28439 else if (EQ (pointer
, intern ("vdrag")))
28440 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28442 else if (EQ (pointer
, intern ("hourglass")))
28443 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28444 else if (EQ (pointer
, Qmodeline
))
28445 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28447 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28450 if (cursor
!= No_Cursor
)
28451 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28454 #endif /* HAVE_WINDOW_SYSTEM */
28456 /* Take proper action when mouse has moved to the mode or header line
28457 or marginal area AREA of window W, x-position X and y-position Y.
28458 X is relative to the start of the text display area of W, so the
28459 width of bitmap areas and scroll bars must be subtracted to get a
28460 position relative to the start of the mode line. */
28463 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28464 enum window_part area
)
28466 struct window
*w
= XWINDOW (window
);
28467 struct frame
*f
= XFRAME (w
->frame
);
28468 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28469 #ifdef HAVE_WINDOW_SYSTEM
28470 Display_Info
*dpyinfo
;
28472 Cursor cursor
= No_Cursor
;
28473 Lisp_Object pointer
= Qnil
;
28474 int dx
, dy
, width
, height
;
28476 Lisp_Object string
, object
= Qnil
;
28477 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28479 Lisp_Object mouse_face
;
28480 int original_x_pixel
= x
;
28481 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28482 struct glyph_row
*row
IF_LINT (= 0);
28484 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28489 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28490 returns them in row/column units! */
28491 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28492 &object
, &dx
, &dy
, &width
, &height
);
28494 row
= (area
== ON_MODE_LINE
28495 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28496 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28498 /* Find the glyph under the mouse pointer. */
28499 if (row
->mode_line_p
&& row
->enabled_p
)
28501 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28502 end
= glyph
+ row
->used
[TEXT_AREA
];
28504 for (x0
= original_x_pixel
;
28505 glyph
< end
&& x0
>= glyph
->pixel_width
;
28507 x0
-= glyph
->pixel_width
;
28515 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28516 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28517 returns them in row/column units! */
28518 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28519 &object
, &dx
, &dy
, &width
, &height
);
28524 #ifdef HAVE_WINDOW_SYSTEM
28525 if (IMAGEP (object
))
28527 Lisp_Object image_map
, hotspot
;
28528 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28530 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28532 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28536 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28537 If so, we could look for mouse-enter, mouse-leave
28538 properties in PLIST (and do something...). */
28539 hotspot
= XCDR (hotspot
);
28540 if (CONSP (hotspot
)
28541 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28543 pointer
= Fplist_get (plist
, Qpointer
);
28544 if (NILP (pointer
))
28546 help
= Fplist_get (plist
, Qhelp_echo
);
28549 help_echo_string
= help
;
28550 XSETWINDOW (help_echo_window
, w
);
28551 help_echo_object
= w
->contents
;
28552 help_echo_pos
= charpos
;
28556 if (NILP (pointer
))
28557 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28559 #endif /* HAVE_WINDOW_SYSTEM */
28561 if (STRINGP (string
))
28562 pos
= make_number (charpos
);
28564 /* Set the help text and mouse pointer. If the mouse is on a part
28565 of the mode line without any text (e.g. past the right edge of
28566 the mode line text), use the default help text and pointer. */
28567 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28569 /* Arrange to display the help by setting the global variables
28570 help_echo_string, help_echo_object, and help_echo_pos. */
28573 if (STRINGP (string
))
28574 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28578 help_echo_string
= help
;
28579 XSETWINDOW (help_echo_window
, w
);
28580 help_echo_object
= string
;
28581 help_echo_pos
= charpos
;
28583 else if (area
== ON_MODE_LINE
)
28585 Lisp_Object default_help
28586 = buffer_local_value (Qmode_line_default_help_echo
,
28589 if (STRINGP (default_help
))
28591 help_echo_string
= default_help
;
28592 XSETWINDOW (help_echo_window
, w
);
28593 help_echo_object
= Qnil
;
28594 help_echo_pos
= -1;
28599 #ifdef HAVE_WINDOW_SYSTEM
28600 /* Change the mouse pointer according to what is under it. */
28601 if (FRAME_WINDOW_P (f
))
28603 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28605 || NILP (Vresize_mini_windows
));
28607 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28608 if (STRINGP (string
))
28610 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28612 if (NILP (pointer
))
28613 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28615 /* Change the mouse pointer according to what is under X/Y. */
28617 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28620 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28621 if (!KEYMAPP (map
))
28622 map
= Fget_text_property (pos
, Qkeymap
, string
);
28623 if (!KEYMAPP (map
) && draggable
)
28624 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28627 else if (draggable
)
28628 /* Default mode-line pointer. */
28629 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28634 /* Change the mouse face according to what is under X/Y. */
28635 if (STRINGP (string
))
28637 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28638 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28639 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28644 struct glyph
* tmp_glyph
;
28648 int total_pixel_width
;
28649 ptrdiff_t begpos
, endpos
, ignore
;
28653 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28654 Qmouse_face
, string
, Qnil
);
28660 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28662 endpos
= SCHARS (string
);
28666 /* Calculate the glyph position GPOS of GLYPH in the
28667 displayed string, relative to the beginning of the
28668 highlighted part of the string.
28670 Note: GPOS is different from CHARPOS. CHARPOS is the
28671 position of GLYPH in the internal string object. A mode
28672 line string format has structures which are converted to
28673 a flattened string by the Emacs Lisp interpreter. The
28674 internal string is an element of those structures. The
28675 displayed string is the flattened string. */
28676 tmp_glyph
= row_start_glyph
;
28677 while (tmp_glyph
< glyph
28678 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28679 && begpos
<= tmp_glyph
->charpos
28680 && tmp_glyph
->charpos
< endpos
)))
28682 gpos
= glyph
- tmp_glyph
;
28684 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28685 the highlighted part of the displayed string to which
28686 GLYPH belongs. Note: GSEQ_LENGTH is different from
28687 SCHARS (STRING), because the latter returns the length of
28688 the internal string. */
28689 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28691 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28692 && begpos
<= tmp_glyph
->charpos
28693 && tmp_glyph
->charpos
< endpos
));
28696 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28698 /* Calculate the total pixel width of all the glyphs between
28699 the beginning of the highlighted area and GLYPH. */
28700 total_pixel_width
= 0;
28701 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28702 total_pixel_width
+= tmp_glyph
->pixel_width
;
28704 /* Pre calculation of re-rendering position. Note: X is in
28705 column units here, after the call to mode_line_string or
28706 marginal_area_string. */
28708 vpos
= (area
== ON_MODE_LINE
28709 ? (w
->current_matrix
)->nrows
- 1
28712 /* If GLYPH's position is included in the region that is
28713 already drawn in mouse face, we have nothing to do. */
28714 if ( EQ (window
, hlinfo
->mouse_face_window
)
28715 && (!row
->reversed_p
28716 ? (hlinfo
->mouse_face_beg_col
<= hpos
28717 && hpos
< hlinfo
->mouse_face_end_col
)
28718 /* In R2L rows we swap BEG and END, see below. */
28719 : (hlinfo
->mouse_face_end_col
<= hpos
28720 && hpos
< hlinfo
->mouse_face_beg_col
))
28721 && hlinfo
->mouse_face_beg_row
== vpos
)
28724 if (clear_mouse_face (hlinfo
))
28725 cursor
= No_Cursor
;
28727 if (!row
->reversed_p
)
28729 hlinfo
->mouse_face_beg_col
= hpos
;
28730 hlinfo
->mouse_face_beg_x
= original_x_pixel
28731 - (total_pixel_width
+ dx
);
28732 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28733 hlinfo
->mouse_face_end_x
= 0;
28737 /* In R2L rows, show_mouse_face expects BEG and END
28738 coordinates to be swapped. */
28739 hlinfo
->mouse_face_end_col
= hpos
;
28740 hlinfo
->mouse_face_end_x
= original_x_pixel
28741 - (total_pixel_width
+ dx
);
28742 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28743 hlinfo
->mouse_face_beg_x
= 0;
28746 hlinfo
->mouse_face_beg_row
= vpos
;
28747 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28748 hlinfo
->mouse_face_past_end
= 0;
28749 hlinfo
->mouse_face_window
= window
;
28751 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28756 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28758 if (NILP (pointer
))
28761 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28762 clear_mouse_face (hlinfo
);
28764 #ifdef HAVE_WINDOW_SYSTEM
28765 if (FRAME_WINDOW_P (f
))
28766 define_frame_cursor1 (f
, cursor
, pointer
);
28772 Take proper action when the mouse has moved to position X, Y on
28773 frame F with regards to highlighting portions of display that have
28774 mouse-face properties. Also de-highlight portions of display where
28775 the mouse was before, set the mouse pointer shape as appropriate
28776 for the mouse coordinates, and activate help echo (tooltips).
28777 X and Y can be negative or out of range. */
28780 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28782 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28783 enum window_part part
= ON_NOTHING
;
28784 Lisp_Object window
;
28786 Cursor cursor
= No_Cursor
;
28787 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28790 /* When a menu is active, don't highlight because this looks odd. */
28791 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28792 if (popup_activated ())
28796 if (!f
->glyphs_initialized_p
28797 || f
->pointer_invisible
)
28800 hlinfo
->mouse_face_mouse_x
= x
;
28801 hlinfo
->mouse_face_mouse_y
= y
;
28802 hlinfo
->mouse_face_mouse_frame
= f
;
28804 if (hlinfo
->mouse_face_defer
)
28807 /* Which window is that in? */
28808 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28810 /* If displaying active text in another window, clear that. */
28811 if (! EQ (window
, hlinfo
->mouse_face_window
)
28812 /* Also clear if we move out of text area in same window. */
28813 || (!NILP (hlinfo
->mouse_face_window
)
28816 && part
!= ON_MODE_LINE
28817 && part
!= ON_HEADER_LINE
))
28818 clear_mouse_face (hlinfo
);
28820 /* Not on a window -> return. */
28821 if (!WINDOWP (window
))
28824 /* Reset help_echo_string. It will get recomputed below. */
28825 help_echo_string
= Qnil
;
28827 /* Convert to window-relative pixel coordinates. */
28828 w
= XWINDOW (window
);
28829 frame_to_window_pixel_xy (w
, &x
, &y
);
28831 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28832 /* Handle tool-bar window differently since it doesn't display a
28834 if (EQ (window
, f
->tool_bar_window
))
28836 note_tool_bar_highlight (f
, x
, y
);
28841 /* Mouse is on the mode, header line or margin? */
28842 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28843 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28845 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28847 #ifdef HAVE_WINDOW_SYSTEM
28848 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28850 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28851 /* Show non-text cursor (Bug#16647). */
28859 #ifdef HAVE_WINDOW_SYSTEM
28860 if (part
== ON_VERTICAL_BORDER
)
28862 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28863 help_echo_string
= build_string ("drag-mouse-1: resize");
28865 else if (part
== ON_RIGHT_DIVIDER
)
28867 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28868 help_echo_string
= build_string ("drag-mouse-1: resize");
28870 else if (part
== ON_BOTTOM_DIVIDER
)
28871 if (! WINDOW_BOTTOMMOST_P (w
)
28873 || NILP (Vresize_mini_windows
))
28875 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28876 help_echo_string
= build_string ("drag-mouse-1: resize");
28879 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28880 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28881 || part
== ON_SCROLL_BAR
)
28882 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28884 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28887 /* Are we in a window whose display is up to date?
28888 And verify the buffer's text has not changed. */
28889 b
= XBUFFER (w
->contents
);
28890 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28892 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28894 struct glyph
*glyph
;
28895 Lisp_Object object
;
28896 Lisp_Object mouse_face
= Qnil
, position
;
28897 Lisp_Object
*overlay_vec
= NULL
;
28898 ptrdiff_t i
, noverlays
;
28899 struct buffer
*obuf
;
28900 ptrdiff_t obegv
, ozv
;
28903 /* Find the glyph under X/Y. */
28904 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28906 #ifdef HAVE_WINDOW_SYSTEM
28907 /* Look for :pointer property on image. */
28908 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28910 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28911 if (img
!= NULL
&& IMAGEP (img
->spec
))
28913 Lisp_Object image_map
, hotspot
;
28914 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28916 && (hotspot
= find_hot_spot (image_map
,
28917 glyph
->slice
.img
.x
+ dx
,
28918 glyph
->slice
.img
.y
+ dy
),
28920 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28924 /* Could check XCAR (hotspot) to see if we enter/leave
28926 If so, we could look for mouse-enter, mouse-leave
28927 properties in PLIST (and do something...). */
28928 hotspot
= XCDR (hotspot
);
28929 if (CONSP (hotspot
)
28930 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28932 pointer
= Fplist_get (plist
, Qpointer
);
28933 if (NILP (pointer
))
28935 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28936 if (!NILP (help_echo_string
))
28938 help_echo_window
= window
;
28939 help_echo_object
= glyph
->object
;
28940 help_echo_pos
= glyph
->charpos
;
28944 if (NILP (pointer
))
28945 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28948 #endif /* HAVE_WINDOW_SYSTEM */
28950 /* Clear mouse face if X/Y not over text. */
28952 || area
!= TEXT_AREA
28953 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
28954 /* Glyph's OBJECT is an integer for glyphs inserted by the
28955 display engine for its internal purposes, like truncation
28956 and continuation glyphs and blanks beyond the end of
28957 line's text on text terminals. If we are over such a
28958 glyph, we are not over any text. */
28959 || INTEGERP (glyph
->object
)
28960 /* R2L rows have a stretch glyph at their front, which
28961 stands for no text, whereas L2R rows have no glyphs at
28962 all beyond the end of text. Treat such stretch glyphs
28963 like we do with NULL glyphs in L2R rows. */
28964 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28965 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
28966 && glyph
->type
== STRETCH_GLYPH
28967 && glyph
->avoid_cursor_p
))
28969 if (clear_mouse_face (hlinfo
))
28970 cursor
= No_Cursor
;
28971 #ifdef HAVE_WINDOW_SYSTEM
28972 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28974 if (area
!= TEXT_AREA
)
28975 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28977 pointer
= Vvoid_text_area_pointer
;
28983 pos
= glyph
->charpos
;
28984 object
= glyph
->object
;
28985 if (!STRINGP (object
) && !BUFFERP (object
))
28988 /* If we get an out-of-range value, return now; avoid an error. */
28989 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28992 /* Make the window's buffer temporarily current for
28993 overlays_at and compute_char_face. */
28994 obuf
= current_buffer
;
28995 current_buffer
= b
;
29001 /* Is this char mouse-active or does it have help-echo? */
29002 position
= make_number (pos
);
29004 if (BUFFERP (object
))
29006 /* Put all the overlays we want in a vector in overlay_vec. */
29007 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29008 /* Sort overlays into increasing priority order. */
29009 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29014 if (NILP (Vmouse_highlight
))
29016 clear_mouse_face (hlinfo
);
29017 goto check_help_echo
;
29020 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29023 cursor
= No_Cursor
;
29025 /* Check mouse-face highlighting. */
29027 /* If there exists an overlay with mouse-face overlapping
29028 the one we are currently highlighting, we have to
29029 check if we enter the overlapping overlay, and then
29030 highlight only that. */
29031 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29032 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29034 /* Find the highest priority overlay with a mouse-face. */
29035 Lisp_Object overlay
= Qnil
;
29036 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29038 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29039 if (!NILP (mouse_face
))
29040 overlay
= overlay_vec
[i
];
29043 /* If we're highlighting the same overlay as before, there's
29044 no need to do that again. */
29045 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29046 goto check_help_echo
;
29047 hlinfo
->mouse_face_overlay
= overlay
;
29049 /* Clear the display of the old active region, if any. */
29050 if (clear_mouse_face (hlinfo
))
29051 cursor
= No_Cursor
;
29053 /* If no overlay applies, get a text property. */
29054 if (NILP (overlay
))
29055 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29057 /* Next, compute the bounds of the mouse highlighting and
29059 if (!NILP (mouse_face
) && STRINGP (object
))
29061 /* The mouse-highlighting comes from a display string
29062 with a mouse-face. */
29066 s
= Fprevious_single_property_change
29067 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29068 e
= Fnext_single_property_change
29069 (position
, Qmouse_face
, object
, Qnil
);
29071 s
= make_number (0);
29073 e
= make_number (SCHARS (object
));
29074 mouse_face_from_string_pos (w
, hlinfo
, object
,
29075 XINT (s
), XINT (e
));
29076 hlinfo
->mouse_face_past_end
= 0;
29077 hlinfo
->mouse_face_window
= window
;
29078 hlinfo
->mouse_face_face_id
29079 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29080 glyph
->face_id
, 1);
29081 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29082 cursor
= No_Cursor
;
29086 /* The mouse-highlighting, if any, comes from an overlay
29087 or text property in the buffer. */
29088 Lisp_Object buffer
IF_LINT (= Qnil
);
29089 Lisp_Object disp_string
IF_LINT (= Qnil
);
29091 if (STRINGP (object
))
29093 /* If we are on a display string with no mouse-face,
29094 check if the text under it has one. */
29095 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29096 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29097 pos
= string_buffer_position (object
, start
);
29100 mouse_face
= get_char_property_and_overlay
29101 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29102 buffer
= w
->contents
;
29103 disp_string
= object
;
29109 disp_string
= Qnil
;
29112 if (!NILP (mouse_face
))
29114 Lisp_Object before
, after
;
29115 Lisp_Object before_string
, after_string
;
29116 /* To correctly find the limits of mouse highlight
29117 in a bidi-reordered buffer, we must not use the
29118 optimization of limiting the search in
29119 previous-single-property-change and
29120 next-single-property-change, because
29121 rows_from_pos_range needs the real start and end
29122 positions to DTRT in this case. That's because
29123 the first row visible in a window does not
29124 necessarily display the character whose position
29125 is the smallest. */
29127 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29128 ? Fmarker_position (w
->start
)
29131 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29132 ? make_number (BUF_Z (XBUFFER (buffer
))
29133 - w
->window_end_pos
)
29136 if (NILP (overlay
))
29138 /* Handle the text property case. */
29139 before
= Fprevious_single_property_change
29140 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29141 after
= Fnext_single_property_change
29142 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29143 before_string
= after_string
= Qnil
;
29147 /* Handle the overlay case. */
29148 before
= Foverlay_start (overlay
);
29149 after
= Foverlay_end (overlay
);
29150 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29151 after_string
= Foverlay_get (overlay
, Qafter_string
);
29153 if (!STRINGP (before_string
)) before_string
= Qnil
;
29154 if (!STRINGP (after_string
)) after_string
= Qnil
;
29157 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29160 : XFASTINT (before
),
29162 ? BUF_Z (XBUFFER (buffer
))
29163 : XFASTINT (after
),
29164 before_string
, after_string
,
29166 cursor
= No_Cursor
;
29173 /* Look for a `help-echo' property. */
29174 if (NILP (help_echo_string
)) {
29175 Lisp_Object help
, overlay
;
29177 /* Check overlays first. */
29178 help
= overlay
= Qnil
;
29179 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29181 overlay
= overlay_vec
[i
];
29182 help
= Foverlay_get (overlay
, Qhelp_echo
);
29187 help_echo_string
= help
;
29188 help_echo_window
= window
;
29189 help_echo_object
= overlay
;
29190 help_echo_pos
= pos
;
29194 Lisp_Object obj
= glyph
->object
;
29195 ptrdiff_t charpos
= glyph
->charpos
;
29197 /* Try text properties. */
29200 && charpos
< SCHARS (obj
))
29202 help
= Fget_text_property (make_number (charpos
),
29206 /* If the string itself doesn't specify a help-echo,
29207 see if the buffer text ``under'' it does. */
29208 struct glyph_row
*r
29209 = MATRIX_ROW (w
->current_matrix
, vpos
);
29210 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29211 ptrdiff_t p
= string_buffer_position (obj
, start
);
29214 help
= Fget_char_property (make_number (p
),
29215 Qhelp_echo
, w
->contents
);
29224 else if (BUFFERP (obj
)
29227 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29232 help_echo_string
= help
;
29233 help_echo_window
= window
;
29234 help_echo_object
= obj
;
29235 help_echo_pos
= charpos
;
29240 #ifdef HAVE_WINDOW_SYSTEM
29241 /* Look for a `pointer' property. */
29242 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29244 /* Check overlays first. */
29245 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29246 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29248 if (NILP (pointer
))
29250 Lisp_Object obj
= glyph
->object
;
29251 ptrdiff_t charpos
= glyph
->charpos
;
29253 /* Try text properties. */
29256 && charpos
< SCHARS (obj
))
29258 pointer
= Fget_text_property (make_number (charpos
),
29260 if (NILP (pointer
))
29262 /* If the string itself doesn't specify a pointer,
29263 see if the buffer text ``under'' it does. */
29264 struct glyph_row
*r
29265 = MATRIX_ROW (w
->current_matrix
, vpos
);
29266 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29267 ptrdiff_t p
= string_buffer_position (obj
, start
);
29269 pointer
= Fget_char_property (make_number (p
),
29270 Qpointer
, w
->contents
);
29273 else if (BUFFERP (obj
)
29276 pointer
= Fget_text_property (make_number (charpos
),
29280 #endif /* HAVE_WINDOW_SYSTEM */
29284 current_buffer
= obuf
;
29289 #ifdef HAVE_WINDOW_SYSTEM
29290 if (FRAME_WINDOW_P (f
))
29291 define_frame_cursor1 (f
, cursor
, pointer
);
29293 /* This is here to prevent a compiler error, about "label at end of
29294 compound statement". */
29301 Clear any mouse-face on window W. This function is part of the
29302 redisplay interface, and is called from try_window_id and similar
29303 functions to ensure the mouse-highlight is off. */
29306 x_clear_window_mouse_face (struct window
*w
)
29308 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29309 Lisp_Object window
;
29312 XSETWINDOW (window
, w
);
29313 if (EQ (window
, hlinfo
->mouse_face_window
))
29314 clear_mouse_face (hlinfo
);
29320 Just discard the mouse face information for frame F, if any.
29321 This is used when the size of F is changed. */
29324 cancel_mouse_face (struct frame
*f
)
29326 Lisp_Object window
;
29327 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29329 window
= hlinfo
->mouse_face_window
;
29330 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29331 reset_mouse_highlight (hlinfo
);
29336 /***********************************************************************
29338 ***********************************************************************/
29340 #ifdef HAVE_WINDOW_SYSTEM
29342 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29343 which intersects rectangle R. R is in window-relative coordinates. */
29346 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29347 enum glyph_row_area area
)
29349 struct glyph
*first
= row
->glyphs
[area
];
29350 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29351 struct glyph
*last
;
29352 int first_x
, start_x
, x
;
29354 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29355 /* If row extends face to end of line write the whole line. */
29356 draw_glyphs (w
, 0, row
, area
,
29357 0, row
->used
[area
],
29358 DRAW_NORMAL_TEXT
, 0);
29361 /* Set START_X to the window-relative start position for drawing glyphs of
29362 AREA. The first glyph of the text area can be partially visible.
29363 The first glyphs of other areas cannot. */
29364 start_x
= window_box_left_offset (w
, area
);
29366 if (area
== TEXT_AREA
)
29369 /* Find the first glyph that must be redrawn. */
29371 && x
+ first
->pixel_width
< r
->x
)
29373 x
+= first
->pixel_width
;
29377 /* Find the last one. */
29381 && x
< r
->x
+ r
->width
)
29383 x
+= last
->pixel_width
;
29389 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29390 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29391 DRAW_NORMAL_TEXT
, 0);
29396 /* Redraw the parts of the glyph row ROW on window W intersecting
29397 rectangle R. R is in window-relative coordinates. Value is
29398 non-zero if mouse-face was overwritten. */
29401 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29403 eassert (row
->enabled_p
);
29405 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29406 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29407 0, row
->used
[TEXT_AREA
],
29408 DRAW_NORMAL_TEXT
, 0);
29411 if (row
->used
[LEFT_MARGIN_AREA
])
29412 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29413 if (row
->used
[TEXT_AREA
])
29414 expose_area (w
, row
, r
, TEXT_AREA
);
29415 if (row
->used
[RIGHT_MARGIN_AREA
])
29416 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29417 draw_row_fringe_bitmaps (w
, row
);
29420 return row
->mouse_face_p
;
29424 /* Redraw those parts of glyphs rows during expose event handling that
29425 overlap other rows. Redrawing of an exposed line writes over parts
29426 of lines overlapping that exposed line; this function fixes that.
29428 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29429 row in W's current matrix that is exposed and overlaps other rows.
29430 LAST_OVERLAPPING_ROW is the last such row. */
29433 expose_overlaps (struct window
*w
,
29434 struct glyph_row
*first_overlapping_row
,
29435 struct glyph_row
*last_overlapping_row
,
29438 struct glyph_row
*row
;
29440 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29441 if (row
->overlapping_p
)
29443 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29446 if (row
->used
[LEFT_MARGIN_AREA
])
29447 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29449 if (row
->used
[TEXT_AREA
])
29450 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29452 if (row
->used
[RIGHT_MARGIN_AREA
])
29453 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29459 /* Return non-zero if W's cursor intersects rectangle R. */
29462 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29464 XRectangle cr
, result
;
29465 struct glyph
*cursor_glyph
;
29466 struct glyph_row
*row
;
29468 if (w
->phys_cursor
.vpos
>= 0
29469 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29470 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29472 && row
->cursor_in_fringe_p
)
29474 /* Cursor is in the fringe. */
29475 cr
.x
= window_box_right_offset (w
,
29476 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29477 ? RIGHT_MARGIN_AREA
29480 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29481 cr
.height
= row
->height
;
29482 return x_intersect_rectangles (&cr
, r
, &result
);
29485 cursor_glyph
= get_phys_cursor_glyph (w
);
29488 /* r is relative to W's box, but w->phys_cursor.x is relative
29489 to left edge of W's TEXT area. Adjust it. */
29490 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29491 cr
.y
= w
->phys_cursor
.y
;
29492 cr
.width
= cursor_glyph
->pixel_width
;
29493 cr
.height
= w
->phys_cursor_height
;
29494 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29495 I assume the effect is the same -- and this is portable. */
29496 return x_intersect_rectangles (&cr
, r
, &result
);
29498 /* If we don't understand the format, pretend we're not in the hot-spot. */
29504 Draw a vertical window border to the right of window W if W doesn't
29505 have vertical scroll bars. */
29508 x_draw_vertical_border (struct window
*w
)
29510 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29512 /* We could do better, if we knew what type of scroll-bar the adjacent
29513 windows (on either side) have... But we don't :-(
29514 However, I think this works ok. ++KFS 2003-04-25 */
29516 /* Redraw borders between horizontally adjacent windows. Don't
29517 do it for frames with vertical scroll bars because either the
29518 right scroll bar of a window, or the left scroll bar of its
29519 neighbor will suffice as a border. */
29520 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29523 /* Note: It is necessary to redraw both the left and the right
29524 borders, for when only this single window W is being
29526 if (!WINDOW_RIGHTMOST_P (w
)
29527 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29529 int x0
, x1
, y0
, y1
;
29531 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29534 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29537 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29540 if (!WINDOW_LEFTMOST_P (w
)
29541 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29543 int x0
, x1
, y0
, y1
;
29545 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29548 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29551 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29556 /* Draw window dividers for window W. */
29559 x_draw_right_divider (struct window
*w
)
29561 struct frame
*f
= WINDOW_XFRAME (w
);
29563 if (w
->mini
|| w
->pseudo_window_p
)
29565 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29567 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29568 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29569 int y0
= WINDOW_TOP_EDGE_Y (w
);
29570 /* The bottom divider prevails. */
29571 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29573 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29578 x_draw_bottom_divider (struct window
*w
)
29580 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29582 if (w
->mini
|| w
->pseudo_window_p
)
29584 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29586 int x0
= WINDOW_LEFT_EDGE_X (w
);
29587 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29588 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29589 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29591 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29595 /* Redraw the part of window W intersection rectangle FR. Pixel
29596 coordinates in FR are frame-relative. Call this function with
29597 input blocked. Value is non-zero if the exposure overwrites
29601 expose_window (struct window
*w
, XRectangle
*fr
)
29603 struct frame
*f
= XFRAME (w
->frame
);
29605 int mouse_face_overwritten_p
= 0;
29607 /* If window is not yet fully initialized, do nothing. This can
29608 happen when toolkit scroll bars are used and a window is split.
29609 Reconfiguring the scroll bar will generate an expose for a newly
29611 if (w
->current_matrix
== NULL
)
29614 /* When we're currently updating the window, display and current
29615 matrix usually don't agree. Arrange for a thorough display
29617 if (w
->must_be_updated_p
)
29619 SET_FRAME_GARBAGED (f
);
29623 /* Frame-relative pixel rectangle of W. */
29624 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29625 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29626 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29627 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29629 if (x_intersect_rectangles (fr
, &wr
, &r
))
29631 int yb
= window_text_bottom_y (w
);
29632 struct glyph_row
*row
;
29633 int cursor_cleared_p
, phys_cursor_on_p
;
29634 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29636 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29637 r
.x
, r
.y
, r
.width
, r
.height
));
29639 /* Convert to window coordinates. */
29640 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29641 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29643 /* Turn off the cursor. */
29644 if (!w
->pseudo_window_p
29645 && phys_cursor_in_rect_p (w
, &r
))
29647 x_clear_cursor (w
);
29648 cursor_cleared_p
= 1;
29651 cursor_cleared_p
= 0;
29653 /* If the row containing the cursor extends face to end of line,
29654 then expose_area might overwrite the cursor outside the
29655 rectangle and thus notice_overwritten_cursor might clear
29656 w->phys_cursor_on_p. We remember the original value and
29657 check later if it is changed. */
29658 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29660 /* Update lines intersecting rectangle R. */
29661 first_overlapping_row
= last_overlapping_row
= NULL
;
29662 for (row
= w
->current_matrix
->rows
;
29667 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29669 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29670 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29671 || (r
.y
>= y0
&& r
.y
< y1
)
29672 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29674 /* A header line may be overlapping, but there is no need
29675 to fix overlapping areas for them. KFS 2005-02-12 */
29676 if (row
->overlapping_p
&& !row
->mode_line_p
)
29678 if (first_overlapping_row
== NULL
)
29679 first_overlapping_row
= row
;
29680 last_overlapping_row
= row
;
29684 if (expose_line (w
, row
, &r
))
29685 mouse_face_overwritten_p
= 1;
29688 else if (row
->overlapping_p
)
29690 /* We must redraw a row overlapping the exposed area. */
29692 ? y0
+ row
->phys_height
> r
.y
29693 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29695 if (first_overlapping_row
== NULL
)
29696 first_overlapping_row
= row
;
29697 last_overlapping_row
= row
;
29705 /* Display the mode line if there is one. */
29706 if (WINDOW_WANTS_MODELINE_P (w
)
29707 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29709 && row
->y
< r
.y
+ r
.height
)
29711 if (expose_line (w
, row
, &r
))
29712 mouse_face_overwritten_p
= 1;
29715 if (!w
->pseudo_window_p
)
29717 /* Fix the display of overlapping rows. */
29718 if (first_overlapping_row
)
29719 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29722 /* Draw border between windows. */
29723 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29724 x_draw_right_divider (w
);
29726 x_draw_vertical_border (w
);
29728 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29729 x_draw_bottom_divider (w
);
29731 /* Turn the cursor on again. */
29732 if (cursor_cleared_p
29733 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29734 update_window_cursor (w
, 1);
29738 return mouse_face_overwritten_p
;
29743 /* Redraw (parts) of all windows in the window tree rooted at W that
29744 intersect R. R contains frame pixel coordinates. Value is
29745 non-zero if the exposure overwrites mouse-face. */
29748 expose_window_tree (struct window
*w
, XRectangle
*r
)
29750 struct frame
*f
= XFRAME (w
->frame
);
29751 int mouse_face_overwritten_p
= 0;
29753 while (w
&& !FRAME_GARBAGED_P (f
))
29755 if (WINDOWP (w
->contents
))
29756 mouse_face_overwritten_p
29757 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29759 mouse_face_overwritten_p
|= expose_window (w
, r
);
29761 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29764 return mouse_face_overwritten_p
;
29769 Redisplay an exposed area of frame F. X and Y are the upper-left
29770 corner of the exposed rectangle. W and H are width and height of
29771 the exposed area. All are pixel values. W or H zero means redraw
29772 the entire frame. */
29775 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29778 int mouse_face_overwritten_p
= 0;
29780 TRACE ((stderr
, "expose_frame "));
29782 /* No need to redraw if frame will be redrawn soon. */
29783 if (FRAME_GARBAGED_P (f
))
29785 TRACE ((stderr
, " garbaged\n"));
29789 /* If basic faces haven't been realized yet, there is no point in
29790 trying to redraw anything. This can happen when we get an expose
29791 event while Emacs is starting, e.g. by moving another window. */
29792 if (FRAME_FACE_CACHE (f
) == NULL
29793 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29795 TRACE ((stderr
, " no faces\n"));
29799 if (w
== 0 || h
== 0)
29802 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29803 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29813 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29814 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29816 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29817 if (WINDOWP (f
->tool_bar_window
))
29818 mouse_face_overwritten_p
29819 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29822 #ifdef HAVE_X_WINDOWS
29824 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29825 if (WINDOWP (f
->menu_bar_window
))
29826 mouse_face_overwritten_p
29827 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29828 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29832 /* Some window managers support a focus-follows-mouse style with
29833 delayed raising of frames. Imagine a partially obscured frame,
29834 and moving the mouse into partially obscured mouse-face on that
29835 frame. The visible part of the mouse-face will be highlighted,
29836 then the WM raises the obscured frame. With at least one WM, KDE
29837 2.1, Emacs is not getting any event for the raising of the frame
29838 (even tried with SubstructureRedirectMask), only Expose events.
29839 These expose events will draw text normally, i.e. not
29840 highlighted. Which means we must redo the highlight here.
29841 Subsume it under ``we love X''. --gerd 2001-08-15 */
29842 /* Included in Windows version because Windows most likely does not
29843 do the right thing if any third party tool offers
29844 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29845 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29847 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29848 if (f
== hlinfo
->mouse_face_mouse_frame
)
29850 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29851 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29852 clear_mouse_face (hlinfo
);
29853 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29860 Determine the intersection of two rectangles R1 and R2. Return
29861 the intersection in *RESULT. Value is non-zero if RESULT is not
29865 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29867 XRectangle
*left
, *right
;
29868 XRectangle
*upper
, *lower
;
29869 int intersection_p
= 0;
29871 /* Rearrange so that R1 is the left-most rectangle. */
29873 left
= r1
, right
= r2
;
29875 left
= r2
, right
= r1
;
29877 /* X0 of the intersection is right.x0, if this is inside R1,
29878 otherwise there is no intersection. */
29879 if (right
->x
<= left
->x
+ left
->width
)
29881 result
->x
= right
->x
;
29883 /* The right end of the intersection is the minimum of
29884 the right ends of left and right. */
29885 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29888 /* Same game for Y. */
29890 upper
= r1
, lower
= r2
;
29892 upper
= r2
, lower
= r1
;
29894 /* The upper end of the intersection is lower.y0, if this is inside
29895 of upper. Otherwise, there is no intersection. */
29896 if (lower
->y
<= upper
->y
+ upper
->height
)
29898 result
->y
= lower
->y
;
29900 /* The lower end of the intersection is the minimum of the lower
29901 ends of upper and lower. */
29902 result
->height
= (min (lower
->y
+ lower
->height
,
29903 upper
->y
+ upper
->height
)
29905 intersection_p
= 1;
29909 return intersection_p
;
29912 #endif /* HAVE_WINDOW_SYSTEM */
29915 /***********************************************************************
29917 ***********************************************************************/
29920 syms_of_xdisp (void)
29922 Vwith_echo_area_save_vector
= Qnil
;
29923 staticpro (&Vwith_echo_area_save_vector
);
29925 Vmessage_stack
= Qnil
;
29926 staticpro (&Vmessage_stack
);
29928 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29929 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29931 message_dolog_marker1
= Fmake_marker ();
29932 staticpro (&message_dolog_marker1
);
29933 message_dolog_marker2
= Fmake_marker ();
29934 staticpro (&message_dolog_marker2
);
29935 message_dolog_marker3
= Fmake_marker ();
29936 staticpro (&message_dolog_marker3
);
29939 defsubr (&Sdump_frame_glyph_matrix
);
29940 defsubr (&Sdump_glyph_matrix
);
29941 defsubr (&Sdump_glyph_row
);
29942 defsubr (&Sdump_tool_bar_row
);
29943 defsubr (&Strace_redisplay
);
29944 defsubr (&Strace_to_stderr
);
29946 #ifdef HAVE_WINDOW_SYSTEM
29947 defsubr (&Stool_bar_height
);
29948 defsubr (&Slookup_image_map
);
29950 defsubr (&Sline_pixel_height
);
29951 defsubr (&Sformat_mode_line
);
29952 defsubr (&Sinvisible_p
);
29953 defsubr (&Scurrent_bidi_paragraph_direction
);
29954 defsubr (&Swindow_text_pixel_size
);
29955 defsubr (&Smove_point_visually
);
29957 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29958 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29959 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29960 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29961 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29962 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29963 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29964 DEFSYM (Qeval
, "eval");
29965 DEFSYM (QCdata
, ":data");
29966 DEFSYM (Qdisplay
, "display");
29967 DEFSYM (Qspace_width
, "space-width");
29968 DEFSYM (Qraise
, "raise");
29969 DEFSYM (Qslice
, "slice");
29970 DEFSYM (Qspace
, "space");
29971 DEFSYM (Qmargin
, "margin");
29972 DEFSYM (Qpointer
, "pointer");
29973 DEFSYM (Qleft_margin
, "left-margin");
29974 DEFSYM (Qright_margin
, "right-margin");
29975 DEFSYM (Qcenter
, "center");
29976 DEFSYM (Qline_height
, "line-height");
29977 DEFSYM (QCalign_to
, ":align-to");
29978 DEFSYM (QCrelative_width
, ":relative-width");
29979 DEFSYM (QCrelative_height
, ":relative-height");
29980 DEFSYM (QCeval
, ":eval");
29981 DEFSYM (QCpropertize
, ":propertize");
29982 DEFSYM (QCfile
, ":file");
29983 DEFSYM (Qfontified
, "fontified");
29984 DEFSYM (Qfontification_functions
, "fontification-functions");
29985 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29986 DEFSYM (Qescape_glyph
, "escape-glyph");
29987 DEFSYM (Qnobreak_space
, "nobreak-space");
29988 DEFSYM (Qimage
, "image");
29989 DEFSYM (Qtext
, "text");
29990 DEFSYM (Qboth
, "both");
29991 DEFSYM (Qboth_horiz
, "both-horiz");
29992 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29993 DEFSYM (QCmap
, ":map");
29994 DEFSYM (QCpointer
, ":pointer");
29995 DEFSYM (Qrect
, "rect");
29996 DEFSYM (Qcircle
, "circle");
29997 DEFSYM (Qpoly
, "poly");
29998 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29999 DEFSYM (Qgrow_only
, "grow-only");
30000 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30001 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30002 DEFSYM (Qposition
, "position");
30003 DEFSYM (Qbuffer_position
, "buffer-position");
30004 DEFSYM (Qobject
, "object");
30005 DEFSYM (Qbar
, "bar");
30006 DEFSYM (Qhbar
, "hbar");
30007 DEFSYM (Qbox
, "box");
30008 DEFSYM (Qhollow
, "hollow");
30009 DEFSYM (Qhand
, "hand");
30010 DEFSYM (Qarrow
, "arrow");
30011 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30013 list_of_error
= list1 (list2 (intern_c_string ("error"),
30014 intern_c_string ("void-variable")));
30015 staticpro (&list_of_error
);
30017 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30018 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30019 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30020 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30022 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30023 staticpro (&echo_buffer
[0]);
30024 staticpro (&echo_buffer
[1]);
30026 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30027 staticpro (&echo_area_buffer
[0]);
30028 staticpro (&echo_area_buffer
[1]);
30030 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30031 staticpro (&Vmessages_buffer_name
);
30033 mode_line_proptrans_alist
= Qnil
;
30034 staticpro (&mode_line_proptrans_alist
);
30035 mode_line_string_list
= Qnil
;
30036 staticpro (&mode_line_string_list
);
30037 mode_line_string_face
= Qnil
;
30038 staticpro (&mode_line_string_face
);
30039 mode_line_string_face_prop
= Qnil
;
30040 staticpro (&mode_line_string_face_prop
);
30041 Vmode_line_unwind_vector
= Qnil
;
30042 staticpro (&Vmode_line_unwind_vector
);
30044 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30046 help_echo_string
= Qnil
;
30047 staticpro (&help_echo_string
);
30048 help_echo_object
= Qnil
;
30049 staticpro (&help_echo_object
);
30050 help_echo_window
= Qnil
;
30051 staticpro (&help_echo_window
);
30052 previous_help_echo_string
= Qnil
;
30053 staticpro (&previous_help_echo_string
);
30054 help_echo_pos
= -1;
30056 DEFSYM (Qright_to_left
, "right-to-left");
30057 DEFSYM (Qleft_to_right
, "left-to-right");
30059 #ifdef HAVE_WINDOW_SYSTEM
30060 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30061 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30062 For example, if a block cursor is over a tab, it will be drawn as
30063 wide as that tab on the display. */);
30064 x_stretch_cursor_p
= 0;
30067 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30068 doc
: /* Non-nil means highlight trailing whitespace.
30069 The face used for trailing whitespace is `trailing-whitespace'. */);
30070 Vshow_trailing_whitespace
= Qnil
;
30072 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30073 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30074 If the value is t, Emacs highlights non-ASCII chars which have the
30075 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30076 or `escape-glyph' face respectively.
30078 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30079 U+2011 (non-breaking hyphen) are affected.
30081 Any other non-nil value means to display these characters as a escape
30082 glyph followed by an ordinary space or hyphen.
30084 A value of nil means no special handling of these characters. */);
30085 Vnobreak_char_display
= Qt
;
30087 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30088 doc
: /* The pointer shape to show in void text areas.
30089 A value of nil means to show the text pointer. Other options are `arrow',
30090 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30091 Vvoid_text_area_pointer
= Qarrow
;
30093 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30094 doc
: /* Non-nil means don't actually do any redisplay.
30095 This is used for internal purposes. */);
30096 Vinhibit_redisplay
= Qnil
;
30098 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30099 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30100 Vglobal_mode_string
= Qnil
;
30102 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30103 doc
: /* Marker for where to display an arrow on top of the buffer text.
30104 This must be the beginning of a line in order to work.
30105 See also `overlay-arrow-string'. */);
30106 Voverlay_arrow_position
= Qnil
;
30108 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30109 doc
: /* String to display as an arrow in non-window frames.
30110 See also `overlay-arrow-position'. */);
30111 Voverlay_arrow_string
= build_pure_c_string ("=>");
30113 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30114 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30115 The symbols on this list are examined during redisplay to determine
30116 where to display overlay arrows. */);
30117 Voverlay_arrow_variable_list
30118 = list1 (intern_c_string ("overlay-arrow-position"));
30120 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30121 doc
: /* The number of lines to try scrolling a window by when point moves out.
30122 If that fails to bring point back on frame, point is centered instead.
30123 If this is zero, point is always centered after it moves off frame.
30124 If you want scrolling to always be a line at a time, you should set
30125 `scroll-conservatively' to a large value rather than set this to 1. */);
30127 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30128 doc
: /* Scroll up to this many lines, to bring point back on screen.
30129 If point moves off-screen, redisplay will scroll by up to
30130 `scroll-conservatively' lines in order to bring point just barely
30131 onto the screen again. If that cannot be done, then redisplay
30132 recenters point as usual.
30134 If the value is greater than 100, redisplay will never recenter point,
30135 but will always scroll just enough text to bring point into view, even
30136 if you move far away.
30138 A value of zero means always recenter point if it moves off screen. */);
30139 scroll_conservatively
= 0;
30141 DEFVAR_INT ("scroll-margin", scroll_margin
,
30142 doc
: /* Number of lines of margin at the top and bottom of a window.
30143 Recenter the window whenever point gets within this many lines
30144 of the top or bottom of the window. */);
30147 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30148 doc
: /* Pixels per inch value for non-window system displays.
30149 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30150 Vdisplay_pixels_per_inch
= make_float (72.0);
30153 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30156 DEFVAR_LISP ("truncate-partial-width-windows",
30157 Vtruncate_partial_width_windows
,
30158 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30159 For an integer value, truncate lines in each window narrower than the
30160 full frame width, provided the window width is less than that integer;
30161 otherwise, respect the value of `truncate-lines'.
30163 For any other non-nil value, truncate lines in all windows that do
30164 not span the full frame width.
30166 A value of nil means to respect the value of `truncate-lines'.
30168 If `word-wrap' is enabled, you might want to reduce this. */);
30169 Vtruncate_partial_width_windows
= make_number (50);
30171 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30172 doc
: /* Maximum buffer size for which line number should be displayed.
30173 If the buffer is bigger than this, the line number does not appear
30174 in the mode line. A value of nil means no limit. */);
30175 Vline_number_display_limit
= Qnil
;
30177 DEFVAR_INT ("line-number-display-limit-width",
30178 line_number_display_limit_width
,
30179 doc
: /* Maximum line width (in characters) for line number display.
30180 If the average length of the lines near point is bigger than this, then the
30181 line number may be omitted from the mode line. */);
30182 line_number_display_limit_width
= 200;
30184 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30185 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30186 highlight_nonselected_windows
= 0;
30188 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30189 doc
: /* Non-nil if more than one frame is visible on this display.
30190 Minibuffer-only frames don't count, but iconified frames do.
30191 This variable is not guaranteed to be accurate except while processing
30192 `frame-title-format' and `icon-title-format'. */);
30194 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30195 doc
: /* Template for displaying the title bar of visible frames.
30196 \(Assuming the window manager supports this feature.)
30198 This variable has the same structure as `mode-line-format', except that
30199 the %c and %l constructs are ignored. It is used only on frames for
30200 which no explicit name has been set \(see `modify-frame-parameters'). */);
30202 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30203 doc
: /* Template for displaying the title bar of an iconified frame.
30204 \(Assuming the window manager supports this feature.)
30205 This variable has the same structure as `mode-line-format' (which see),
30206 and is used only on frames for which no explicit name has been set
30207 \(see `modify-frame-parameters'). */);
30209 = Vframe_title_format
30210 = listn (CONSTYPE_PURE
, 3,
30211 intern_c_string ("multiple-frames"),
30212 build_pure_c_string ("%b"),
30213 listn (CONSTYPE_PURE
, 4,
30214 empty_unibyte_string
,
30215 intern_c_string ("invocation-name"),
30216 build_pure_c_string ("@"),
30217 intern_c_string ("system-name")));
30219 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30220 doc
: /* Maximum number of lines to keep in the message log buffer.
30221 If nil, disable message logging. If t, log messages but don't truncate
30222 the buffer when it becomes large. */);
30223 Vmessage_log_max
= make_number (1000);
30225 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30226 doc
: /* Functions called before redisplay, if window sizes have changed.
30227 The value should be a list of functions that take one argument.
30228 Just before redisplay, for each frame, if any of its windows have changed
30229 size since the last redisplay, or have been split or deleted,
30230 all the functions in the list are called, with the frame as argument. */);
30231 Vwindow_size_change_functions
= Qnil
;
30233 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30234 doc
: /* List of functions to call before redisplaying a window with scrolling.
30235 Each function is called with two arguments, the window and its new
30236 display-start position. Note that these functions are also called by
30237 `set-window-buffer'. Also note that the value of `window-end' is not
30238 valid when these functions are called.
30240 Warning: Do not use this feature to alter the way the window
30241 is scrolled. It is not designed for that, and such use probably won't
30243 Vwindow_scroll_functions
= Qnil
;
30245 DEFVAR_LISP ("window-text-change-functions",
30246 Vwindow_text_change_functions
,
30247 doc
: /* Functions to call in redisplay when text in the window might change. */);
30248 Vwindow_text_change_functions
= Qnil
;
30250 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30251 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30252 Each function is called with two arguments, the window and the end trigger value.
30253 See `set-window-redisplay-end-trigger'. */);
30254 Vredisplay_end_trigger_functions
= Qnil
;
30256 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30257 doc
: /* Non-nil means autoselect window with mouse pointer.
30258 If nil, do not autoselect windows.
30259 A positive number means delay autoselection by that many seconds: a
30260 window is autoselected only after the mouse has remained in that
30261 window for the duration of the delay.
30262 A negative number has a similar effect, but causes windows to be
30263 autoselected only after the mouse has stopped moving. \(Because of
30264 the way Emacs compares mouse events, you will occasionally wait twice
30265 that time before the window gets selected.\)
30266 Any other value means to autoselect window instantaneously when the
30267 mouse pointer enters it.
30269 Autoselection selects the minibuffer only if it is active, and never
30270 unselects the minibuffer if it is active.
30272 When customizing this variable make sure that the actual value of
30273 `focus-follows-mouse' matches the behavior of your window manager. */);
30274 Vmouse_autoselect_window
= Qnil
;
30276 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30277 doc
: /* Non-nil means automatically resize tool-bars.
30278 This dynamically changes the tool-bar's height to the minimum height
30279 that is needed to make all tool-bar items visible.
30280 If value is `grow-only', the tool-bar's height is only increased
30281 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30282 Vauto_resize_tool_bars
= Qt
;
30284 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30285 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30286 auto_raise_tool_bar_buttons_p
= 1;
30288 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30289 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30290 make_cursor_line_fully_visible_p
= 1;
30292 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30293 doc
: /* Border below tool-bar in pixels.
30294 If an integer, use it as the height of the border.
30295 If it is one of `internal-border-width' or `border-width', use the
30296 value of the corresponding frame parameter.
30297 Otherwise, no border is added below the tool-bar. */);
30298 Vtool_bar_border
= Qinternal_border_width
;
30300 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30301 doc
: /* Margin around tool-bar buttons in pixels.
30302 If an integer, use that for both horizontal and vertical margins.
30303 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30304 HORZ specifying the horizontal margin, and VERT specifying the
30305 vertical margin. */);
30306 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30308 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30309 doc
: /* Relief thickness of tool-bar buttons. */);
30310 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30312 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30313 doc
: /* Tool bar style to use.
30315 image - show images only
30316 text - show text only
30317 both - show both, text below image
30318 both-horiz - show text to the right of the image
30319 text-image-horiz - show text to the left of the image
30320 any other - use system default or image if no system default.
30322 This variable only affects the GTK+ toolkit version of Emacs. */);
30323 Vtool_bar_style
= Qnil
;
30325 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30326 doc
: /* Maximum number of characters a label can have to be shown.
30327 The tool bar style must also show labels for this to have any effect, see
30328 `tool-bar-style'. */);
30329 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30331 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30332 doc
: /* List of functions to call to fontify regions of text.
30333 Each function is called with one argument POS. Functions must
30334 fontify a region starting at POS in the current buffer, and give
30335 fontified regions the property `fontified'. */);
30336 Vfontification_functions
= Qnil
;
30337 Fmake_variable_buffer_local (Qfontification_functions
);
30339 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30340 unibyte_display_via_language_environment
,
30341 doc
: /* Non-nil means display unibyte text according to language environment.
30342 Specifically, this means that raw bytes in the range 160-255 decimal
30343 are displayed by converting them to the equivalent multibyte characters
30344 according to the current language environment. As a result, they are
30345 displayed according to the current fontset.
30347 Note that this variable affects only how these bytes are displayed,
30348 but does not change the fact they are interpreted as raw bytes. */);
30349 unibyte_display_via_language_environment
= 0;
30351 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30352 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30353 If a float, it specifies a fraction of the mini-window frame's height.
30354 If an integer, it specifies a number of lines. */);
30355 Vmax_mini_window_height
= make_float (0.25);
30357 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30358 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30359 A value of nil means don't automatically resize mini-windows.
30360 A value of t means resize them to fit the text displayed in them.
30361 A value of `grow-only', the default, means let mini-windows grow only;
30362 they return to their normal size when the minibuffer is closed, or the
30363 echo area becomes empty. */);
30364 Vresize_mini_windows
= Qgrow_only
;
30366 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30367 doc
: /* Alist specifying how to blink the cursor off.
30368 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30369 `cursor-type' frame-parameter or variable equals ON-STATE,
30370 comparing using `equal', Emacs uses OFF-STATE to specify
30371 how to blink it off. ON-STATE and OFF-STATE are values for
30372 the `cursor-type' frame parameter.
30374 If a frame's ON-STATE has no entry in this list,
30375 the frame's other specifications determine how to blink the cursor off. */);
30376 Vblink_cursor_alist
= Qnil
;
30378 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30379 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30380 If non-nil, windows are automatically scrolled horizontally to make
30381 point visible. */);
30382 automatic_hscrolling_p
= 1;
30383 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30385 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30386 doc
: /* How many columns away from the window edge point is allowed to get
30387 before automatic hscrolling will horizontally scroll the window. */);
30388 hscroll_margin
= 5;
30390 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30391 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30392 When point is less than `hscroll-margin' columns from the window
30393 edge, automatic hscrolling will scroll the window by the amount of columns
30394 determined by this variable. If its value is a positive integer, scroll that
30395 many columns. If it's a positive floating-point number, it specifies the
30396 fraction of the window's width to scroll. If it's nil or zero, point will be
30397 centered horizontally after the scroll. Any other value, including negative
30398 numbers, are treated as if the value were zero.
30400 Automatic hscrolling always moves point outside the scroll margin, so if
30401 point was more than scroll step columns inside the margin, the window will
30402 scroll more than the value given by the scroll step.
30404 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30405 and `scroll-right' overrides this variable's effect. */);
30406 Vhscroll_step
= make_number (0);
30408 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30409 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30410 Bind this around calls to `message' to let it take effect. */);
30411 message_truncate_lines
= 0;
30413 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30414 doc
: /* Normal hook run to update the menu bar definitions.
30415 Redisplay runs this hook before it redisplays the menu bar.
30416 This is used to update menus such as Buffers, whose contents depend on
30418 Vmenu_bar_update_hook
= Qnil
;
30420 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30421 doc
: /* Frame for which we are updating a menu.
30422 The enable predicate for a menu binding should check this variable. */);
30423 Vmenu_updating_frame
= Qnil
;
30425 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30426 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30427 inhibit_menubar_update
= 0;
30429 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30430 doc
: /* Prefix prepended to all continuation lines at display time.
30431 The value may be a string, an image, or a stretch-glyph; it is
30432 interpreted in the same way as the value of a `display' text property.
30434 This variable is overridden by any `wrap-prefix' text or overlay
30437 To add a prefix to non-continuation lines, use `line-prefix'. */);
30438 Vwrap_prefix
= Qnil
;
30439 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30440 Fmake_variable_buffer_local (Qwrap_prefix
);
30442 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30443 doc
: /* Prefix prepended to all non-continuation lines at display time.
30444 The value may be a string, an image, or a stretch-glyph; it is
30445 interpreted in the same way as the value of a `display' text property.
30447 This variable is overridden by any `line-prefix' text or overlay
30450 To add a prefix to continuation lines, use `wrap-prefix'. */);
30451 Vline_prefix
= Qnil
;
30452 DEFSYM (Qline_prefix
, "line-prefix");
30453 Fmake_variable_buffer_local (Qline_prefix
);
30455 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30456 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30457 inhibit_eval_during_redisplay
= 0;
30459 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30460 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30461 inhibit_free_realized_faces
= 0;
30464 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30465 doc
: /* Inhibit try_window_id display optimization. */);
30466 inhibit_try_window_id
= 0;
30468 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30469 doc
: /* Inhibit try_window_reusing display optimization. */);
30470 inhibit_try_window_reusing
= 0;
30472 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30473 doc
: /* Inhibit try_cursor_movement display optimization. */);
30474 inhibit_try_cursor_movement
= 0;
30475 #endif /* GLYPH_DEBUG */
30477 DEFVAR_INT ("overline-margin", overline_margin
,
30478 doc
: /* Space between overline and text, in pixels.
30479 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30480 margin to the character height. */);
30481 overline_margin
= 2;
30483 DEFVAR_INT ("underline-minimum-offset",
30484 underline_minimum_offset
,
30485 doc
: /* Minimum distance between baseline and underline.
30486 This can improve legibility of underlined text at small font sizes,
30487 particularly when using variable `x-use-underline-position-properties'
30488 with fonts that specify an UNDERLINE_POSITION relatively close to the
30489 baseline. The default value is 1. */);
30490 underline_minimum_offset
= 1;
30492 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30493 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30494 This feature only works when on a window system that can change
30495 cursor shapes. */);
30496 display_hourglass_p
= 1;
30498 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30499 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30500 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30502 #ifdef HAVE_WINDOW_SYSTEM
30503 hourglass_atimer
= NULL
;
30504 hourglass_shown_p
= 0;
30505 #endif /* HAVE_WINDOW_SYSTEM */
30507 DEFSYM (Qglyphless_char
, "glyphless-char");
30508 DEFSYM (Qhex_code
, "hex-code");
30509 DEFSYM (Qempty_box
, "empty-box");
30510 DEFSYM (Qthin_space
, "thin-space");
30511 DEFSYM (Qzero_width
, "zero-width");
30513 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30514 doc
: /* Function run just before redisplay.
30515 It is called with one argument, which is the set of windows that are to
30516 be redisplayed. This set can be nil (meaning, only the selected window),
30517 or t (meaning all windows). */);
30518 Vpre_redisplay_function
= intern ("ignore");
30520 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30521 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30523 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30524 doc
: /* Char-table defining glyphless characters.
30525 Each element, if non-nil, should be one of the following:
30526 an ASCII acronym string: display this string in a box
30527 `hex-code': display the hexadecimal code of a character in a box
30528 `empty-box': display as an empty box
30529 `thin-space': display as 1-pixel width space
30530 `zero-width': don't display
30531 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30532 display method for graphical terminals and text terminals respectively.
30533 GRAPHICAL and TEXT should each have one of the values listed above.
30535 The char-table has one extra slot to control the display of a character for
30536 which no font is found. This slot only takes effect on graphical terminals.
30537 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30538 `thin-space'. The default is `empty-box'.
30540 If a character has a non-nil entry in an active display table, the
30541 display table takes effect; in this case, Emacs does not consult
30542 `glyphless-char-display' at all. */);
30543 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30544 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30547 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30548 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30549 Vdebug_on_message
= Qnil
;
30551 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30553 Vredisplay__all_windows_cause
30554 = Fmake_vector (make_number (100), make_number (0));
30556 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30558 Vredisplay__mode_lines_cause
30559 = Fmake_vector (make_number (100), make_number (0));
30563 /* Initialize this module when Emacs starts. */
30568 CHARPOS (this_line_start_pos
) = 0;
30570 if (!noninteractive
)
30572 struct window
*m
= XWINDOW (minibuf_window
);
30573 Lisp_Object frame
= m
->frame
;
30574 struct frame
*f
= XFRAME (frame
);
30575 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30576 struct window
*r
= XWINDOW (root
);
30579 echo_area_window
= minibuf_window
;
30581 r
->top_line
= FRAME_TOP_MARGIN (f
);
30582 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30583 r
->total_cols
= FRAME_COLS (f
);
30584 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30585 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30586 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30588 m
->top_line
= FRAME_LINES (f
) - 1;
30589 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30590 m
->total_cols
= FRAME_COLS (f
);
30591 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30592 m
->total_lines
= 1;
30593 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30595 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30596 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30597 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30599 /* The default ellipsis glyphs `...'. */
30600 for (i
= 0; i
< 3; ++i
)
30601 default_invis_vector
[i
] = make_number ('.');
30605 /* Allocate the buffer for frame titles.
30606 Also used for `format-mode-line'. */
30608 mode_line_noprop_buf
= xmalloc (size
);
30609 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30610 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30611 mode_line_target
= MODE_LINE_DISPLAY
;
30614 help_echo_showing_p
= 0;
30617 #ifdef HAVE_WINDOW_SYSTEM
30619 /* Platform-independent portion of hourglass implementation. */
30621 /* Cancel a currently active hourglass timer, and start a new one. */
30623 start_hourglass (void)
30625 struct timespec delay
;
30627 cancel_hourglass ();
30629 if (INTEGERP (Vhourglass_delay
)
30630 && XINT (Vhourglass_delay
) > 0)
30631 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30632 TYPE_MAXIMUM (time_t)),
30634 else if (FLOATP (Vhourglass_delay
)
30635 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30636 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30638 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30642 extern void w32_note_current_window (void);
30643 w32_note_current_window ();
30645 #endif /* HAVE_NTGUI */
30647 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30648 show_hourglass
, NULL
);
30652 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30655 cancel_hourglass (void)
30657 if (hourglass_atimer
)
30659 cancel_atimer (hourglass_atimer
);
30660 hourglass_atimer
= NULL
;
30663 if (hourglass_shown_p
)
30667 #endif /* HAVE_WINDOW_SYSTEM */