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
);
1266 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1267 start_display (&it
, w
, pt
);
1268 it
.vpos
= it
.current_y
= 0;
1270 return make_number (line_bottom_y (&it
));
1273 /* Return the default pixel height of text lines in window W. The
1274 value is the canonical height of the W frame's default font, plus
1275 any extra space required by the line-spacing variable or frame
1278 Implementation note: this ignores any line-spacing text properties
1279 put on the newline characters. This is because those properties
1280 only affect the _screen_ line ending in the newline (i.e., in a
1281 continued line, only the last screen line will be affected), which
1282 means only a small number of lines in a buffer can ever use this
1283 feature. Since this function is used to compute the default pixel
1284 equivalent of text lines in a window, we can safely ignore those
1285 few lines. For the same reasons, we ignore the line-height
1288 default_line_pixel_height (struct window
*w
)
1290 struct frame
*f
= WINDOW_XFRAME (w
);
1291 int height
= FRAME_LINE_HEIGHT (f
);
1293 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1295 struct buffer
*b
= XBUFFER (w
->contents
);
1296 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1299 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1302 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1303 height
+= XFASTINT (val
);
1304 else if (FLOATP (val
))
1306 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1313 height
+= f
->extra_line_spacing
;
1319 /* Subroutine of pos_visible_p below. Extracts a display string, if
1320 any, from the display spec given as its argument. */
1322 string_from_display_spec (Lisp_Object spec
)
1326 while (CONSP (spec
))
1328 if (STRINGP (XCAR (spec
)))
1333 else if (VECTORP (spec
))
1337 for (i
= 0; i
< ASIZE (spec
); i
++)
1339 if (STRINGP (AREF (spec
, i
)))
1340 return AREF (spec
, i
);
1349 /* Limit insanely large values of W->hscroll on frame F to the largest
1350 value that will still prevent first_visible_x and last_visible_x of
1351 'struct it' from overflowing an int. */
1353 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1355 ptrdiff_t window_hscroll
= w
->hscroll
;
1356 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1357 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1359 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1360 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1362 return window_hscroll
;
1365 /* Return 1 if position CHARPOS is visible in window W.
1366 CHARPOS < 0 means return info about WINDOW_END position.
1367 If visible, set *X and *Y to pixel coordinates of top left corner.
1368 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1369 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1372 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1373 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1376 void *itdata
= bidi_shelve_cache ();
1377 struct text_pos top
;
1379 struct buffer
*old_buffer
= NULL
;
1381 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1384 if (XBUFFER (w
->contents
) != current_buffer
)
1386 old_buffer
= current_buffer
;
1387 set_buffer_internal_1 (XBUFFER (w
->contents
));
1390 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1391 /* Scrolling a minibuffer window via scroll bar when the echo area
1392 shows long text sometimes resets the minibuffer contents behind
1394 if (CHARPOS (top
) > ZV
)
1395 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1397 /* Compute exact mode line heights. */
1398 if (WINDOW_WANTS_MODELINE_P (w
))
1400 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1401 BVAR (current_buffer
, mode_line_format
));
1403 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1404 w
->header_line_height
1405 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1406 BVAR (current_buffer
, header_line_format
));
1408 start_display (&it
, w
, top
);
1409 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1410 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1413 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1414 && IT_CHARPOS (it
) >= charpos
)
1415 /* When scanning backwards under bidi iteration, move_it_to
1416 stops at or _before_ CHARPOS, because it stops at or to
1417 the _right_ of the character at CHARPOS. */
1418 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1419 && IT_CHARPOS (it
) <= charpos
)))
1421 /* We have reached CHARPOS, or passed it. How the call to
1422 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1423 or covered by a display property, move_it_to stops at the end
1424 of the invisible text, to the right of CHARPOS. (ii) If
1425 CHARPOS is in a display vector, move_it_to stops on its last
1427 int top_x
= it
.current_x
;
1428 int top_y
= it
.current_y
;
1429 /* Calling line_bottom_y may change it.method, it.position, etc. */
1430 enum it_method it_method
= it
.method
;
1431 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1432 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1434 if (top_y
< window_top_y
)
1435 visible_p
= bottom_y
> window_top_y
;
1436 else if (top_y
< it
.last_visible_y
)
1438 if (bottom_y
>= it
.last_visible_y
1439 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1440 && IT_CHARPOS (it
) < charpos
)
1442 /* When the last line of the window is scanned backwards
1443 under bidi iteration, we could be duped into thinking
1444 that we have passed CHARPOS, when in fact move_it_to
1445 simply stopped short of CHARPOS because it reached
1446 last_visible_y. To see if that's what happened, we call
1447 move_it_to again with a slightly larger vertical limit,
1448 and see if it actually moved vertically; if it did, we
1449 didn't really reach CHARPOS, which is beyond window end. */
1450 struct it save_it
= it
;
1451 /* Why 10? because we don't know how many canonical lines
1452 will the height of the next line(s) be. So we guess. */
1453 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1455 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1456 MOVE_TO_POS
| MOVE_TO_Y
);
1457 if (it
.current_y
> top_y
)
1464 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1466 /* We stopped on the last glyph of a display vector.
1467 Try and recompute. Hack alert! */
1468 if (charpos
< 2 || top
.charpos
>= charpos
)
1469 top_x
= it
.glyph_row
->x
;
1472 struct it it2
, it2_prev
;
1473 /* The idea is to get to the previous buffer
1474 position, consume the character there, and use
1475 the pixel coordinates we get after that. But if
1476 the previous buffer position is also displayed
1477 from a display vector, we need to consume all of
1478 the glyphs from that display vector. */
1479 start_display (&it2
, w
, top
);
1480 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1481 /* If we didn't get to CHARPOS - 1, there's some
1482 replacing display property at that position, and
1483 we stopped after it. That is exactly the place
1484 whose coordinates we want. */
1485 if (IT_CHARPOS (it2
) != charpos
- 1)
1489 /* Iterate until we get out of the display
1490 vector that displays the character at
1493 get_next_display_element (&it2
);
1494 PRODUCE_GLYPHS (&it2
);
1496 set_iterator_to_next (&it2
, 1);
1497 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1498 && IT_CHARPOS (it2
) < charpos
);
1500 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1501 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1502 top_x
= it
.glyph_row
->x
;
1505 top_x
= it2_prev
.current_x
;
1506 top_y
= it2_prev
.current_y
;
1510 else if (IT_CHARPOS (it
) != charpos
)
1512 Lisp_Object cpos
= make_number (charpos
);
1513 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1514 Lisp_Object string
= string_from_display_spec (spec
);
1515 struct text_pos tpos
;
1516 int replacing_spec_p
;
1517 bool newline_in_string
1519 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1521 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1524 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1525 charpos
, FRAME_WINDOW_P (it
.f
)));
1526 /* The tricky code below is needed because there's a
1527 discrepancy between move_it_to and how we set cursor
1528 when PT is at the beginning of a portion of text
1529 covered by a display property or an overlay with a
1530 display property, or the display line ends in a
1531 newline from a display string. move_it_to will stop
1532 _after_ such display strings, whereas
1533 set_cursor_from_row conspires with cursor_row_p to
1534 place the cursor on the first glyph produced from the
1537 /* We have overshoot PT because it is covered by a
1538 display property that replaces the text it covers.
1539 If the string includes embedded newlines, we are also
1540 in the wrong display line. Backtrack to the correct
1541 line, where the display property begins. */
1542 if (replacing_spec_p
)
1544 Lisp_Object startpos
, endpos
;
1545 EMACS_INT start
, end
;
1549 /* Find the first and the last buffer positions
1550 covered by the display string. */
1552 Fnext_single_char_property_change (cpos
, Qdisplay
,
1555 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1557 start
= XFASTINT (startpos
);
1558 end
= XFASTINT (endpos
);
1559 /* Move to the last buffer position before the
1560 display property. */
1561 start_display (&it3
, w
, top
);
1562 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1563 /* Move forward one more line if the position before
1564 the display string is a newline or if it is the
1565 rightmost character on a line that is
1566 continued or word-wrapped. */
1567 if (it3
.method
== GET_FROM_BUFFER
1569 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1570 move_it_by_lines (&it3
, 1);
1571 else if (move_it_in_display_line_to (&it3
, -1,
1575 == MOVE_LINE_CONTINUED
)
1577 move_it_by_lines (&it3
, 1);
1578 /* When we are under word-wrap, the #$@%!
1579 move_it_by_lines moves 2 lines, so we need to
1581 if (it3
.line_wrap
== WORD_WRAP
)
1582 move_it_by_lines (&it3
, -1);
1585 /* Record the vertical coordinate of the display
1586 line where we wound up. */
1587 top_y
= it3
.current_y
;
1590 /* When characters are reordered for display,
1591 the character displayed to the left of the
1592 display string could be _after_ the display
1593 property in the logical order. Use the
1594 smallest vertical position of these two. */
1595 start_display (&it3
, w
, top
);
1596 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1597 if (it3
.current_y
< top_y
)
1598 top_y
= it3
.current_y
;
1600 /* Move from the top of the window to the beginning
1601 of the display line where the display string
1603 start_display (&it3
, w
, top
);
1604 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1605 /* If it3_moved stays zero after the 'while' loop
1606 below, that means we already were at a newline
1607 before the loop (e.g., the display string begins
1608 with a newline), so we don't need to (and cannot)
1609 inspect the glyphs of it3.glyph_row, because
1610 PRODUCE_GLYPHS will not produce anything for a
1611 newline, and thus it3.glyph_row stays at its
1612 stale content it got at top of the window. */
1614 /* Finally, advance the iterator until we hit the
1615 first display element whose character position is
1616 CHARPOS, or until the first newline from the
1617 display string, which signals the end of the
1619 while (get_next_display_element (&it3
))
1621 PRODUCE_GLYPHS (&it3
);
1622 if (IT_CHARPOS (it3
) == charpos
1623 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1626 set_iterator_to_next (&it3
, 0);
1628 top_x
= it3
.current_x
- it3
.pixel_width
;
1629 /* Normally, we would exit the above loop because we
1630 found the display element whose character
1631 position is CHARPOS. For the contingency that we
1632 didn't, and stopped at the first newline from the
1633 display string, move back over the glyphs
1634 produced from the string, until we find the
1635 rightmost glyph not from the string. */
1637 && newline_in_string
1638 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1640 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1641 + it3
.glyph_row
->used
[TEXT_AREA
];
1643 while (EQ ((g
- 1)->object
, string
))
1646 top_x
-= g
->pixel_width
;
1648 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1649 + it3
.glyph_row
->used
[TEXT_AREA
]);
1655 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1656 *rtop
= max (0, window_top_y
- top_y
);
1657 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1658 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1659 - max (top_y
, window_top_y
)));
1665 /* We were asked to provide info about WINDOW_END. */
1667 void *it2data
= NULL
;
1669 SAVE_IT (it2
, it
, it2data
);
1670 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1671 move_it_by_lines (&it
, 1);
1672 if (charpos
< IT_CHARPOS (it
)
1673 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1676 RESTORE_IT (&it2
, &it2
, it2data
);
1677 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1679 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1680 *rtop
= max (0, -it2
.current_y
);
1681 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1682 - it
.last_visible_y
));
1683 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1685 - max (it2
.current_y
,
1686 WINDOW_HEADER_LINE_HEIGHT (w
))));
1690 bidi_unshelve_cache (it2data
, 1);
1692 bidi_unshelve_cache (itdata
, 0);
1695 set_buffer_internal_1 (old_buffer
);
1697 if (visible_p
&& w
->hscroll
> 0)
1699 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1700 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1703 /* Debugging code. */
1705 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1706 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1708 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1715 /* Return the next character from STR. Return in *LEN the length of
1716 the character. This is like STRING_CHAR_AND_LENGTH but never
1717 returns an invalid character. If we find one, we return a `?', but
1718 with the length of the invalid character. */
1721 string_char_and_length (const unsigned char *str
, int *len
)
1725 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1726 if (!CHAR_VALID_P (c
))
1727 /* We may not change the length here because other places in Emacs
1728 don't use this function, i.e. they silently accept invalid
1737 /* Given a position POS containing a valid character and byte position
1738 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1740 static struct text_pos
1741 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1743 eassert (STRINGP (string
) && nchars
>= 0);
1745 if (STRING_MULTIBYTE (string
))
1747 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1752 string_char_and_length (p
, &len
);
1755 BYTEPOS (pos
) += len
;
1759 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1765 /* Value is the text position, i.e. character and byte position,
1766 for character position CHARPOS in STRING. */
1768 static struct text_pos
1769 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1771 struct text_pos pos
;
1772 eassert (STRINGP (string
));
1773 eassert (charpos
>= 0);
1774 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1779 /* Value is a text position, i.e. character and byte position, for
1780 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1781 means recognize multibyte characters. */
1783 static struct text_pos
1784 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1786 struct text_pos pos
;
1788 eassert (s
!= NULL
);
1789 eassert (charpos
>= 0);
1795 SET_TEXT_POS (pos
, 0, 0);
1798 string_char_and_length ((const unsigned char *) s
, &len
);
1801 BYTEPOS (pos
) += len
;
1805 SET_TEXT_POS (pos
, charpos
, charpos
);
1811 /* Value is the number of characters in C string S. MULTIBYTE_P
1812 non-zero means recognize multibyte characters. */
1815 number_of_chars (const char *s
, bool multibyte_p
)
1821 ptrdiff_t rest
= strlen (s
);
1823 const unsigned char *p
= (const unsigned char *) s
;
1825 for (nchars
= 0; rest
> 0; ++nchars
)
1827 string_char_and_length (p
, &len
);
1828 rest
-= len
, p
+= len
;
1832 nchars
= strlen (s
);
1838 /* Compute byte position NEWPOS->bytepos corresponding to
1839 NEWPOS->charpos. POS is a known position in string STRING.
1840 NEWPOS->charpos must be >= POS.charpos. */
1843 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1845 eassert (STRINGP (string
));
1846 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1848 if (STRING_MULTIBYTE (string
))
1849 *newpos
= string_pos_nchars_ahead (pos
, string
,
1850 CHARPOS (*newpos
) - CHARPOS (pos
));
1852 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1856 Return an estimation of the pixel height of mode or header lines on
1857 frame F. FACE_ID specifies what line's height to estimate. */
1860 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1862 #ifdef HAVE_WINDOW_SYSTEM
1863 if (FRAME_WINDOW_P (f
))
1865 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1867 /* This function is called so early when Emacs starts that the face
1868 cache and mode line face are not yet initialized. */
1869 if (FRAME_FACE_CACHE (f
))
1871 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1875 height
= FONT_HEIGHT (face
->font
);
1876 if (face
->box_line_width
> 0)
1877 height
+= 2 * face
->box_line_width
;
1888 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1889 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1890 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1891 not force the value into range. */
1894 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1895 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1898 #ifdef HAVE_WINDOW_SYSTEM
1899 if (FRAME_WINDOW_P (f
))
1901 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1902 even for negative values. */
1904 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1906 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1908 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1909 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1912 STORE_NATIVE_RECT (*bounds
,
1913 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1914 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1915 FRAME_COLUMN_WIDTH (f
) - 1,
1916 FRAME_LINE_HEIGHT (f
) - 1);
1918 /* PXW: Should we clip pixels before converting to columns/lines? */
1923 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1924 pix_x
= FRAME_TOTAL_COLS (f
);
1928 else if (pix_y
> FRAME_LINES (f
))
1929 pix_y
= FRAME_LINES (f
);
1939 /* Find the glyph under window-relative coordinates X/Y in window W.
1940 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1941 strings. Return in *HPOS and *VPOS the row and column number of
1942 the glyph found. Return in *AREA the glyph area containing X.
1943 Value is a pointer to the glyph found or null if X/Y is not on
1944 text, or we can't tell because W's current matrix is not up to
1947 static struct glyph
*
1948 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1949 int *dx
, int *dy
, int *area
)
1951 struct glyph
*glyph
, *end
;
1952 struct glyph_row
*row
= NULL
;
1955 /* Find row containing Y. Give up if some row is not enabled. */
1956 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1958 row
= MATRIX_ROW (w
->current_matrix
, i
);
1959 if (!row
->enabled_p
)
1961 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1968 /* Give up if Y is not in the window. */
1969 if (i
== w
->current_matrix
->nrows
)
1972 /* Get the glyph area containing X. */
1973 if (w
->pseudo_window_p
)
1980 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1982 *area
= LEFT_MARGIN_AREA
;
1983 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1985 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1988 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1992 *area
= RIGHT_MARGIN_AREA
;
1993 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1997 /* Find glyph containing X. */
1998 glyph
= row
->glyphs
[*area
];
1999 end
= glyph
+ row
->used
[*area
];
2001 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2003 x
-= glyph
->pixel_width
;
2013 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2016 *hpos
= glyph
- row
->glyphs
[*area
];
2020 /* Convert frame-relative x/y to coordinates relative to window W.
2021 Takes pseudo-windows into account. */
2024 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2026 if (w
->pseudo_window_p
)
2028 /* A pseudo-window is always full-width, and starts at the
2029 left edge of the frame, plus a frame border. */
2030 struct frame
*f
= XFRAME (w
->frame
);
2031 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2032 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2036 *x
-= WINDOW_LEFT_EDGE_X (w
);
2037 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2041 #ifdef HAVE_WINDOW_SYSTEM
2044 Return in RECTS[] at most N clipping rectangles for glyph string S.
2045 Return the number of stored rectangles. */
2048 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2055 if (s
->row
->full_width_p
)
2057 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2058 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2059 if (s
->row
->mode_line_p
)
2060 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2062 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2064 /* Unless displaying a mode or menu bar line, which are always
2065 fully visible, clip to the visible part of the row. */
2066 if (s
->w
->pseudo_window_p
)
2067 r
.height
= s
->row
->visible_height
;
2069 r
.height
= s
->height
;
2073 /* This is a text line that may be partially visible. */
2074 r
.x
= window_box_left (s
->w
, s
->area
);
2075 r
.width
= window_box_width (s
->w
, s
->area
);
2076 r
.height
= s
->row
->visible_height
;
2080 if (r
.x
< s
->clip_head
->x
)
2082 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2083 r
.width
-= s
->clip_head
->x
- r
.x
;
2086 r
.x
= s
->clip_head
->x
;
2089 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2091 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2092 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2097 /* If S draws overlapping rows, it's sufficient to use the top and
2098 bottom of the window for clipping because this glyph string
2099 intentionally draws over other lines. */
2100 if (s
->for_overlaps
)
2102 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2103 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2105 /* Alas, the above simple strategy does not work for the
2106 environments with anti-aliased text: if the same text is
2107 drawn onto the same place multiple times, it gets thicker.
2108 If the overlap we are processing is for the erased cursor, we
2109 take the intersection with the rectangle of the cursor. */
2110 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2112 XRectangle rc
, r_save
= r
;
2114 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2115 rc
.y
= s
->w
->phys_cursor
.y
;
2116 rc
.width
= s
->w
->phys_cursor_width
;
2117 rc
.height
= s
->w
->phys_cursor_height
;
2119 x_intersect_rectangles (&r_save
, &rc
, &r
);
2124 /* Don't use S->y for clipping because it doesn't take partially
2125 visible lines into account. For example, it can be negative for
2126 partially visible lines at the top of a window. */
2127 if (!s
->row
->full_width_p
2128 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2129 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2131 r
.y
= max (0, s
->row
->y
);
2134 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2136 /* If drawing the cursor, don't let glyph draw outside its
2137 advertised boundaries. Cleartype does this under some circumstances. */
2138 if (s
->hl
== DRAW_CURSOR
)
2140 struct glyph
*glyph
= s
->first_glyph
;
2145 r
.width
-= s
->x
- r
.x
;
2148 r
.width
= min (r
.width
, glyph
->pixel_width
);
2150 /* If r.y is below window bottom, ensure that we still see a cursor. */
2151 height
= min (glyph
->ascent
+ glyph
->descent
,
2152 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2153 max_y
= window_text_bottom_y (s
->w
) - height
;
2154 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2155 if (s
->ybase
- glyph
->ascent
> max_y
)
2162 /* Don't draw cursor glyph taller than our actual glyph. */
2163 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2164 if (height
< r
.height
)
2166 max_y
= r
.y
+ r
.height
;
2167 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2168 r
.height
= min (max_y
- r
.y
, height
);
2175 XRectangle r_save
= r
;
2177 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2181 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2182 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2184 #ifdef CONVERT_FROM_XRECT
2185 CONVERT_FROM_XRECT (r
, *rects
);
2193 /* If we are processing overlapping and allowed to return
2194 multiple clipping rectangles, we exclude the row of the glyph
2195 string from the clipping rectangle. This is to avoid drawing
2196 the same text on the environment with anti-aliasing. */
2197 #ifdef CONVERT_FROM_XRECT
2200 XRectangle
*rs
= rects
;
2202 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2204 if (s
->for_overlaps
& OVERLAPS_PRED
)
2207 if (r
.y
+ r
.height
> row_y
)
2210 rs
[i
].height
= row_y
- r
.y
;
2216 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2219 if (r
.y
< row_y
+ s
->row
->visible_height
)
2221 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2223 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2224 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2233 #ifdef CONVERT_FROM_XRECT
2234 for (i
= 0; i
< n
; i
++)
2235 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2242 Return in *NR the clipping rectangle for glyph string S. */
2245 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2247 get_glyph_string_clip_rects (s
, nr
, 1);
2252 Return the position and height of the phys cursor in window W.
2253 Set w->phys_cursor_width to width of phys cursor.
2257 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2258 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2260 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2261 int x
, y
, wd
, h
, h0
, y0
;
2263 /* Compute the width of the rectangle to draw. If on a stretch
2264 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2265 rectangle as wide as the glyph, but use a canonical character
2267 wd
= glyph
->pixel_width
- 1;
2268 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2272 x
= w
->phys_cursor
.x
;
2279 if (glyph
->type
== STRETCH_GLYPH
2280 && !x_stretch_cursor_p
)
2281 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2282 w
->phys_cursor_width
= wd
;
2284 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2286 /* If y is below window bottom, ensure that we still see a cursor. */
2287 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2289 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2290 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2292 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2295 h
= max (h
- (y0
- y
) + 1, h0
);
2300 y0
= window_text_bottom_y (w
) - h0
;
2308 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2309 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2314 * Remember which glyph the mouse is over.
2318 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2322 struct glyph_row
*r
, *gr
, *end_row
;
2323 enum window_part part
;
2324 enum glyph_row_area area
;
2325 int x
, y
, width
, height
;
2327 /* Try to determine frame pixel position and size of the glyph under
2328 frame pixel coordinates X/Y on frame F. */
2330 if (window_resize_pixelwise
)
2335 else if (!f
->glyphs_initialized_p
2336 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2339 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2340 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2344 w
= XWINDOW (window
);
2345 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2346 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2348 x
= window_relative_x_coord (w
, part
, gx
);
2349 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2351 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2352 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2354 if (w
->pseudo_window_p
)
2357 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2363 case ON_LEFT_MARGIN
:
2364 area
= LEFT_MARGIN_AREA
;
2367 case ON_RIGHT_MARGIN
:
2368 area
= RIGHT_MARGIN_AREA
;
2371 case ON_HEADER_LINE
:
2373 gr
= (part
== ON_HEADER_LINE
2374 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2375 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2378 goto text_glyph_row_found
;
2385 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2386 if (r
->y
+ r
->height
> y
)
2392 text_glyph_row_found
:
2395 struct glyph
*g
= gr
->glyphs
[area
];
2396 struct glyph
*end
= g
+ gr
->used
[area
];
2398 height
= gr
->height
;
2399 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2400 if (gx
+ g
->pixel_width
> x
)
2405 if (g
->type
== IMAGE_GLYPH
)
2407 /* Don't remember when mouse is over image, as
2408 image may have hot-spots. */
2409 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2412 width
= g
->pixel_width
;
2416 /* Use nominal char spacing at end of line. */
2418 gx
+= (x
/ width
) * width
;
2421 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2423 gx
+= window_box_left_offset (w
, area
);
2424 /* Don't expand over the modeline to make sure the vertical
2425 drag cursor is shown early enough. */
2426 height
= min (height
,
2427 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2432 /* Use nominal line height at end of window. */
2433 gx
= (x
/ width
) * width
;
2435 gy
+= (y
/ height
) * height
;
2436 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2437 /* See comment above. */
2438 height
= min (height
,
2439 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2443 case ON_LEFT_FRINGE
:
2444 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2445 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2446 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2447 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2450 case ON_RIGHT_FRINGE
:
2451 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2452 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2453 : window_box_right_offset (w
, TEXT_AREA
));
2454 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2455 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2456 && !WINDOW_RIGHTMOST_P (w
))
2457 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2458 /* Make sure the vertical border can get her own glyph to the
2459 right of the one we build here. */
2460 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2462 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2464 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2468 case ON_VERTICAL_BORDER
:
2469 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2473 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2475 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2476 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2477 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2479 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2483 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2484 if (r
->y
+ r
->height
> y
)
2491 height
= gr
->height
;
2494 /* Use nominal line height at end of window. */
2496 gy
+= (y
/ height
) * height
;
2500 case ON_RIGHT_DIVIDER
:
2501 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2502 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2504 /* The bottom divider prevails. */
2505 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2508 case ON_BOTTOM_DIVIDER
:
2510 width
= WINDOW_PIXEL_WIDTH (w
);
2511 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2512 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2518 /* If there is no glyph under the mouse, then we divide the screen
2519 into a grid of the smallest glyph in the frame, and use that
2522 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2523 round down even for negative values. */
2529 gx
= (gx
/ width
) * width
;
2530 gy
= (gy
/ height
) * height
;
2536 gx
+= WINDOW_LEFT_EDGE_X (w
);
2537 gy
+= WINDOW_TOP_EDGE_Y (w
);
2540 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2542 /* Visible feedback for debugging. */
2545 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2546 f
->output_data
.x
->normal_gc
,
2547 gx
, gy
, width
, height
);
2553 #endif /* HAVE_WINDOW_SYSTEM */
2556 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2559 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2560 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2562 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2565 /***********************************************************************
2566 Lisp form evaluation
2567 ***********************************************************************/
2569 /* Error handler for safe_eval and safe_call. */
2572 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2574 add_to_log ("Error during redisplay: %S signaled %S",
2575 Flist (nargs
, args
), arg
);
2579 /* Call function FUNC with the rest of NARGS - 1 arguments
2580 following. Return the result, or nil if something went
2581 wrong. Prevent redisplay during the evaluation. */
2584 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2588 if (inhibit_eval_during_redisplay
)
2594 ptrdiff_t count
= SPECPDL_INDEX ();
2595 struct gcpro gcpro1
;
2596 Lisp_Object
*args
= alloca (nargs
* word_size
);
2599 va_start (ap
, func
);
2600 for (i
= 1; i
< nargs
; i
++)
2601 args
[i
] = va_arg (ap
, Lisp_Object
);
2605 gcpro1
.nvars
= nargs
;
2606 specbind (Qinhibit_redisplay
, Qt
);
2607 /* Use Qt to ensure debugger does not run,
2608 so there is no possibility of wanting to redisplay. */
2609 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2612 val
= unbind_to (count
, val
);
2619 /* Call function FN with one argument ARG.
2620 Return the result, or nil if something went wrong. */
2623 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2625 return safe_call (2, fn
, arg
);
2628 static Lisp_Object Qeval
;
2631 safe_eval (Lisp_Object sexpr
)
2633 return safe_call1 (Qeval
, sexpr
);
2636 /* Call function FN with two arguments ARG1 and ARG2.
2637 Return the result, or nil if something went wrong. */
2640 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2642 return safe_call (3, fn
, arg1
, arg2
);
2647 /***********************************************************************
2649 ***********************************************************************/
2653 /* Define CHECK_IT to perform sanity checks on iterators.
2654 This is for debugging. It is too slow to do unconditionally. */
2657 check_it (struct it
*it
)
2659 if (it
->method
== GET_FROM_STRING
)
2661 eassert (STRINGP (it
->string
));
2662 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2666 eassert (IT_STRING_CHARPOS (*it
) < 0);
2667 if (it
->method
== GET_FROM_BUFFER
)
2669 /* Check that character and byte positions agree. */
2670 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2675 eassert (it
->current
.dpvec_index
>= 0);
2677 eassert (it
->current
.dpvec_index
< 0);
2680 #define CHECK_IT(IT) check_it ((IT))
2684 #define CHECK_IT(IT) (void) 0
2689 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2691 /* Check that the window end of window W is what we expect it
2692 to be---the last row in the current matrix displaying text. */
2695 check_window_end (struct window
*w
)
2697 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2699 struct glyph_row
*row
;
2700 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2702 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2703 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2707 #define CHECK_WINDOW_END(W) check_window_end ((W))
2711 #define CHECK_WINDOW_END(W) (void) 0
2713 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2715 /***********************************************************************
2716 Iterator initialization
2717 ***********************************************************************/
2719 /* Initialize IT for displaying current_buffer in window W, starting
2720 at character position CHARPOS. CHARPOS < 0 means that no buffer
2721 position is specified which is useful when the iterator is assigned
2722 a position later. BYTEPOS is the byte position corresponding to
2725 If ROW is not null, calls to produce_glyphs with IT as parameter
2726 will produce glyphs in that row.
2728 BASE_FACE_ID is the id of a base face to use. It must be one of
2729 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2730 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2731 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2733 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2734 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2735 will be initialized to use the corresponding mode line glyph row of
2736 the desired matrix of W. */
2739 init_iterator (struct it
*it
, struct window
*w
,
2740 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2741 struct glyph_row
*row
, enum face_id base_face_id
)
2743 enum face_id remapped_base_face_id
= base_face_id
;
2745 /* Some precondition checks. */
2746 eassert (w
!= NULL
&& it
!= NULL
);
2747 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2750 /* If face attributes have been changed since the last redisplay,
2751 free realized faces now because they depend on face definitions
2752 that might have changed. Don't free faces while there might be
2753 desired matrices pending which reference these faces. */
2754 if (face_change_count
&& !inhibit_free_realized_faces
)
2756 face_change_count
= 0;
2757 free_all_realized_faces (Qnil
);
2760 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2761 if (! NILP (Vface_remapping_alist
))
2762 remapped_base_face_id
2763 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2765 /* Use one of the mode line rows of W's desired matrix if
2769 if (base_face_id
== MODE_LINE_FACE_ID
2770 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2771 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2772 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2773 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2777 memset (it
, 0, sizeof *it
);
2778 it
->current
.overlay_string_index
= -1;
2779 it
->current
.dpvec_index
= -1;
2780 it
->base_face_id
= remapped_base_face_id
;
2782 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2783 it
->paragraph_embedding
= L2R
;
2784 it
->bidi_it
.string
.lstring
= Qnil
;
2785 it
->bidi_it
.string
.s
= NULL
;
2786 it
->bidi_it
.string
.bufpos
= 0;
2789 /* The window in which we iterate over current_buffer: */
2790 XSETWINDOW (it
->window
, w
);
2792 it
->f
= XFRAME (w
->frame
);
2796 /* Extra space between lines (on window systems only). */
2797 if (base_face_id
== DEFAULT_FACE_ID
2798 && FRAME_WINDOW_P (it
->f
))
2800 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2801 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2802 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2803 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2804 * FRAME_LINE_HEIGHT (it
->f
));
2805 else if (it
->f
->extra_line_spacing
> 0)
2806 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2807 it
->max_extra_line_spacing
= 0;
2810 /* If realized faces have been removed, e.g. because of face
2811 attribute changes of named faces, recompute them. When running
2812 in batch mode, the face cache of the initial frame is null. If
2813 we happen to get called, make a dummy face cache. */
2814 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2815 init_frame_faces (it
->f
);
2816 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2817 recompute_basic_faces (it
->f
);
2819 /* Current value of the `slice', `space-width', and 'height' properties. */
2820 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2821 it
->space_width
= Qnil
;
2822 it
->font_height
= Qnil
;
2823 it
->override_ascent
= -1;
2825 /* Are control characters displayed as `^C'? */
2826 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2828 /* -1 means everything between a CR and the following line end
2829 is invisible. >0 means lines indented more than this value are
2831 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2833 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2835 : (!NILP (BVAR (current_buffer
, selective_display
))
2837 it
->selective_display_ellipsis_p
2838 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2840 /* Display table to use. */
2841 it
->dp
= window_display_table (w
);
2843 /* Are multibyte characters enabled in current_buffer? */
2844 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2846 /* Get the position at which the redisplay_end_trigger hook should
2847 be run, if it is to be run at all. */
2848 if (MARKERP (w
->redisplay_end_trigger
)
2849 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2850 it
->redisplay_end_trigger_charpos
2851 = marker_position (w
->redisplay_end_trigger
);
2852 else if (INTEGERP (w
->redisplay_end_trigger
))
2853 it
->redisplay_end_trigger_charpos
2854 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2857 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2859 /* Are lines in the display truncated? */
2860 if (base_face_id
!= DEFAULT_FACE_ID
2862 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2863 && ((!NILP (Vtruncate_partial_width_windows
)
2864 && !INTEGERP (Vtruncate_partial_width_windows
))
2865 || (INTEGERP (Vtruncate_partial_width_windows
)
2866 /* PXW: Shall we do something about this? */
2867 && (WINDOW_TOTAL_COLS (it
->w
)
2868 < XINT (Vtruncate_partial_width_windows
))))))
2869 it
->line_wrap
= TRUNCATE
;
2870 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2871 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2872 ? WINDOW_WRAP
: WORD_WRAP
;
2874 it
->line_wrap
= TRUNCATE
;
2876 /* Get dimensions of truncation and continuation glyphs. These are
2877 displayed as fringe bitmaps under X, but we need them for such
2878 frames when the fringes are turned off. But leave the dimensions
2879 zero for tooltip frames, as these glyphs look ugly there and also
2880 sabotage calculations of tooltip dimensions in x-show-tip. */
2881 #ifdef HAVE_WINDOW_SYSTEM
2882 if (!(FRAME_WINDOW_P (it
->f
)
2883 && FRAMEP (tip_frame
)
2884 && it
->f
== XFRAME (tip_frame
)))
2887 if (it
->line_wrap
== TRUNCATE
)
2889 /* We will need the truncation glyph. */
2890 eassert (it
->glyph_row
== NULL
);
2891 produce_special_glyphs (it
, IT_TRUNCATION
);
2892 it
->truncation_pixel_width
= it
->pixel_width
;
2896 /* We will need the continuation glyph. */
2897 eassert (it
->glyph_row
== NULL
);
2898 produce_special_glyphs (it
, IT_CONTINUATION
);
2899 it
->continuation_pixel_width
= it
->pixel_width
;
2903 /* Reset these values to zero because the produce_special_glyphs
2904 above has changed them. */
2905 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2906 it
->phys_ascent
= it
->phys_descent
= 0;
2908 /* Set this after getting the dimensions of truncation and
2909 continuation glyphs, so that we don't produce glyphs when calling
2910 produce_special_glyphs, above. */
2911 it
->glyph_row
= row
;
2912 it
->area
= TEXT_AREA
;
2914 /* Forget any previous info about this row being reversed. */
2916 it
->glyph_row
->reversed_p
= 0;
2918 /* Get the dimensions of the display area. The display area
2919 consists of the visible window area plus a horizontally scrolled
2920 part to the left of the window. All x-values are relative to the
2921 start of this total display area. */
2922 if (base_face_id
!= DEFAULT_FACE_ID
)
2924 /* Mode lines, menu bar in terminal frames. */
2925 it
->first_visible_x
= 0;
2926 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2931 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2932 it
->last_visible_x
= (it
->first_visible_x
2933 + window_box_width (w
, TEXT_AREA
));
2935 /* If we truncate lines, leave room for the truncation glyph(s) at
2936 the right margin. Otherwise, leave room for the continuation
2937 glyph(s). Done only if the window has no fringes. Since we
2938 don't know at this point whether there will be any R2L lines in
2939 the window, we reserve space for truncation/continuation glyphs
2940 even if only one of the fringes is absent. */
2941 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2942 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2944 if (it
->line_wrap
== TRUNCATE
)
2945 it
->last_visible_x
-= it
->truncation_pixel_width
;
2947 it
->last_visible_x
-= it
->continuation_pixel_width
;
2950 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2951 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2954 /* Leave room for a border glyph. */
2955 if (!FRAME_WINDOW_P (it
->f
)
2956 && !WINDOW_RIGHTMOST_P (it
->w
))
2957 it
->last_visible_x
-= 1;
2959 it
->last_visible_y
= window_text_bottom_y (w
);
2961 /* For mode lines and alike, arrange for the first glyph having a
2962 left box line if the face specifies a box. */
2963 if (base_face_id
!= DEFAULT_FACE_ID
)
2967 it
->face_id
= remapped_base_face_id
;
2969 /* If we have a boxed mode line, make the first character appear
2970 with a left box line. */
2971 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2972 if (face
&& face
->box
!= FACE_NO_BOX
)
2973 it
->start_of_box_run_p
= true;
2976 /* If a buffer position was specified, set the iterator there,
2977 getting overlays and face properties from that position. */
2978 if (charpos
>= BUF_BEG (current_buffer
))
2980 it
->end_charpos
= ZV
;
2981 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
2982 IT_CHARPOS (*it
) = charpos
;
2983 IT_BYTEPOS (*it
) = bytepos
;
2985 /* We will rely on `reseat' to set this up properly, via
2986 handle_face_prop. */
2987 it
->face_id
= it
->base_face_id
;
2989 it
->start
= it
->current
;
2990 /* Do we need to reorder bidirectional text? Not if this is a
2991 unibyte buffer: by definition, none of the single-byte
2992 characters are strong R2L, so no reordering is needed. And
2993 bidi.c doesn't support unibyte buffers anyway. Also, don't
2994 reorder while we are loading loadup.el, since the tables of
2995 character properties needed for reordering are not yet
2999 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3002 /* If we are to reorder bidirectional text, init the bidi
3006 /* Note the paragraph direction that this buffer wants to
3008 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3010 it
->paragraph_embedding
= L2R
;
3011 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3013 it
->paragraph_embedding
= R2L
;
3015 it
->paragraph_embedding
= NEUTRAL_DIR
;
3016 bidi_unshelve_cache (NULL
, 0);
3017 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3021 /* Compute faces etc. */
3022 reseat (it
, it
->current
.pos
, 1);
3029 /* Initialize IT for the display of window W with window start POS. */
3032 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3034 struct glyph_row
*row
;
3035 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3037 row
= w
->desired_matrix
->rows
+ first_vpos
;
3038 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3039 it
->first_vpos
= first_vpos
;
3041 /* Don't reseat to previous visible line start if current start
3042 position is in a string or image. */
3043 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3045 int start_at_line_beg_p
;
3046 int first_y
= it
->current_y
;
3048 /* If window start is not at a line start, skip forward to POS to
3049 get the correct continuation lines width. */
3050 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3051 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3052 if (!start_at_line_beg_p
)
3056 reseat_at_previous_visible_line_start (it
);
3057 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3059 new_x
= it
->current_x
+ it
->pixel_width
;
3061 /* If lines are continued, this line may end in the middle
3062 of a multi-glyph character (e.g. a control character
3063 displayed as \003, or in the middle of an overlay
3064 string). In this case move_it_to above will not have
3065 taken us to the start of the continuation line but to the
3066 end of the continued line. */
3067 if (it
->current_x
> 0
3068 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3069 && (/* And glyph doesn't fit on the line. */
3070 new_x
> it
->last_visible_x
3071 /* Or it fits exactly and we're on a window
3073 || (new_x
== it
->last_visible_x
3074 && FRAME_WINDOW_P (it
->f
)
3075 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3076 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3077 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3079 if ((it
->current
.dpvec_index
>= 0
3080 || it
->current
.overlay_string_index
>= 0)
3081 /* If we are on a newline from a display vector or
3082 overlay string, then we are already at the end of
3083 a screen line; no need to go to the next line in
3084 that case, as this line is not really continued.
3085 (If we do go to the next line, C-e will not DTRT.) */
3088 set_iterator_to_next (it
, 1);
3089 move_it_in_display_line_to (it
, -1, -1, 0);
3092 it
->continuation_lines_width
+= it
->current_x
;
3094 /* If the character at POS is displayed via a display
3095 vector, move_it_to above stops at the final glyph of
3096 IT->dpvec. To make the caller redisplay that character
3097 again (a.k.a. start at POS), we need to reset the
3098 dpvec_index to the beginning of IT->dpvec. */
3099 else if (it
->current
.dpvec_index
>= 0)
3100 it
->current
.dpvec_index
= 0;
3102 /* We're starting a new display line, not affected by the
3103 height of the continued line, so clear the appropriate
3104 fields in the iterator structure. */
3105 it
->max_ascent
= it
->max_descent
= 0;
3106 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3108 it
->current_y
= first_y
;
3110 it
->current_x
= it
->hpos
= 0;
3116 /* Return 1 if POS is a position in ellipses displayed for invisible
3117 text. W is the window we display, for text property lookup. */
3120 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3122 Lisp_Object prop
, window
;
3124 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3126 /* If POS specifies a position in a display vector, this might
3127 be for an ellipsis displayed for invisible text. We won't
3128 get the iterator set up for delivering that ellipsis unless
3129 we make sure that it gets aware of the invisible text. */
3130 if (pos
->dpvec_index
>= 0
3131 && pos
->overlay_string_index
< 0
3132 && CHARPOS (pos
->string_pos
) < 0
3134 && (XSETWINDOW (window
, w
),
3135 prop
= Fget_char_property (make_number (charpos
),
3136 Qinvisible
, window
),
3137 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3139 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3141 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3148 /* Initialize IT for stepping through current_buffer in window W,
3149 starting at position POS that includes overlay string and display
3150 vector/ control character translation position information. Value
3151 is zero if there are overlay strings with newlines at POS. */
3154 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3156 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3157 int i
, overlay_strings_with_newlines
= 0;
3159 /* If POS specifies a position in a display vector, this might
3160 be for an ellipsis displayed for invisible text. We won't
3161 get the iterator set up for delivering that ellipsis unless
3162 we make sure that it gets aware of the invisible text. */
3163 if (in_ellipses_for_invisible_text_p (pos
, w
))
3169 /* Keep in mind: the call to reseat in init_iterator skips invisible
3170 text, so we might end up at a position different from POS. This
3171 is only a problem when POS is a row start after a newline and an
3172 overlay starts there with an after-string, and the overlay has an
3173 invisible property. Since we don't skip invisible text in
3174 display_line and elsewhere immediately after consuming the
3175 newline before the row start, such a POS will not be in a string,
3176 but the call to init_iterator below will move us to the
3178 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3180 /* This only scans the current chunk -- it should scan all chunks.
3181 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3182 to 16 in 22.1 to make this a lesser problem. */
3183 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3185 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3186 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3188 while (s
< e
&& *s
!= '\n')
3193 overlay_strings_with_newlines
= 1;
3198 /* If position is within an overlay string, set up IT to the right
3200 if (pos
->overlay_string_index
>= 0)
3204 /* If the first overlay string happens to have a `display'
3205 property for an image, the iterator will be set up for that
3206 image, and we have to undo that setup first before we can
3207 correct the overlay string index. */
3208 if (it
->method
== GET_FROM_IMAGE
)
3211 /* We already have the first chunk of overlay strings in
3212 IT->overlay_strings. Load more until the one for
3213 pos->overlay_string_index is in IT->overlay_strings. */
3214 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3216 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3217 it
->current
.overlay_string_index
= 0;
3220 load_overlay_strings (it
, 0);
3221 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3225 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3226 relative_index
= (it
->current
.overlay_string_index
3227 % OVERLAY_STRING_CHUNK_SIZE
);
3228 it
->string
= it
->overlay_strings
[relative_index
];
3229 eassert (STRINGP (it
->string
));
3230 it
->current
.string_pos
= pos
->string_pos
;
3231 it
->method
= GET_FROM_STRING
;
3232 it
->end_charpos
= SCHARS (it
->string
);
3233 /* Set up the bidi iterator for this overlay string. */
3236 it
->bidi_it
.string
.lstring
= it
->string
;
3237 it
->bidi_it
.string
.s
= NULL
;
3238 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3239 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3240 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3241 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3242 it
->bidi_it
.w
= it
->w
;
3243 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3244 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3246 /* Synchronize the state of the bidi iterator with
3247 pos->string_pos. For any string position other than
3248 zero, this will be done automagically when we resume
3249 iteration over the string and get_visually_first_element
3250 is called. But if string_pos is zero, and the string is
3251 to be reordered for display, we need to resync manually,
3252 since it could be that the iteration state recorded in
3253 pos ended at string_pos of 0 moving backwards in string. */
3254 if (CHARPOS (pos
->string_pos
) == 0)
3256 get_visually_first_element (it
);
3257 if (IT_STRING_CHARPOS (*it
) != 0)
3260 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3261 bidi_move_to_visually_next (&it
->bidi_it
);
3262 } while (it
->bidi_it
.charpos
!= 0);
3264 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3265 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3269 if (CHARPOS (pos
->string_pos
) >= 0)
3271 /* Recorded position is not in an overlay string, but in another
3272 string. This can only be a string from a `display' property.
3273 IT should already be filled with that string. */
3274 it
->current
.string_pos
= pos
->string_pos
;
3275 eassert (STRINGP (it
->string
));
3277 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3278 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3281 /* Restore position in display vector translations, control
3282 character translations or ellipses. */
3283 if (pos
->dpvec_index
>= 0)
3285 if (it
->dpvec
== NULL
)
3286 get_next_display_element (it
);
3287 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3288 it
->current
.dpvec_index
= pos
->dpvec_index
;
3292 return !overlay_strings_with_newlines
;
3296 /* Initialize IT for stepping through current_buffer in window W
3297 starting at ROW->start. */
3300 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3302 init_from_display_pos (it
, w
, &row
->start
);
3303 it
->start
= row
->start
;
3304 it
->continuation_lines_width
= row
->continuation_lines_width
;
3309 /* Initialize IT for stepping through current_buffer in window W
3310 starting in the line following ROW, i.e. starting at ROW->end.
3311 Value is zero if there are overlay strings with newlines at ROW's
3315 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3319 if (init_from_display_pos (it
, w
, &row
->end
))
3321 if (row
->continued_p
)
3322 it
->continuation_lines_width
3323 = row
->continuation_lines_width
+ row
->pixel_width
;
3334 /***********************************************************************
3336 ***********************************************************************/
3338 /* Called when IT reaches IT->stop_charpos. Handle text property and
3339 overlay changes. Set IT->stop_charpos to the next position where
3343 handle_stop (struct it
*it
)
3345 enum prop_handled handled
;
3346 int handle_overlay_change_p
;
3350 it
->current
.dpvec_index
= -1;
3351 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3352 it
->ignore_overlay_strings_at_pos_p
= 0;
3355 /* Use face of preceding text for ellipsis (if invisible) */
3356 if (it
->selective_display_ellipsis_p
)
3357 it
->saved_face_id
= it
->face_id
;
3361 handled
= HANDLED_NORMALLY
;
3363 /* Call text property handlers. */
3364 for (p
= it_props
; p
->handler
; ++p
)
3366 handled
= p
->handler (it
);
3368 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3370 else if (handled
== HANDLED_RETURN
)
3372 /* We still want to show before and after strings from
3373 overlays even if the actual buffer text is replaced. */
3374 if (!handle_overlay_change_p
3376 /* Don't call get_overlay_strings_1 if we already
3377 have overlay strings loaded, because doing so
3378 will load them again and push the iterator state
3379 onto the stack one more time, which is not
3380 expected by the rest of the code that processes
3382 || (it
->current
.overlay_string_index
< 0
3383 ? !get_overlay_strings_1 (it
, 0, 0)
3387 setup_for_ellipsis (it
, 0);
3388 /* When handling a display spec, we might load an
3389 empty string. In that case, discard it here. We
3390 used to discard it in handle_single_display_spec,
3391 but that causes get_overlay_strings_1, above, to
3392 ignore overlay strings that we must check. */
3393 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3397 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3401 it
->ignore_overlay_strings_at_pos_p
= true;
3402 it
->string_from_display_prop_p
= 0;
3403 it
->from_disp_prop_p
= 0;
3404 handle_overlay_change_p
= 0;
3406 handled
= HANDLED_RECOMPUTE_PROPS
;
3409 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3410 handle_overlay_change_p
= 0;
3413 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3415 /* Don't check for overlay strings below when set to deliver
3416 characters from a display vector. */
3417 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3418 handle_overlay_change_p
= 0;
3420 /* Handle overlay changes.
3421 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3422 if it finds overlays. */
3423 if (handle_overlay_change_p
)
3424 handled
= handle_overlay_change (it
);
3429 setup_for_ellipsis (it
, 0);
3433 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3435 /* Determine where to stop next. */
3436 if (handled
== HANDLED_NORMALLY
)
3437 compute_stop_pos (it
);
3441 /* Compute IT->stop_charpos from text property and overlay change
3442 information for IT's current position. */
3445 compute_stop_pos (struct it
*it
)
3447 register INTERVAL iv
, next_iv
;
3448 Lisp_Object object
, limit
, position
;
3449 ptrdiff_t charpos
, bytepos
;
3451 if (STRINGP (it
->string
))
3453 /* Strings are usually short, so don't limit the search for
3455 it
->stop_charpos
= it
->end_charpos
;
3456 object
= it
->string
;
3458 charpos
= IT_STRING_CHARPOS (*it
);
3459 bytepos
= IT_STRING_BYTEPOS (*it
);
3465 /* If end_charpos is out of range for some reason, such as a
3466 misbehaving display function, rationalize it (Bug#5984). */
3467 if (it
->end_charpos
> ZV
)
3468 it
->end_charpos
= ZV
;
3469 it
->stop_charpos
= it
->end_charpos
;
3471 /* If next overlay change is in front of the current stop pos
3472 (which is IT->end_charpos), stop there. Note: value of
3473 next_overlay_change is point-max if no overlay change
3475 charpos
= IT_CHARPOS (*it
);
3476 bytepos
= IT_BYTEPOS (*it
);
3477 pos
= next_overlay_change (charpos
);
3478 if (pos
< it
->stop_charpos
)
3479 it
->stop_charpos
= pos
;
3481 /* Set up variables for computing the stop position from text
3482 property changes. */
3483 XSETBUFFER (object
, current_buffer
);
3484 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3487 /* Get the interval containing IT's position. Value is a null
3488 interval if there isn't such an interval. */
3489 position
= make_number (charpos
);
3490 iv
= validate_interval_range (object
, &position
, &position
, 0);
3493 Lisp_Object values_here
[LAST_PROP_IDX
];
3496 /* Get properties here. */
3497 for (p
= it_props
; p
->handler
; ++p
)
3498 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3500 /* Look for an interval following iv that has different
3502 for (next_iv
= next_interval (iv
);
3505 || XFASTINT (limit
) > next_iv
->position
));
3506 next_iv
= next_interval (next_iv
))
3508 for (p
= it_props
; p
->handler
; ++p
)
3510 Lisp_Object new_value
;
3512 new_value
= textget (next_iv
->plist
, *p
->name
);
3513 if (!EQ (values_here
[p
->idx
], new_value
))
3523 if (INTEGERP (limit
)
3524 && next_iv
->position
>= XFASTINT (limit
))
3525 /* No text property change up to limit. */
3526 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3528 /* Text properties change in next_iv. */
3529 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3533 if (it
->cmp_it
.id
< 0)
3535 ptrdiff_t stoppos
= it
->end_charpos
;
3537 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3539 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3540 stoppos
, it
->string
);
3543 eassert (STRINGP (it
->string
)
3544 || (it
->stop_charpos
>= BEGV
3545 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3549 /* Return the position of the next overlay change after POS in
3550 current_buffer. Value is point-max if no overlay change
3551 follows. This is like `next-overlay-change' but doesn't use
3555 next_overlay_change (ptrdiff_t pos
)
3557 ptrdiff_t i
, noverlays
;
3559 Lisp_Object
*overlays
;
3561 /* Get all overlays at the given position. */
3562 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3564 /* If any of these overlays ends before endpos,
3565 use its ending point instead. */
3566 for (i
= 0; i
< noverlays
; ++i
)
3571 oend
= OVERLAY_END (overlays
[i
]);
3572 oendpos
= OVERLAY_POSITION (oend
);
3573 endpos
= min (endpos
, oendpos
);
3579 /* How many characters forward to search for a display property or
3580 display string. Searching too far forward makes the bidi display
3581 sluggish, especially in small windows. */
3582 #define MAX_DISP_SCAN 250
3584 /* Return the character position of a display string at or after
3585 position specified by POSITION. If no display string exists at or
3586 after POSITION, return ZV. A display string is either an overlay
3587 with `display' property whose value is a string, or a `display'
3588 text property whose value is a string. STRING is data about the
3589 string to iterate; if STRING->lstring is nil, we are iterating a
3590 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3591 on a GUI frame. DISP_PROP is set to zero if we searched
3592 MAX_DISP_SCAN characters forward without finding any display
3593 strings, non-zero otherwise. It is set to 2 if the display string
3594 uses any kind of `(space ...)' spec that will produce a stretch of
3595 white space in the text area. */
3597 compute_display_string_pos (struct text_pos
*position
,
3598 struct bidi_string_data
*string
,
3600 int frame_window_p
, int *disp_prop
)
3602 /* OBJECT = nil means current buffer. */
3603 Lisp_Object object
, object1
;
3604 Lisp_Object pos
, spec
, limpos
;
3605 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3606 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3607 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3608 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3610 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3611 struct text_pos tpos
;
3614 if (string
&& STRINGP (string
->lstring
))
3615 object1
= object
= string
->lstring
;
3616 else if (w
&& !string_p
)
3618 XSETWINDOW (object
, w
);
3622 object1
= object
= Qnil
;
3627 /* We don't support display properties whose values are strings
3628 that have display string properties. */
3629 || string
->from_disp_str
3630 /* C strings cannot have display properties. */
3631 || (string
->s
&& !STRINGP (object
)))
3637 /* If the character at CHARPOS is where the display string begins,
3639 pos
= make_number (charpos
);
3640 if (STRINGP (object
))
3641 bufpos
= string
->bufpos
;
3645 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3647 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3650 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3658 /* Look forward for the first character with a `display' property
3659 that will replace the underlying text when displayed. */
3660 limpos
= make_number (lim
);
3662 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3663 CHARPOS (tpos
) = XFASTINT (pos
);
3664 if (CHARPOS (tpos
) >= lim
)
3669 if (STRINGP (object
))
3670 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3672 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3673 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3674 if (!STRINGP (object
))
3675 bufpos
= CHARPOS (tpos
);
3676 } while (NILP (spec
)
3677 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3678 bufpos
, frame_window_p
)));
3682 return CHARPOS (tpos
);
3685 /* Return the character position of the end of the display string that
3686 started at CHARPOS. If there's no display string at CHARPOS,
3687 return -1. A display string is either an overlay with `display'
3688 property whose value is a string or a `display' text property whose
3689 value is a string. */
3691 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3693 /* OBJECT = nil means current buffer. */
3694 Lisp_Object object
=
3695 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3696 Lisp_Object pos
= make_number (charpos
);
3698 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3700 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3703 /* It could happen that the display property or overlay was removed
3704 since we found it in compute_display_string_pos above. One way
3705 this can happen is if JIT font-lock was called (through
3706 handle_fontified_prop), and jit-lock-functions remove text
3707 properties or overlays from the portion of buffer that includes
3708 CHARPOS. Muse mode is known to do that, for example. In this
3709 case, we return -1 to the caller, to signal that no display
3710 string is actually present at CHARPOS. See bidi_fetch_char for
3711 how this is handled.
3713 An alternative would be to never look for display properties past
3714 it->stop_charpos. But neither compute_display_string_pos nor
3715 bidi_fetch_char that calls it know or care where the next
3717 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3720 /* Look forward for the first character where the `display' property
3722 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3724 return XFASTINT (pos
);
3729 /***********************************************************************
3731 ***********************************************************************/
3733 /* Handle changes in the `fontified' property of the current buffer by
3734 calling hook functions from Qfontification_functions to fontify
3737 static enum prop_handled
3738 handle_fontified_prop (struct it
*it
)
3740 Lisp_Object prop
, pos
;
3741 enum prop_handled handled
= HANDLED_NORMALLY
;
3743 if (!NILP (Vmemory_full
))
3746 /* Get the value of the `fontified' property at IT's current buffer
3747 position. (The `fontified' property doesn't have a special
3748 meaning in strings.) If the value is nil, call functions from
3749 Qfontification_functions. */
3750 if (!STRINGP (it
->string
)
3752 && !NILP (Vfontification_functions
)
3753 && !NILP (Vrun_hooks
)
3754 && (pos
= make_number (IT_CHARPOS (*it
)),
3755 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3756 /* Ignore the special cased nil value always present at EOB since
3757 no amount of fontifying will be able to change it. */
3758 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3760 ptrdiff_t count
= SPECPDL_INDEX ();
3762 struct buffer
*obuf
= current_buffer
;
3763 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3764 bool old_clip_changed
= current_buffer
->clip_changed
;
3766 val
= Vfontification_functions
;
3767 specbind (Qfontification_functions
, Qnil
);
3769 eassert (it
->end_charpos
== ZV
);
3771 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3772 safe_call1 (val
, pos
);
3775 Lisp_Object fns
, fn
;
3776 struct gcpro gcpro1
, gcpro2
;
3781 for (; CONSP (val
); val
= XCDR (val
))
3787 /* A value of t indicates this hook has a local
3788 binding; it means to run the global binding too.
3789 In a global value, t should not occur. If it
3790 does, we must ignore it to avoid an endless
3792 for (fns
= Fdefault_value (Qfontification_functions
);
3798 safe_call1 (fn
, pos
);
3802 safe_call1 (fn
, pos
);
3808 unbind_to (count
, Qnil
);
3810 /* Fontification functions routinely call `save-restriction'.
3811 Normally, this tags clip_changed, which can confuse redisplay
3812 (see discussion in Bug#6671). Since we don't perform any
3813 special handling of fontification changes in the case where
3814 `save-restriction' isn't called, there's no point doing so in
3815 this case either. So, if the buffer's restrictions are
3816 actually left unchanged, reset clip_changed. */
3817 if (obuf
== current_buffer
)
3819 if (begv
== BEGV
&& zv
== ZV
)
3820 current_buffer
->clip_changed
= old_clip_changed
;
3822 /* There isn't much we can reasonably do to protect against
3823 misbehaving fontification, but here's a fig leaf. */
3824 else if (BUFFER_LIVE_P (obuf
))
3825 set_buffer_internal_1 (obuf
);
3827 /* The fontification code may have added/removed text.
3828 It could do even a lot worse, but let's at least protect against
3829 the most obvious case where only the text past `pos' gets changed',
3830 as is/was done in grep.el where some escapes sequences are turned
3831 into face properties (bug#7876). */
3832 it
->end_charpos
= ZV
;
3834 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3835 something. This avoids an endless loop if they failed to
3836 fontify the text for which reason ever. */
3837 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3838 handled
= HANDLED_RECOMPUTE_PROPS
;
3846 /***********************************************************************
3848 ***********************************************************************/
3850 /* Set up iterator IT from face properties at its current position.
3851 Called from handle_stop. */
3853 static enum prop_handled
3854 handle_face_prop (struct it
*it
)
3857 ptrdiff_t next_stop
;
3859 if (!STRINGP (it
->string
))
3862 = face_at_buffer_position (it
->w
,
3866 + TEXT_PROP_DISTANCE_LIMIT
),
3867 0, it
->base_face_id
);
3869 /* Is this a start of a run of characters with box face?
3870 Caveat: this can be called for a freshly initialized
3871 iterator; face_id is -1 in this case. We know that the new
3872 face will not change until limit, i.e. if the new face has a
3873 box, all characters up to limit will have one. But, as
3874 usual, we don't know whether limit is really the end. */
3875 if (new_face_id
!= it
->face_id
)
3877 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3878 /* If it->face_id is -1, old_face below will be NULL, see
3879 the definition of FACE_FROM_ID. This will happen if this
3880 is the initial call that gets the face. */
3881 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3883 /* If the value of face_id of the iterator is -1, we have to
3884 look in front of IT's position and see whether there is a
3885 face there that's different from new_face_id. */
3886 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3888 int prev_face_id
= face_before_it_pos (it
);
3890 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3893 /* If the new face has a box, but the old face does not,
3894 this is the start of a run of characters with box face,
3895 i.e. this character has a shadow on the left side. */
3896 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3897 && (old_face
== NULL
|| !old_face
->box
));
3898 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3906 Lisp_Object from_overlay
3907 = (it
->current
.overlay_string_index
>= 0
3908 ? it
->string_overlays
[it
->current
.overlay_string_index
3909 % OVERLAY_STRING_CHUNK_SIZE
]
3912 /* See if we got to this string directly or indirectly from
3913 an overlay property. That includes the before-string or
3914 after-string of an overlay, strings in display properties
3915 provided by an overlay, their text properties, etc.
3917 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3918 if (! NILP (from_overlay
))
3919 for (i
= it
->sp
- 1; i
>= 0; i
--)
3921 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3923 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3924 % OVERLAY_STRING_CHUNK_SIZE
];
3925 else if (! NILP (it
->stack
[i
].from_overlay
))
3926 from_overlay
= it
->stack
[i
].from_overlay
;
3928 if (!NILP (from_overlay
))
3932 if (! NILP (from_overlay
))
3934 bufpos
= IT_CHARPOS (*it
);
3935 /* For a string from an overlay, the base face depends
3936 only on text properties and ignores overlays. */
3938 = face_for_overlay_string (it
->w
,
3942 + TEXT_PROP_DISTANCE_LIMIT
),
3950 /* For strings from a `display' property, use the face at
3951 IT's current buffer position as the base face to merge
3952 with, so that overlay strings appear in the same face as
3953 surrounding text, unless they specify their own faces.
3954 For strings from wrap-prefix and line-prefix properties,
3955 use the default face, possibly remapped via
3956 Vface_remapping_alist. */
3957 /* Note that the fact that we use the face at _buffer_
3958 position means that a 'display' property on an overlay
3959 string will not inherit the face of that overlay string,
3960 but will instead revert to the face of buffer text
3961 covered by the overlay. This is visible, e.g., when the
3962 overlay specifies a box face, but neither the buffer nor
3963 the display string do. This sounds like a design bug,
3964 but Emacs always did that since v21.1, so changing that
3965 might be a big deal. */
3966 base_face_id
= it
->string_from_prefix_prop_p
3967 ? (!NILP (Vface_remapping_alist
)
3968 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
3970 : underlying_face_id (it
);
3973 new_face_id
= face_at_string_position (it
->w
,
3975 IT_STRING_CHARPOS (*it
),
3980 /* Is this a start of a run of characters with box? Caveat:
3981 this can be called for a freshly allocated iterator; face_id
3982 is -1 is this case. We know that the new face will not
3983 change until the next check pos, i.e. if the new face has a
3984 box, all characters up to that position will have a
3985 box. But, as usual, we don't know whether that position
3986 is really the end. */
3987 if (new_face_id
!= it
->face_id
)
3989 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3990 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3992 /* If new face has a box but old face hasn't, this is the
3993 start of a run of characters with box, i.e. it has a
3994 shadow on the left side. */
3995 it
->start_of_box_run_p
3996 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3997 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4001 it
->face_id
= new_face_id
;
4002 return HANDLED_NORMALLY
;
4006 /* Return the ID of the face ``underlying'' IT's current position,
4007 which is in a string. If the iterator is associated with a
4008 buffer, return the face at IT's current buffer position.
4009 Otherwise, use the iterator's base_face_id. */
4012 underlying_face_id (struct it
*it
)
4014 int face_id
= it
->base_face_id
, i
;
4016 eassert (STRINGP (it
->string
));
4018 for (i
= it
->sp
- 1; i
>= 0; --i
)
4019 if (NILP (it
->stack
[i
].string
))
4020 face_id
= it
->stack
[i
].face_id
;
4026 /* Compute the face one character before or after the current position
4027 of IT, in the visual order. BEFORE_P non-zero means get the face
4028 in front (to the left in L2R paragraphs, to the right in R2L
4029 paragraphs) of IT's screen position. Value is the ID of the face. */
4032 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4035 ptrdiff_t next_check_charpos
;
4037 void *it_copy_data
= NULL
;
4039 eassert (it
->s
== NULL
);
4041 if (STRINGP (it
->string
))
4043 ptrdiff_t bufpos
, charpos
;
4046 /* No face change past the end of the string (for the case
4047 we are padding with spaces). No face change before the
4049 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4050 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4055 /* Set charpos to the position before or after IT's current
4056 position, in the logical order, which in the non-bidi
4057 case is the same as the visual order. */
4059 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4060 else if (it
->what
== IT_COMPOSITION
)
4061 /* For composition, we must check the character after the
4063 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4065 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4071 /* With bidi iteration, the character before the current
4072 in the visual order cannot be found by simple
4073 iteration, because "reverse" reordering is not
4074 supported. Instead, we need to use the move_it_*
4075 family of functions. */
4076 /* Ignore face changes before the first visible
4077 character on this display line. */
4078 if (it
->current_x
<= it
->first_visible_x
)
4080 SAVE_IT (it_copy
, *it
, it_copy_data
);
4081 /* Implementation note: Since move_it_in_display_line
4082 works in the iterator geometry, and thinks the first
4083 character is always the leftmost, even in R2L lines,
4084 we don't need to distinguish between the R2L and L2R
4086 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4087 it_copy
.current_x
- 1, MOVE_TO_X
);
4088 charpos
= IT_STRING_CHARPOS (it_copy
);
4089 RESTORE_IT (it
, it
, it_copy_data
);
4093 /* Set charpos to the string position of the character
4094 that comes after IT's current position in the visual
4096 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4100 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4102 charpos
= it_copy
.bidi_it
.charpos
;
4105 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4107 if (it
->current
.overlay_string_index
>= 0)
4108 bufpos
= IT_CHARPOS (*it
);
4112 base_face_id
= underlying_face_id (it
);
4114 /* Get the face for ASCII, or unibyte. */
4115 face_id
= face_at_string_position (it
->w
,
4119 &next_check_charpos
,
4122 /* Correct the face for charsets different from ASCII. Do it
4123 for the multibyte case only. The face returned above is
4124 suitable for unibyte text if IT->string is unibyte. */
4125 if (STRING_MULTIBYTE (it
->string
))
4127 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4128 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4130 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4132 c
= string_char_and_length (p
, &len
);
4133 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4138 struct text_pos pos
;
4140 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4141 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4144 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4145 pos
= it
->current
.pos
;
4150 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4153 if (it
->what
== IT_COMPOSITION
)
4155 /* For composition, we must check the position after
4157 pos
.charpos
+= it
->cmp_it
.nchars
;
4158 pos
.bytepos
+= it
->len
;
4161 INC_TEXT_POS (pos
, it
->multibyte_p
);
4168 /* With bidi iteration, the character before the current
4169 in the visual order cannot be found by simple
4170 iteration, because "reverse" reordering is not
4171 supported. Instead, we need to use the move_it_*
4172 family of functions. */
4173 /* Ignore face changes before the first visible
4174 character on this display line. */
4175 if (it
->current_x
<= it
->first_visible_x
)
4177 SAVE_IT (it_copy
, *it
, it_copy_data
);
4178 /* Implementation note: Since move_it_in_display_line
4179 works in the iterator geometry, and thinks the first
4180 character is always the leftmost, even in R2L lines,
4181 we don't need to distinguish between the R2L and L2R
4183 move_it_in_display_line (&it_copy
, ZV
,
4184 it_copy
.current_x
- 1, MOVE_TO_X
);
4185 pos
= it_copy
.current
.pos
;
4186 RESTORE_IT (it
, it
, it_copy_data
);
4190 /* Set charpos to the buffer position of the character
4191 that comes after IT's current position in the visual
4193 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4197 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4200 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4203 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4205 /* Determine face for CHARSET_ASCII, or unibyte. */
4206 face_id
= face_at_buffer_position (it
->w
,
4208 &next_check_charpos
,
4211 /* Correct the face for charsets different from ASCII. Do it
4212 for the multibyte case only. The face returned above is
4213 suitable for unibyte text if current_buffer is unibyte. */
4214 if (it
->multibyte_p
)
4216 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4217 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4218 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4227 /***********************************************************************
4229 ***********************************************************************/
4231 /* Set up iterator IT from invisible properties at its current
4232 position. Called from handle_stop. */
4234 static enum prop_handled
4235 handle_invisible_prop (struct it
*it
)
4237 enum prop_handled handled
= HANDLED_NORMALLY
;
4241 if (STRINGP (it
->string
))
4243 Lisp_Object end_charpos
, limit
, charpos
;
4245 /* Get the value of the invisible text property at the
4246 current position. Value will be nil if there is no such
4248 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4249 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4250 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4252 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4254 /* Record whether we have to display an ellipsis for the
4256 int display_ellipsis_p
= (invis_p
== 2);
4257 ptrdiff_t len
, endpos
;
4259 handled
= HANDLED_RECOMPUTE_PROPS
;
4261 /* Get the position at which the next visible text can be
4262 found in IT->string, if any. */
4263 endpos
= len
= SCHARS (it
->string
);
4264 XSETINT (limit
, len
);
4267 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4269 if (INTEGERP (end_charpos
))
4271 endpos
= XFASTINT (end_charpos
);
4272 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4273 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4275 display_ellipsis_p
= true;
4278 while (invis_p
&& endpos
< len
);
4280 if (display_ellipsis_p
)
4281 it
->ellipsis_p
= true;
4285 /* Text at END_CHARPOS is visible. Move IT there. */
4286 struct text_pos old
;
4289 old
= it
->current
.string_pos
;
4290 oldpos
= CHARPOS (old
);
4293 if (it
->bidi_it
.first_elt
4294 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4295 bidi_paragraph_init (it
->paragraph_embedding
,
4297 /* Bidi-iterate out of the invisible text. */
4300 bidi_move_to_visually_next (&it
->bidi_it
);
4302 while (oldpos
<= it
->bidi_it
.charpos
4303 && it
->bidi_it
.charpos
< endpos
);
4305 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4306 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4307 if (IT_CHARPOS (*it
) >= endpos
)
4308 it
->prev_stop
= endpos
;
4312 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4313 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4318 /* The rest of the string is invisible. If this is an
4319 overlay string, proceed with the next overlay string
4320 or whatever comes and return a character from there. */
4321 if (it
->current
.overlay_string_index
>= 0
4322 && !display_ellipsis_p
)
4324 next_overlay_string (it
);
4325 /* Don't check for overlay strings when we just
4326 finished processing them. */
4327 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4331 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4332 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4339 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4340 Lisp_Object pos
, overlay
;
4342 /* First of all, is there invisible text at this position? */
4343 tem
= start_charpos
= IT_CHARPOS (*it
);
4344 pos
= make_number (tem
);
4345 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4347 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4349 /* If we are on invisible text, skip over it. */
4350 if (invis_p
&& start_charpos
< it
->end_charpos
)
4352 /* Record whether we have to display an ellipsis for the
4354 int display_ellipsis_p
= invis_p
== 2;
4356 handled
= HANDLED_RECOMPUTE_PROPS
;
4358 /* Loop skipping over invisible text. The loop is left at
4359 ZV or with IT on the first char being visible again. */
4362 /* Try to skip some invisible text. Return value is the
4363 position reached which can be equal to where we start
4364 if there is nothing invisible there. This skips both
4365 over invisible text properties and overlays with
4366 invisible property. */
4367 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4369 /* If we skipped nothing at all we weren't at invisible
4370 text in the first place. If everything to the end of
4371 the buffer was skipped, end the loop. */
4372 if (newpos
== tem
|| newpos
>= ZV
)
4376 /* We skipped some characters but not necessarily
4377 all there are. Check if we ended up on visible
4378 text. Fget_char_property returns the property of
4379 the char before the given position, i.e. if we
4380 get invis_p = 0, this means that the char at
4381 newpos is visible. */
4382 pos
= make_number (newpos
);
4383 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4384 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4387 /* If we ended up on invisible text, proceed to
4388 skip starting with next_stop. */
4392 /* If there are adjacent invisible texts, don't lose the
4393 second one's ellipsis. */
4395 display_ellipsis_p
= true;
4399 /* The position newpos is now either ZV or on visible text. */
4402 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4404 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4406 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4408 /* If the invisible text ends on a newline or on a
4409 character after a newline, we can avoid the costly,
4410 character by character, bidi iteration to NEWPOS, and
4411 instead simply reseat the iterator there. That's
4412 because all bidi reordering information is tossed at
4413 the newline. This is a big win for modes that hide
4414 complete lines, like Outline, Org, etc. */
4415 if (on_newline
|| after_newline
)
4417 struct text_pos tpos
;
4418 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4420 SET_TEXT_POS (tpos
, newpos
, bpos
);
4421 reseat_1 (it
, tpos
, 0);
4422 /* If we reseat on a newline/ZV, we need to prep the
4423 bidi iterator for advancing to the next character
4424 after the newline/EOB, keeping the current paragraph
4425 direction (so that PRODUCE_GLYPHS does TRT wrt
4426 prepending/appending glyphs to a glyph row). */
4429 it
->bidi_it
.first_elt
= 0;
4430 it
->bidi_it
.paragraph_dir
= pdir
;
4431 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4432 it
->bidi_it
.nchars
= 1;
4433 it
->bidi_it
.ch_len
= 1;
4436 else /* Must use the slow method. */
4438 /* With bidi iteration, the region of invisible text
4439 could start and/or end in the middle of a
4440 non-base embedding level. Therefore, we need to
4441 skip invisible text using the bidi iterator,
4442 starting at IT's current position, until we find
4443 ourselves outside of the invisible text.
4444 Skipping invisible text _after_ bidi iteration
4445 avoids affecting the visual order of the
4446 displayed text when invisible properties are
4447 added or removed. */
4448 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4450 /* If we were `reseat'ed to a new paragraph,
4451 determine the paragraph base direction. We
4452 need to do it now because
4453 next_element_from_buffer may not have a
4454 chance to do it, if we are going to skip any
4455 text at the beginning, which resets the
4457 bidi_paragraph_init (it
->paragraph_embedding
,
4462 bidi_move_to_visually_next (&it
->bidi_it
);
4464 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4465 && it
->bidi_it
.charpos
< newpos
);
4466 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4467 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4468 /* If we overstepped NEWPOS, record its position in
4469 the iterator, so that we skip invisible text if
4470 later the bidi iteration lands us in the
4471 invisible region again. */
4472 if (IT_CHARPOS (*it
) >= newpos
)
4473 it
->prev_stop
= newpos
;
4478 IT_CHARPOS (*it
) = newpos
;
4479 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4482 /* If there are before-strings at the start of invisible
4483 text, and the text is invisible because of a text
4484 property, arrange to show before-strings because 20.x did
4485 it that way. (If the text is invisible because of an
4486 overlay property instead of a text property, this is
4487 already handled in the overlay code.) */
4489 && get_overlay_strings (it
, it
->stop_charpos
))
4491 handled
= HANDLED_RECOMPUTE_PROPS
;
4492 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4494 else if (display_ellipsis_p
)
4496 /* Make sure that the glyphs of the ellipsis will get
4497 correct `charpos' values. If we would not update
4498 it->position here, the glyphs would belong to the
4499 last visible character _before_ the invisible
4500 text, which confuses `set_cursor_from_row'.
4502 We use the last invisible position instead of the
4503 first because this way the cursor is always drawn on
4504 the first "." of the ellipsis, whenever PT is inside
4505 the invisible text. Otherwise the cursor would be
4506 placed _after_ the ellipsis when the point is after the
4507 first invisible character. */
4508 if (!STRINGP (it
->object
))
4510 it
->position
.charpos
= newpos
- 1;
4511 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4513 it
->ellipsis_p
= true;
4514 /* Let the ellipsis display before
4515 considering any properties of the following char.
4516 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4517 handled
= HANDLED_RETURN
;
4526 /* Make iterator IT return `...' next.
4527 Replaces LEN characters from buffer. */
4530 setup_for_ellipsis (struct it
*it
, int len
)
4532 /* Use the display table definition for `...'. Invalid glyphs
4533 will be handled by the method returning elements from dpvec. */
4534 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4536 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4537 it
->dpvec
= v
->contents
;
4538 it
->dpend
= v
->contents
+ v
->header
.size
;
4542 /* Default `...'. */
4543 it
->dpvec
= default_invis_vector
;
4544 it
->dpend
= default_invis_vector
+ 3;
4547 it
->dpvec_char_len
= len
;
4548 it
->current
.dpvec_index
= 0;
4549 it
->dpvec_face_id
= -1;
4551 /* Remember the current face id in case glyphs specify faces.
4552 IT's face is restored in set_iterator_to_next.
4553 saved_face_id was set to preceding char's face in handle_stop. */
4554 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4555 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4557 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4558 it
->ellipsis_p
= true;
4563 /***********************************************************************
4565 ***********************************************************************/
4567 /* Set up iterator IT from `display' property at its current position.
4568 Called from handle_stop.
4569 We return HANDLED_RETURN if some part of the display property
4570 overrides the display of the buffer text itself.
4571 Otherwise we return HANDLED_NORMALLY. */
4573 static enum prop_handled
4574 handle_display_prop (struct it
*it
)
4576 Lisp_Object propval
, object
, overlay
;
4577 struct text_pos
*position
;
4579 /* Nonzero if some property replaces the display of the text itself. */
4580 int display_replaced_p
= 0;
4582 if (STRINGP (it
->string
))
4584 object
= it
->string
;
4585 position
= &it
->current
.string_pos
;
4586 bufpos
= CHARPOS (it
->current
.pos
);
4590 XSETWINDOW (object
, it
->w
);
4591 position
= &it
->current
.pos
;
4592 bufpos
= CHARPOS (*position
);
4595 /* Reset those iterator values set from display property values. */
4596 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4597 it
->space_width
= Qnil
;
4598 it
->font_height
= Qnil
;
4601 /* We don't support recursive `display' properties, i.e. string
4602 values that have a string `display' property, that have a string
4603 `display' property etc. */
4604 if (!it
->string_from_display_prop_p
)
4605 it
->area
= TEXT_AREA
;
4607 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4608 Qdisplay
, object
, &overlay
);
4610 return HANDLED_NORMALLY
;
4611 /* Now OVERLAY is the overlay that gave us this property, or nil
4612 if it was a text property. */
4614 if (!STRINGP (it
->string
))
4615 object
= it
->w
->contents
;
4617 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4619 FRAME_WINDOW_P (it
->f
));
4621 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4624 /* Subroutine of handle_display_prop. Returns non-zero if the display
4625 specification in SPEC is a replacing specification, i.e. it would
4626 replace the text covered by `display' property with something else,
4627 such as an image or a display string. If SPEC includes any kind or
4628 `(space ...) specification, the value is 2; this is used by
4629 compute_display_string_pos, which see.
4631 See handle_single_display_spec for documentation of arguments.
4632 frame_window_p is non-zero if the window being redisplayed is on a
4633 GUI frame; this argument is used only if IT is NULL, see below.
4635 IT can be NULL, if this is called by the bidi reordering code
4636 through compute_display_string_pos, which see. In that case, this
4637 function only examines SPEC, but does not otherwise "handle" it, in
4638 the sense that it doesn't set up members of IT from the display
4641 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4642 Lisp_Object overlay
, struct text_pos
*position
,
4643 ptrdiff_t bufpos
, int frame_window_p
)
4645 int replacing_p
= 0;
4649 /* Simple specifications. */
4650 && !EQ (XCAR (spec
), Qimage
)
4651 && !EQ (XCAR (spec
), Qspace
)
4652 && !EQ (XCAR (spec
), Qwhen
)
4653 && !EQ (XCAR (spec
), Qslice
)
4654 && !EQ (XCAR (spec
), Qspace_width
)
4655 && !EQ (XCAR (spec
), Qheight
)
4656 && !EQ (XCAR (spec
), Qraise
)
4657 /* Marginal area specifications. */
4658 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4659 && !EQ (XCAR (spec
), Qleft_fringe
)
4660 && !EQ (XCAR (spec
), Qright_fringe
)
4661 && !NILP (XCAR (spec
)))
4663 for (; CONSP (spec
); spec
= XCDR (spec
))
4665 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4666 overlay
, position
, bufpos
,
4667 replacing_p
, frame_window_p
)))
4670 /* If some text in a string is replaced, `position' no
4671 longer points to the position of `object'. */
4672 if (!it
|| STRINGP (object
))
4677 else if (VECTORP (spec
))
4680 for (i
= 0; i
< ASIZE (spec
); ++i
)
4681 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4682 overlay
, position
, bufpos
,
4683 replacing_p
, frame_window_p
)))
4686 /* If some text in a string is replaced, `position' no
4687 longer points to the position of `object'. */
4688 if (!it
|| STRINGP (object
))
4694 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4695 position
, bufpos
, 0,
4703 /* Value is the position of the end of the `display' property starting
4704 at START_POS in OBJECT. */
4706 static struct text_pos
4707 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4710 struct text_pos end_pos
;
4712 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4713 Qdisplay
, object
, Qnil
);
4714 CHARPOS (end_pos
) = XFASTINT (end
);
4715 if (STRINGP (object
))
4716 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4718 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4724 /* Set up IT from a single `display' property specification SPEC. OBJECT
4725 is the object in which the `display' property was found. *POSITION
4726 is the position in OBJECT at which the `display' property was found.
4727 BUFPOS is the buffer position of OBJECT (different from POSITION if
4728 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4729 previously saw a display specification which already replaced text
4730 display with something else, for example an image; we ignore such
4731 properties after the first one has been processed.
4733 OVERLAY is the overlay this `display' property came from,
4734 or nil if it was a text property.
4736 If SPEC is a `space' or `image' specification, and in some other
4737 cases too, set *POSITION to the position where the `display'
4740 If IT is NULL, only examine the property specification in SPEC, but
4741 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4742 is intended to be displayed in a window on a GUI frame.
4744 Value is non-zero if something was found which replaces the display
4745 of buffer or string text. */
4748 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4749 Lisp_Object overlay
, struct text_pos
*position
,
4750 ptrdiff_t bufpos
, int display_replaced_p
,
4754 Lisp_Object location
, value
;
4755 struct text_pos start_pos
= *position
;
4758 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4759 If the result is non-nil, use VALUE instead of SPEC. */
4761 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4770 if (!NILP (form
) && !EQ (form
, Qt
))
4772 ptrdiff_t count
= SPECPDL_INDEX ();
4773 struct gcpro gcpro1
;
4775 /* Bind `object' to the object having the `display' property, a
4776 buffer or string. Bind `position' to the position in the
4777 object where the property was found, and `buffer-position'
4778 to the current position in the buffer. */
4781 XSETBUFFER (object
, current_buffer
);
4782 specbind (Qobject
, object
);
4783 specbind (Qposition
, make_number (CHARPOS (*position
)));
4784 specbind (Qbuffer_position
, make_number (bufpos
));
4786 form
= safe_eval (form
);
4788 unbind_to (count
, Qnil
);
4794 /* Handle `(height HEIGHT)' specifications. */
4796 && EQ (XCAR (spec
), Qheight
)
4797 && CONSP (XCDR (spec
)))
4801 if (!FRAME_WINDOW_P (it
->f
))
4804 it
->font_height
= XCAR (XCDR (spec
));
4805 if (!NILP (it
->font_height
))
4807 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4808 int new_height
= -1;
4810 if (CONSP (it
->font_height
)
4811 && (EQ (XCAR (it
->font_height
), Qplus
)
4812 || EQ (XCAR (it
->font_height
), Qminus
))
4813 && CONSP (XCDR (it
->font_height
))
4814 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4816 /* `(+ N)' or `(- N)' where N is an integer. */
4817 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4818 if (EQ (XCAR (it
->font_height
), Qplus
))
4820 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4822 else if (FUNCTIONP (it
->font_height
))
4824 /* Call function with current height as argument.
4825 Value is the new height. */
4827 height
= safe_call1 (it
->font_height
,
4828 face
->lface
[LFACE_HEIGHT_INDEX
]);
4829 if (NUMBERP (height
))
4830 new_height
= XFLOATINT (height
);
4832 else if (NUMBERP (it
->font_height
))
4834 /* Value is a multiple of the canonical char height. */
4837 f
= FACE_FROM_ID (it
->f
,
4838 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4839 new_height
= (XFLOATINT (it
->font_height
)
4840 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4844 /* Evaluate IT->font_height with `height' bound to the
4845 current specified height to get the new height. */
4846 ptrdiff_t count
= SPECPDL_INDEX ();
4848 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4849 value
= safe_eval (it
->font_height
);
4850 unbind_to (count
, Qnil
);
4852 if (NUMBERP (value
))
4853 new_height
= XFLOATINT (value
);
4857 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4864 /* Handle `(space-width WIDTH)'. */
4866 && EQ (XCAR (spec
), Qspace_width
)
4867 && CONSP (XCDR (spec
)))
4871 if (!FRAME_WINDOW_P (it
->f
))
4874 value
= XCAR (XCDR (spec
));
4875 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4876 it
->space_width
= value
;
4882 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4884 && EQ (XCAR (spec
), Qslice
))
4890 if (!FRAME_WINDOW_P (it
->f
))
4893 if (tem
= XCDR (spec
), CONSP (tem
))
4895 it
->slice
.x
= XCAR (tem
);
4896 if (tem
= XCDR (tem
), CONSP (tem
))
4898 it
->slice
.y
= XCAR (tem
);
4899 if (tem
= XCDR (tem
), CONSP (tem
))
4901 it
->slice
.width
= XCAR (tem
);
4902 if (tem
= XCDR (tem
), CONSP (tem
))
4903 it
->slice
.height
= XCAR (tem
);
4912 /* Handle `(raise FACTOR)'. */
4914 && EQ (XCAR (spec
), Qraise
)
4915 && CONSP (XCDR (spec
)))
4919 if (!FRAME_WINDOW_P (it
->f
))
4922 #ifdef HAVE_WINDOW_SYSTEM
4923 value
= XCAR (XCDR (spec
));
4924 if (NUMBERP (value
))
4926 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4927 it
->voffset
= - (XFLOATINT (value
)
4928 * (FONT_HEIGHT (face
->font
)));
4930 #endif /* HAVE_WINDOW_SYSTEM */
4936 /* Don't handle the other kinds of display specifications
4937 inside a string that we got from a `display' property. */
4938 if (it
&& it
->string_from_display_prop_p
)
4941 /* Characters having this form of property are not displayed, so
4942 we have to find the end of the property. */
4945 start_pos
= *position
;
4946 *position
= display_prop_end (it
, object
, start_pos
);
4950 /* Stop the scan at that end position--we assume that all
4951 text properties change there. */
4953 it
->stop_charpos
= position
->charpos
;
4955 /* Handle `(left-fringe BITMAP [FACE])'
4956 and `(right-fringe BITMAP [FACE])'. */
4958 && (EQ (XCAR (spec
), Qleft_fringe
)
4959 || EQ (XCAR (spec
), Qright_fringe
))
4960 && CONSP (XCDR (spec
)))
4966 if (!FRAME_WINDOW_P (it
->f
))
4967 /* If we return here, POSITION has been advanced
4968 across the text with this property. */
4970 /* Synchronize the bidi iterator with POSITION. This is
4971 needed because we are not going to push the iterator
4972 on behalf of this display property, so there will be
4973 no pop_it call to do this synchronization for us. */
4976 it
->position
= *position
;
4977 iterate_out_of_display_property (it
);
4978 *position
= it
->position
;
4983 else if (!frame_window_p
)
4986 #ifdef HAVE_WINDOW_SYSTEM
4987 value
= XCAR (XCDR (spec
));
4988 if (!SYMBOLP (value
)
4989 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4990 /* If we return here, POSITION has been advanced
4991 across the text with this property. */
4993 if (it
&& it
->bidi_p
)
4995 it
->position
= *position
;
4996 iterate_out_of_display_property (it
);
4997 *position
= it
->position
;
5004 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5006 if (CONSP (XCDR (XCDR (spec
))))
5008 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5009 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5015 /* Save current settings of IT so that we can restore them
5016 when we are finished with the glyph property value. */
5017 push_it (it
, position
);
5019 it
->area
= TEXT_AREA
;
5020 it
->what
= IT_IMAGE
;
5021 it
->image_id
= -1; /* no image */
5022 it
->position
= start_pos
;
5023 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5024 it
->method
= GET_FROM_IMAGE
;
5025 it
->from_overlay
= Qnil
;
5026 it
->face_id
= face_id
;
5027 it
->from_disp_prop_p
= true;
5029 /* Say that we haven't consumed the characters with
5030 `display' property yet. The call to pop_it in
5031 set_iterator_to_next will clean this up. */
5032 *position
= start_pos
;
5034 if (EQ (XCAR (spec
), Qleft_fringe
))
5036 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5037 it
->left_user_fringe_face_id
= face_id
;
5041 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5042 it
->right_user_fringe_face_id
= face_id
;
5045 #endif /* HAVE_WINDOW_SYSTEM */
5049 /* Prepare to handle `((margin left-margin) ...)',
5050 `((margin right-margin) ...)' and `((margin nil) ...)'
5051 prefixes for display specifications. */
5052 location
= Qunbound
;
5053 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5057 value
= XCDR (spec
);
5059 value
= XCAR (value
);
5062 if (EQ (XCAR (tem
), Qmargin
)
5063 && (tem
= XCDR (tem
),
5064 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5066 || EQ (tem
, Qleft_margin
)
5067 || EQ (tem
, Qright_margin
))))
5071 if (EQ (location
, Qunbound
))
5077 /* After this point, VALUE is the property after any
5078 margin prefix has been stripped. It must be a string,
5079 an image specification, or `(space ...)'.
5081 LOCATION specifies where to display: `left-margin',
5082 `right-margin' or nil. */
5084 valid_p
= (STRINGP (value
)
5085 #ifdef HAVE_WINDOW_SYSTEM
5086 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5087 && valid_image_p (value
))
5088 #endif /* not HAVE_WINDOW_SYSTEM */
5089 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5091 if (valid_p
&& !display_replaced_p
)
5097 /* Callers need to know whether the display spec is any kind
5098 of `(space ...)' spec that is about to affect text-area
5100 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5105 /* Save current settings of IT so that we can restore them
5106 when we are finished with the glyph property value. */
5107 push_it (it
, position
);
5108 it
->from_overlay
= overlay
;
5109 it
->from_disp_prop_p
= true;
5111 if (NILP (location
))
5112 it
->area
= TEXT_AREA
;
5113 else if (EQ (location
, Qleft_margin
))
5114 it
->area
= LEFT_MARGIN_AREA
;
5116 it
->area
= RIGHT_MARGIN_AREA
;
5118 if (STRINGP (value
))
5121 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5122 it
->current
.overlay_string_index
= -1;
5123 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5124 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5125 it
->method
= GET_FROM_STRING
;
5126 it
->stop_charpos
= 0;
5128 it
->base_level_stop
= 0;
5129 it
->string_from_display_prop_p
= true;
5130 /* Say that we haven't consumed the characters with
5131 `display' property yet. The call to pop_it in
5132 set_iterator_to_next will clean this up. */
5133 if (BUFFERP (object
))
5134 *position
= start_pos
;
5136 /* Force paragraph direction to be that of the parent
5137 object. If the parent object's paragraph direction is
5138 not yet determined, default to L2R. */
5139 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5140 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5142 it
->paragraph_embedding
= L2R
;
5144 /* Set up the bidi iterator for this display string. */
5147 it
->bidi_it
.string
.lstring
= it
->string
;
5148 it
->bidi_it
.string
.s
= NULL
;
5149 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5150 it
->bidi_it
.string
.bufpos
= bufpos
;
5151 it
->bidi_it
.string
.from_disp_str
= 1;
5152 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5153 it
->bidi_it
.w
= it
->w
;
5154 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5157 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5159 it
->method
= GET_FROM_STRETCH
;
5161 *position
= it
->position
= start_pos
;
5162 retval
= 1 + (it
->area
== TEXT_AREA
);
5164 #ifdef HAVE_WINDOW_SYSTEM
5167 it
->what
= IT_IMAGE
;
5168 it
->image_id
= lookup_image (it
->f
, value
);
5169 it
->position
= start_pos
;
5170 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5171 it
->method
= GET_FROM_IMAGE
;
5173 /* Say that we haven't consumed the characters with
5174 `display' property yet. The call to pop_it in
5175 set_iterator_to_next will clean this up. */
5176 *position
= start_pos
;
5178 #endif /* HAVE_WINDOW_SYSTEM */
5183 /* Invalid property or property not supported. Restore
5184 POSITION to what it was before. */
5185 *position
= start_pos
;
5189 /* Check if PROP is a display property value whose text should be
5190 treated as intangible. OVERLAY is the overlay from which PROP
5191 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5192 specify the buffer position covered by PROP. */
5195 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5196 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5198 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5199 struct text_pos position
;
5201 SET_TEXT_POS (position
, charpos
, bytepos
);
5202 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5203 &position
, charpos
, frame_window_p
);
5207 /* Return 1 if PROP is a display sub-property value containing STRING.
5209 Implementation note: this and the following function are really
5210 special cases of handle_display_spec and
5211 handle_single_display_spec, and should ideally use the same code.
5212 Until they do, these two pairs must be consistent and must be
5213 modified in sync. */
5216 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5218 if (EQ (string
, prop
))
5221 /* Skip over `when FORM'. */
5222 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5227 /* Actually, the condition following `when' should be eval'ed,
5228 like handle_single_display_spec does, and we should return
5229 zero if it evaluates to nil. However, this function is
5230 called only when the buffer was already displayed and some
5231 glyph in the glyph matrix was found to come from a display
5232 string. Therefore, the condition was already evaluated, and
5233 the result was non-nil, otherwise the display string wouldn't
5234 have been displayed and we would have never been called for
5235 this property. Thus, we can skip the evaluation and assume
5236 its result is non-nil. */
5241 /* Skip over `margin LOCATION'. */
5242 if (EQ (XCAR (prop
), Qmargin
))
5253 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5257 /* Return 1 if STRING appears in the `display' property PROP. */
5260 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5263 && !EQ (XCAR (prop
), Qwhen
)
5264 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5266 /* A list of sub-properties. */
5267 while (CONSP (prop
))
5269 if (single_display_spec_string_p (XCAR (prop
), string
))
5274 else if (VECTORP (prop
))
5276 /* A vector of sub-properties. */
5278 for (i
= 0; i
< ASIZE (prop
); ++i
)
5279 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5283 return single_display_spec_string_p (prop
, string
);
5288 /* Look for STRING in overlays and text properties in the current
5289 buffer, between character positions FROM and TO (excluding TO).
5290 BACK_P non-zero means look back (in this case, TO is supposed to be
5292 Value is the first character position where STRING was found, or
5293 zero if it wasn't found before hitting TO.
5295 This function may only use code that doesn't eval because it is
5296 called asynchronously from note_mouse_highlight. */
5299 string_buffer_position_lim (Lisp_Object string
,
5300 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5302 Lisp_Object limit
, prop
, pos
;
5305 pos
= make_number (max (from
, BEGV
));
5307 if (!back_p
) /* looking forward */
5309 limit
= make_number (min (to
, ZV
));
5310 while (!found
&& !EQ (pos
, limit
))
5312 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5313 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5316 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5320 else /* looking back */
5322 limit
= make_number (max (to
, BEGV
));
5323 while (!found
&& !EQ (pos
, limit
))
5325 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5326 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5329 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5334 return found
? XINT (pos
) : 0;
5337 /* Determine which buffer position in current buffer STRING comes from.
5338 AROUND_CHARPOS is an approximate position where it could come from.
5339 Value is the buffer position or 0 if it couldn't be determined.
5341 This function is necessary because we don't record buffer positions
5342 in glyphs generated from strings (to keep struct glyph small).
5343 This function may only use code that doesn't eval because it is
5344 called asynchronously from note_mouse_highlight. */
5347 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5349 const int MAX_DISTANCE
= 1000;
5350 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5351 around_charpos
+ MAX_DISTANCE
,
5355 found
= string_buffer_position_lim (string
, around_charpos
,
5356 around_charpos
- MAX_DISTANCE
, 1);
5362 /***********************************************************************
5363 `composition' property
5364 ***********************************************************************/
5366 /* Set up iterator IT from `composition' property at its current
5367 position. Called from handle_stop. */
5369 static enum prop_handled
5370 handle_composition_prop (struct it
*it
)
5372 Lisp_Object prop
, string
;
5373 ptrdiff_t pos
, pos_byte
, start
, end
;
5375 if (STRINGP (it
->string
))
5379 pos
= IT_STRING_CHARPOS (*it
);
5380 pos_byte
= IT_STRING_BYTEPOS (*it
);
5381 string
= it
->string
;
5382 s
= SDATA (string
) + pos_byte
;
5383 it
->c
= STRING_CHAR (s
);
5387 pos
= IT_CHARPOS (*it
);
5388 pos_byte
= IT_BYTEPOS (*it
);
5390 it
->c
= FETCH_CHAR (pos_byte
);
5393 /* If there's a valid composition and point is not inside of the
5394 composition (in the case that the composition is from the current
5395 buffer), draw a glyph composed from the composition components. */
5396 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5397 && composition_valid_p (start
, end
, prop
)
5398 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5401 /* As we can't handle this situation (perhaps font-lock added
5402 a new composition), we just return here hoping that next
5403 redisplay will detect this composition much earlier. */
5404 return HANDLED_NORMALLY
;
5407 if (STRINGP (it
->string
))
5408 pos_byte
= string_char_to_byte (it
->string
, start
);
5410 pos_byte
= CHAR_TO_BYTE (start
);
5412 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5415 if (it
->cmp_it
.id
>= 0)
5418 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5419 it
->cmp_it
.nglyphs
= -1;
5423 return HANDLED_NORMALLY
;
5428 /***********************************************************************
5430 ***********************************************************************/
5432 /* The following structure is used to record overlay strings for
5433 later sorting in load_overlay_strings. */
5435 struct overlay_entry
5437 Lisp_Object overlay
;
5444 /* Set up iterator IT from overlay strings at its current position.
5445 Called from handle_stop. */
5447 static enum prop_handled
5448 handle_overlay_change (struct it
*it
)
5450 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5451 return HANDLED_RECOMPUTE_PROPS
;
5453 return HANDLED_NORMALLY
;
5457 /* Set up the next overlay string for delivery by IT, if there is an
5458 overlay string to deliver. Called by set_iterator_to_next when the
5459 end of the current overlay string is reached. If there are more
5460 overlay strings to display, IT->string and
5461 IT->current.overlay_string_index are set appropriately here.
5462 Otherwise IT->string is set to nil. */
5465 next_overlay_string (struct it
*it
)
5467 ++it
->current
.overlay_string_index
;
5468 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5470 /* No more overlay strings. Restore IT's settings to what
5471 they were before overlay strings were processed, and
5472 continue to deliver from current_buffer. */
5474 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5477 || (NILP (it
->string
)
5478 && it
->method
== GET_FROM_BUFFER
5479 && it
->stop_charpos
>= BEGV
5480 && it
->stop_charpos
<= it
->end_charpos
));
5481 it
->current
.overlay_string_index
= -1;
5482 it
->n_overlay_strings
= 0;
5483 it
->overlay_strings_charpos
= -1;
5484 /* If there's an empty display string on the stack, pop the
5485 stack, to resync the bidi iterator with IT's position. Such
5486 empty strings are pushed onto the stack in
5487 get_overlay_strings_1. */
5488 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5491 /* If we're at the end of the buffer, record that we have
5492 processed the overlay strings there already, so that
5493 next_element_from_buffer doesn't try it again. */
5494 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5495 it
->overlay_strings_at_end_processed_p
= true;
5499 /* There are more overlay strings to process. If
5500 IT->current.overlay_string_index has advanced to a position
5501 where we must load IT->overlay_strings with more strings, do
5502 it. We must load at the IT->overlay_strings_charpos where
5503 IT->n_overlay_strings was originally computed; when invisible
5504 text is present, this might not be IT_CHARPOS (Bug#7016). */
5505 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5507 if (it
->current
.overlay_string_index
&& i
== 0)
5508 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5510 /* Initialize IT to deliver display elements from the overlay
5512 it
->string
= it
->overlay_strings
[i
];
5513 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5514 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5515 it
->method
= GET_FROM_STRING
;
5516 it
->stop_charpos
= 0;
5517 it
->end_charpos
= SCHARS (it
->string
);
5518 if (it
->cmp_it
.stop_pos
>= 0)
5519 it
->cmp_it
.stop_pos
= 0;
5521 it
->base_level_stop
= 0;
5523 /* Set up the bidi iterator for this overlay string. */
5526 it
->bidi_it
.string
.lstring
= it
->string
;
5527 it
->bidi_it
.string
.s
= NULL
;
5528 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5529 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5530 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5531 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5532 it
->bidi_it
.w
= it
->w
;
5533 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5541 /* Compare two overlay_entry structures E1 and E2. Used as a
5542 comparison function for qsort in load_overlay_strings. Overlay
5543 strings for the same position are sorted so that
5545 1. All after-strings come in front of before-strings, except
5546 when they come from the same overlay.
5548 2. Within after-strings, strings are sorted so that overlay strings
5549 from overlays with higher priorities come first.
5551 2. Within before-strings, strings are sorted so that overlay
5552 strings from overlays with higher priorities come last.
5554 Value is analogous to strcmp. */
5558 compare_overlay_entries (const void *e1
, const void *e2
)
5560 struct overlay_entry
const *entry1
= e1
;
5561 struct overlay_entry
const *entry2
= e2
;
5564 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5566 /* Let after-strings appear in front of before-strings if
5567 they come from different overlays. */
5568 if (EQ (entry1
->overlay
, entry2
->overlay
))
5569 result
= entry1
->after_string_p
? 1 : -1;
5571 result
= entry1
->after_string_p
? -1 : 1;
5573 else if (entry1
->priority
!= entry2
->priority
)
5575 if (entry1
->after_string_p
)
5576 /* After-strings sorted in order of decreasing priority. */
5577 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5579 /* Before-strings sorted in order of increasing priority. */
5580 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5589 /* Load the vector IT->overlay_strings with overlay strings from IT's
5590 current buffer position, or from CHARPOS if that is > 0. Set
5591 IT->n_overlays to the total number of overlay strings found.
5593 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5594 a time. On entry into load_overlay_strings,
5595 IT->current.overlay_string_index gives the number of overlay
5596 strings that have already been loaded by previous calls to this
5599 IT->add_overlay_start contains an additional overlay start
5600 position to consider for taking overlay strings from, if non-zero.
5601 This position comes into play when the overlay has an `invisible'
5602 property, and both before and after-strings. When we've skipped to
5603 the end of the overlay, because of its `invisible' property, we
5604 nevertheless want its before-string to appear.
5605 IT->add_overlay_start will contain the overlay start position
5608 Overlay strings are sorted so that after-string strings come in
5609 front of before-string strings. Within before and after-strings,
5610 strings are sorted by overlay priority. See also function
5611 compare_overlay_entries. */
5614 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5616 Lisp_Object overlay
, window
, str
, invisible
;
5617 struct Lisp_Overlay
*ov
;
5618 ptrdiff_t start
, end
;
5619 ptrdiff_t size
= 20;
5620 ptrdiff_t n
= 0, i
, j
;
5622 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5626 charpos
= IT_CHARPOS (*it
);
5628 /* Append the overlay string STRING of overlay OVERLAY to vector
5629 `entries' which has size `size' and currently contains `n'
5630 elements. AFTER_P non-zero means STRING is an after-string of
5632 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5635 Lisp_Object priority; \
5639 struct overlay_entry *old = entries; \
5640 SAFE_NALLOCA (entries, 2, size); \
5641 memcpy (entries, old, size * sizeof *entries); \
5645 entries[n].string = (STRING); \
5646 entries[n].overlay = (OVERLAY); \
5647 priority = Foverlay_get ((OVERLAY), Qpriority); \
5648 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5649 entries[n].after_string_p = (AFTER_P); \
5654 /* Process overlay before the overlay center. */
5655 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5657 XSETMISC (overlay
, ov
);
5658 eassert (OVERLAYP (overlay
));
5659 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5660 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5665 /* Skip this overlay if it doesn't start or end at IT's current
5667 if (end
!= charpos
&& start
!= charpos
)
5670 /* Skip this overlay if it doesn't apply to IT->w. */
5671 window
= Foverlay_get (overlay
, Qwindow
);
5672 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5675 /* If the text ``under'' the overlay is invisible, both before-
5676 and after-strings from this overlay are visible; start and
5677 end position are indistinguishable. */
5678 invisible
= Foverlay_get (overlay
, Qinvisible
);
5679 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5681 /* If overlay has a non-empty before-string, record it. */
5682 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5683 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5685 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5687 /* If overlay has a non-empty after-string, record it. */
5688 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5689 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5691 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5694 /* Process overlays after the overlay center. */
5695 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5697 XSETMISC (overlay
, ov
);
5698 eassert (OVERLAYP (overlay
));
5699 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5700 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5702 if (start
> charpos
)
5705 /* Skip this overlay if it doesn't start or end at IT's current
5707 if (end
!= charpos
&& start
!= charpos
)
5710 /* Skip this overlay if it doesn't apply to IT->w. */
5711 window
= Foverlay_get (overlay
, Qwindow
);
5712 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5715 /* If the text ``under'' the overlay is invisible, it has a zero
5716 dimension, and both before- and after-strings apply. */
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 #undef RECORD_OVERLAY_STRING
5737 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5739 /* Record number of overlay strings, and where we computed it. */
5740 it
->n_overlay_strings
= n
;
5741 it
->overlay_strings_charpos
= charpos
;
5743 /* IT->current.overlay_string_index is the number of overlay strings
5744 that have already been consumed by IT. Copy some of the
5745 remaining overlay strings to IT->overlay_strings. */
5747 j
= it
->current
.overlay_string_index
;
5748 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5750 it
->overlay_strings
[i
] = entries
[j
].string
;
5751 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5759 /* Get the first chunk of overlay strings at IT's current buffer
5760 position, or at CHARPOS if that is > 0. Value is non-zero if at
5761 least one overlay string was found. */
5764 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5766 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5767 process. This fills IT->overlay_strings with strings, and sets
5768 IT->n_overlay_strings to the total number of strings to process.
5769 IT->pos.overlay_string_index has to be set temporarily to zero
5770 because load_overlay_strings needs this; it must be set to -1
5771 when no overlay strings are found because a zero value would
5772 indicate a position in the first overlay string. */
5773 it
->current
.overlay_string_index
= 0;
5774 load_overlay_strings (it
, charpos
);
5776 /* If we found overlay strings, set up IT to deliver display
5777 elements from the first one. Otherwise set up IT to deliver
5778 from current_buffer. */
5779 if (it
->n_overlay_strings
)
5781 /* Make sure we know settings in current_buffer, so that we can
5782 restore meaningful values when we're done with the overlay
5785 compute_stop_pos (it
);
5786 eassert (it
->face_id
>= 0);
5788 /* Save IT's settings. They are restored after all overlay
5789 strings have been processed. */
5790 eassert (!compute_stop_p
|| it
->sp
== 0);
5792 /* When called from handle_stop, there might be an empty display
5793 string loaded. In that case, don't bother saving it. But
5794 don't use this optimization with the bidi iterator, since we
5795 need the corresponding pop_it call to resync the bidi
5796 iterator's position with IT's position, after we are done
5797 with the overlay strings. (The corresponding call to pop_it
5798 in case of an empty display string is in
5799 next_overlay_string.) */
5801 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5804 /* Set up IT to deliver display elements from the first overlay
5806 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5807 it
->string
= it
->overlay_strings
[0];
5808 it
->from_overlay
= Qnil
;
5809 it
->stop_charpos
= 0;
5810 eassert (STRINGP (it
->string
));
5811 it
->end_charpos
= SCHARS (it
->string
);
5813 it
->base_level_stop
= 0;
5814 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5815 it
->method
= GET_FROM_STRING
;
5816 it
->from_disp_prop_p
= 0;
5818 /* Force paragraph direction to be that of the parent
5820 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5821 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5823 it
->paragraph_embedding
= L2R
;
5825 /* Set up the bidi iterator for this overlay string. */
5828 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5830 it
->bidi_it
.string
.lstring
= it
->string
;
5831 it
->bidi_it
.string
.s
= NULL
;
5832 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5833 it
->bidi_it
.string
.bufpos
= pos
;
5834 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5835 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5836 it
->bidi_it
.w
= it
->w
;
5837 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5842 it
->current
.overlay_string_index
= -1;
5847 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5850 it
->method
= GET_FROM_BUFFER
;
5852 (void) get_overlay_strings_1 (it
, charpos
, 1);
5856 /* Value is non-zero if we found at least one overlay string. */
5857 return STRINGP (it
->string
);
5862 /***********************************************************************
5863 Saving and restoring state
5864 ***********************************************************************/
5866 /* Save current settings of IT on IT->stack. Called, for example,
5867 before setting up IT for an overlay string, to be able to restore
5868 IT's settings to what they were after the overlay string has been
5869 processed. If POSITION is non-NULL, it is the position to save on
5870 the stack instead of IT->position. */
5873 push_it (struct it
*it
, struct text_pos
*position
)
5875 struct iterator_stack_entry
*p
;
5877 eassert (it
->sp
< IT_STACK_SIZE
);
5878 p
= it
->stack
+ it
->sp
;
5880 p
->stop_charpos
= it
->stop_charpos
;
5881 p
->prev_stop
= it
->prev_stop
;
5882 p
->base_level_stop
= it
->base_level_stop
;
5883 p
->cmp_it
= it
->cmp_it
;
5884 eassert (it
->face_id
>= 0);
5885 p
->face_id
= it
->face_id
;
5886 p
->string
= it
->string
;
5887 p
->method
= it
->method
;
5888 p
->from_overlay
= it
->from_overlay
;
5891 case GET_FROM_IMAGE
:
5892 p
->u
.image
.object
= it
->object
;
5893 p
->u
.image
.image_id
= it
->image_id
;
5894 p
->u
.image
.slice
= it
->slice
;
5896 case GET_FROM_STRETCH
:
5897 p
->u
.stretch
.object
= it
->object
;
5900 p
->position
= position
? *position
: it
->position
;
5901 p
->current
= it
->current
;
5902 p
->end_charpos
= it
->end_charpos
;
5903 p
->string_nchars
= it
->string_nchars
;
5905 p
->multibyte_p
= it
->multibyte_p
;
5906 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5907 p
->space_width
= it
->space_width
;
5908 p
->font_height
= it
->font_height
;
5909 p
->voffset
= it
->voffset
;
5910 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5911 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5912 p
->display_ellipsis_p
= 0;
5913 p
->line_wrap
= it
->line_wrap
;
5914 p
->bidi_p
= it
->bidi_p
;
5915 p
->paragraph_embedding
= it
->paragraph_embedding
;
5916 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5919 /* Save the state of the bidi iterator as well. */
5921 bidi_push_it (&it
->bidi_it
);
5925 iterate_out_of_display_property (struct it
*it
)
5927 int buffer_p
= !STRINGP (it
->string
);
5928 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5929 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5931 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5933 /* Maybe initialize paragraph direction. If we are at the beginning
5934 of a new paragraph, next_element_from_buffer may not have a
5935 chance to do that. */
5936 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5937 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5938 /* prev_stop can be zero, so check against BEGV as well. */
5939 while (it
->bidi_it
.charpos
>= bob
5940 && it
->prev_stop
<= it
->bidi_it
.charpos
5941 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5942 && it
->bidi_it
.charpos
< eob
)
5943 bidi_move_to_visually_next (&it
->bidi_it
);
5944 /* Record the stop_pos we just crossed, for when we cross it
5946 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5947 it
->prev_stop
= CHARPOS (it
->position
);
5948 /* If we ended up not where pop_it put us, resync IT's
5949 positional members with the bidi iterator. */
5950 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5951 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5953 it
->current
.pos
= it
->position
;
5955 it
->current
.string_pos
= it
->position
;
5958 /* Restore IT's settings from IT->stack. Called, for example, when no
5959 more overlay strings must be processed, and we return to delivering
5960 display elements from a buffer, or when the end of a string from a
5961 `display' property is reached and we return to delivering display
5962 elements from an overlay string, or from a buffer. */
5965 pop_it (struct it
*it
)
5967 struct iterator_stack_entry
*p
;
5968 int from_display_prop
= it
->from_disp_prop_p
;
5970 eassert (it
->sp
> 0);
5972 p
= it
->stack
+ it
->sp
;
5973 it
->stop_charpos
= p
->stop_charpos
;
5974 it
->prev_stop
= p
->prev_stop
;
5975 it
->base_level_stop
= p
->base_level_stop
;
5976 it
->cmp_it
= p
->cmp_it
;
5977 it
->face_id
= p
->face_id
;
5978 it
->current
= p
->current
;
5979 it
->position
= p
->position
;
5980 it
->string
= p
->string
;
5981 it
->from_overlay
= p
->from_overlay
;
5982 if (NILP (it
->string
))
5983 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5984 it
->method
= p
->method
;
5987 case GET_FROM_IMAGE
:
5988 it
->image_id
= p
->u
.image
.image_id
;
5989 it
->object
= p
->u
.image
.object
;
5990 it
->slice
= p
->u
.image
.slice
;
5992 case GET_FROM_STRETCH
:
5993 it
->object
= p
->u
.stretch
.object
;
5995 case GET_FROM_BUFFER
:
5996 it
->object
= it
->w
->contents
;
5998 case GET_FROM_STRING
:
6000 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6002 /* Restore the face_box_p flag, since it could have been
6003 overwritten by the face of the object that we just finished
6006 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6007 it
->object
= it
->string
;
6010 case GET_FROM_DISPLAY_VECTOR
:
6012 it
->method
= GET_FROM_C_STRING
;
6013 else if (STRINGP (it
->string
))
6014 it
->method
= GET_FROM_STRING
;
6017 it
->method
= GET_FROM_BUFFER
;
6018 it
->object
= it
->w
->contents
;
6021 it
->end_charpos
= p
->end_charpos
;
6022 it
->string_nchars
= p
->string_nchars
;
6024 it
->multibyte_p
= p
->multibyte_p
;
6025 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6026 it
->space_width
= p
->space_width
;
6027 it
->font_height
= p
->font_height
;
6028 it
->voffset
= p
->voffset
;
6029 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6030 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6031 it
->line_wrap
= p
->line_wrap
;
6032 it
->bidi_p
= p
->bidi_p
;
6033 it
->paragraph_embedding
= p
->paragraph_embedding
;
6034 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6037 bidi_pop_it (&it
->bidi_it
);
6038 /* Bidi-iterate until we get out of the portion of text, if any,
6039 covered by a `display' text property or by an overlay with
6040 `display' property. (We cannot just jump there, because the
6041 internal coherency of the bidi iterator state can not be
6042 preserved across such jumps.) We also must determine the
6043 paragraph base direction if the overlay we just processed is
6044 at the beginning of a new paragraph. */
6045 if (from_display_prop
6046 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6047 iterate_out_of_display_property (it
);
6049 eassert ((BUFFERP (it
->object
)
6050 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6051 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6052 || (STRINGP (it
->object
)
6053 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6054 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6055 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6061 /***********************************************************************
6063 ***********************************************************************/
6065 /* Set IT's current position to the previous line start. */
6068 back_to_previous_line_start (struct it
*it
)
6070 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6073 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6077 /* Move IT to the next line start.
6079 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6080 we skipped over part of the text (as opposed to moving the iterator
6081 continuously over the text). Otherwise, don't change the value
6084 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6085 iterator on the newline, if it was found.
6087 Newlines may come from buffer text, overlay strings, or strings
6088 displayed via the `display' property. That's the reason we can't
6089 simply use find_newline_no_quit.
6091 Note that this function may not skip over invisible text that is so
6092 because of text properties and immediately follows a newline. If
6093 it would, function reseat_at_next_visible_line_start, when called
6094 from set_iterator_to_next, would effectively make invisible
6095 characters following a newline part of the wrong glyph row, which
6096 leads to wrong cursor motion. */
6099 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6100 struct bidi_it
*bidi_it_prev
)
6102 ptrdiff_t old_selective
;
6103 int newline_found_p
, n
;
6104 const int MAX_NEWLINE_DISTANCE
= 500;
6106 /* If already on a newline, just consume it to avoid unintended
6107 skipping over invisible text below. */
6108 if (it
->what
== IT_CHARACTER
6110 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6112 if (it
->bidi_p
&& bidi_it_prev
)
6113 *bidi_it_prev
= it
->bidi_it
;
6114 set_iterator_to_next (it
, 0);
6119 /* Don't handle selective display in the following. It's (a)
6120 unnecessary because it's done by the caller, and (b) leads to an
6121 infinite recursion because next_element_from_ellipsis indirectly
6122 calls this function. */
6123 old_selective
= it
->selective
;
6126 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6127 from buffer text. */
6128 for (n
= newline_found_p
= 0;
6129 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6130 n
+= STRINGP (it
->string
) ? 0 : 1)
6132 if (!get_next_display_element (it
))
6134 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6135 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6136 *bidi_it_prev
= it
->bidi_it
;
6137 set_iterator_to_next (it
, 0);
6140 /* If we didn't find a newline near enough, see if we can use a
6142 if (!newline_found_p
)
6144 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6145 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6149 eassert (!STRINGP (it
->string
));
6151 /* If there isn't any `display' property in sight, and no
6152 overlays, we can just use the position of the newline in
6154 if (it
->stop_charpos
>= limit
6155 || ((pos
= Fnext_single_property_change (make_number (start
),
6157 make_number (limit
)),
6159 && next_overlay_change (start
) == ZV
))
6163 IT_CHARPOS (*it
) = limit
;
6164 IT_BYTEPOS (*it
) = bytepos
;
6168 struct bidi_it bprev
;
6170 /* Help bidi.c avoid expensive searches for display
6171 properties and overlays, by telling it that there are
6172 none up to `limit'. */
6173 if (it
->bidi_it
.disp_pos
< limit
)
6175 it
->bidi_it
.disp_pos
= limit
;
6176 it
->bidi_it
.disp_prop
= 0;
6179 bprev
= it
->bidi_it
;
6180 bidi_move_to_visually_next (&it
->bidi_it
);
6181 } while (it
->bidi_it
.charpos
!= limit
);
6182 IT_CHARPOS (*it
) = limit
;
6183 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6185 *bidi_it_prev
= bprev
;
6187 *skipped_p
= newline_found_p
= true;
6191 while (get_next_display_element (it
)
6192 && !newline_found_p
)
6194 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6195 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6196 *bidi_it_prev
= it
->bidi_it
;
6197 set_iterator_to_next (it
, 0);
6202 it
->selective
= old_selective
;
6203 return newline_found_p
;
6207 /* Set IT's current position to the previous visible line start. Skip
6208 invisible text that is so either due to text properties or due to
6209 selective display. Caution: this does not change IT->current_x and
6213 back_to_previous_visible_line_start (struct it
*it
)
6215 while (IT_CHARPOS (*it
) > BEGV
)
6217 back_to_previous_line_start (it
);
6219 if (IT_CHARPOS (*it
) <= BEGV
)
6222 /* If selective > 0, then lines indented more than its value are
6224 if (it
->selective
> 0
6225 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6229 /* Check the newline before point for invisibility. */
6232 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6233 Qinvisible
, it
->window
);
6234 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6238 if (IT_CHARPOS (*it
) <= BEGV
)
6243 void *it2data
= NULL
;
6246 Lisp_Object val
, overlay
;
6248 SAVE_IT (it2
, *it
, it2data
);
6250 /* If newline is part of a composition, continue from start of composition */
6251 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6252 && beg
< IT_CHARPOS (*it
))
6255 /* If newline is replaced by a display property, find start of overlay
6256 or interval and continue search from that point. */
6257 pos
= --IT_CHARPOS (it2
);
6260 bidi_unshelve_cache (NULL
, 0);
6261 it2
.string_from_display_prop_p
= 0;
6262 it2
.from_disp_prop_p
= 0;
6263 if (handle_display_prop (&it2
) == HANDLED_RETURN
6264 && !NILP (val
= get_char_property_and_overlay
6265 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6266 && (OVERLAYP (overlay
)
6267 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6268 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6270 RESTORE_IT (it
, it
, it2data
);
6274 /* Newline is not replaced by anything -- so we are done. */
6275 RESTORE_IT (it
, it
, it2data
);
6281 IT_CHARPOS (*it
) = beg
;
6282 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6286 it
->continuation_lines_width
= 0;
6288 eassert (IT_CHARPOS (*it
) >= BEGV
);
6289 eassert (IT_CHARPOS (*it
) == BEGV
6290 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6295 /* Reseat iterator IT at the previous visible line start. Skip
6296 invisible text that is so either due to text properties or due to
6297 selective display. At the end, update IT's overlay information,
6298 face information etc. */
6301 reseat_at_previous_visible_line_start (struct it
*it
)
6303 back_to_previous_visible_line_start (it
);
6304 reseat (it
, it
->current
.pos
, 1);
6309 /* Reseat iterator IT on the next visible line start in the current
6310 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6311 preceding the line start. Skip over invisible text that is so
6312 because of selective display. Compute faces, overlays etc at the
6313 new position. Note that this function does not skip over text that
6314 is invisible because of text properties. */
6317 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6319 int newline_found_p
, skipped_p
= 0;
6320 struct bidi_it bidi_it_prev
;
6322 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6324 /* Skip over lines that are invisible because they are indented
6325 more than the value of IT->selective. */
6326 if (it
->selective
> 0)
6327 while (IT_CHARPOS (*it
) < ZV
6328 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6331 eassert (IT_BYTEPOS (*it
) == BEGV
6332 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6334 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6337 /* Position on the newline if that's what's requested. */
6338 if (on_newline_p
&& newline_found_p
)
6340 if (STRINGP (it
->string
))
6342 if (IT_STRING_CHARPOS (*it
) > 0)
6346 --IT_STRING_CHARPOS (*it
);
6347 --IT_STRING_BYTEPOS (*it
);
6351 /* We need to restore the bidi iterator to the state
6352 it had on the newline, and resync the IT's
6353 position with that. */
6354 it
->bidi_it
= bidi_it_prev
;
6355 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6356 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6360 else if (IT_CHARPOS (*it
) > BEGV
)
6369 /* We need to restore the bidi iterator to the state it
6370 had on the newline and resync IT with that. */
6371 it
->bidi_it
= bidi_it_prev
;
6372 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6373 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6375 reseat (it
, it
->current
.pos
, 0);
6379 reseat (it
, it
->current
.pos
, 0);
6386 /***********************************************************************
6387 Changing an iterator's position
6388 ***********************************************************************/
6390 /* Change IT's current position to POS in current_buffer. If FORCE_P
6391 is non-zero, always check for text properties at the new position.
6392 Otherwise, text properties are only looked up if POS >=
6393 IT->check_charpos of a property. */
6396 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6398 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6400 reseat_1 (it
, pos
, 0);
6402 /* Determine where to check text properties. Avoid doing it
6403 where possible because text property lookup is very expensive. */
6405 || CHARPOS (pos
) > it
->stop_charpos
6406 || CHARPOS (pos
) < original_pos
)
6410 /* For bidi iteration, we need to prime prev_stop and
6411 base_level_stop with our best estimations. */
6412 /* Implementation note: Of course, POS is not necessarily a
6413 stop position, so assigning prev_pos to it is a lie; we
6414 should have called compute_stop_backwards. However, if
6415 the current buffer does not include any R2L characters,
6416 that call would be a waste of cycles, because the
6417 iterator will never move back, and thus never cross this
6418 "fake" stop position. So we delay that backward search
6419 until the time we really need it, in next_element_from_buffer. */
6420 if (CHARPOS (pos
) != it
->prev_stop
)
6421 it
->prev_stop
= CHARPOS (pos
);
6422 if (CHARPOS (pos
) < it
->base_level_stop
)
6423 it
->base_level_stop
= 0; /* meaning it's unknown */
6429 it
->prev_stop
= it
->base_level_stop
= 0;
6438 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6439 IT->stop_pos to POS, also. */
6442 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6444 /* Don't call this function when scanning a C string. */
6445 eassert (it
->s
== NULL
);
6447 /* POS must be a reasonable value. */
6448 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6450 it
->current
.pos
= it
->position
= pos
;
6451 it
->end_charpos
= ZV
;
6453 it
->current
.dpvec_index
= -1;
6454 it
->current
.overlay_string_index
= -1;
6455 IT_STRING_CHARPOS (*it
) = -1;
6456 IT_STRING_BYTEPOS (*it
) = -1;
6458 it
->method
= GET_FROM_BUFFER
;
6459 it
->object
= it
->w
->contents
;
6460 it
->area
= TEXT_AREA
;
6461 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6463 it
->string_from_display_prop_p
= 0;
6464 it
->string_from_prefix_prop_p
= 0;
6466 it
->from_disp_prop_p
= 0;
6467 it
->face_before_selective_p
= 0;
6470 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6472 bidi_unshelve_cache (NULL
, 0);
6473 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6474 it
->bidi_it
.string
.s
= NULL
;
6475 it
->bidi_it
.string
.lstring
= Qnil
;
6476 it
->bidi_it
.string
.bufpos
= 0;
6477 it
->bidi_it
.string
.from_disp_str
= 0;
6478 it
->bidi_it
.string
.unibyte
= 0;
6479 it
->bidi_it
.w
= it
->w
;
6484 it
->stop_charpos
= CHARPOS (pos
);
6485 it
->base_level_stop
= CHARPOS (pos
);
6487 /* This make the information stored in it->cmp_it invalidate. */
6492 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6493 If S is non-null, it is a C string to iterate over. Otherwise,
6494 STRING gives a Lisp string to iterate over.
6496 If PRECISION > 0, don't return more then PRECISION number of
6497 characters from the string.
6499 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6500 characters have been returned. FIELD_WIDTH < 0 means an infinite
6503 MULTIBYTE = 0 means disable processing of multibyte characters,
6504 MULTIBYTE > 0 means enable it,
6505 MULTIBYTE < 0 means use IT->multibyte_p.
6507 IT must be initialized via a prior call to init_iterator before
6508 calling this function. */
6511 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6512 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6515 /* No text property checks performed by default, but see below. */
6516 it
->stop_charpos
= -1;
6518 /* Set iterator position and end position. */
6519 memset (&it
->current
, 0, sizeof it
->current
);
6520 it
->current
.overlay_string_index
= -1;
6521 it
->current
.dpvec_index
= -1;
6522 eassert (charpos
>= 0);
6524 /* If STRING is specified, use its multibyteness, otherwise use the
6525 setting of MULTIBYTE, if specified. */
6527 it
->multibyte_p
= multibyte
> 0;
6529 /* Bidirectional reordering of strings is controlled by the default
6530 value of bidi-display-reordering. Don't try to reorder while
6531 loading loadup.el, as the necessary character property tables are
6532 not yet available. */
6535 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6539 eassert (STRINGP (string
));
6540 it
->string
= string
;
6542 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6543 it
->method
= GET_FROM_STRING
;
6544 it
->current
.string_pos
= string_pos (charpos
, string
);
6548 it
->bidi_it
.string
.lstring
= string
;
6549 it
->bidi_it
.string
.s
= NULL
;
6550 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6551 it
->bidi_it
.string
.bufpos
= 0;
6552 it
->bidi_it
.string
.from_disp_str
= 0;
6553 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6554 it
->bidi_it
.w
= it
->w
;
6555 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6556 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6561 it
->s
= (const unsigned char *) s
;
6564 /* Note that we use IT->current.pos, not it->current.string_pos,
6565 for displaying C strings. */
6566 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6567 if (it
->multibyte_p
)
6569 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6570 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6574 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6575 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6580 it
->bidi_it
.string
.lstring
= Qnil
;
6581 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6582 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6583 it
->bidi_it
.string
.bufpos
= 0;
6584 it
->bidi_it
.string
.from_disp_str
= 0;
6585 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6586 it
->bidi_it
.w
= it
->w
;
6587 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6590 it
->method
= GET_FROM_C_STRING
;
6593 /* PRECISION > 0 means don't return more than PRECISION characters
6595 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6597 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6599 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6602 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6603 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6604 FIELD_WIDTH < 0 means infinite field width. This is useful for
6605 padding with `-' at the end of a mode line. */
6606 if (field_width
< 0)
6607 field_width
= INFINITY
;
6608 /* Implementation note: We deliberately don't enlarge
6609 it->bidi_it.string.schars here to fit it->end_charpos, because
6610 the bidi iterator cannot produce characters out of thin air. */
6611 if (field_width
> it
->end_charpos
- charpos
)
6612 it
->end_charpos
= charpos
+ field_width
;
6614 /* Use the standard display table for displaying strings. */
6615 if (DISP_TABLE_P (Vstandard_display_table
))
6616 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6618 it
->stop_charpos
= charpos
;
6619 it
->prev_stop
= charpos
;
6620 it
->base_level_stop
= 0;
6623 it
->bidi_it
.first_elt
= 1;
6624 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6625 it
->bidi_it
.disp_pos
= -1;
6627 if (s
== NULL
&& it
->multibyte_p
)
6629 ptrdiff_t endpos
= SCHARS (it
->string
);
6630 if (endpos
> it
->end_charpos
)
6631 endpos
= it
->end_charpos
;
6632 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6640 /***********************************************************************
6642 ***********************************************************************/
6644 /* Map enum it_method value to corresponding next_element_from_* function. */
6646 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6648 next_element_from_buffer
,
6649 next_element_from_display_vector
,
6650 next_element_from_string
,
6651 next_element_from_c_string
,
6652 next_element_from_image
,
6653 next_element_from_stretch
6656 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6659 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6660 (possibly with the following characters). */
6662 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6663 ((IT)->cmp_it.id >= 0 \
6664 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6665 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6666 END_CHARPOS, (IT)->w, \
6667 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6671 /* Lookup the char-table Vglyphless_char_display for character C (-1
6672 if we want information for no-font case), and return the display
6673 method symbol. By side-effect, update it->what and
6674 it->glyphless_method. This function is called from
6675 get_next_display_element for each character element, and from
6676 x_produce_glyphs when no suitable font was found. */
6679 lookup_glyphless_char_display (int c
, struct it
*it
)
6681 Lisp_Object glyphless_method
= Qnil
;
6683 if (CHAR_TABLE_P (Vglyphless_char_display
)
6684 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6688 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6689 if (CONSP (glyphless_method
))
6690 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6691 ? XCAR (glyphless_method
)
6692 : XCDR (glyphless_method
);
6695 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6699 if (NILP (glyphless_method
))
6702 /* The default is to display the character by a proper font. */
6704 /* The default for the no-font case is to display an empty box. */
6705 glyphless_method
= Qempty_box
;
6707 if (EQ (glyphless_method
, Qzero_width
))
6710 return glyphless_method
;
6711 /* This method can't be used for the no-font case. */
6712 glyphless_method
= Qempty_box
;
6714 if (EQ (glyphless_method
, Qthin_space
))
6715 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6716 else if (EQ (glyphless_method
, Qempty_box
))
6717 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6718 else if (EQ (glyphless_method
, Qhex_code
))
6719 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6720 else if (STRINGP (glyphless_method
))
6721 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6724 /* Invalid value. We use the default method. */
6725 glyphless_method
= Qnil
;
6728 it
->what
= IT_GLYPHLESS
;
6729 return glyphless_method
;
6732 /* Merge escape glyph face and cache the result. */
6734 static struct frame
*last_escape_glyph_frame
= NULL
;
6735 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6736 static int last_escape_glyph_merged_face_id
= 0;
6739 merge_escape_glyph_face (struct it
*it
)
6743 if (it
->f
== last_escape_glyph_frame
6744 && it
->face_id
== last_escape_glyph_face_id
)
6745 face_id
= last_escape_glyph_merged_face_id
;
6748 /* Merge the `escape-glyph' face into the current face. */
6749 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6750 last_escape_glyph_frame
= it
->f
;
6751 last_escape_glyph_face_id
= it
->face_id
;
6752 last_escape_glyph_merged_face_id
= face_id
;
6757 /* Likewise for glyphless glyph face. */
6759 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6760 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6761 static int last_glyphless_glyph_merged_face_id
= 0;
6764 merge_glyphless_glyph_face (struct it
*it
)
6768 if (it
->f
== last_glyphless_glyph_frame
6769 && it
->face_id
== last_glyphless_glyph_face_id
)
6770 face_id
= last_glyphless_glyph_merged_face_id
;
6773 /* Merge the `glyphless-char' face into the current face. */
6774 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6775 last_glyphless_glyph_frame
= it
->f
;
6776 last_glyphless_glyph_face_id
= it
->face_id
;
6777 last_glyphless_glyph_merged_face_id
= face_id
;
6782 /* Load IT's display element fields with information about the next
6783 display element from the current position of IT. Value is zero if
6784 end of buffer (or C string) is reached. */
6787 get_next_display_element (struct it
*it
)
6789 /* Non-zero means that we found a display element. Zero means that
6790 we hit the end of what we iterate over. Performance note: the
6791 function pointer `method' used here turns out to be faster than
6792 using a sequence of if-statements. */
6796 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6798 if (it
->what
== IT_CHARACTER
)
6800 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6801 and only if (a) the resolved directionality of that character
6803 /* FIXME: Do we need an exception for characters from display
6805 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6806 it
->c
= bidi_mirror_char (it
->c
);
6807 /* Map via display table or translate control characters.
6808 IT->c, IT->len etc. have been set to the next character by
6809 the function call above. If we have a display table, and it
6810 contains an entry for IT->c, translate it. Don't do this if
6811 IT->c itself comes from a display table, otherwise we could
6812 end up in an infinite recursion. (An alternative could be to
6813 count the recursion depth of this function and signal an
6814 error when a certain maximum depth is reached.) Is it worth
6816 if (success_p
&& it
->dpvec
== NULL
)
6819 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6820 int nonascii_space_p
= 0;
6821 int nonascii_hyphen_p
= 0;
6822 int c
= it
->c
; /* This is the character to display. */
6824 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6826 eassert (SINGLE_BYTE_CHAR_P (c
));
6827 if (unibyte_display_via_language_environment
)
6829 c
= DECODE_CHAR (unibyte
, c
);
6831 c
= BYTE8_TO_CHAR (it
->c
);
6834 c
= BYTE8_TO_CHAR (it
->c
);
6838 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6841 struct Lisp_Vector
*v
= XVECTOR (dv
);
6843 /* Return the first character from the display table
6844 entry, if not empty. If empty, don't display the
6845 current character. */
6848 it
->dpvec_char_len
= it
->len
;
6849 it
->dpvec
= v
->contents
;
6850 it
->dpend
= v
->contents
+ v
->header
.size
;
6851 it
->current
.dpvec_index
= 0;
6852 it
->dpvec_face_id
= -1;
6853 it
->saved_face_id
= it
->face_id
;
6854 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6859 set_iterator_to_next (it
, 0);
6864 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6866 if (it
->what
== IT_GLYPHLESS
)
6868 /* Don't display this character. */
6869 set_iterator_to_next (it
, 0);
6873 /* If `nobreak-char-display' is non-nil, we display
6874 non-ASCII spaces and hyphens specially. */
6875 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6878 nonascii_space_p
= true;
6879 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6880 nonascii_hyphen_p
= true;
6883 /* Translate control characters into `\003' or `^C' form.
6884 Control characters coming from a display table entry are
6885 currently not translated because we use IT->dpvec to hold
6886 the translation. This could easily be changed but I
6887 don't believe that it is worth doing.
6889 The characters handled by `nobreak-char-display' must be
6892 Non-printable characters and raw-byte characters are also
6893 translated to octal form. */
6894 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6895 ? (it
->area
!= TEXT_AREA
6896 /* In mode line, treat \n, \t like other crl chars. */
6899 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6900 || (c
!= '\n' && c
!= '\t'))
6902 || nonascii_hyphen_p
6904 || ! CHAR_PRINTABLE_P (c
))))
6906 /* C is a control character, non-ASCII space/hyphen,
6907 raw-byte, or a non-printable character which must be
6908 displayed either as '\003' or as `^C' where the '\\'
6909 and '^' can be defined in the display table. Fill
6910 IT->ctl_chars with glyphs for what we have to
6911 display. Then, set IT->dpvec to these glyphs. */
6918 /* Handle control characters with ^. */
6920 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6924 g
= '^'; /* default glyph for Control */
6925 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6927 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6929 g
= GLYPH_CODE_CHAR (gc
);
6930 lface_id
= GLYPH_CODE_FACE (gc
);
6934 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6935 : merge_escape_glyph_face (it
));
6937 XSETINT (it
->ctl_chars
[0], g
);
6938 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6940 goto display_control
;
6943 /* Handle non-ascii space in the mode where it only gets
6946 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6948 /* Merge `nobreak-space' into the current face. */
6949 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6951 XSETINT (it
->ctl_chars
[0], ' ');
6953 goto display_control
;
6956 /* Handle sequences that start with the "escape glyph". */
6958 /* the default escape glyph is \. */
6959 escape_glyph
= '\\';
6962 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6964 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6965 lface_id
= GLYPH_CODE_FACE (gc
);
6969 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6970 : merge_escape_glyph_face (it
));
6972 /* Draw non-ASCII hyphen with just highlighting: */
6974 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6976 XSETINT (it
->ctl_chars
[0], '-');
6978 goto display_control
;
6981 /* Draw non-ASCII space/hyphen with escape glyph: */
6983 if (nonascii_space_p
|| nonascii_hyphen_p
)
6985 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6986 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6988 goto display_control
;
6995 if (CHAR_BYTE8_P (c
))
6996 /* Display \200 instead of \17777600. */
6997 c
= CHAR_TO_BYTE8 (c
);
6998 len
= sprintf (str
, "%03o", c
);
7000 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7001 for (i
= 0; i
< len
; i
++)
7002 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7007 /* Set up IT->dpvec and return first character from it. */
7008 it
->dpvec_char_len
= it
->len
;
7009 it
->dpvec
= it
->ctl_chars
;
7010 it
->dpend
= it
->dpvec
+ ctl_len
;
7011 it
->current
.dpvec_index
= 0;
7012 it
->dpvec_face_id
= face_id
;
7013 it
->saved_face_id
= it
->face_id
;
7014 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7018 it
->char_to_display
= c
;
7022 it
->char_to_display
= it
->c
;
7026 #ifdef HAVE_WINDOW_SYSTEM
7027 /* Adjust face id for a multibyte character. There are no multibyte
7028 character in unibyte text. */
7029 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7032 && FRAME_WINDOW_P (it
->f
))
7034 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7036 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7038 /* Automatic composition with glyph-string. */
7039 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7041 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7045 ptrdiff_t pos
= (it
->s
? -1
7046 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7047 : IT_CHARPOS (*it
));
7050 if (it
->what
== IT_CHARACTER
)
7051 c
= it
->char_to_display
;
7054 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7058 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7059 /* TAB in a composition means display glyphs with
7060 padding space on the left or right. */
7061 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7064 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7067 #endif /* HAVE_WINDOW_SYSTEM */
7070 /* Is this character the last one of a run of characters with
7071 box? If yes, set IT->end_of_box_run_p to 1. */
7075 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7077 int face_id
= underlying_face_id (it
);
7078 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7082 if (face
->box
== FACE_NO_BOX
)
7084 /* If the box comes from face properties in a
7085 display string, check faces in that string. */
7086 int string_face_id
= face_after_it_pos (it
);
7087 it
->end_of_box_run_p
7088 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7091 /* Otherwise, the box comes from the underlying face.
7092 If this is the last string character displayed, check
7093 the next buffer location. */
7094 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7095 /* n_overlay_strings is unreliable unless
7096 overlay_string_index is non-negative. */
7097 && ((it
->current
.overlay_string_index
>= 0
7098 && (it
->current
.overlay_string_index
7099 == it
->n_overlay_strings
- 1))
7100 /* A string from display property. */
7101 || it
->from_disp_prop_p
))
7105 struct text_pos pos
= it
->current
.pos
;
7107 /* For a string from a display property, the next
7108 buffer position is stored in the 'position'
7109 member of the iteration stack slot below the
7110 current one, see handle_single_display_spec. By
7111 contrast, it->current.pos was is not yet updated
7112 to point to that buffer position; that will
7113 happen in pop_it, after we finish displaying the
7114 current string. Note that we already checked
7115 above that it->sp is positive, so subtracting one
7117 if (it
->from_disp_prop_p
)
7118 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7120 INC_TEXT_POS (pos
, it
->multibyte_p
);
7122 if (CHARPOS (pos
) >= ZV
)
7123 it
->end_of_box_run_p
= true;
7126 next_face_id
= face_at_buffer_position
7127 (it
->w
, CHARPOS (pos
), &ignore
,
7128 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7129 it
->end_of_box_run_p
7130 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7136 /* next_element_from_display_vector sets this flag according to
7137 faces of the display vector glyphs, see there. */
7138 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7140 int face_id
= face_after_it_pos (it
);
7141 it
->end_of_box_run_p
7142 = (face_id
!= it
->face_id
7143 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7146 /* If we reached the end of the object we've been iterating (e.g., a
7147 display string or an overlay string), and there's something on
7148 IT->stack, proceed with what's on the stack. It doesn't make
7149 sense to return zero if there's unprocessed stuff on the stack,
7150 because otherwise that stuff will never be displayed. */
7151 if (!success_p
&& it
->sp
> 0)
7153 set_iterator_to_next (it
, 0);
7154 success_p
= get_next_display_element (it
);
7157 /* Value is 0 if end of buffer or string reached. */
7162 /* Move IT to the next display element.
7164 RESEAT_P non-zero means if called on a newline in buffer text,
7165 skip to the next visible line start.
7167 Functions get_next_display_element and set_iterator_to_next are
7168 separate because I find this arrangement easier to handle than a
7169 get_next_display_element function that also increments IT's
7170 position. The way it is we can first look at an iterator's current
7171 display element, decide whether it fits on a line, and if it does,
7172 increment the iterator position. The other way around we probably
7173 would either need a flag indicating whether the iterator has to be
7174 incremented the next time, or we would have to implement a
7175 decrement position function which would not be easy to write. */
7178 set_iterator_to_next (struct it
*it
, int reseat_p
)
7180 /* Reset flags indicating start and end of a sequence of characters
7181 with box. Reset them at the start of this function because
7182 moving the iterator to a new position might set them. */
7183 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7187 case GET_FROM_BUFFER
:
7188 /* The current display element of IT is a character from
7189 current_buffer. Advance in the buffer, and maybe skip over
7190 invisible lines that are so because of selective display. */
7191 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7192 reseat_at_next_visible_line_start (it
, 0);
7193 else if (it
->cmp_it
.id
>= 0)
7195 /* We are currently getting glyphs from a composition. */
7200 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7201 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7202 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7204 it
->cmp_it
.from
= it
->cmp_it
.to
;
7209 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7211 it
->end_charpos
, Qnil
);
7214 else if (! it
->cmp_it
.reversed_p
)
7216 /* Composition created while scanning forward. */
7217 /* Update IT's char/byte positions to point to the first
7218 character of the next grapheme cluster, or to the
7219 character visually after the current composition. */
7220 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7221 bidi_move_to_visually_next (&it
->bidi_it
);
7222 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7223 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7225 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7227 /* Proceed to the next grapheme cluster. */
7228 it
->cmp_it
.from
= it
->cmp_it
.to
;
7232 /* No more grapheme clusters in this composition.
7233 Find the next stop position. */
7234 ptrdiff_t stop
= it
->end_charpos
;
7235 if (it
->bidi_it
.scan_dir
< 0)
7236 /* Now we are scanning backward and don't know
7239 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7240 IT_BYTEPOS (*it
), stop
, Qnil
);
7245 /* Composition created while scanning backward. */
7246 /* Update IT's char/byte positions to point to the last
7247 character of the previous grapheme cluster, or the
7248 character visually after the current composition. */
7249 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7250 bidi_move_to_visually_next (&it
->bidi_it
);
7251 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7252 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7253 if (it
->cmp_it
.from
> 0)
7255 /* Proceed to the previous grapheme cluster. */
7256 it
->cmp_it
.to
= it
->cmp_it
.from
;
7260 /* No more grapheme clusters in this composition.
7261 Find the next stop position. */
7262 ptrdiff_t stop
= it
->end_charpos
;
7263 if (it
->bidi_it
.scan_dir
< 0)
7264 /* Now we are scanning backward and don't know
7267 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7268 IT_BYTEPOS (*it
), stop
, Qnil
);
7274 eassert (it
->len
!= 0);
7278 IT_BYTEPOS (*it
) += it
->len
;
7279 IT_CHARPOS (*it
) += 1;
7283 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7284 /* If this is a new paragraph, determine its base
7285 direction (a.k.a. its base embedding level). */
7286 if (it
->bidi_it
.new_paragraph
)
7287 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7288 bidi_move_to_visually_next (&it
->bidi_it
);
7289 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7290 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7291 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7293 /* As the scan direction was changed, we must
7294 re-compute the stop position for composition. */
7295 ptrdiff_t stop
= it
->end_charpos
;
7296 if (it
->bidi_it
.scan_dir
< 0)
7298 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7299 IT_BYTEPOS (*it
), stop
, Qnil
);
7302 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7306 case GET_FROM_C_STRING
:
7307 /* Current display element of IT is from a C string. */
7309 /* If the string position is beyond string's end, it means
7310 next_element_from_c_string is padding the string with
7311 blanks, in which case we bypass the bidi iterator,
7312 because it cannot deal with such virtual characters. */
7313 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7315 IT_BYTEPOS (*it
) += it
->len
;
7316 IT_CHARPOS (*it
) += 1;
7320 bidi_move_to_visually_next (&it
->bidi_it
);
7321 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7322 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7326 case GET_FROM_DISPLAY_VECTOR
:
7327 /* Current display element of IT is from a display table entry.
7328 Advance in the display table definition. Reset it to null if
7329 end reached, and continue with characters from buffers/
7331 ++it
->current
.dpvec_index
;
7333 /* Restore face of the iterator to what they were before the
7334 display vector entry (these entries may contain faces). */
7335 it
->face_id
= it
->saved_face_id
;
7337 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7339 int recheck_faces
= it
->ellipsis_p
;
7342 it
->method
= GET_FROM_C_STRING
;
7343 else if (STRINGP (it
->string
))
7344 it
->method
= GET_FROM_STRING
;
7347 it
->method
= GET_FROM_BUFFER
;
7348 it
->object
= it
->w
->contents
;
7352 it
->current
.dpvec_index
= -1;
7354 /* Skip over characters which were displayed via IT->dpvec. */
7355 if (it
->dpvec_char_len
< 0)
7356 reseat_at_next_visible_line_start (it
, 1);
7357 else if (it
->dpvec_char_len
> 0)
7359 if (it
->method
== GET_FROM_STRING
7360 && it
->current
.overlay_string_index
>= 0
7361 && it
->n_overlay_strings
> 0)
7362 it
->ignore_overlay_strings_at_pos_p
= true;
7363 it
->len
= it
->dpvec_char_len
;
7364 set_iterator_to_next (it
, reseat_p
);
7367 /* Maybe recheck faces after display vector. */
7369 it
->stop_charpos
= IT_CHARPOS (*it
);
7373 case GET_FROM_STRING
:
7374 /* Current display element is a character from a Lisp string. */
7375 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7376 /* Don't advance past string end. These conditions are true
7377 when set_iterator_to_next is called at the end of
7378 get_next_display_element, in which case the Lisp string is
7379 already exhausted, and all we want is pop the iterator
7381 if (it
->current
.overlay_string_index
>= 0)
7383 /* This is an overlay string, so there's no padding with
7384 spaces, and the number of characters in the string is
7385 where the string ends. */
7386 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7387 goto consider_string_end
;
7391 /* Not an overlay string. There could be padding, so test
7392 against it->end_charpos. */
7393 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7394 goto consider_string_end
;
7396 if (it
->cmp_it
.id
>= 0)
7402 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7403 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7404 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7405 it
->cmp_it
.from
= it
->cmp_it
.to
;
7409 composition_compute_stop_pos (&it
->cmp_it
,
7410 IT_STRING_CHARPOS (*it
),
7411 IT_STRING_BYTEPOS (*it
),
7412 it
->end_charpos
, it
->string
);
7415 else if (! it
->cmp_it
.reversed_p
)
7417 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7418 bidi_move_to_visually_next (&it
->bidi_it
);
7419 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7420 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7422 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7423 it
->cmp_it
.from
= it
->cmp_it
.to
;
7426 ptrdiff_t stop
= it
->end_charpos
;
7427 if (it
->bidi_it
.scan_dir
< 0)
7429 composition_compute_stop_pos (&it
->cmp_it
,
7430 IT_STRING_CHARPOS (*it
),
7431 IT_STRING_BYTEPOS (*it
), stop
,
7437 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7438 bidi_move_to_visually_next (&it
->bidi_it
);
7439 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7440 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7441 if (it
->cmp_it
.from
> 0)
7442 it
->cmp_it
.to
= it
->cmp_it
.from
;
7445 ptrdiff_t stop
= it
->end_charpos
;
7446 if (it
->bidi_it
.scan_dir
< 0)
7448 composition_compute_stop_pos (&it
->cmp_it
,
7449 IT_STRING_CHARPOS (*it
),
7450 IT_STRING_BYTEPOS (*it
), stop
,
7458 /* If the string position is beyond string's end, it
7459 means next_element_from_string is padding the string
7460 with blanks, in which case we bypass the bidi
7461 iterator, because it cannot deal with such virtual
7463 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7465 IT_STRING_BYTEPOS (*it
) += it
->len
;
7466 IT_STRING_CHARPOS (*it
) += 1;
7470 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7472 bidi_move_to_visually_next (&it
->bidi_it
);
7473 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7474 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7475 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7477 ptrdiff_t stop
= it
->end_charpos
;
7479 if (it
->bidi_it
.scan_dir
< 0)
7481 composition_compute_stop_pos (&it
->cmp_it
,
7482 IT_STRING_CHARPOS (*it
),
7483 IT_STRING_BYTEPOS (*it
), stop
,
7489 consider_string_end
:
7491 if (it
->current
.overlay_string_index
>= 0)
7493 /* IT->string is an overlay string. Advance to the
7494 next, if there is one. */
7495 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7498 next_overlay_string (it
);
7500 setup_for_ellipsis (it
, 0);
7505 /* IT->string is not an overlay string. If we reached
7506 its end, and there is something on IT->stack, proceed
7507 with what is on the stack. This can be either another
7508 string, this time an overlay string, or a buffer. */
7509 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7513 if (it
->method
== GET_FROM_STRING
)
7514 goto consider_string_end
;
7519 case GET_FROM_IMAGE
:
7520 case GET_FROM_STRETCH
:
7521 /* The position etc with which we have to proceed are on
7522 the stack. The position may be at the end of a string,
7523 if the `display' property takes up the whole string. */
7524 eassert (it
->sp
> 0);
7526 if (it
->method
== GET_FROM_STRING
)
7527 goto consider_string_end
;
7531 /* There are no other methods defined, so this should be a bug. */
7535 eassert (it
->method
!= GET_FROM_STRING
7536 || (STRINGP (it
->string
)
7537 && IT_STRING_CHARPOS (*it
) >= 0));
7540 /* Load IT's display element fields with information about the next
7541 display element which comes from a display table entry or from the
7542 result of translating a control character to one of the forms `^C'
7545 IT->dpvec holds the glyphs to return as characters.
7546 IT->saved_face_id holds the face id before the display vector--it
7547 is restored into IT->face_id in set_iterator_to_next. */
7550 next_element_from_display_vector (struct it
*it
)
7553 int prev_face_id
= it
->face_id
;
7557 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7559 it
->face_id
= it
->saved_face_id
;
7561 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7562 That seemed totally bogus - so I changed it... */
7563 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7565 if (GLYPH_CODE_P (gc
))
7567 struct face
*this_face
, *prev_face
, *next_face
;
7569 it
->c
= GLYPH_CODE_CHAR (gc
);
7570 it
->len
= CHAR_BYTES (it
->c
);
7572 /* The entry may contain a face id to use. Such a face id is
7573 the id of a Lisp face, not a realized face. A face id of
7574 zero means no face is specified. */
7575 if (it
->dpvec_face_id
>= 0)
7576 it
->face_id
= it
->dpvec_face_id
;
7579 int lface_id
= GLYPH_CODE_FACE (gc
);
7581 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7585 /* Glyphs in the display vector could have the box face, so we
7586 need to set the related flags in the iterator, as
7588 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7589 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7591 /* Is this character the first character of a box-face run? */
7592 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7594 || prev_face
->box
== FACE_NO_BOX
));
7596 /* For the last character of the box-face run, we need to look
7597 either at the next glyph from the display vector, or at the
7598 face we saw before the display vector. */
7599 next_face_id
= it
->saved_face_id
;
7600 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7602 if (it
->dpvec_face_id
>= 0)
7603 next_face_id
= it
->dpvec_face_id
;
7607 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7610 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7614 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7615 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7617 || next_face
->box
== FACE_NO_BOX
));
7618 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7621 /* Display table entry is invalid. Return a space. */
7622 it
->c
= ' ', it
->len
= 1;
7624 /* Don't change position and object of the iterator here. They are
7625 still the values of the character that had this display table
7626 entry or was translated, and that's what we want. */
7627 it
->what
= IT_CHARACTER
;
7631 /* Get the first element of string/buffer in the visual order, after
7632 being reseated to a new position in a string or a buffer. */
7634 get_visually_first_element (struct it
*it
)
7636 int string_p
= STRINGP (it
->string
) || it
->s
;
7637 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7638 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7640 if (STRINGP (it
->string
))
7642 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7643 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7647 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7648 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7651 if (it
->bidi_it
.charpos
== eob
)
7653 /* Nothing to do, but reset the FIRST_ELT flag, like
7654 bidi_paragraph_init does, because we are not going to
7656 it
->bidi_it
.first_elt
= 0;
7658 else if (it
->bidi_it
.charpos
== bob
7660 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7661 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7663 /* If we are at the beginning of a line/string, we can produce
7664 the next element right away. */
7665 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7666 bidi_move_to_visually_next (&it
->bidi_it
);
7670 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7672 /* We need to prime the bidi iterator starting at the line's or
7673 string's beginning, before we will be able to produce the
7676 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7678 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7679 IT_BYTEPOS (*it
), -1,
7680 &it
->bidi_it
.bytepos
);
7681 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7684 /* Now return to buffer/string position where we were asked
7685 to get the next display element, and produce that. */
7686 bidi_move_to_visually_next (&it
->bidi_it
);
7688 while (it
->bidi_it
.bytepos
!= orig_bytepos
7689 && it
->bidi_it
.charpos
< eob
);
7692 /* Adjust IT's position information to where we ended up. */
7693 if (STRINGP (it
->string
))
7695 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7696 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7700 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7701 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7704 if (STRINGP (it
->string
) || !it
->s
)
7706 ptrdiff_t stop
, charpos
, bytepos
;
7708 if (STRINGP (it
->string
))
7711 stop
= SCHARS (it
->string
);
7712 if (stop
> it
->end_charpos
)
7713 stop
= it
->end_charpos
;
7714 charpos
= IT_STRING_CHARPOS (*it
);
7715 bytepos
= IT_STRING_BYTEPOS (*it
);
7719 stop
= it
->end_charpos
;
7720 charpos
= IT_CHARPOS (*it
);
7721 bytepos
= IT_BYTEPOS (*it
);
7723 if (it
->bidi_it
.scan_dir
< 0)
7725 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7730 /* Load IT with the next display element from Lisp string IT->string.
7731 IT->current.string_pos is the current position within the string.
7732 If IT->current.overlay_string_index >= 0, the Lisp string is an
7736 next_element_from_string (struct it
*it
)
7738 struct text_pos position
;
7740 eassert (STRINGP (it
->string
));
7741 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7742 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7743 position
= it
->current
.string_pos
;
7745 /* With bidi reordering, the character to display might not be the
7746 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7747 that we were reseat()ed to a new string, whose paragraph
7748 direction is not known. */
7749 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7751 get_visually_first_element (it
);
7752 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7755 /* Time to check for invisible text? */
7756 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7758 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7761 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7762 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7764 /* With bidi non-linear iteration, we could find
7765 ourselves far beyond the last computed stop_charpos,
7766 with several other stop positions in between that we
7767 missed. Scan them all now, in buffer's logical
7768 order, until we find and handle the last stop_charpos
7769 that precedes our current position. */
7770 handle_stop_backwards (it
, it
->stop_charpos
);
7771 return GET_NEXT_DISPLAY_ELEMENT (it
);
7777 /* Take note of the stop position we just moved
7778 across, for when we will move back across it. */
7779 it
->prev_stop
= it
->stop_charpos
;
7780 /* If we are at base paragraph embedding level, take
7781 note of the last stop position seen at this
7783 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7784 it
->base_level_stop
= it
->stop_charpos
;
7788 /* Since a handler may have changed IT->method, we must
7790 return GET_NEXT_DISPLAY_ELEMENT (it
);
7794 /* If we are before prev_stop, we may have overstepped
7795 on our way backwards a stop_pos, and if so, we need
7796 to handle that stop_pos. */
7797 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7798 /* We can sometimes back up for reasons that have nothing
7799 to do with bidi reordering. E.g., compositions. The
7800 code below is only needed when we are above the base
7801 embedding level, so test for that explicitly. */
7802 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7804 /* If we lost track of base_level_stop, we have no better
7805 place for handle_stop_backwards to start from than string
7806 beginning. This happens, e.g., when we were reseated to
7807 the previous screenful of text by vertical-motion. */
7808 if (it
->base_level_stop
<= 0
7809 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7810 it
->base_level_stop
= 0;
7811 handle_stop_backwards (it
, it
->base_level_stop
);
7812 return GET_NEXT_DISPLAY_ELEMENT (it
);
7816 if (it
->current
.overlay_string_index
>= 0)
7818 /* Get the next character from an overlay string. In overlay
7819 strings, there is no field width or padding with spaces to
7821 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7826 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7827 IT_STRING_BYTEPOS (*it
),
7828 it
->bidi_it
.scan_dir
< 0
7830 : SCHARS (it
->string
))
7831 && next_element_from_composition (it
))
7835 else if (STRING_MULTIBYTE (it
->string
))
7837 const unsigned char *s
= (SDATA (it
->string
)
7838 + IT_STRING_BYTEPOS (*it
));
7839 it
->c
= string_char_and_length (s
, &it
->len
);
7843 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7849 /* Get the next character from a Lisp string that is not an
7850 overlay string. Such strings come from the mode line, for
7851 example. We may have to pad with spaces, or truncate the
7852 string. See also next_element_from_c_string. */
7853 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7858 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7860 /* Pad with spaces. */
7861 it
->c
= ' ', it
->len
= 1;
7862 CHARPOS (position
) = BYTEPOS (position
) = -1;
7864 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7865 IT_STRING_BYTEPOS (*it
),
7866 it
->bidi_it
.scan_dir
< 0
7868 : it
->string_nchars
)
7869 && next_element_from_composition (it
))
7873 else if (STRING_MULTIBYTE (it
->string
))
7875 const unsigned char *s
= (SDATA (it
->string
)
7876 + IT_STRING_BYTEPOS (*it
));
7877 it
->c
= string_char_and_length (s
, &it
->len
);
7881 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7886 /* Record what we have and where it came from. */
7887 it
->what
= IT_CHARACTER
;
7888 it
->object
= it
->string
;
7889 it
->position
= position
;
7894 /* Load IT with next display element from C string IT->s.
7895 IT->string_nchars is the maximum number of characters to return
7896 from the string. IT->end_charpos may be greater than
7897 IT->string_nchars when this function is called, in which case we
7898 may have to return padding spaces. Value is zero if end of string
7899 reached, including padding spaces. */
7902 next_element_from_c_string (struct it
*it
)
7904 bool success_p
= true;
7907 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7908 it
->what
= IT_CHARACTER
;
7909 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7912 /* With bidi reordering, the character to display might not be the
7913 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7914 we were reseated to a new string, whose paragraph direction is
7916 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7917 get_visually_first_element (it
);
7919 /* IT's position can be greater than IT->string_nchars in case a
7920 field width or precision has been specified when the iterator was
7922 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7924 /* End of the game. */
7928 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7930 /* Pad with spaces. */
7931 it
->c
= ' ', it
->len
= 1;
7932 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7934 else if (it
->multibyte_p
)
7935 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7937 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7943 /* Set up IT to return characters from an ellipsis, if appropriate.
7944 The definition of the ellipsis glyphs may come from a display table
7945 entry. This function fills IT with the first glyph from the
7946 ellipsis if an ellipsis is to be displayed. */
7949 next_element_from_ellipsis (struct it
*it
)
7951 if (it
->selective_display_ellipsis_p
)
7952 setup_for_ellipsis (it
, it
->len
);
7955 /* The face at the current position may be different from the
7956 face we find after the invisible text. Remember what it
7957 was in IT->saved_face_id, and signal that it's there by
7958 setting face_before_selective_p. */
7959 it
->saved_face_id
= it
->face_id
;
7960 it
->method
= GET_FROM_BUFFER
;
7961 it
->object
= it
->w
->contents
;
7962 reseat_at_next_visible_line_start (it
, 1);
7963 it
->face_before_selective_p
= true;
7966 return GET_NEXT_DISPLAY_ELEMENT (it
);
7970 /* Deliver an image display element. The iterator IT is already
7971 filled with image information (done in handle_display_prop). Value
7976 next_element_from_image (struct it
*it
)
7978 it
->what
= IT_IMAGE
;
7979 it
->ignore_overlay_strings_at_pos_p
= 0;
7984 /* Fill iterator IT with next display element from a stretch glyph
7985 property. IT->object is the value of the text property. Value is
7989 next_element_from_stretch (struct it
*it
)
7991 it
->what
= IT_STRETCH
;
7995 /* Scan backwards from IT's current position until we find a stop
7996 position, or until BEGV. This is called when we find ourself
7997 before both the last known prev_stop and base_level_stop while
7998 reordering bidirectional text. */
8001 compute_stop_pos_backwards (struct it
*it
)
8003 const int SCAN_BACK_LIMIT
= 1000;
8004 struct text_pos pos
;
8005 struct display_pos save_current
= it
->current
;
8006 struct text_pos save_position
= it
->position
;
8007 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8008 ptrdiff_t where_we_are
= charpos
;
8009 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8010 ptrdiff_t save_end_pos
= it
->end_charpos
;
8012 eassert (NILP (it
->string
) && !it
->s
);
8013 eassert (it
->bidi_p
);
8017 it
->end_charpos
= min (charpos
+ 1, ZV
);
8018 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8019 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8020 reseat_1 (it
, pos
, 0);
8021 compute_stop_pos (it
);
8022 /* We must advance forward, right? */
8023 if (it
->stop_charpos
<= charpos
)
8026 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8028 if (it
->stop_charpos
<= where_we_are
)
8029 it
->prev_stop
= it
->stop_charpos
;
8031 it
->prev_stop
= BEGV
;
8033 it
->current
= save_current
;
8034 it
->position
= save_position
;
8035 it
->stop_charpos
= save_stop_pos
;
8036 it
->end_charpos
= save_end_pos
;
8039 /* Scan forward from CHARPOS in the current buffer/string, until we
8040 find a stop position > current IT's position. Then handle the stop
8041 position before that. This is called when we bump into a stop
8042 position while reordering bidirectional text. CHARPOS should be
8043 the last previously processed stop_pos (or BEGV/0, if none were
8044 processed yet) whose position is less that IT's current
8048 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8050 int bufp
= !STRINGP (it
->string
);
8051 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8052 struct display_pos save_current
= it
->current
;
8053 struct text_pos save_position
= it
->position
;
8054 struct text_pos pos1
;
8055 ptrdiff_t next_stop
;
8057 /* Scan in strict logical order. */
8058 eassert (it
->bidi_p
);
8062 it
->prev_stop
= charpos
;
8065 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8066 reseat_1 (it
, pos1
, 0);
8069 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8070 compute_stop_pos (it
);
8071 /* We must advance forward, right? */
8072 if (it
->stop_charpos
<= it
->prev_stop
)
8074 charpos
= it
->stop_charpos
;
8076 while (charpos
<= where_we_are
);
8079 it
->current
= save_current
;
8080 it
->position
= save_position
;
8081 next_stop
= it
->stop_charpos
;
8082 it
->stop_charpos
= it
->prev_stop
;
8084 it
->stop_charpos
= next_stop
;
8087 /* Load IT with the next display element from current_buffer. Value
8088 is zero if end of buffer reached. IT->stop_charpos is the next
8089 position at which to stop and check for text properties or buffer
8093 next_element_from_buffer (struct it
*it
)
8095 bool success_p
= true;
8097 eassert (IT_CHARPOS (*it
) >= BEGV
);
8098 eassert (NILP (it
->string
) && !it
->s
);
8099 eassert (!it
->bidi_p
8100 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8101 && it
->bidi_it
.string
.s
== NULL
));
8103 /* With bidi reordering, the character to display might not be the
8104 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8105 we were reseat()ed to a new buffer position, which is potentially
8106 a different paragraph. */
8107 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8109 get_visually_first_element (it
);
8110 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8113 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8115 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8117 int overlay_strings_follow_p
;
8119 /* End of the game, except when overlay strings follow that
8120 haven't been returned yet. */
8121 if (it
->overlay_strings_at_end_processed_p
)
8122 overlay_strings_follow_p
= 0;
8125 it
->overlay_strings_at_end_processed_p
= true;
8126 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8129 if (overlay_strings_follow_p
)
8130 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8134 it
->position
= it
->current
.pos
;
8138 else if (!(!it
->bidi_p
8139 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8140 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8142 /* With bidi non-linear iteration, we could find ourselves
8143 far beyond the last computed stop_charpos, with several
8144 other stop positions in between that we missed. Scan
8145 them all now, in buffer's logical order, until we find
8146 and handle the last stop_charpos that precedes our
8147 current position. */
8148 handle_stop_backwards (it
, it
->stop_charpos
);
8149 return GET_NEXT_DISPLAY_ELEMENT (it
);
8155 /* Take note of the stop position we just moved across,
8156 for when we will move back across it. */
8157 it
->prev_stop
= it
->stop_charpos
;
8158 /* If we are at base paragraph embedding level, take
8159 note of the last stop position seen at this
8161 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8162 it
->base_level_stop
= it
->stop_charpos
;
8165 return GET_NEXT_DISPLAY_ELEMENT (it
);
8169 /* If we are before prev_stop, we may have overstepped on
8170 our way backwards a stop_pos, and if so, we need to
8171 handle that stop_pos. */
8172 && IT_CHARPOS (*it
) < it
->prev_stop
8173 /* We can sometimes back up for reasons that have nothing
8174 to do with bidi reordering. E.g., compositions. The
8175 code below is only needed when we are above the base
8176 embedding level, so test for that explicitly. */
8177 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8179 if (it
->base_level_stop
<= 0
8180 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8182 /* If we lost track of base_level_stop, we need to find
8183 prev_stop by looking backwards. This happens, e.g., when
8184 we were reseated to the previous screenful of text by
8186 it
->base_level_stop
= BEGV
;
8187 compute_stop_pos_backwards (it
);
8188 handle_stop_backwards (it
, it
->prev_stop
);
8191 handle_stop_backwards (it
, it
->base_level_stop
);
8192 return GET_NEXT_DISPLAY_ELEMENT (it
);
8196 /* No face changes, overlays etc. in sight, so just return a
8197 character from current_buffer. */
8201 /* Maybe run the redisplay end trigger hook. Performance note:
8202 This doesn't seem to cost measurable time. */
8203 if (it
->redisplay_end_trigger_charpos
8205 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8206 run_redisplay_end_trigger_hook (it
);
8208 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8209 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8211 && next_element_from_composition (it
))
8216 /* Get the next character, maybe multibyte. */
8217 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8218 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8219 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8221 it
->c
= *p
, it
->len
= 1;
8223 /* Record what we have and where it came from. */
8224 it
->what
= IT_CHARACTER
;
8225 it
->object
= it
->w
->contents
;
8226 it
->position
= it
->current
.pos
;
8228 /* Normally we return the character found above, except when we
8229 really want to return an ellipsis for selective display. */
8234 /* A value of selective > 0 means hide lines indented more
8235 than that number of columns. */
8236 if (it
->selective
> 0
8237 && IT_CHARPOS (*it
) + 1 < ZV
8238 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8239 IT_BYTEPOS (*it
) + 1,
8242 success_p
= next_element_from_ellipsis (it
);
8243 it
->dpvec_char_len
= -1;
8246 else if (it
->c
== '\r' && it
->selective
== -1)
8248 /* A value of selective == -1 means that everything from the
8249 CR to the end of the line is invisible, with maybe an
8250 ellipsis displayed for it. */
8251 success_p
= next_element_from_ellipsis (it
);
8252 it
->dpvec_char_len
= -1;
8257 /* Value is zero if end of buffer reached. */
8258 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8263 /* Run the redisplay end trigger hook for IT. */
8266 run_redisplay_end_trigger_hook (struct it
*it
)
8268 Lisp_Object args
[3];
8270 /* IT->glyph_row should be non-null, i.e. we should be actually
8271 displaying something, or otherwise we should not run the hook. */
8272 eassert (it
->glyph_row
);
8274 /* Set up hook arguments. */
8275 args
[0] = Qredisplay_end_trigger_functions
;
8276 args
[1] = it
->window
;
8277 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8278 it
->redisplay_end_trigger_charpos
= 0;
8280 /* Since we are *trying* to run these functions, don't try to run
8281 them again, even if they get an error. */
8282 wset_redisplay_end_trigger (it
->w
, Qnil
);
8283 Frun_hook_with_args (3, args
);
8285 /* Notice if it changed the face of the character we are on. */
8286 handle_face_prop (it
);
8290 /* Deliver a composition display element. Unlike the other
8291 next_element_from_XXX, this function is not registered in the array
8292 get_next_element[]. It is called from next_element_from_buffer and
8293 next_element_from_string when necessary. */
8296 next_element_from_composition (struct it
*it
)
8298 it
->what
= IT_COMPOSITION
;
8299 it
->len
= it
->cmp_it
.nbytes
;
8300 if (STRINGP (it
->string
))
8304 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8305 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8308 it
->position
= it
->current
.string_pos
;
8309 it
->object
= it
->string
;
8310 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8311 IT_STRING_BYTEPOS (*it
), it
->string
);
8317 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8318 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8321 if (it
->bidi_it
.new_paragraph
)
8322 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8323 /* Resync the bidi iterator with IT's new position.
8324 FIXME: this doesn't support bidirectional text. */
8325 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8326 bidi_move_to_visually_next (&it
->bidi_it
);
8330 it
->position
= it
->current
.pos
;
8331 it
->object
= it
->w
->contents
;
8332 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8333 IT_BYTEPOS (*it
), Qnil
);
8340 /***********************************************************************
8341 Moving an iterator without producing glyphs
8342 ***********************************************************************/
8344 /* Check if iterator is at a position corresponding to a valid buffer
8345 position after some move_it_ call. */
8347 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8348 ((it)->method == GET_FROM_STRING \
8349 ? IT_STRING_CHARPOS (*it) == 0 \
8353 /* Move iterator IT to a specified buffer or X position within one
8354 line on the display without producing glyphs.
8356 OP should be a bit mask including some or all of these bits:
8357 MOVE_TO_X: Stop upon reaching x-position TO_X.
8358 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8359 Regardless of OP's value, stop upon reaching the end of the display line.
8361 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8362 This means, in particular, that TO_X includes window's horizontal
8365 The return value has several possible values that
8366 say what condition caused the scan to stop:
8368 MOVE_POS_MATCH_OR_ZV
8369 - when TO_POS or ZV was reached.
8372 -when TO_X was reached before TO_POS or ZV were reached.
8375 - when we reached the end of the display area and the line must
8379 - when we reached the end of the display area and the line is
8383 - when we stopped at a line end, i.e. a newline or a CR and selective
8386 static enum move_it_result
8387 move_it_in_display_line_to (struct it
*it
,
8388 ptrdiff_t to_charpos
, int to_x
,
8389 enum move_operation_enum op
)
8391 enum move_it_result result
= MOVE_UNDEFINED
;
8392 struct glyph_row
*saved_glyph_row
;
8393 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8394 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8395 void *ppos_data
= NULL
;
8397 enum it_method prev_method
= it
->method
;
8398 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8399 int saw_smaller_pos
= prev_pos
< to_charpos
;
8401 /* Don't produce glyphs in produce_glyphs. */
8402 saved_glyph_row
= it
->glyph_row
;
8403 it
->glyph_row
= NULL
;
8405 /* Use wrap_it to save a copy of IT wherever a word wrap could
8406 occur. Use atpos_it to save a copy of IT at the desired buffer
8407 position, if found, so that we can scan ahead and check if the
8408 word later overshoots the window edge. Use atx_it similarly, for
8414 /* Use ppos_it under bidi reordering to save a copy of IT for the
8415 initial position. We restore that position in IT when we have
8416 scanned the entire display line without finding a match for
8417 TO_CHARPOS and all the character positions are greater than
8418 TO_CHARPOS. We then restart the scan from the initial position,
8419 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8420 the closest to TO_CHARPOS. */
8423 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8425 SAVE_IT (ppos_it
, *it
, ppos_data
);
8426 closest_pos
= IT_CHARPOS (*it
);
8432 #define BUFFER_POS_REACHED_P() \
8433 ((op & MOVE_TO_POS) != 0 \
8434 && BUFFERP (it->object) \
8435 && (IT_CHARPOS (*it) == to_charpos \
8437 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8438 && IT_CHARPOS (*it) > to_charpos) \
8439 || (it->what == IT_COMPOSITION \
8440 && ((IT_CHARPOS (*it) > to_charpos \
8441 && to_charpos >= it->cmp_it.charpos) \
8442 || (IT_CHARPOS (*it) < to_charpos \
8443 && to_charpos <= it->cmp_it.charpos)))) \
8444 && (it->method == GET_FROM_BUFFER \
8445 || (it->method == GET_FROM_DISPLAY_VECTOR \
8446 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8448 /* If there's a line-/wrap-prefix, handle it. */
8449 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8450 && it
->current_y
< it
->last_visible_y
)
8451 handle_line_prefix (it
);
8453 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8454 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8458 int x
, i
, ascent
= 0, descent
= 0;
8460 /* Utility macro to reset an iterator with x, ascent, and descent. */
8461 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8462 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8463 (IT)->max_descent = descent)
8465 /* Stop if we move beyond TO_CHARPOS (after an image or a
8466 display string or stretch glyph). */
8467 if ((op
& MOVE_TO_POS
) != 0
8468 && BUFFERP (it
->object
)
8469 && it
->method
== GET_FROM_BUFFER
8471 /* When the iterator is at base embedding level, we
8472 are guaranteed that characters are delivered for
8473 display in strictly increasing order of their
8474 buffer positions. */
8475 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8476 && IT_CHARPOS (*it
) > to_charpos
)
8478 && (prev_method
== GET_FROM_IMAGE
8479 || prev_method
== GET_FROM_STRETCH
8480 || prev_method
== GET_FROM_STRING
)
8481 /* Passed TO_CHARPOS from left to right. */
8482 && ((prev_pos
< to_charpos
8483 && IT_CHARPOS (*it
) > to_charpos
)
8484 /* Passed TO_CHARPOS from right to left. */
8485 || (prev_pos
> to_charpos
8486 && IT_CHARPOS (*it
) < to_charpos
)))))
8488 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8490 result
= MOVE_POS_MATCH_OR_ZV
;
8493 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8494 /* If wrap_it is valid, the current position might be in a
8495 word that is wrapped. So, save the iterator in
8496 atpos_it and continue to see if wrapping happens. */
8497 SAVE_IT (atpos_it
, *it
, atpos_data
);
8500 /* Stop when ZV reached.
8501 We used to stop here when TO_CHARPOS reached as well, but that is
8502 too soon if this glyph does not fit on this line. So we handle it
8503 explicitly below. */
8504 if (!get_next_display_element (it
))
8506 result
= MOVE_POS_MATCH_OR_ZV
;
8510 if (it
->line_wrap
== TRUNCATE
)
8512 if (BUFFER_POS_REACHED_P ())
8514 result
= MOVE_POS_MATCH_OR_ZV
;
8520 if (it
->line_wrap
== WORD_WRAP
)
8522 if (IT_DISPLAYING_WHITESPACE (it
))
8526 /* We have reached a glyph that follows one or more
8527 whitespace characters. If the position is
8528 already found, we are done. */
8529 if (atpos_it
.sp
>= 0)
8531 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8532 result
= MOVE_POS_MATCH_OR_ZV
;
8537 RESTORE_IT (it
, &atx_it
, atx_data
);
8538 result
= MOVE_X_REACHED
;
8541 /* Otherwise, we can wrap here. */
8542 SAVE_IT (wrap_it
, *it
, wrap_data
);
8548 /* Remember the line height for the current line, in case
8549 the next element doesn't fit on the line. */
8550 ascent
= it
->max_ascent
;
8551 descent
= it
->max_descent
;
8553 /* The call to produce_glyphs will get the metrics of the
8554 display element IT is loaded with. Record the x-position
8555 before this display element, in case it doesn't fit on the
8559 PRODUCE_GLYPHS (it
);
8561 if (it
->area
!= TEXT_AREA
)
8563 prev_method
= it
->method
;
8564 if (it
->method
== GET_FROM_BUFFER
)
8565 prev_pos
= IT_CHARPOS (*it
);
8566 set_iterator_to_next (it
, 1);
8567 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8568 SET_TEXT_POS (this_line_min_pos
,
8569 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8571 && (op
& MOVE_TO_POS
)
8572 && IT_CHARPOS (*it
) > to_charpos
8573 && IT_CHARPOS (*it
) < closest_pos
)
8574 closest_pos
= IT_CHARPOS (*it
);
8578 /* The number of glyphs we get back in IT->nglyphs will normally
8579 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8580 character on a terminal frame, or (iii) a line end. For the
8581 second case, IT->nglyphs - 1 padding glyphs will be present.
8582 (On X frames, there is only one glyph produced for a
8583 composite character.)
8585 The behavior implemented below means, for continuation lines,
8586 that as many spaces of a TAB as fit on the current line are
8587 displayed there. For terminal frames, as many glyphs of a
8588 multi-glyph character are displayed in the current line, too.
8589 This is what the old redisplay code did, and we keep it that
8590 way. Under X, the whole shape of a complex character must
8591 fit on the line or it will be completely displayed in the
8594 Note that both for tabs and padding glyphs, all glyphs have
8598 /* More than one glyph or glyph doesn't fit on line. All
8599 glyphs have the same width. */
8600 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8602 int x_before_this_char
= x
;
8603 int hpos_before_this_char
= it
->hpos
;
8605 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8607 new_x
= x
+ single_glyph_width
;
8609 /* We want to leave anything reaching TO_X to the caller. */
8610 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8612 if (BUFFER_POS_REACHED_P ())
8614 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8615 goto buffer_pos_reached
;
8616 if (atpos_it
.sp
< 0)
8618 SAVE_IT (atpos_it
, *it
, atpos_data
);
8619 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8624 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8627 result
= MOVE_X_REACHED
;
8632 SAVE_IT (atx_it
, *it
, atx_data
);
8633 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8638 if (/* Lines are continued. */
8639 it
->line_wrap
!= TRUNCATE
8640 && (/* And glyph doesn't fit on the line. */
8641 new_x
> it
->last_visible_x
8642 /* Or it fits exactly and we're on a window
8644 || (new_x
== it
->last_visible_x
8645 && FRAME_WINDOW_P (it
->f
)
8646 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8647 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8648 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8650 if (/* IT->hpos == 0 means the very first glyph
8651 doesn't fit on the line, e.g. a wide image. */
8653 || (new_x
== it
->last_visible_x
8654 && FRAME_WINDOW_P (it
->f
)
8655 /* When word-wrap is ON and we have a valid
8656 wrap point, we don't allow the last glyph
8657 to "just barely fit" on the line. */
8658 && (it
->line_wrap
!= WORD_WRAP
8659 || wrap_it
.sp
< 0)))
8662 it
->current_x
= new_x
;
8664 /* The character's last glyph just barely fits
8666 if (i
== it
->nglyphs
- 1)
8668 /* If this is the destination position,
8669 return a position *before* it in this row,
8670 now that we know it fits in this row. */
8671 if (BUFFER_POS_REACHED_P ())
8673 if (it
->line_wrap
!= WORD_WRAP
8676 it
->hpos
= hpos_before_this_char
;
8677 it
->current_x
= x_before_this_char
;
8678 result
= MOVE_POS_MATCH_OR_ZV
;
8681 if (it
->line_wrap
== WORD_WRAP
8684 SAVE_IT (atpos_it
, *it
, atpos_data
);
8685 atpos_it
.current_x
= x_before_this_char
;
8686 atpos_it
.hpos
= hpos_before_this_char
;
8690 prev_method
= it
->method
;
8691 if (it
->method
== GET_FROM_BUFFER
)
8692 prev_pos
= IT_CHARPOS (*it
);
8693 set_iterator_to_next (it
, 1);
8694 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8695 SET_TEXT_POS (this_line_min_pos
,
8696 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8697 /* On graphical terminals, newlines may
8698 "overflow" into the fringe if
8699 overflow-newline-into-fringe is non-nil.
8700 On text terminals, and on graphical
8701 terminals with no right margin, newlines
8702 may overflow into the last glyph on the
8704 if (!FRAME_WINDOW_P (it
->f
)
8706 && it
->bidi_it
.paragraph_dir
== R2L
)
8707 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8708 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8709 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8711 if (!get_next_display_element (it
))
8713 result
= MOVE_POS_MATCH_OR_ZV
;
8716 if (BUFFER_POS_REACHED_P ())
8718 if (ITERATOR_AT_END_OF_LINE_P (it
))
8719 result
= MOVE_POS_MATCH_OR_ZV
;
8721 result
= MOVE_LINE_CONTINUED
;
8724 if (ITERATOR_AT_END_OF_LINE_P (it
)
8725 && (it
->line_wrap
!= WORD_WRAP
8728 result
= MOVE_NEWLINE_OR_CR
;
8735 IT_RESET_X_ASCENT_DESCENT (it
);
8737 if (wrap_it
.sp
>= 0)
8739 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8744 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8746 result
= MOVE_LINE_CONTINUED
;
8750 if (BUFFER_POS_REACHED_P ())
8752 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8753 goto buffer_pos_reached
;
8754 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8756 SAVE_IT (atpos_it
, *it
, atpos_data
);
8757 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8761 if (new_x
> it
->first_visible_x
)
8763 /* Glyph is visible. Increment number of glyphs that
8764 would be displayed. */
8769 if (result
!= MOVE_UNDEFINED
)
8772 else if (BUFFER_POS_REACHED_P ())
8775 IT_RESET_X_ASCENT_DESCENT (it
);
8776 result
= MOVE_POS_MATCH_OR_ZV
;
8779 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8781 /* Stop when TO_X specified and reached. This check is
8782 necessary here because of lines consisting of a line end,
8783 only. The line end will not produce any glyphs and we
8784 would never get MOVE_X_REACHED. */
8785 eassert (it
->nglyphs
== 0);
8786 result
= MOVE_X_REACHED
;
8790 /* Is this a line end? If yes, we're done. */
8791 if (ITERATOR_AT_END_OF_LINE_P (it
))
8793 /* If we are past TO_CHARPOS, but never saw any character
8794 positions smaller than TO_CHARPOS, return
8795 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8797 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8799 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8801 if (closest_pos
< ZV
)
8803 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8804 move_it_in_display_line_to (it
, closest_pos
, -1,
8806 result
= MOVE_POS_MATCH_OR_ZV
;
8809 goto buffer_pos_reached
;
8811 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8812 && IT_CHARPOS (*it
) > to_charpos
)
8813 goto buffer_pos_reached
;
8815 result
= MOVE_NEWLINE_OR_CR
;
8818 result
= MOVE_NEWLINE_OR_CR
;
8822 prev_method
= it
->method
;
8823 if (it
->method
== GET_FROM_BUFFER
)
8824 prev_pos
= IT_CHARPOS (*it
);
8825 /* The current display element has been consumed. Advance
8827 set_iterator_to_next (it
, 1);
8828 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8829 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8830 if (IT_CHARPOS (*it
) < to_charpos
)
8831 saw_smaller_pos
= 1;
8833 && (op
& MOVE_TO_POS
)
8834 && IT_CHARPOS (*it
) >= to_charpos
8835 && IT_CHARPOS (*it
) < closest_pos
)
8836 closest_pos
= IT_CHARPOS (*it
);
8838 /* Stop if lines are truncated and IT's current x-position is
8839 past the right edge of the window now. */
8840 if (it
->line_wrap
== TRUNCATE
8841 && it
->current_x
>= it
->last_visible_x
)
8843 if (!FRAME_WINDOW_P (it
->f
)
8844 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8845 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8846 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8847 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8851 if ((at_eob_p
= !get_next_display_element (it
))
8852 || BUFFER_POS_REACHED_P ()
8853 /* If we are past TO_CHARPOS, but never saw any
8854 character positions smaller than TO_CHARPOS,
8855 return MOVE_POS_MATCH_OR_ZV, like the
8856 unidirectional display did. */
8857 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8859 && IT_CHARPOS (*it
) > to_charpos
))
8862 && !BUFFER_POS_REACHED_P ()
8863 && !at_eob_p
&& closest_pos
< ZV
)
8865 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8866 move_it_in_display_line_to (it
, closest_pos
, -1,
8869 result
= MOVE_POS_MATCH_OR_ZV
;
8872 if (ITERATOR_AT_END_OF_LINE_P (it
))
8874 result
= MOVE_NEWLINE_OR_CR
;
8878 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8880 && IT_CHARPOS (*it
) > to_charpos
)
8882 if (closest_pos
< ZV
)
8884 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8885 move_it_in_display_line_to (it
, closest_pos
, -1, MOVE_TO_POS
);
8887 result
= MOVE_POS_MATCH_OR_ZV
;
8890 result
= MOVE_LINE_TRUNCATED
;
8893 #undef IT_RESET_X_ASCENT_DESCENT
8896 #undef BUFFER_POS_REACHED_P
8898 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8899 restore the saved iterator. */
8900 if (atpos_it
.sp
>= 0)
8901 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8902 else if (atx_it
.sp
>= 0)
8903 RESTORE_IT (it
, &atx_it
, atx_data
);
8908 bidi_unshelve_cache (atpos_data
, 1);
8910 bidi_unshelve_cache (atx_data
, 1);
8912 bidi_unshelve_cache (wrap_data
, 1);
8914 bidi_unshelve_cache (ppos_data
, 1);
8916 /* Restore the iterator settings altered at the beginning of this
8918 it
->glyph_row
= saved_glyph_row
;
8922 /* For external use. */
8924 move_it_in_display_line (struct it
*it
,
8925 ptrdiff_t to_charpos
, int to_x
,
8926 enum move_operation_enum op
)
8928 if (it
->line_wrap
== WORD_WRAP
8929 && (op
& MOVE_TO_X
))
8932 void *save_data
= NULL
;
8935 SAVE_IT (save_it
, *it
, save_data
);
8936 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8937 /* When word-wrap is on, TO_X may lie past the end
8938 of a wrapped line. Then it->current is the
8939 character on the next line, so backtrack to the
8940 space before the wrap point. */
8941 if (skip
== MOVE_LINE_CONTINUED
)
8943 int prev_x
= max (it
->current_x
- 1, 0);
8944 RESTORE_IT (it
, &save_it
, save_data
);
8945 move_it_in_display_line_to
8946 (it
, -1, prev_x
, MOVE_TO_X
);
8949 bidi_unshelve_cache (save_data
, 1);
8952 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8956 /* Move IT forward until it satisfies one or more of the criteria in
8957 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8959 OP is a bit-mask that specifies where to stop, and in particular,
8960 which of those four position arguments makes a difference. See the
8961 description of enum move_operation_enum.
8963 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8964 screen line, this function will set IT to the next position that is
8965 displayed to the right of TO_CHARPOS on the screen.
8967 Return the maximum pixel length of any line scanned but never more
8968 than it.last_visible_x. */
8971 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8973 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8974 int line_height
, line_start_x
= 0, reached
= 0;
8975 int max_current_x
= 0;
8976 void *backup_data
= NULL
;
8980 if (op
& MOVE_TO_VPOS
)
8982 /* If no TO_CHARPOS and no TO_X specified, stop at the
8983 start of the line TO_VPOS. */
8984 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8986 if (it
->vpos
== to_vpos
)
8992 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8996 /* TO_VPOS >= 0 means stop at TO_X in the line at
8997 TO_VPOS, or at TO_POS, whichever comes first. */
8998 if (it
->vpos
== to_vpos
)
9004 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9006 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9011 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9013 /* We have reached TO_X but not in the line we want. */
9014 skip
= move_it_in_display_line_to (it
, to_charpos
,
9016 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9024 else if (op
& MOVE_TO_Y
)
9026 struct it it_backup
;
9028 if (it
->line_wrap
== WORD_WRAP
)
9029 SAVE_IT (it_backup
, *it
, backup_data
);
9031 /* TO_Y specified means stop at TO_X in the line containing
9032 TO_Y---or at TO_CHARPOS if this is reached first. The
9033 problem is that we can't really tell whether the line
9034 contains TO_Y before we have completely scanned it, and
9035 this may skip past TO_X. What we do is to first scan to
9038 If TO_X is not specified, use a TO_X of zero. The reason
9039 is to make the outcome of this function more predictable.
9040 If we didn't use TO_X == 0, we would stop at the end of
9041 the line which is probably not what a caller would expect
9043 skip
= move_it_in_display_line_to
9044 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9045 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9047 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9048 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9050 else if (skip
== MOVE_X_REACHED
)
9052 /* If TO_X was reached, we want to know whether TO_Y is
9053 in the line. We know this is the case if the already
9054 scanned glyphs make the line tall enough. Otherwise,
9055 we must check by scanning the rest of the line. */
9056 line_height
= it
->max_ascent
+ it
->max_descent
;
9057 if (to_y
>= it
->current_y
9058 && to_y
< it
->current_y
+ line_height
)
9063 SAVE_IT (it_backup
, *it
, backup_data
);
9064 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9065 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9067 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9068 line_height
= it
->max_ascent
+ it
->max_descent
;
9069 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9071 if (to_y
>= it
->current_y
9072 && to_y
< it
->current_y
+ line_height
)
9074 /* If TO_Y is in this line and TO_X was reached
9075 above, we scanned too far. We have to restore
9076 IT's settings to the ones before skipping. But
9077 keep the more accurate values of max_ascent and
9078 max_descent we've found while skipping the rest
9079 of the line, for the sake of callers, such as
9080 pos_visible_p, that need to know the line
9082 int max_ascent
= it
->max_ascent
;
9083 int max_descent
= it
->max_descent
;
9085 RESTORE_IT (it
, &it_backup
, backup_data
);
9086 it
->max_ascent
= max_ascent
;
9087 it
->max_descent
= max_descent
;
9093 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9099 /* Check whether TO_Y is in this line. */
9100 line_height
= it
->max_ascent
+ it
->max_descent
;
9101 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9103 if (to_y
>= it
->current_y
9104 && to_y
< it
->current_y
+ line_height
)
9106 if (to_y
> it
->current_y
)
9107 max_current_x
= max (it
->current_x
, max_current_x
);
9109 /* When word-wrap is on, TO_X may lie past the end
9110 of a wrapped line. Then it->current is the
9111 character on the next line, so backtrack to the
9112 space before the wrap point. */
9113 if (skip
== MOVE_LINE_CONTINUED
9114 && it
->line_wrap
== WORD_WRAP
)
9116 int prev_x
= max (it
->current_x
- 1, 0);
9117 RESTORE_IT (it
, &it_backup
, backup_data
);
9118 skip
= move_it_in_display_line_to
9119 (it
, -1, prev_x
, MOVE_TO_X
);
9128 max_current_x
= max (it
->current_x
, max_current_x
);
9132 else if (BUFFERP (it
->object
)
9133 && (it
->method
== GET_FROM_BUFFER
9134 || it
->method
== GET_FROM_STRETCH
)
9135 && IT_CHARPOS (*it
) >= to_charpos
9136 /* Under bidi iteration, a call to set_iterator_to_next
9137 can scan far beyond to_charpos if the initial
9138 portion of the next line needs to be reordered. In
9139 that case, give move_it_in_display_line_to another
9142 && it
->bidi_it
.scan_dir
== -1))
9143 skip
= MOVE_POS_MATCH_OR_ZV
;
9145 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9149 case MOVE_POS_MATCH_OR_ZV
:
9150 max_current_x
= max (it
->current_x
, max_current_x
);
9154 case MOVE_NEWLINE_OR_CR
:
9155 max_current_x
= max (it
->current_x
, max_current_x
);
9156 set_iterator_to_next (it
, 1);
9157 it
->continuation_lines_width
= 0;
9160 case MOVE_LINE_TRUNCATED
:
9161 max_current_x
= it
->last_visible_x
;
9162 it
->continuation_lines_width
= 0;
9163 reseat_at_next_visible_line_start (it
, 0);
9164 if ((op
& MOVE_TO_POS
) != 0
9165 && IT_CHARPOS (*it
) > to_charpos
)
9172 case MOVE_LINE_CONTINUED
:
9173 max_current_x
= it
->last_visible_x
;
9174 /* For continued lines ending in a tab, some of the glyphs
9175 associated with the tab are displayed on the current
9176 line. Since it->current_x does not include these glyphs,
9177 we use it->last_visible_x instead. */
9180 it
->continuation_lines_width
+= it
->last_visible_x
;
9181 /* When moving by vpos, ensure that the iterator really
9182 advances to the next line (bug#847, bug#969). Fixme:
9183 do we need to do this in other circumstances? */
9184 if (it
->current_x
!= it
->last_visible_x
9185 && (op
& MOVE_TO_VPOS
)
9186 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9188 line_start_x
= it
->current_x
+ it
->pixel_width
9189 - it
->last_visible_x
;
9190 set_iterator_to_next (it
, 0);
9194 it
->continuation_lines_width
+= it
->current_x
;
9201 /* Reset/increment for the next run. */
9202 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9203 it
->current_x
= line_start_x
;
9206 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9208 last_height
= it
->max_ascent
+ it
->max_descent
;
9209 it
->max_ascent
= it
->max_descent
= 0;
9214 /* On text terminals, we may stop at the end of a line in the middle
9215 of a multi-character glyph. If the glyph itself is continued,
9216 i.e. it is actually displayed on the next line, don't treat this
9217 stopping point as valid; move to the next line instead (unless
9218 that brings us offscreen). */
9219 if (!FRAME_WINDOW_P (it
->f
)
9221 && IT_CHARPOS (*it
) == to_charpos
9222 && it
->what
== IT_CHARACTER
9224 && it
->line_wrap
== WINDOW_WRAP
9225 && it
->current_x
== it
->last_visible_x
- 1
9228 && it
->vpos
< it
->w
->window_end_vpos
)
9230 it
->continuation_lines_width
+= it
->current_x
;
9231 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9232 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9234 last_height
= it
->max_ascent
+ it
->max_descent
;
9238 bidi_unshelve_cache (backup_data
, 1);
9240 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9242 return max_current_x
;
9246 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9248 If DY > 0, move IT backward at least that many pixels. DY = 0
9249 means move IT backward to the preceding line start or BEGV. This
9250 function may move over more than DY pixels if IT->current_y - DY
9251 ends up in the middle of a line; in this case IT->current_y will be
9252 set to the top of the line moved to. */
9255 move_it_vertically_backward (struct it
*it
, int dy
)
9259 void *it2data
= NULL
, *it3data
= NULL
;
9260 ptrdiff_t start_pos
;
9262 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9263 ptrdiff_t pos_limit
;
9268 start_pos
= IT_CHARPOS (*it
);
9270 /* Estimate how many newlines we must move back. */
9271 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9272 if (it
->line_wrap
== TRUNCATE
)
9275 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9277 /* Set the iterator's position that many lines back. But don't go
9278 back more than NLINES full screen lines -- this wins a day with
9279 buffers which have very long lines. */
9280 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9281 back_to_previous_visible_line_start (it
);
9283 /* Reseat the iterator here. When moving backward, we don't want
9284 reseat to skip forward over invisible text, set up the iterator
9285 to deliver from overlay strings at the new position etc. So,
9286 use reseat_1 here. */
9287 reseat_1 (it
, it
->current
.pos
, 1);
9289 /* We are now surely at a line start. */
9290 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9291 reordering is in effect. */
9292 it
->continuation_lines_width
= 0;
9294 /* Move forward and see what y-distance we moved. First move to the
9295 start of the next line so that we get its height. We need this
9296 height to be able to tell whether we reached the specified
9298 SAVE_IT (it2
, *it
, it2data
);
9299 it2
.max_ascent
= it2
.max_descent
= 0;
9302 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9303 MOVE_TO_POS
| MOVE_TO_VPOS
);
9305 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9306 /* If we are in a display string which starts at START_POS,
9307 and that display string includes a newline, and we are
9308 right after that newline (i.e. at the beginning of a
9309 display line), exit the loop, because otherwise we will
9310 infloop, since move_it_to will see that it is already at
9311 START_POS and will not move. */
9312 || (it2
.method
== GET_FROM_STRING
9313 && IT_CHARPOS (it2
) == start_pos
9314 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9315 eassert (IT_CHARPOS (*it
) >= BEGV
);
9316 SAVE_IT (it3
, it2
, it3data
);
9318 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9319 eassert (IT_CHARPOS (*it
) >= BEGV
);
9320 /* H is the actual vertical distance from the position in *IT
9321 and the starting position. */
9322 h
= it2
.current_y
- it
->current_y
;
9323 /* NLINES is the distance in number of lines. */
9324 nlines
= it2
.vpos
- it
->vpos
;
9326 /* Correct IT's y and vpos position
9327 so that they are relative to the starting point. */
9333 /* DY == 0 means move to the start of the screen line. The
9334 value of nlines is > 0 if continuation lines were involved,
9335 or if the original IT position was at start of a line. */
9336 RESTORE_IT (it
, it
, it2data
);
9338 move_it_by_lines (it
, nlines
);
9339 /* The above code moves us to some position NLINES down,
9340 usually to its first glyph (leftmost in an L2R line), but
9341 that's not necessarily the start of the line, under bidi
9342 reordering. We want to get to the character position
9343 that is immediately after the newline of the previous
9346 && !it
->continuation_lines_width
9347 && !STRINGP (it
->string
)
9348 && IT_CHARPOS (*it
) > BEGV
9349 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9351 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9354 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9355 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9357 bidi_unshelve_cache (it3data
, 1);
9361 /* The y-position we try to reach, relative to *IT.
9362 Note that H has been subtracted in front of the if-statement. */
9363 int target_y
= it
->current_y
+ h
- dy
;
9364 int y0
= it3
.current_y
;
9368 RESTORE_IT (&it3
, &it3
, it3data
);
9369 y1
= line_bottom_y (&it3
);
9370 line_height
= y1
- y0
;
9371 RESTORE_IT (it
, it
, it2data
);
9372 /* If we did not reach target_y, try to move further backward if
9373 we can. If we moved too far backward, try to move forward. */
9374 if (target_y
< it
->current_y
9375 /* This is heuristic. In a window that's 3 lines high, with
9376 a line height of 13 pixels each, recentering with point
9377 on the bottom line will try to move -39/2 = 19 pixels
9378 backward. Try to avoid moving into the first line. */
9379 && (it
->current_y
- target_y
9380 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9381 && IT_CHARPOS (*it
) > BEGV
)
9383 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9384 target_y
- it
->current_y
));
9385 dy
= it
->current_y
- target_y
;
9386 goto move_further_back
;
9388 else if (target_y
>= it
->current_y
+ line_height
9389 && IT_CHARPOS (*it
) < ZV
)
9391 /* Should move forward by at least one line, maybe more.
9393 Note: Calling move_it_by_lines can be expensive on
9394 terminal frames, where compute_motion is used (via
9395 vmotion) to do the job, when there are very long lines
9396 and truncate-lines is nil. That's the reason for
9397 treating terminal frames specially here. */
9399 if (!FRAME_WINDOW_P (it
->f
))
9400 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9405 move_it_by_lines (it
, 1);
9407 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9414 /* Move IT by a specified amount of pixel lines DY. DY negative means
9415 move backwards. DY = 0 means move to start of screen line. At the
9416 end, IT will be on the start of a screen line. */
9419 move_it_vertically (struct it
*it
, int dy
)
9422 move_it_vertically_backward (it
, -dy
);
9425 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9426 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9427 MOVE_TO_POS
| MOVE_TO_Y
);
9428 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9430 /* If buffer ends in ZV without a newline, move to the start of
9431 the line to satisfy the post-condition. */
9432 if (IT_CHARPOS (*it
) == ZV
9434 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9435 move_it_by_lines (it
, 0);
9440 /* Move iterator IT past the end of the text line it is in. */
9443 move_it_past_eol (struct it
*it
)
9445 enum move_it_result rc
;
9447 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9448 if (rc
== MOVE_NEWLINE_OR_CR
)
9449 set_iterator_to_next (it
, 0);
9453 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9454 negative means move up. DVPOS == 0 means move to the start of the
9457 Optimization idea: If we would know that IT->f doesn't use
9458 a face with proportional font, we could be faster for
9459 truncate-lines nil. */
9462 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9465 /* The commented-out optimization uses vmotion on terminals. This
9466 gives bad results, because elements like it->what, on which
9467 callers such as pos_visible_p rely, aren't updated. */
9468 /* struct position pos;
9469 if (!FRAME_WINDOW_P (it->f))
9471 struct text_pos textpos;
9473 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9474 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9475 reseat (it, textpos, 1);
9476 it->vpos += pos.vpos;
9477 it->current_y += pos.vpos;
9483 /* DVPOS == 0 means move to the start of the screen line. */
9484 move_it_vertically_backward (it
, 0);
9485 /* Let next call to line_bottom_y calculate real line height. */
9490 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9491 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9493 /* Only move to the next buffer position if we ended up in a
9494 string from display property, not in an overlay string
9495 (before-string or after-string). That is because the
9496 latter don't conceal the underlying buffer position, so
9497 we can ask to move the iterator to the exact position we
9498 are interested in. Note that, even if we are already at
9499 IT_CHARPOS (*it), the call below is not a no-op, as it
9500 will detect that we are at the end of the string, pop the
9501 iterator, and compute it->current_x and it->hpos
9503 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9504 -1, -1, -1, MOVE_TO_POS
);
9510 void *it2data
= NULL
;
9511 ptrdiff_t start_charpos
, i
;
9513 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9514 ptrdiff_t pos_limit
;
9516 /* Start at the beginning of the screen line containing IT's
9517 position. This may actually move vertically backwards,
9518 in case of overlays, so adjust dvpos accordingly. */
9520 move_it_vertically_backward (it
, 0);
9523 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9524 screen lines, and reseat the iterator there. */
9525 start_charpos
= IT_CHARPOS (*it
);
9526 if (it
->line_wrap
== TRUNCATE
)
9529 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9530 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9531 back_to_previous_visible_line_start (it
);
9532 reseat (it
, it
->current
.pos
, 1);
9534 /* Move further back if we end up in a string or an image. */
9535 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9537 /* First try to move to start of display line. */
9539 move_it_vertically_backward (it
, 0);
9541 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9543 /* If start of line is still in string or image,
9544 move further back. */
9545 back_to_previous_visible_line_start (it
);
9546 reseat (it
, it
->current
.pos
, 1);
9550 it
->current_x
= it
->hpos
= 0;
9552 /* Above call may have moved too far if continuation lines
9553 are involved. Scan forward and see if it did. */
9554 SAVE_IT (it2
, *it
, it2data
);
9555 it2
.vpos
= it2
.current_y
= 0;
9556 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9557 it
->vpos
-= it2
.vpos
;
9558 it
->current_y
-= it2
.current_y
;
9559 it
->current_x
= it
->hpos
= 0;
9561 /* If we moved too far back, move IT some lines forward. */
9562 if (it2
.vpos
> -dvpos
)
9564 int delta
= it2
.vpos
+ dvpos
;
9566 RESTORE_IT (&it2
, &it2
, it2data
);
9567 SAVE_IT (it2
, *it
, it2data
);
9568 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9569 /* Move back again if we got too far ahead. */
9570 if (IT_CHARPOS (*it
) >= start_charpos
)
9571 RESTORE_IT (it
, &it2
, it2data
);
9573 bidi_unshelve_cache (it2data
, 1);
9576 RESTORE_IT (it
, it
, it2data
);
9580 /* Return true if IT points into the middle of a display vector. */
9583 in_display_vector_p (struct it
*it
)
9585 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9586 && it
->current
.dpvec_index
> 0
9587 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9590 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9591 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9592 WINDOW must be a live window and defaults to the selected one. The
9593 return value is a cons of the maximum pixel-width of any text line and
9594 the maximum pixel-height of all text lines.
9596 The optional argument FROM, if non-nil, specifies the first text
9597 position and defaults to the minimum accessible position of the buffer.
9598 If FROM is t, use the minimum accessible position that is not a newline
9599 character. TO, if non-nil, specifies the last text position and
9600 defaults to the maximum accessible position of the buffer. If TO is t,
9601 use the maximum accessible position that is not a newline character.
9603 The optional argument X_LIMIT, if non-nil, specifies the maximum text
9604 width that can be returned. X_LIMIT nil or omitted, means to use the
9605 pixel-width of WINDOW's body; use this if you do not intend to change
9606 the width of WINDOW. Use the maximum width WINDOW may assume if you
9607 intend to change WINDOW's width.
9609 The optional argument Y_LIMIT, if non-nil, specifies the maximum text
9610 height that can be returned. Text lines whose y-coordinate is beyond
9611 Y_LIMIT are ignored. Since calculating the text height of a large
9612 buffer can take some time, it makes sense to specify this argument if
9613 the size of the buffer is unknown.
9615 Optional argument MODE_AND_HEADER_LINE nil or omitted means do not
9616 include the height of the mode- or header-line of WINDOW in the return
9617 value. If it is either the symbol `mode-line' or `header-line', include
9618 only the height of that line, if present, in the return value. If t,
9619 include the height of both, if present, in the return value. */)
9620 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9621 Lisp_Object mode_and_header_line
)
9623 struct window
*w
= decode_live_window (window
);
9627 struct buffer
*old_buffer
= NULL
;
9628 ptrdiff_t start
, end
, pos
;
9629 struct text_pos startp
;
9630 void *itdata
= NULL
;
9631 int c
, max_y
= -1, x
= 0, y
= 0;
9637 if (b
!= current_buffer
)
9639 old_buffer
= current_buffer
;
9640 set_buffer_internal (b
);
9645 else if (EQ (from
, Qt
))
9648 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9649 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9651 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9656 CHECK_NUMBER_COERCE_MARKER (from
);
9657 start
= min (max (XINT (from
), BEGV
), ZV
);
9662 else if (EQ (to
, Qt
))
9665 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9666 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9668 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9673 CHECK_NUMBER_COERCE_MARKER (to
);
9674 end
= max (start
, min (XINT (to
), ZV
));
9677 if (!NILP (y_limit
))
9679 CHECK_NUMBER (y_limit
);
9680 max_y
= min (XINT (y_limit
), INT_MAX
);
9683 itdata
= bidi_shelve_cache ();
9684 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9685 start_display (&it
, w
, startp
);
9688 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9691 CHECK_NUMBER (x_limit
);
9692 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9693 /* Actually, we never want move_it_to stop at to_x. But to make
9694 sure that move_it_in_display_line_to always moves far enough,
9695 we set it to INT_MAX and specify MOVE_TO_X. */
9696 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9697 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9700 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9702 if (!EQ (mode_and_header_line
, Qheader_line
)
9703 && !EQ (mode_and_header_line
, Qt
))
9704 /* Do not count the header-line which was counted automatically by
9706 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9708 if (EQ (mode_and_header_line
, Qmode_line
)
9709 || EQ (mode_and_header_line
, Qt
))
9710 /* Do count the mode-line which is not included automatically by
9712 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9714 bidi_unshelve_cache (itdata
, 0);
9717 set_buffer_internal (old_buffer
);
9719 return Fcons (make_number (x
), make_number (y
));
9722 /***********************************************************************
9724 ***********************************************************************/
9727 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9731 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9733 Lisp_Object args
[3];
9734 Lisp_Object msg
, fmt
;
9737 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9741 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9743 args
[0] = fmt
= build_string (format
);
9746 msg
= Fformat (3, args
);
9748 len
= SBYTES (msg
) + 1;
9749 buffer
= SAFE_ALLOCA (len
);
9750 memcpy (buffer
, SDATA (msg
), len
);
9752 message_dolog (buffer
, len
- 1, 1, 0);
9759 /* Output a newline in the *Messages* buffer if "needs" one. */
9762 message_log_maybe_newline (void)
9764 if (message_log_need_newline
)
9765 message_dolog ("", 0, 1, 0);
9769 /* Add a string M of length NBYTES to the message log, optionally
9770 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9771 true, means interpret the contents of M as multibyte. This
9772 function calls low-level routines in order to bypass text property
9773 hooks, etc. which might not be safe to run.
9775 This may GC (insert may run before/after change hooks),
9776 so the buffer M must NOT point to a Lisp string. */
9779 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9781 const unsigned char *msg
= (const unsigned char *) m
;
9783 if (!NILP (Vmemory_full
))
9786 if (!NILP (Vmessage_log_max
))
9788 struct buffer
*oldbuf
;
9789 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9790 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9791 ptrdiff_t point_at_end
= 0;
9792 ptrdiff_t zv_at_end
= 0;
9793 Lisp_Object old_deactivate_mark
;
9794 struct gcpro gcpro1
;
9796 old_deactivate_mark
= Vdeactivate_mark
;
9797 oldbuf
= current_buffer
;
9799 /* Ensure the Messages buffer exists, and switch to it.
9800 If we created it, set the major-mode. */
9803 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9805 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9808 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9809 call0 (intern ("messages-buffer-mode"));
9812 bset_undo_list (current_buffer
, Qt
);
9813 bset_cache_long_scans (current_buffer
, Qnil
);
9815 oldpoint
= message_dolog_marker1
;
9816 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9817 oldbegv
= message_dolog_marker2
;
9818 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9819 oldzv
= message_dolog_marker3
;
9820 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9821 GCPRO1 (old_deactivate_mark
);
9829 BEGV_BYTE
= BEG_BYTE
;
9832 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9834 /* Insert the string--maybe converting multibyte to single byte
9835 or vice versa, so that all the text fits the buffer. */
9837 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9843 /* Convert a multibyte string to single-byte
9844 for the *Message* buffer. */
9845 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9847 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9848 work
[0] = (ASCII_CHAR_P (c
)
9850 : multibyte_char_to_unibyte (c
));
9851 insert_1_both (work
, 1, 1, 1, 0, 0);
9854 else if (! multibyte
9855 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9859 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9860 /* Convert a single-byte string to multibyte
9861 for the *Message* buffer. */
9862 for (i
= 0; i
< nbytes
; i
++)
9865 MAKE_CHAR_MULTIBYTE (c
);
9866 char_bytes
= CHAR_STRING (c
, str
);
9867 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9871 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9875 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9878 insert_1_both ("\n", 1, 1, 1, 0, 0);
9880 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9882 this_bol_byte
= PT_BYTE
;
9884 /* See if this line duplicates the previous one.
9885 If so, combine duplicates. */
9888 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9890 prev_bol_byte
= PT_BYTE
;
9892 dups
= message_log_check_duplicate (prev_bol_byte
,
9896 del_range_both (prev_bol
, prev_bol_byte
,
9897 this_bol
, this_bol_byte
, 0);
9900 char dupstr
[sizeof " [ times]"
9901 + INT_STRLEN_BOUND (printmax_t
)];
9903 /* If you change this format, don't forget to also
9904 change message_log_check_duplicate. */
9905 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9906 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9907 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9912 /* If we have more than the desired maximum number of lines
9913 in the *Messages* buffer now, delete the oldest ones.
9914 This is safe because we don't have undo in this buffer. */
9916 if (NATNUMP (Vmessage_log_max
))
9918 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9919 -XFASTINT (Vmessage_log_max
) - 1, 0);
9920 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9923 BEGV
= marker_position (oldbegv
);
9924 BEGV_BYTE
= marker_byte_position (oldbegv
);
9933 ZV
= marker_position (oldzv
);
9934 ZV_BYTE
= marker_byte_position (oldzv
);
9938 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9940 /* We can't do Fgoto_char (oldpoint) because it will run some
9942 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
9943 marker_byte_position (oldpoint
));
9946 unchain_marker (XMARKER (oldpoint
));
9947 unchain_marker (XMARKER (oldbegv
));
9948 unchain_marker (XMARKER (oldzv
));
9950 /* We called insert_1_both above with its 5th argument (PREPARE)
9951 zero, which prevents insert_1_both from calling
9952 prepare_to_modify_buffer, which in turns prevents us from
9953 incrementing windows_or_buffers_changed even if *Messages* is
9954 shown in some window. So we must manually set
9955 windows_or_buffers_changed here to make up for that. */
9956 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9957 bset_redisplay (current_buffer
);
9959 set_buffer_internal (oldbuf
);
9961 message_log_need_newline
= !nlflag
;
9962 Vdeactivate_mark
= old_deactivate_mark
;
9967 /* We are at the end of the buffer after just having inserted a newline.
9968 (Note: We depend on the fact we won't be crossing the gap.)
9969 Check to see if the most recent message looks a lot like the previous one.
9970 Return 0 if different, 1 if the new one should just replace it, or a
9971 value N > 1 if we should also append " [N times]". */
9974 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
9977 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
9979 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9980 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9982 for (i
= 0; i
< len
; i
++)
9984 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
9992 if (*p1
++ == ' ' && *p1
++ == '[')
9995 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9996 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10003 /* Display an echo area message M with a specified length of NBYTES
10004 bytes. The string may include null characters. If M is not a
10005 string, clear out any existing message, and let the mini-buffer
10008 This function cancels echoing. */
10011 message3 (Lisp_Object m
)
10013 struct gcpro gcpro1
;
10016 clear_message (true, true);
10019 /* First flush out any partial line written with print. */
10020 message_log_maybe_newline ();
10023 ptrdiff_t nbytes
= SBYTES (m
);
10024 bool multibyte
= STRING_MULTIBYTE (m
);
10026 char *buffer
= SAFE_ALLOCA (nbytes
);
10027 memcpy (buffer
, SDATA (m
), nbytes
);
10028 message_dolog (buffer
, nbytes
, 1, multibyte
);
10031 message3_nolog (m
);
10037 /* The non-logging version of message3.
10038 This does not cancel echoing, because it is used for echoing.
10039 Perhaps we need to make a separate function for echoing
10040 and make this cancel echoing. */
10043 message3_nolog (Lisp_Object m
)
10045 struct frame
*sf
= SELECTED_FRAME ();
10047 if (FRAME_INITIAL_P (sf
))
10049 if (noninteractive_need_newline
)
10050 putc ('\n', stderr
);
10051 noninteractive_need_newline
= 0;
10054 Lisp_Object s
= ENCODE_SYSTEM (m
);
10056 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10058 if (cursor_in_echo_area
== 0)
10059 fprintf (stderr
, "\n");
10062 /* Error messages get reported properly by cmd_error, so this must be just an
10063 informative message; if the frame hasn't really been initialized yet, just
10065 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10067 /* Get the frame containing the mini-buffer
10068 that the selected frame is using. */
10069 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10070 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10071 struct frame
*f
= XFRAME (frame
);
10073 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10074 Fmake_frame_visible (frame
);
10076 if (STRINGP (m
) && SCHARS (m
) > 0)
10079 if (minibuffer_auto_raise
)
10080 Fraise_frame (frame
);
10081 /* Assume we are not echoing.
10082 (If we are, echo_now will override this.) */
10083 echo_message_buffer
= Qnil
;
10086 clear_message (true, true);
10088 do_pending_window_change (0);
10089 echo_area_display (1);
10090 do_pending_window_change (0);
10091 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10092 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10097 /* Display a null-terminated echo area message M. If M is 0, clear
10098 out any existing message, and let the mini-buffer text show through.
10100 The buffer M must continue to exist until after the echo area gets
10101 cleared or some other message gets displayed there. Do not pass
10102 text that is stored in a Lisp string. Do not pass text in a buffer
10103 that was alloca'd. */
10106 message1 (const char *m
)
10108 message3 (m
? build_unibyte_string (m
) : Qnil
);
10112 /* The non-logging counterpart of message1. */
10115 message1_nolog (const char *m
)
10117 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10120 /* Display a message M which contains a single %s
10121 which gets replaced with STRING. */
10124 message_with_string (const char *m
, Lisp_Object string
, int log
)
10126 CHECK_STRING (string
);
10128 if (noninteractive
)
10132 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10133 String whose data pointer might be passed to us in M. So
10134 we use a local copy. */
10135 char *fmt
= xstrdup (m
);
10137 if (noninteractive_need_newline
)
10138 putc ('\n', stderr
);
10139 noninteractive_need_newline
= 0;
10140 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10141 if (!cursor_in_echo_area
)
10142 fprintf (stderr
, "\n");
10147 else if (INTERACTIVE
)
10149 /* The frame whose minibuffer we're going to display the message on.
10150 It may be larger than the selected frame, so we need
10151 to use its buffer, not the selected frame's buffer. */
10152 Lisp_Object mini_window
;
10153 struct frame
*f
, *sf
= SELECTED_FRAME ();
10155 /* Get the frame containing the minibuffer
10156 that the selected frame is using. */
10157 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10158 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10160 /* Error messages get reported properly by cmd_error, so this must be
10161 just an informative message; if the frame hasn't really been
10162 initialized yet, just toss it. */
10163 if (f
->glyphs_initialized_p
)
10165 Lisp_Object args
[2], msg
;
10166 struct gcpro gcpro1
, gcpro2
;
10168 args
[0] = build_string (m
);
10169 args
[1] = msg
= string
;
10170 GCPRO2 (args
[0], msg
);
10173 msg
= Fformat (2, args
);
10178 message3_nolog (msg
);
10182 /* Print should start at the beginning of the message
10183 buffer next time. */
10184 message_buf_print
= 0;
10190 /* Dump an informative message to the minibuf. If M is 0, clear out
10191 any existing message, and let the mini-buffer text show through. */
10194 vmessage (const char *m
, va_list ap
)
10196 if (noninteractive
)
10200 if (noninteractive_need_newline
)
10201 putc ('\n', stderr
);
10202 noninteractive_need_newline
= 0;
10203 vfprintf (stderr
, m
, ap
);
10204 if (cursor_in_echo_area
== 0)
10205 fprintf (stderr
, "\n");
10209 else if (INTERACTIVE
)
10211 /* The frame whose mini-buffer we're going to display the message
10212 on. It may be larger than the selected frame, so we need to
10213 use its buffer, not the selected frame's buffer. */
10214 Lisp_Object mini_window
;
10215 struct frame
*f
, *sf
= SELECTED_FRAME ();
10217 /* Get the frame containing the mini-buffer
10218 that the selected frame is using. */
10219 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10220 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10222 /* Error messages get reported properly by cmd_error, so this must be
10223 just an informative message; if the frame hasn't really been
10224 initialized yet, just toss it. */
10225 if (f
->glyphs_initialized_p
)
10230 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10231 char *message_buf
= alloca (maxsize
+ 1);
10233 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10235 message3 (make_string (message_buf
, len
));
10240 /* Print should start at the beginning of the message
10241 buffer next time. */
10242 message_buf_print
= 0;
10248 message (const char *m
, ...)
10258 /* The non-logging version of message. */
10261 message_nolog (const char *m
, ...)
10263 Lisp_Object old_log_max
;
10266 old_log_max
= Vmessage_log_max
;
10267 Vmessage_log_max
= Qnil
;
10269 Vmessage_log_max
= old_log_max
;
10275 /* Display the current message in the current mini-buffer. This is
10276 only called from error handlers in process.c, and is not time
10280 update_echo_area (void)
10282 if (!NILP (echo_area_buffer
[0]))
10284 Lisp_Object string
;
10285 string
= Fcurrent_message ();
10291 /* Make sure echo area buffers in `echo_buffers' are live.
10292 If they aren't, make new ones. */
10295 ensure_echo_area_buffers (void)
10299 for (i
= 0; i
< 2; ++i
)
10300 if (!BUFFERP (echo_buffer
[i
])
10301 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10304 Lisp_Object old_buffer
;
10307 old_buffer
= echo_buffer
[i
];
10308 echo_buffer
[i
] = Fget_buffer_create
10309 (make_formatted_string (name
, " *Echo Area %d*", i
));
10310 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10311 /* to force word wrap in echo area -
10312 it was decided to postpone this*/
10313 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10315 for (j
= 0; j
< 2; ++j
)
10316 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10317 echo_area_buffer
[j
] = echo_buffer
[i
];
10322 /* Call FN with args A1..A2 with either the current or last displayed
10323 echo_area_buffer as current buffer.
10325 WHICH zero means use the current message buffer
10326 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10327 from echo_buffer[] and clear it.
10329 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10330 suitable buffer from echo_buffer[] and clear it.
10332 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10333 that the current message becomes the last displayed one, make
10334 choose a suitable buffer for echo_area_buffer[0], and clear it.
10336 Value is what FN returns. */
10339 with_echo_area_buffer (struct window
*w
, int which
,
10340 int (*fn
) (ptrdiff_t, Lisp_Object
),
10341 ptrdiff_t a1
, Lisp_Object a2
)
10343 Lisp_Object buffer
;
10344 int this_one
, the_other
, clear_buffer_p
, rc
;
10345 ptrdiff_t count
= SPECPDL_INDEX ();
10347 /* If buffers aren't live, make new ones. */
10348 ensure_echo_area_buffers ();
10350 clear_buffer_p
= 0;
10353 this_one
= 0, the_other
= 1;
10354 else if (which
> 0)
10355 this_one
= 1, the_other
= 0;
10358 this_one
= 0, the_other
= 1;
10359 clear_buffer_p
= true;
10361 /* We need a fresh one in case the current echo buffer equals
10362 the one containing the last displayed echo area message. */
10363 if (!NILP (echo_area_buffer
[this_one
])
10364 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10365 echo_area_buffer
[this_one
] = Qnil
;
10368 /* Choose a suitable buffer from echo_buffer[] is we don't
10370 if (NILP (echo_area_buffer
[this_one
]))
10372 echo_area_buffer
[this_one
]
10373 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10374 ? echo_buffer
[the_other
]
10375 : echo_buffer
[this_one
]);
10376 clear_buffer_p
= true;
10379 buffer
= echo_area_buffer
[this_one
];
10381 /* Don't get confused by reusing the buffer used for echoing
10382 for a different purpose. */
10383 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10386 record_unwind_protect (unwind_with_echo_area_buffer
,
10387 with_echo_area_buffer_unwind_data (w
));
10389 /* Make the echo area buffer current. Note that for display
10390 purposes, it is not necessary that the displayed window's buffer
10391 == current_buffer, except for text property lookup. So, let's
10392 only set that buffer temporarily here without doing a full
10393 Fset_window_buffer. We must also change w->pointm, though,
10394 because otherwise an assertions in unshow_buffer fails, and Emacs
10396 set_buffer_internal_1 (XBUFFER (buffer
));
10399 wset_buffer (w
, buffer
);
10400 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10403 bset_undo_list (current_buffer
, Qt
);
10404 bset_read_only (current_buffer
, Qnil
);
10405 specbind (Qinhibit_read_only
, Qt
);
10406 specbind (Qinhibit_modification_hooks
, Qt
);
10408 if (clear_buffer_p
&& Z
> BEG
)
10409 del_range (BEG
, Z
);
10411 eassert (BEGV
>= BEG
);
10412 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10416 eassert (BEGV
>= BEG
);
10417 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10419 unbind_to (count
, Qnil
);
10424 /* Save state that should be preserved around the call to the function
10425 FN called in with_echo_area_buffer. */
10428 with_echo_area_buffer_unwind_data (struct window
*w
)
10431 Lisp_Object vector
, tmp
;
10433 /* Reduce consing by keeping one vector in
10434 Vwith_echo_area_save_vector. */
10435 vector
= Vwith_echo_area_save_vector
;
10436 Vwith_echo_area_save_vector
= Qnil
;
10439 vector
= Fmake_vector (make_number (9), Qnil
);
10441 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10442 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10443 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10447 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10448 ASET (vector
, i
, w
->contents
); ++i
;
10449 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10450 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10451 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10452 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10457 for (; i
< end
; ++i
)
10458 ASET (vector
, i
, Qnil
);
10461 eassert (i
== ASIZE (vector
));
10466 /* Restore global state from VECTOR which was created by
10467 with_echo_area_buffer_unwind_data. */
10470 unwind_with_echo_area_buffer (Lisp_Object vector
)
10472 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10473 Vdeactivate_mark
= AREF (vector
, 1);
10474 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10476 if (WINDOWP (AREF (vector
, 3)))
10479 Lisp_Object buffer
;
10481 w
= XWINDOW (AREF (vector
, 3));
10482 buffer
= AREF (vector
, 4);
10484 wset_buffer (w
, buffer
);
10485 set_marker_both (w
->pointm
, buffer
,
10486 XFASTINT (AREF (vector
, 5)),
10487 XFASTINT (AREF (vector
, 6)));
10488 set_marker_both (w
->start
, buffer
,
10489 XFASTINT (AREF (vector
, 7)),
10490 XFASTINT (AREF (vector
, 8)));
10493 Vwith_echo_area_save_vector
= vector
;
10497 /* Set up the echo area for use by print functions. MULTIBYTE_P
10498 non-zero means we will print multibyte. */
10501 setup_echo_area_for_printing (int multibyte_p
)
10503 /* If we can't find an echo area any more, exit. */
10504 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10505 Fkill_emacs (Qnil
);
10507 ensure_echo_area_buffers ();
10509 if (!message_buf_print
)
10511 /* A message has been output since the last time we printed.
10512 Choose a fresh echo area buffer. */
10513 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10514 echo_area_buffer
[0] = echo_buffer
[1];
10516 echo_area_buffer
[0] = echo_buffer
[0];
10518 /* Switch to that buffer and clear it. */
10519 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10520 bset_truncate_lines (current_buffer
, Qnil
);
10524 ptrdiff_t count
= SPECPDL_INDEX ();
10525 specbind (Qinhibit_read_only
, Qt
);
10526 /* Note that undo recording is always disabled. */
10527 del_range (BEG
, Z
);
10528 unbind_to (count
, Qnil
);
10530 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10532 /* Set up the buffer for the multibyteness we need. */
10534 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10535 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10537 /* Raise the frame containing the echo area. */
10538 if (minibuffer_auto_raise
)
10540 struct frame
*sf
= SELECTED_FRAME ();
10541 Lisp_Object mini_window
;
10542 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10543 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10546 message_log_maybe_newline ();
10547 message_buf_print
= 1;
10551 if (NILP (echo_area_buffer
[0]))
10553 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10554 echo_area_buffer
[0] = echo_buffer
[1];
10556 echo_area_buffer
[0] = echo_buffer
[0];
10559 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10561 /* Someone switched buffers between print requests. */
10562 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10563 bset_truncate_lines (current_buffer
, Qnil
);
10569 /* Display an echo area message in window W. Value is non-zero if W's
10570 height is changed. If display_last_displayed_message_p is
10571 non-zero, display the message that was last displayed, otherwise
10572 display the current message. */
10575 display_echo_area (struct window
*w
)
10577 int i
, no_message_p
, window_height_changed_p
;
10579 /* Temporarily disable garbage collections while displaying the echo
10580 area. This is done because a GC can print a message itself.
10581 That message would modify the echo area buffer's contents while a
10582 redisplay of the buffer is going on, and seriously confuse
10584 ptrdiff_t count
= inhibit_garbage_collection ();
10586 /* If there is no message, we must call display_echo_area_1
10587 nevertheless because it resizes the window. But we will have to
10588 reset the echo_area_buffer in question to nil at the end because
10589 with_echo_area_buffer will sets it to an empty buffer. */
10590 i
= display_last_displayed_message_p
? 1 : 0;
10591 no_message_p
= NILP (echo_area_buffer
[i
]);
10593 window_height_changed_p
10594 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10595 display_echo_area_1
,
10596 (intptr_t) w
, Qnil
);
10599 echo_area_buffer
[i
] = Qnil
;
10601 unbind_to (count
, Qnil
);
10602 return window_height_changed_p
;
10606 /* Helper for display_echo_area. Display the current buffer which
10607 contains the current echo area message in window W, a mini-window,
10608 a pointer to which is passed in A1. A2..A4 are currently not used.
10609 Change the height of W so that all of the message is displayed.
10610 Value is non-zero if height of W was changed. */
10613 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10616 struct window
*w
= (struct window
*) i1
;
10617 Lisp_Object window
;
10618 struct text_pos start
;
10619 int window_height_changed_p
= 0;
10621 /* Do this before displaying, so that we have a large enough glyph
10622 matrix for the display. If we can't get enough space for the
10623 whole text, display the last N lines. That works by setting w->start. */
10624 window_height_changed_p
= resize_mini_window (w
, 0);
10626 /* Use the starting position chosen by resize_mini_window. */
10627 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10630 clear_glyph_matrix (w
->desired_matrix
);
10631 XSETWINDOW (window
, w
);
10632 try_window (window
, start
, 0);
10634 return window_height_changed_p
;
10638 /* Resize the echo area window to exactly the size needed for the
10639 currently displayed message, if there is one. If a mini-buffer
10640 is active, don't shrink it. */
10643 resize_echo_area_exactly (void)
10645 if (BUFFERP (echo_area_buffer
[0])
10646 && WINDOWP (echo_area_window
))
10648 struct window
*w
= XWINDOW (echo_area_window
);
10649 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10650 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10651 (intptr_t) w
, resize_exactly
);
10654 windows_or_buffers_changed
= 42;
10655 update_mode_lines
= 30;
10656 redisplay_internal ();
10662 /* Callback function for with_echo_area_buffer, when used from
10663 resize_echo_area_exactly. A1 contains a pointer to the window to
10664 resize, EXACTLY non-nil means resize the mini-window exactly to the
10665 size of the text displayed. A3 and A4 are not used. Value is what
10666 resize_mini_window returns. */
10669 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10672 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10676 /* Resize mini-window W to fit the size of its contents. EXACT_P
10677 means size the window exactly to the size needed. Otherwise, it's
10678 only enlarged until W's buffer is empty.
10680 Set W->start to the right place to begin display. If the whole
10681 contents fit, start at the beginning. Otherwise, start so as
10682 to make the end of the contents appear. This is particularly
10683 important for y-or-n-p, but seems desirable generally.
10685 Value is non-zero if the window height has been changed. */
10688 resize_mini_window (struct window
*w
, int exact_p
)
10690 struct frame
*f
= XFRAME (w
->frame
);
10691 int window_height_changed_p
= 0;
10693 eassert (MINI_WINDOW_P (w
));
10695 /* By default, start display at the beginning. */
10696 set_marker_both (w
->start
, w
->contents
,
10697 BUF_BEGV (XBUFFER (w
->contents
)),
10698 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10700 /* Don't resize windows while redisplaying a window; it would
10701 confuse redisplay functions when the size of the window they are
10702 displaying changes from under them. Such a resizing can happen,
10703 for instance, when which-func prints a long message while
10704 we are running fontification-functions. We're running these
10705 functions with safe_call which binds inhibit-redisplay to t. */
10706 if (!NILP (Vinhibit_redisplay
))
10709 /* Nil means don't try to resize. */
10710 if (NILP (Vresize_mini_windows
)
10711 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10714 if (!FRAME_MINIBUF_ONLY_P (f
))
10717 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10718 + WINDOW_PIXEL_HEIGHT (w
));
10719 int unit
= FRAME_LINE_HEIGHT (f
);
10720 int height
, max_height
;
10721 struct text_pos start
;
10722 struct buffer
*old_current_buffer
= NULL
;
10724 if (current_buffer
!= XBUFFER (w
->contents
))
10726 old_current_buffer
= current_buffer
;
10727 set_buffer_internal (XBUFFER (w
->contents
));
10730 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10732 /* Compute the max. number of lines specified by the user. */
10733 if (FLOATP (Vmax_mini_window_height
))
10734 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10735 else if (INTEGERP (Vmax_mini_window_height
))
10736 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10738 max_height
= total_height
/ 4;
10740 /* Correct that max. height if it's bogus. */
10741 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10743 /* Find out the height of the text in the window. */
10744 if (it
.line_wrap
== TRUNCATE
)
10749 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10750 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10751 height
= it
.current_y
+ last_height
;
10753 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10754 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10757 /* Compute a suitable window start. */
10758 if (height
> max_height
)
10760 height
= (max_height
/ unit
) * unit
;
10761 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10762 move_it_vertically_backward (&it
, height
- unit
);
10763 start
= it
.current
.pos
;
10766 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10767 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10769 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10771 /* Let it grow only, until we display an empty message, in which
10772 case the window shrinks again. */
10773 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10775 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10777 FRAME_WINDOWS_FROZEN (f
) = 1;
10778 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10779 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10781 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10782 && (exact_p
|| BEGV
== ZV
))
10784 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10786 FRAME_WINDOWS_FROZEN (f
) = 0;
10787 shrink_mini_window (w
, 1);
10788 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10793 /* Always resize to exact size needed. */
10794 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10796 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10798 FRAME_WINDOWS_FROZEN (f
) = 1;
10799 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10800 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10802 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10804 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10806 FRAME_WINDOWS_FROZEN (f
) = 0;
10807 shrink_mini_window (w
, 1);
10811 FRAME_WINDOWS_FROZEN (f
) = 1;
10812 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10815 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10819 if (old_current_buffer
)
10820 set_buffer_internal (old_current_buffer
);
10823 return window_height_changed_p
;
10827 /* Value is the current message, a string, or nil if there is no
10828 current message. */
10831 current_message (void)
10835 if (!BUFFERP (echo_area_buffer
[0]))
10839 with_echo_area_buffer (0, 0, current_message_1
,
10840 (intptr_t) &msg
, Qnil
);
10842 echo_area_buffer
[0] = Qnil
;
10850 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10853 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10856 *msg
= make_buffer_string (BEG
, Z
, 1);
10863 /* Push the current message on Vmessage_stack for later restoration
10864 by restore_message. Value is non-zero if the current message isn't
10865 empty. This is a relatively infrequent operation, so it's not
10866 worth optimizing. */
10869 push_message (void)
10871 Lisp_Object msg
= current_message ();
10872 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10873 return STRINGP (msg
);
10877 /* Restore message display from the top of Vmessage_stack. */
10880 restore_message (void)
10882 eassert (CONSP (Vmessage_stack
));
10883 message3_nolog (XCAR (Vmessage_stack
));
10887 /* Handler for unwind-protect calling pop_message. */
10890 pop_message_unwind (void)
10892 /* Pop the top-most entry off Vmessage_stack. */
10893 eassert (CONSP (Vmessage_stack
));
10894 Vmessage_stack
= XCDR (Vmessage_stack
);
10898 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10899 exits. If the stack is not empty, we have a missing pop_message
10903 check_message_stack (void)
10905 if (!NILP (Vmessage_stack
))
10910 /* Truncate to NCHARS what will be displayed in the echo area the next
10911 time we display it---but don't redisplay it now. */
10914 truncate_echo_area (ptrdiff_t nchars
)
10917 echo_area_buffer
[0] = Qnil
;
10918 else if (!noninteractive
10920 && !NILP (echo_area_buffer
[0]))
10922 struct frame
*sf
= SELECTED_FRAME ();
10923 /* Error messages get reported properly by cmd_error, so this must be
10924 just an informative message; if the frame hasn't really been
10925 initialized yet, just toss it. */
10926 if (sf
->glyphs_initialized_p
)
10927 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
10932 /* Helper function for truncate_echo_area. Truncate the current
10933 message to at most NCHARS characters. */
10936 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
10938 if (BEG
+ nchars
< Z
)
10939 del_range (BEG
+ nchars
, Z
);
10941 echo_area_buffer
[0] = Qnil
;
10945 /* Set the current message to STRING. */
10948 set_message (Lisp_Object string
)
10950 eassert (STRINGP (string
));
10952 message_enable_multibyte
= STRING_MULTIBYTE (string
);
10954 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
10955 message_buf_print
= 0;
10956 help_echo_showing_p
= 0;
10958 if (STRINGP (Vdebug_on_message
)
10959 && STRINGP (string
)
10960 && fast_string_match (Vdebug_on_message
, string
) >= 0)
10961 call_debugger (list2 (Qerror
, string
));
10965 /* Helper function for set_message. First argument is ignored and second
10966 argument has the same meaning as for set_message.
10967 This function is called with the echo area buffer being current. */
10970 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
10972 eassert (STRINGP (string
));
10974 /* Change multibyteness of the echo buffer appropriately. */
10975 if (message_enable_multibyte
10976 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10977 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10979 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
10980 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10981 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
10983 /* Insert new message at BEG. */
10984 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10986 /* This function takes care of single/multibyte conversion.
10987 We just have to ensure that the echo area buffer has the right
10988 setting of enable_multibyte_characters. */
10989 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
10995 /* Clear messages. CURRENT_P non-zero means clear the current
10996 message. LAST_DISPLAYED_P non-zero means clear the message
11000 clear_message (bool current_p
, bool last_displayed_p
)
11004 echo_area_buffer
[0] = Qnil
;
11005 message_cleared_p
= true;
11008 if (last_displayed_p
)
11009 echo_area_buffer
[1] = Qnil
;
11011 message_buf_print
= 0;
11014 /* Clear garbaged frames.
11016 This function is used where the old redisplay called
11017 redraw_garbaged_frames which in turn called redraw_frame which in
11018 turn called clear_frame. The call to clear_frame was a source of
11019 flickering. I believe a clear_frame is not necessary. It should
11020 suffice in the new redisplay to invalidate all current matrices,
11021 and ensure a complete redisplay of all windows. */
11024 clear_garbaged_frames (void)
11026 if (frame_garbaged
)
11028 Lisp_Object tail
, frame
;
11030 FOR_EACH_FRAME (tail
, frame
)
11032 struct frame
*f
= XFRAME (frame
);
11034 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11039 clear_current_matrices (f
);
11040 fset_redisplay (f
);
11041 f
->garbaged
= false;
11042 f
->resized_p
= false;
11046 frame_garbaged
= false;
11051 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11052 is non-zero update selected_frame. Value is non-zero if the
11053 mini-windows height has been changed. */
11056 echo_area_display (int update_frame_p
)
11058 Lisp_Object mini_window
;
11061 int window_height_changed_p
= 0;
11062 struct frame
*sf
= SELECTED_FRAME ();
11064 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11065 w
= XWINDOW (mini_window
);
11066 f
= XFRAME (WINDOW_FRAME (w
));
11068 /* Don't display if frame is invisible or not yet initialized. */
11069 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11072 #ifdef HAVE_WINDOW_SYSTEM
11073 /* When Emacs starts, selected_frame may be the initial terminal
11074 frame. If we let this through, a message would be displayed on
11076 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11078 #endif /* HAVE_WINDOW_SYSTEM */
11080 /* Redraw garbaged frames. */
11081 clear_garbaged_frames ();
11083 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11085 echo_area_window
= mini_window
;
11086 window_height_changed_p
= display_echo_area (w
);
11087 w
->must_be_updated_p
= true;
11089 /* Update the display, unless called from redisplay_internal.
11090 Also don't update the screen during redisplay itself. The
11091 update will happen at the end of redisplay, and an update
11092 here could cause confusion. */
11093 if (update_frame_p
&& !redisplaying_p
)
11097 /* If the display update has been interrupted by pending
11098 input, update mode lines in the frame. Due to the
11099 pending input, it might have been that redisplay hasn't
11100 been called, so that mode lines above the echo area are
11101 garbaged. This looks odd, so we prevent it here. */
11102 if (!display_completed
)
11103 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11105 if (window_height_changed_p
11106 /* Don't do this if Emacs is shutting down. Redisplay
11107 needs to run hooks. */
11108 && !NILP (Vrun_hooks
))
11110 /* Must update other windows. Likewise as in other
11111 cases, don't let this update be interrupted by
11113 ptrdiff_t count
= SPECPDL_INDEX ();
11114 specbind (Qredisplay_dont_pause
, Qt
);
11115 windows_or_buffers_changed
= 44;
11116 redisplay_internal ();
11117 unbind_to (count
, Qnil
);
11119 else if (FRAME_WINDOW_P (f
) && n
== 0)
11121 /* Window configuration is the same as before.
11122 Can do with a display update of the echo area,
11123 unless we displayed some mode lines. */
11124 update_single_window (w
, 1);
11128 update_frame (f
, 1, 1);
11130 /* If cursor is in the echo area, make sure that the next
11131 redisplay displays the minibuffer, so that the cursor will
11132 be replaced with what the minibuffer wants. */
11133 if (cursor_in_echo_area
)
11134 wset_redisplay (XWINDOW (mini_window
));
11137 else if (!EQ (mini_window
, selected_window
))
11138 wset_redisplay (XWINDOW (mini_window
));
11140 /* Last displayed message is now the current message. */
11141 echo_area_buffer
[1] = echo_area_buffer
[0];
11142 /* Inform read_char that we're not echoing. */
11143 echo_message_buffer
= Qnil
;
11145 /* Prevent redisplay optimization in redisplay_internal by resetting
11146 this_line_start_pos. This is done because the mini-buffer now
11147 displays the message instead of its buffer text. */
11148 if (EQ (mini_window
, selected_window
))
11149 CHARPOS (this_line_start_pos
) = 0;
11151 return window_height_changed_p
;
11154 /* Nonzero if W's buffer was changed but not saved. */
11157 window_buffer_changed (struct window
*w
)
11159 struct buffer
*b
= XBUFFER (w
->contents
);
11161 eassert (BUFFER_LIVE_P (b
));
11163 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11166 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11169 mode_line_update_needed (struct window
*w
)
11171 return (w
->column_number_displayed
!= -1
11172 && !(PT
== w
->last_point
&& !window_outdated (w
))
11173 && (w
->column_number_displayed
!= current_column ()));
11176 /* Nonzero if window start of W is frozen and may not be changed during
11180 window_frozen_p (struct window
*w
)
11182 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11184 Lisp_Object window
;
11186 XSETWINDOW (window
, w
);
11187 if (MINI_WINDOW_P (w
))
11189 else if (EQ (window
, selected_window
))
11191 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11192 && EQ (window
, Vminibuf_scroll_window
))
11193 /* This special window can't be frozen too. */
11201 /***********************************************************************
11202 Mode Lines and Frame Titles
11203 ***********************************************************************/
11205 /* A buffer for constructing non-propertized mode-line strings and
11206 frame titles in it; allocated from the heap in init_xdisp and
11207 resized as needed in store_mode_line_noprop_char. */
11209 static char *mode_line_noprop_buf
;
11211 /* The buffer's end, and a current output position in it. */
11213 static char *mode_line_noprop_buf_end
;
11214 static char *mode_line_noprop_ptr
;
11216 #define MODE_LINE_NOPROP_LEN(start) \
11217 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11220 MODE_LINE_DISPLAY
= 0,
11224 } mode_line_target
;
11226 /* Alist that caches the results of :propertize.
11227 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11228 static Lisp_Object mode_line_proptrans_alist
;
11230 /* List of strings making up the mode-line. */
11231 static Lisp_Object mode_line_string_list
;
11233 /* Base face property when building propertized mode line string. */
11234 static Lisp_Object mode_line_string_face
;
11235 static Lisp_Object mode_line_string_face_prop
;
11238 /* Unwind data for mode line strings */
11240 static Lisp_Object Vmode_line_unwind_vector
;
11243 format_mode_line_unwind_data (struct frame
*target_frame
,
11244 struct buffer
*obuf
,
11246 int save_proptrans
)
11248 Lisp_Object vector
, tmp
;
11250 /* Reduce consing by keeping one vector in
11251 Vwith_echo_area_save_vector. */
11252 vector
= Vmode_line_unwind_vector
;
11253 Vmode_line_unwind_vector
= Qnil
;
11256 vector
= Fmake_vector (make_number (10), Qnil
);
11258 ASET (vector
, 0, make_number (mode_line_target
));
11259 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11260 ASET (vector
, 2, mode_line_string_list
);
11261 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11262 ASET (vector
, 4, mode_line_string_face
);
11263 ASET (vector
, 5, mode_line_string_face_prop
);
11266 XSETBUFFER (tmp
, obuf
);
11269 ASET (vector
, 6, tmp
);
11270 ASET (vector
, 7, owin
);
11273 /* Similarly to `with-selected-window', if the operation selects
11274 a window on another frame, we must restore that frame's
11275 selected window, and (for a tty) the top-frame. */
11276 ASET (vector
, 8, target_frame
->selected_window
);
11277 if (FRAME_TERMCAP_P (target_frame
))
11278 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11285 unwind_format_mode_line (Lisp_Object vector
)
11287 Lisp_Object old_window
= AREF (vector
, 7);
11288 Lisp_Object target_frame_window
= AREF (vector
, 8);
11289 Lisp_Object old_top_frame
= AREF (vector
, 9);
11291 mode_line_target
= XINT (AREF (vector
, 0));
11292 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11293 mode_line_string_list
= AREF (vector
, 2);
11294 if (! EQ (AREF (vector
, 3), Qt
))
11295 mode_line_proptrans_alist
= AREF (vector
, 3);
11296 mode_line_string_face
= AREF (vector
, 4);
11297 mode_line_string_face_prop
= AREF (vector
, 5);
11299 /* Select window before buffer, since it may change the buffer. */
11300 if (!NILP (old_window
))
11302 /* If the operation that we are unwinding had selected a window
11303 on a different frame, reset its frame-selected-window. For a
11304 text terminal, reset its top-frame if necessary. */
11305 if (!NILP (target_frame_window
))
11308 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11310 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11311 Fselect_window (target_frame_window
, Qt
);
11313 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11314 Fselect_frame (old_top_frame
, Qt
);
11317 Fselect_window (old_window
, Qt
);
11320 if (!NILP (AREF (vector
, 6)))
11322 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11323 ASET (vector
, 6, Qnil
);
11326 Vmode_line_unwind_vector
= vector
;
11330 /* Store a single character C for the frame title in mode_line_noprop_buf.
11331 Re-allocate mode_line_noprop_buf if necessary. */
11334 store_mode_line_noprop_char (char c
)
11336 /* If output position has reached the end of the allocated buffer,
11337 increase the buffer's size. */
11338 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11340 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11341 ptrdiff_t size
= len
;
11342 mode_line_noprop_buf
=
11343 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11344 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11345 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11348 *mode_line_noprop_ptr
++ = c
;
11352 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11353 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11354 characters that yield more columns than PRECISION; PRECISION <= 0
11355 means copy the whole string. Pad with spaces until FIELD_WIDTH
11356 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11357 pad. Called from display_mode_element when it is used to build a
11361 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11363 const unsigned char *str
= (const unsigned char *) string
;
11365 ptrdiff_t dummy
, nbytes
;
11367 /* Copy at most PRECISION chars from STR. */
11368 nbytes
= strlen (string
);
11369 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11371 store_mode_line_noprop_char (*str
++);
11373 /* Fill up with spaces until FIELD_WIDTH reached. */
11374 while (field_width
> 0
11375 && n
< field_width
)
11377 store_mode_line_noprop_char (' ');
11384 /***********************************************************************
11386 ***********************************************************************/
11388 #ifdef HAVE_WINDOW_SYSTEM
11390 /* Set the title of FRAME, if it has changed. The title format is
11391 Vicon_title_format if FRAME is iconified, otherwise it is
11392 frame_title_format. */
11395 x_consider_frame_title (Lisp_Object frame
)
11397 struct frame
*f
= XFRAME (frame
);
11399 if (FRAME_WINDOW_P (f
)
11400 || FRAME_MINIBUF_ONLY_P (f
)
11401 || f
->explicit_name
)
11403 /* Do we have more than one visible frame on this X display? */
11404 Lisp_Object tail
, other_frame
, fmt
;
11405 ptrdiff_t title_start
;
11409 ptrdiff_t count
= SPECPDL_INDEX ();
11411 FOR_EACH_FRAME (tail
, other_frame
)
11413 struct frame
*tf
= XFRAME (other_frame
);
11416 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11417 && !FRAME_MINIBUF_ONLY_P (tf
)
11418 && !EQ (other_frame
, tip_frame
)
11419 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11423 /* Set global variable indicating that multiple frames exist. */
11424 multiple_frames
= CONSP (tail
);
11426 /* Switch to the buffer of selected window of the frame. Set up
11427 mode_line_target so that display_mode_element will output into
11428 mode_line_noprop_buf; then display the title. */
11429 record_unwind_protect (unwind_format_mode_line
,
11430 format_mode_line_unwind_data
11431 (f
, current_buffer
, selected_window
, 0));
11433 Fselect_window (f
->selected_window
, Qt
);
11434 set_buffer_internal_1
11435 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11436 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11438 mode_line_target
= MODE_LINE_TITLE
;
11439 title_start
= MODE_LINE_NOPROP_LEN (0);
11440 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11441 NULL
, DEFAULT_FACE_ID
);
11442 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11443 len
= MODE_LINE_NOPROP_LEN (title_start
);
11444 title
= mode_line_noprop_buf
+ title_start
;
11445 unbind_to (count
, Qnil
);
11447 /* Set the title only if it's changed. This avoids consing in
11448 the common case where it hasn't. (If it turns out that we've
11449 already wasted too much time by walking through the list with
11450 display_mode_element, then we might need to optimize at a
11451 higher level than this.) */
11452 if (! STRINGP (f
->name
)
11453 || SBYTES (f
->name
) != len
11454 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11455 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11459 #endif /* not HAVE_WINDOW_SYSTEM */
11462 /***********************************************************************
11464 ***********************************************************************/
11466 /* Non-zero if we will not redisplay all visible windows. */
11467 #define REDISPLAY_SOME_P() \
11468 ((windows_or_buffers_changed == 0 \
11469 || windows_or_buffers_changed == REDISPLAY_SOME) \
11470 && (update_mode_lines == 0 \
11471 || update_mode_lines == REDISPLAY_SOME))
11473 /* Prepare for redisplay by updating menu-bar item lists when
11474 appropriate. This can call eval. */
11477 prepare_menu_bars (void)
11479 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11480 bool some_windows
= REDISPLAY_SOME_P ();
11481 struct gcpro gcpro1
, gcpro2
;
11482 Lisp_Object tooltip_frame
;
11484 #ifdef HAVE_WINDOW_SYSTEM
11485 tooltip_frame
= tip_frame
;
11487 tooltip_frame
= Qnil
;
11490 if (FUNCTIONP (Vpre_redisplay_function
))
11492 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11493 if (all_windows
&& some_windows
)
11495 Lisp_Object ws
= window_list ();
11496 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11498 Lisp_Object
this = XCAR (ws
);
11499 struct window
*w
= XWINDOW (this);
11501 || XFRAME (w
->frame
)->redisplay
11502 || XBUFFER (w
->contents
)->text
->redisplay
)
11504 windows
= Fcons (this, windows
);
11508 safe_call1 (Vpre_redisplay_function
, windows
);
11511 /* Update all frame titles based on their buffer names, etc. We do
11512 this before the menu bars so that the buffer-menu will show the
11513 up-to-date frame titles. */
11514 #ifdef HAVE_WINDOW_SYSTEM
11517 Lisp_Object tail
, frame
;
11519 FOR_EACH_FRAME (tail
, frame
)
11521 struct frame
*f
= XFRAME (frame
);
11522 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11526 && !XBUFFER (w
->contents
)->text
->redisplay
)
11529 if (!EQ (frame
, tooltip_frame
)
11530 && (FRAME_ICONIFIED_P (f
)
11531 || FRAME_VISIBLE_P (f
) == 1
11532 /* Exclude TTY frames that are obscured because they
11533 are not the top frame on their console. This is
11534 because x_consider_frame_title actually switches
11535 to the frame, which for TTY frames means it is
11536 marked as garbaged, and will be completely
11537 redrawn on the next redisplay cycle. This causes
11538 TTY frames to be completely redrawn, when there
11539 are more than one of them, even though nothing
11540 should be changed on display. */
11541 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11542 x_consider_frame_title (frame
);
11545 #endif /* HAVE_WINDOW_SYSTEM */
11547 /* Update the menu bar item lists, if appropriate. This has to be
11548 done before any actual redisplay or generation of display lines. */
11552 Lisp_Object tail
, frame
;
11553 ptrdiff_t count
= SPECPDL_INDEX ();
11554 /* 1 means that update_menu_bar has run its hooks
11555 so any further calls to update_menu_bar shouldn't do so again. */
11556 int menu_bar_hooks_run
= 0;
11558 record_unwind_save_match_data ();
11560 FOR_EACH_FRAME (tail
, frame
)
11562 struct frame
*f
= XFRAME (frame
);
11563 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11565 /* Ignore tooltip frame. */
11566 if (EQ (frame
, tooltip_frame
))
11572 && !XBUFFER (w
->contents
)->text
->redisplay
)
11575 /* If a window on this frame changed size, report that to
11576 the user and clear the size-change flag. */
11577 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11579 Lisp_Object functions
;
11581 /* Clear flag first in case we get an error below. */
11582 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11583 functions
= Vwindow_size_change_functions
;
11584 GCPRO2 (tail
, functions
);
11586 while (CONSP (functions
))
11588 if (!EQ (XCAR (functions
), Qt
))
11589 call1 (XCAR (functions
), frame
);
11590 functions
= XCDR (functions
);
11596 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11597 #ifdef HAVE_WINDOW_SYSTEM
11598 update_tool_bar (f
, 0);
11601 if (windows_or_buffers_changed
11604 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11609 unbind_to (count
, Qnil
);
11613 struct frame
*sf
= SELECTED_FRAME ();
11614 update_menu_bar (sf
, 1, 0);
11615 #ifdef HAVE_WINDOW_SYSTEM
11616 update_tool_bar (sf
, 1);
11622 /* Update the menu bar item list for frame F. This has to be done
11623 before we start to fill in any display lines, because it can call
11626 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11628 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11629 already ran the menu bar hooks for this redisplay, so there
11630 is no need to run them again. The return value is the
11631 updated value of this flag, to pass to the next call. */
11634 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11636 Lisp_Object window
;
11637 register struct window
*w
;
11639 /* If called recursively during a menu update, do nothing. This can
11640 happen when, for instance, an activate-menubar-hook causes a
11642 if (inhibit_menubar_update
)
11645 window
= FRAME_SELECTED_WINDOW (f
);
11646 w
= XWINDOW (window
);
11648 if (FRAME_WINDOW_P (f
)
11650 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11651 || defined (HAVE_NS) || defined (USE_GTK)
11652 FRAME_EXTERNAL_MENU_BAR (f
)
11654 FRAME_MENU_BAR_LINES (f
) > 0
11656 : FRAME_MENU_BAR_LINES (f
) > 0)
11658 /* If the user has switched buffers or windows, we need to
11659 recompute to reflect the new bindings. But we'll
11660 recompute when update_mode_lines is set too; that means
11661 that people can use force-mode-line-update to request
11662 that the menu bar be recomputed. The adverse effect on
11663 the rest of the redisplay algorithm is about the same as
11664 windows_or_buffers_changed anyway. */
11665 if (windows_or_buffers_changed
11666 /* This used to test w->update_mode_line, but we believe
11667 there is no need to recompute the menu in that case. */
11668 || update_mode_lines
11669 || window_buffer_changed (w
))
11671 struct buffer
*prev
= current_buffer
;
11672 ptrdiff_t count
= SPECPDL_INDEX ();
11674 specbind (Qinhibit_menubar_update
, Qt
);
11676 set_buffer_internal_1 (XBUFFER (w
->contents
));
11677 if (save_match_data
)
11678 record_unwind_save_match_data ();
11679 if (NILP (Voverriding_local_map_menu_flag
))
11681 specbind (Qoverriding_terminal_local_map
, Qnil
);
11682 specbind (Qoverriding_local_map
, Qnil
);
11687 /* Run the Lucid hook. */
11688 safe_run_hooks (Qactivate_menubar_hook
);
11690 /* If it has changed current-menubar from previous value,
11691 really recompute the menu-bar from the value. */
11692 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11693 call0 (Qrecompute_lucid_menubar
);
11695 safe_run_hooks (Qmenu_bar_update_hook
);
11700 XSETFRAME (Vmenu_updating_frame
, f
);
11701 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11703 /* Redisplay the menu bar in case we changed it. */
11704 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11705 || defined (HAVE_NS) || defined (USE_GTK)
11706 if (FRAME_WINDOW_P (f
))
11708 #if defined (HAVE_NS)
11709 /* All frames on Mac OS share the same menubar. So only
11710 the selected frame should be allowed to set it. */
11711 if (f
== SELECTED_FRAME ())
11713 set_frame_menubar (f
, 0, 0);
11716 /* On a terminal screen, the menu bar is an ordinary screen
11717 line, and this makes it get updated. */
11718 w
->update_mode_line
= 1;
11719 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11720 /* In the non-toolkit version, the menu bar is an ordinary screen
11721 line, and this makes it get updated. */
11722 w
->update_mode_line
= 1;
11723 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11725 unbind_to (count
, Qnil
);
11726 set_buffer_internal_1 (prev
);
11733 /***********************************************************************
11735 ***********************************************************************/
11737 #ifdef HAVE_WINDOW_SYSTEM
11739 /* Tool-bar item index of the item on which a mouse button was pressed
11742 int last_tool_bar_item
;
11744 /* Select `frame' temporarily without running all the code in
11746 FIXME: Maybe do_switch_frame should be trimmed down similarly
11747 when `norecord' is set. */
11749 fast_set_selected_frame (Lisp_Object frame
)
11751 if (!EQ (selected_frame
, frame
))
11753 selected_frame
= frame
;
11754 selected_window
= XFRAME (frame
)->selected_window
;
11758 /* Update the tool-bar item list for frame F. This has to be done
11759 before we start to fill in any display lines. Called from
11760 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11761 and restore it here. */
11764 update_tool_bar (struct frame
*f
, int save_match_data
)
11766 #if defined (USE_GTK) || defined (HAVE_NS)
11767 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11769 int do_update
= (WINDOWP (f
->tool_bar_window
)
11770 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11775 Lisp_Object window
;
11778 window
= FRAME_SELECTED_WINDOW (f
);
11779 w
= XWINDOW (window
);
11781 /* If the user has switched buffers or windows, we need to
11782 recompute to reflect the new bindings. But we'll
11783 recompute when update_mode_lines is set too; that means
11784 that people can use force-mode-line-update to request
11785 that the menu bar be recomputed. The adverse effect on
11786 the rest of the redisplay algorithm is about the same as
11787 windows_or_buffers_changed anyway. */
11788 if (windows_or_buffers_changed
11789 || w
->update_mode_line
11790 || update_mode_lines
11791 || window_buffer_changed (w
))
11793 struct buffer
*prev
= current_buffer
;
11794 ptrdiff_t count
= SPECPDL_INDEX ();
11795 Lisp_Object frame
, new_tool_bar
;
11796 int new_n_tool_bar
;
11797 struct gcpro gcpro1
;
11799 /* Set current_buffer to the buffer of the selected
11800 window of the frame, so that we get the right local
11802 set_buffer_internal_1 (XBUFFER (w
->contents
));
11804 /* Save match data, if we must. */
11805 if (save_match_data
)
11806 record_unwind_save_match_data ();
11808 /* Make sure that we don't accidentally use bogus keymaps. */
11809 if (NILP (Voverriding_local_map_menu_flag
))
11811 specbind (Qoverriding_terminal_local_map
, Qnil
);
11812 specbind (Qoverriding_local_map
, Qnil
);
11815 GCPRO1 (new_tool_bar
);
11817 /* We must temporarily set the selected frame to this frame
11818 before calling tool_bar_items, because the calculation of
11819 the tool-bar keymap uses the selected frame (see
11820 `tool-bar-make-keymap' in tool-bar.el). */
11821 eassert (EQ (selected_window
,
11822 /* Since we only explicitly preserve selected_frame,
11823 check that selected_window would be redundant. */
11824 XFRAME (selected_frame
)->selected_window
));
11825 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11826 XSETFRAME (frame
, f
);
11827 fast_set_selected_frame (frame
);
11829 /* Build desired tool-bar items from keymaps. */
11831 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11834 /* Redisplay the tool-bar if we changed it. */
11835 if (new_n_tool_bar
!= f
->n_tool_bar_items
11836 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11838 /* Redisplay that happens asynchronously due to an expose event
11839 may access f->tool_bar_items. Make sure we update both
11840 variables within BLOCK_INPUT so no such event interrupts. */
11842 fset_tool_bar_items (f
, new_tool_bar
);
11843 f
->n_tool_bar_items
= new_n_tool_bar
;
11844 w
->update_mode_line
= 1;
11850 unbind_to (count
, Qnil
);
11851 set_buffer_internal_1 (prev
);
11856 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11858 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11859 F's desired tool-bar contents. F->tool_bar_items must have
11860 been set up previously by calling prepare_menu_bars. */
11863 build_desired_tool_bar_string (struct frame
*f
)
11865 int i
, size
, size_needed
;
11866 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11867 Lisp_Object image
, plist
, props
;
11869 image
= plist
= props
= Qnil
;
11870 GCPRO3 (image
, plist
, props
);
11872 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11873 Otherwise, make a new string. */
11875 /* The size of the string we might be able to reuse. */
11876 size
= (STRINGP (f
->desired_tool_bar_string
)
11877 ? SCHARS (f
->desired_tool_bar_string
)
11880 /* We need one space in the string for each image. */
11881 size_needed
= f
->n_tool_bar_items
;
11883 /* Reuse f->desired_tool_bar_string, if possible. */
11884 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11885 fset_desired_tool_bar_string
11886 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11889 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11890 Fremove_text_properties (make_number (0), make_number (size
),
11891 props
, f
->desired_tool_bar_string
);
11894 /* Put a `display' property on the string for the images to display,
11895 put a `menu_item' property on tool-bar items with a value that
11896 is the index of the item in F's tool-bar item vector. */
11897 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11899 #define PROP(IDX) \
11900 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11902 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11903 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11904 int hmargin
, vmargin
, relief
, idx
, end
;
11906 /* If image is a vector, choose the image according to the
11908 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11909 if (VECTORP (image
))
11913 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11914 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11917 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11918 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11920 eassert (ASIZE (image
) >= idx
);
11921 image
= AREF (image
, idx
);
11926 /* Ignore invalid image specifications. */
11927 if (!valid_image_p (image
))
11930 /* Display the tool-bar button pressed, or depressed. */
11931 plist
= Fcopy_sequence (XCDR (image
));
11933 /* Compute margin and relief to draw. */
11934 relief
= (tool_bar_button_relief
>= 0
11935 ? tool_bar_button_relief
11936 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11937 hmargin
= vmargin
= relief
;
11939 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
11940 INT_MAX
- max (hmargin
, vmargin
)))
11942 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11943 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11945 else if (CONSP (Vtool_bar_button_margin
))
11947 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
11948 INT_MAX
- hmargin
))
11949 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11951 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
11952 INT_MAX
- vmargin
))
11953 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11956 if (auto_raise_tool_bar_buttons_p
)
11958 /* Add a `:relief' property to the image spec if the item is
11962 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11969 /* If image is selected, display it pressed, i.e. with a
11970 negative relief. If it's not selected, display it with a
11972 plist
= Fplist_put (plist
, QCrelief
,
11974 ? make_number (-relief
)
11975 : make_number (relief
)));
11980 /* Put a margin around the image. */
11981 if (hmargin
|| vmargin
)
11983 if (hmargin
== vmargin
)
11984 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11986 plist
= Fplist_put (plist
, QCmargin
,
11987 Fcons (make_number (hmargin
),
11988 make_number (vmargin
)));
11991 /* If button is not enabled, and we don't have special images
11992 for the disabled state, make the image appear disabled by
11993 applying an appropriate algorithm to it. */
11994 if (!enabled_p
&& idx
< 0)
11995 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11997 /* Put a `display' text property on the string for the image to
11998 display. Put a `menu-item' property on the string that gives
11999 the start of this item's properties in the tool-bar items
12001 image
= Fcons (Qimage
, plist
);
12002 props
= list4 (Qdisplay
, image
,
12003 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12005 /* Let the last image hide all remaining spaces in the tool bar
12006 string. The string can be longer than needed when we reuse a
12007 previous string. */
12008 if (i
+ 1 == f
->n_tool_bar_items
)
12009 end
= SCHARS (f
->desired_tool_bar_string
);
12012 Fadd_text_properties (make_number (i
), make_number (end
),
12013 props
, f
->desired_tool_bar_string
);
12021 /* Display one line of the tool-bar of frame IT->f.
12023 HEIGHT specifies the desired height of the tool-bar line.
12024 If the actual height of the glyph row is less than HEIGHT, the
12025 row's height is increased to HEIGHT, and the icons are centered
12026 vertically in the new height.
12028 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12029 count a final empty row in case the tool-bar width exactly matches
12034 display_tool_bar_line (struct it
*it
, int height
)
12036 struct glyph_row
*row
= it
->glyph_row
;
12037 int max_x
= it
->last_visible_x
;
12038 struct glyph
*last
;
12040 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12041 clear_glyph_row (row
);
12042 row
->enabled_p
= true;
12043 row
->y
= it
->current_y
;
12045 /* Note that this isn't made use of if the face hasn't a box,
12046 so there's no need to check the face here. */
12047 it
->start_of_box_run_p
= 1;
12049 while (it
->current_x
< max_x
)
12051 int x
, n_glyphs_before
, i
, nglyphs
;
12052 struct it it_before
;
12054 /* Get the next display element. */
12055 if (!get_next_display_element (it
))
12057 /* Don't count empty row if we are counting needed tool-bar lines. */
12058 if (height
< 0 && !it
->hpos
)
12063 /* Produce glyphs. */
12064 n_glyphs_before
= row
->used
[TEXT_AREA
];
12067 PRODUCE_GLYPHS (it
);
12069 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12071 x
= it_before
.current_x
;
12072 while (i
< nglyphs
)
12074 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12076 if (x
+ glyph
->pixel_width
> max_x
)
12078 /* Glyph doesn't fit on line. Backtrack. */
12079 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12081 /* If this is the only glyph on this line, it will never fit on the
12082 tool-bar, so skip it. But ensure there is at least one glyph,
12083 so we don't accidentally disable the tool-bar. */
12084 if (n_glyphs_before
== 0
12085 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12091 x
+= glyph
->pixel_width
;
12095 /* Stop at line end. */
12096 if (ITERATOR_AT_END_OF_LINE_P (it
))
12099 set_iterator_to_next (it
, 1);
12104 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12106 /* Use default face for the border below the tool bar.
12108 FIXME: When auto-resize-tool-bars is grow-only, there is
12109 no additional border below the possibly empty tool-bar lines.
12110 So to make the extra empty lines look "normal", we have to
12111 use the tool-bar face for the border too. */
12112 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12113 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12114 it
->face_id
= DEFAULT_FACE_ID
;
12116 extend_face_to_end_of_line (it
);
12117 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12118 last
->right_box_line_p
= 1;
12119 if (last
== row
->glyphs
[TEXT_AREA
])
12120 last
->left_box_line_p
= 1;
12122 /* Make line the desired height and center it vertically. */
12123 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12125 /* Don't add more than one line height. */
12126 height
%= FRAME_LINE_HEIGHT (it
->f
);
12127 it
->max_ascent
+= height
/ 2;
12128 it
->max_descent
+= (height
+ 1) / 2;
12131 compute_line_metrics (it
);
12133 /* If line is empty, make it occupy the rest of the tool-bar. */
12134 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12136 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12137 row
->visible_height
= row
->height
;
12138 row
->ascent
= row
->phys_ascent
= 0;
12139 row
->extra_line_spacing
= 0;
12142 row
->full_width_p
= 1;
12143 row
->continued_p
= 0;
12144 row
->truncated_on_left_p
= 0;
12145 row
->truncated_on_right_p
= 0;
12147 it
->current_x
= it
->hpos
= 0;
12148 it
->current_y
+= row
->height
;
12154 /* Max tool-bar height. Basically, this is what makes all other windows
12155 disappear when the frame gets too small. Rethink this! */
12157 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12158 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12160 /* Value is the number of pixels needed to make all tool-bar items of
12161 frame F visible. The actual number of glyph rows needed is
12162 returned in *N_ROWS if non-NULL. */
12165 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12167 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12169 /* tool_bar_height is called from redisplay_tool_bar after building
12170 the desired matrix, so use (unused) mode-line row as temporary row to
12171 avoid destroying the first tool-bar row. */
12172 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12174 /* Initialize an iterator for iteration over
12175 F->desired_tool_bar_string in the tool-bar window of frame F. */
12176 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12177 it
.first_visible_x
= 0;
12178 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12179 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12180 it
.paragraph_embedding
= L2R
;
12182 while (!ITERATOR_AT_END_P (&it
))
12184 clear_glyph_row (temp_row
);
12185 it
.glyph_row
= temp_row
;
12186 display_tool_bar_line (&it
, -1);
12188 clear_glyph_row (temp_row
);
12190 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12192 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12195 return it
.current_y
;
12197 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12200 #endif /* !USE_GTK && !HAVE_NS */
12202 #if defined USE_GTK || defined HAVE_NS
12203 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12204 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12207 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12209 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12210 If FRAME is nil or omitted, use the selected frame. Optional argument
12211 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12212 (Lisp_Object frame
, Lisp_Object pixelwise
)
12216 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12217 struct frame
*f
= decode_any_frame (frame
);
12219 if (WINDOWP (f
->tool_bar_window
)
12220 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12222 update_tool_bar (f
, 1);
12223 if (f
->n_tool_bar_items
)
12225 build_desired_tool_bar_string (f
);
12226 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12231 return make_number (height
);
12235 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12236 height should be changed. */
12239 redisplay_tool_bar (struct frame
*f
)
12241 #if defined (USE_GTK) || defined (HAVE_NS)
12243 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12244 update_frame_tool_bar (f
);
12247 #else /* !USE_GTK && !HAVE_NS */
12251 struct glyph_row
*row
;
12253 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12254 do anything. This means you must start with tool-bar-lines
12255 non-zero to get the auto-sizing effect. Or in other words, you
12256 can turn off tool-bars by specifying tool-bar-lines zero. */
12257 if (!WINDOWP (f
->tool_bar_window
)
12258 || (w
= XWINDOW (f
->tool_bar_window
),
12259 WINDOW_PIXEL_HEIGHT (w
) == 0))
12262 /* Set up an iterator for the tool-bar window. */
12263 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12264 it
.first_visible_x
= 0;
12265 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12266 row
= it
.glyph_row
;
12268 /* Build a string that represents the contents of the tool-bar. */
12269 build_desired_tool_bar_string (f
);
12270 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12271 /* FIXME: This should be controlled by a user option. But it
12272 doesn't make sense to have an R2L tool bar if the menu bar cannot
12273 be drawn also R2L, and making the menu bar R2L is tricky due
12274 toolkit-specific code that implements it. If an R2L tool bar is
12275 ever supported, display_tool_bar_line should also be augmented to
12276 call unproduce_glyphs like display_line and display_string
12278 it
.paragraph_embedding
= L2R
;
12280 if (f
->n_tool_bar_rows
== 0)
12282 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12284 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12287 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12288 / FRAME_LINE_HEIGHT (f
));
12290 XSETFRAME (frame
, f
);
12291 Fmodify_frame_parameters (frame
,
12292 list1 (Fcons (Qtool_bar_lines
,
12293 make_number (new_lines
))));
12294 /* Always do that now. */
12295 clear_glyph_matrix (w
->desired_matrix
);
12296 f
->fonts_changed
= 1;
12301 /* Display as many lines as needed to display all tool-bar items. */
12303 if (f
->n_tool_bar_rows
> 0)
12305 int border
, rows
, height
, extra
;
12307 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12308 border
= XINT (Vtool_bar_border
);
12309 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12310 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12311 else if (EQ (Vtool_bar_border
, Qborder_width
))
12312 border
= f
->border_width
;
12318 rows
= f
->n_tool_bar_rows
;
12319 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12320 extra
= it
.last_visible_y
- border
- height
* rows
;
12322 while (it
.current_y
< it
.last_visible_y
)
12325 if (extra
> 0 && rows
-- > 0)
12327 h
= (extra
+ rows
- 1) / rows
;
12330 display_tool_bar_line (&it
, height
+ h
);
12335 while (it
.current_y
< it
.last_visible_y
)
12336 display_tool_bar_line (&it
, 0);
12339 /* It doesn't make much sense to try scrolling in the tool-bar
12340 window, so don't do it. */
12341 w
->desired_matrix
->no_scrolling_p
= 1;
12342 w
->must_be_updated_p
= 1;
12344 if (!NILP (Vauto_resize_tool_bars
))
12346 /* Do we really allow the toolbar to occupy the whole frame? */
12347 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12348 int change_height_p
= 0;
12350 /* If we couldn't display everything, change the tool-bar's
12351 height if there is room for more. */
12352 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12353 && it
.current_y
< max_tool_bar_height
)
12354 change_height_p
= 1;
12356 /* We subtract 1 because display_tool_bar_line advances the
12357 glyph_row pointer before returning to its caller. We want to
12358 examine the last glyph row produced by
12359 display_tool_bar_line. */
12360 row
= it
.glyph_row
- 1;
12362 /* If there are blank lines at the end, except for a partially
12363 visible blank line at the end that is smaller than
12364 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12365 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12366 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12367 change_height_p
= 1;
12369 /* If row displays tool-bar items, but is partially visible,
12370 change the tool-bar's height. */
12371 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12372 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12373 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12374 change_height_p
= 1;
12376 /* Resize windows as needed by changing the `tool-bar-lines'
12377 frame parameter. */
12378 if (change_height_p
)
12382 int new_height
= tool_bar_height (f
, &nrows
, 1);
12384 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12385 && !f
->minimize_tool_bar_window_p
)
12386 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12387 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12388 f
->minimize_tool_bar_window_p
= 0;
12390 if (change_height_p
)
12392 /* Current size of the tool-bar window in canonical line
12394 int old_lines
= WINDOW_TOTAL_LINES (w
);
12395 /* Required size of the tool-bar window in canonical
12397 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12398 / FRAME_LINE_HEIGHT (f
));
12399 /* Maximum size of the tool-bar window in canonical line
12400 units that this frame can allow. */
12402 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12404 /* Don't try to change the tool-bar window size and set
12405 the fonts_changed flag unless really necessary. That
12406 flag causes redisplay to give up and retry
12407 redisplaying the frame from scratch, so setting it
12408 unnecessarily can lead to nasty redisplay loops. */
12409 if (new_lines
<= max_lines
12410 && eabs (new_lines
- old_lines
) >= 1)
12412 XSETFRAME (frame
, f
);
12413 Fmodify_frame_parameters (frame
,
12414 list1 (Fcons (Qtool_bar_lines
,
12415 make_number (new_lines
))));
12416 clear_glyph_matrix (w
->desired_matrix
);
12417 f
->n_tool_bar_rows
= nrows
;
12418 f
->fonts_changed
= 1;
12425 f
->minimize_tool_bar_window_p
= 0;
12428 #endif /* USE_GTK || HAVE_NS */
12431 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12433 /* Get information about the tool-bar item which is displayed in GLYPH
12434 on frame F. Return in *PROP_IDX the index where tool-bar item
12435 properties start in F->tool_bar_items. Value is zero if
12436 GLYPH doesn't display a tool-bar item. */
12439 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12445 /* This function can be called asynchronously, which means we must
12446 exclude any possibility that Fget_text_property signals an
12448 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12449 charpos
= max (0, charpos
);
12451 /* Get the text property `menu-item' at pos. The value of that
12452 property is the start index of this item's properties in
12453 F->tool_bar_items. */
12454 prop
= Fget_text_property (make_number (charpos
),
12455 Qmenu_item
, f
->current_tool_bar_string
);
12456 if (INTEGERP (prop
))
12458 *prop_idx
= XINT (prop
);
12468 /* Get information about the tool-bar item at position X/Y on frame F.
12469 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12470 the current matrix of the tool-bar window of F, or NULL if not
12471 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12472 item in F->tool_bar_items. Value is
12474 -1 if X/Y is not on a tool-bar item
12475 0 if X/Y is on the same item that was highlighted before.
12479 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12480 int *hpos
, int *vpos
, int *prop_idx
)
12482 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12483 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12486 /* Find the glyph under X/Y. */
12487 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12488 if (*glyph
== NULL
)
12491 /* Get the start of this tool-bar item's properties in
12492 f->tool_bar_items. */
12493 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12496 /* Is mouse on the highlighted item? */
12497 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12498 && *vpos
>= hlinfo
->mouse_face_beg_row
12499 && *vpos
<= hlinfo
->mouse_face_end_row
12500 && (*vpos
> hlinfo
->mouse_face_beg_row
12501 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12502 && (*vpos
< hlinfo
->mouse_face_end_row
12503 || *hpos
< hlinfo
->mouse_face_end_col
12504 || hlinfo
->mouse_face_past_end
))
12512 Handle mouse button event on the tool-bar of frame F, at
12513 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12514 0 for button release. MODIFIERS is event modifiers for button
12518 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12521 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12522 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12523 int hpos
, vpos
, prop_idx
;
12524 struct glyph
*glyph
;
12525 Lisp_Object enabled_p
;
12528 /* If not on the highlighted tool-bar item, and mouse-highlight is
12529 non-nil, return. This is so we generate the tool-bar button
12530 click only when the mouse button is released on the same item as
12531 where it was pressed. However, when mouse-highlight is disabled,
12532 generate the click when the button is released regardless of the
12533 highlight, since tool-bar items are not highlighted in that
12535 frame_to_window_pixel_xy (w
, &x
, &y
);
12536 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12538 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12541 /* When mouse-highlight is off, generate the click for the item
12542 where the button was pressed, disregarding where it was
12544 if (NILP (Vmouse_highlight
) && !down_p
)
12545 prop_idx
= last_tool_bar_item
;
12547 /* If item is disabled, do nothing. */
12548 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12549 if (NILP (enabled_p
))
12554 /* Show item in pressed state. */
12555 if (!NILP (Vmouse_highlight
))
12556 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12557 last_tool_bar_item
= prop_idx
;
12561 Lisp_Object key
, frame
;
12562 struct input_event event
;
12563 EVENT_INIT (event
);
12565 /* Show item in released state. */
12566 if (!NILP (Vmouse_highlight
))
12567 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12569 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12571 XSETFRAME (frame
, f
);
12572 event
.kind
= TOOL_BAR_EVENT
;
12573 event
.frame_or_window
= frame
;
12575 kbd_buffer_store_event (&event
);
12577 event
.kind
= TOOL_BAR_EVENT
;
12578 event
.frame_or_window
= frame
;
12580 event
.modifiers
= modifiers
;
12581 kbd_buffer_store_event (&event
);
12582 last_tool_bar_item
= -1;
12587 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12588 tool-bar window-relative coordinates X/Y. Called from
12589 note_mouse_highlight. */
12592 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12594 Lisp_Object window
= f
->tool_bar_window
;
12595 struct window
*w
= XWINDOW (window
);
12596 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12597 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12599 struct glyph
*glyph
;
12600 struct glyph_row
*row
;
12602 Lisp_Object enabled_p
;
12604 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12605 int mouse_down_p
, rc
;
12607 /* Function note_mouse_highlight is called with negative X/Y
12608 values when mouse moves outside of the frame. */
12609 if (x
<= 0 || y
<= 0)
12611 clear_mouse_face (hlinfo
);
12615 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12618 /* Not on tool-bar item. */
12619 clear_mouse_face (hlinfo
);
12623 /* On same tool-bar item as before. */
12624 goto set_help_echo
;
12626 clear_mouse_face (hlinfo
);
12628 /* Mouse is down, but on different tool-bar item? */
12629 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12630 && f
== dpyinfo
->last_mouse_frame
);
12633 && last_tool_bar_item
!= prop_idx
)
12636 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12638 /* If tool-bar item is not enabled, don't highlight it. */
12639 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12640 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12642 /* Compute the x-position of the glyph. In front and past the
12643 image is a space. We include this in the highlighted area. */
12644 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12645 for (i
= x
= 0; i
< hpos
; ++i
)
12646 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12648 /* Record this as the current active region. */
12649 hlinfo
->mouse_face_beg_col
= hpos
;
12650 hlinfo
->mouse_face_beg_row
= vpos
;
12651 hlinfo
->mouse_face_beg_x
= x
;
12652 hlinfo
->mouse_face_past_end
= 0;
12654 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12655 hlinfo
->mouse_face_end_row
= vpos
;
12656 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12657 hlinfo
->mouse_face_window
= window
;
12658 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12660 /* Display it as active. */
12661 show_mouse_face (hlinfo
, draw
);
12666 /* Set help_echo_string to a help string to display for this tool-bar item.
12667 XTread_socket does the rest. */
12668 help_echo_object
= help_echo_window
= Qnil
;
12669 help_echo_pos
= -1;
12670 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12671 if (NILP (help_echo_string
))
12672 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12675 #endif /* !USE_GTK && !HAVE_NS */
12677 #endif /* HAVE_WINDOW_SYSTEM */
12681 /************************************************************************
12682 Horizontal scrolling
12683 ************************************************************************/
12685 static int hscroll_window_tree (Lisp_Object
);
12686 static int hscroll_windows (Lisp_Object
);
12688 /* For all leaf windows in the window tree rooted at WINDOW, set their
12689 hscroll value so that PT is (i) visible in the window, and (ii) so
12690 that it is not within a certain margin at the window's left and
12691 right border. Value is non-zero if any window's hscroll has been
12695 hscroll_window_tree (Lisp_Object window
)
12697 int hscrolled_p
= 0;
12698 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12699 int hscroll_step_abs
= 0;
12700 double hscroll_step_rel
= 0;
12702 if (hscroll_relative_p
)
12704 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12705 if (hscroll_step_rel
< 0)
12707 hscroll_relative_p
= 0;
12708 hscroll_step_abs
= 0;
12711 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12713 hscroll_step_abs
= XINT (Vhscroll_step
);
12714 if (hscroll_step_abs
< 0)
12715 hscroll_step_abs
= 0;
12718 hscroll_step_abs
= 0;
12720 while (WINDOWP (window
))
12722 struct window
*w
= XWINDOW (window
);
12724 if (WINDOWP (w
->contents
))
12725 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12726 else if (w
->cursor
.vpos
>= 0)
12729 int text_area_width
;
12730 struct glyph_row
*cursor_row
;
12731 struct glyph_row
*bottom_row
;
12734 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12735 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12736 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12738 cursor_row
= bottom_row
- 1;
12740 if (!cursor_row
->enabled_p
)
12742 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12743 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12744 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12746 cursor_row
= bottom_row
- 1;
12748 row_r2l_p
= cursor_row
->reversed_p
;
12750 text_area_width
= window_box_width (w
, TEXT_AREA
);
12752 /* Scroll when cursor is inside this scroll margin. */
12753 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12755 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12756 /* For left-to-right rows, hscroll when cursor is either
12757 (i) inside the right hscroll margin, or (ii) if it is
12758 inside the left margin and the window is already
12762 && w
->cursor
.x
<= h_margin
)
12763 || (cursor_row
->enabled_p
12764 && cursor_row
->truncated_on_right_p
12765 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12766 /* For right-to-left rows, the logic is similar,
12767 except that rules for scrolling to left and right
12768 are reversed. E.g., if cursor.x <= h_margin, we
12769 need to hscroll "to the right" unconditionally,
12770 and that will scroll the screen to the left so as
12771 to reveal the next portion of the row. */
12773 && ((cursor_row
->enabled_p
12774 /* FIXME: It is confusing to set the
12775 truncated_on_right_p flag when R2L rows
12776 are actually truncated on the left. */
12777 && cursor_row
->truncated_on_right_p
12778 && w
->cursor
.x
<= h_margin
)
12780 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12784 struct buffer
*saved_current_buffer
;
12788 /* Find point in a display of infinite width. */
12789 saved_current_buffer
= current_buffer
;
12790 current_buffer
= XBUFFER (w
->contents
);
12792 if (w
== XWINDOW (selected_window
))
12795 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12797 /* Move iterator to pt starting at cursor_row->start in
12798 a line with infinite width. */
12799 init_to_row_start (&it
, w
, cursor_row
);
12800 it
.last_visible_x
= INFINITY
;
12801 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12802 current_buffer
= saved_current_buffer
;
12804 /* Position cursor in window. */
12805 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12806 hscroll
= max (0, (it
.current_x
12807 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12808 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12809 : (text_area_width
/ 2))))
12810 / FRAME_COLUMN_WIDTH (it
.f
);
12811 else if ((!row_r2l_p
12812 && w
->cursor
.x
>= text_area_width
- h_margin
)
12813 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12815 if (hscroll_relative_p
)
12816 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12819 wanted_x
= text_area_width
12820 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12823 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12827 if (hscroll_relative_p
)
12828 wanted_x
= text_area_width
* hscroll_step_rel
12831 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12834 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12836 hscroll
= max (hscroll
, w
->min_hscroll
);
12838 /* Don't prevent redisplay optimizations if hscroll
12839 hasn't changed, as it will unnecessarily slow down
12841 if (w
->hscroll
!= hscroll
)
12843 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12844 w
->hscroll
= hscroll
;
12853 /* Value is non-zero if hscroll of any leaf window has been changed. */
12854 return hscrolled_p
;
12858 /* Set hscroll so that cursor is visible and not inside horizontal
12859 scroll margins for all windows in the tree rooted at WINDOW. See
12860 also hscroll_window_tree above. Value is non-zero if any window's
12861 hscroll has been changed. If it has, desired matrices on the frame
12862 of WINDOW are cleared. */
12865 hscroll_windows (Lisp_Object window
)
12867 int hscrolled_p
= hscroll_window_tree (window
);
12869 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12870 return hscrolled_p
;
12875 /************************************************************************
12877 ************************************************************************/
12879 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12880 to a non-zero value. This is sometimes handy to have in a debugger
12885 /* First and last unchanged row for try_window_id. */
12887 static int debug_first_unchanged_at_end_vpos
;
12888 static int debug_last_unchanged_at_beg_vpos
;
12890 /* Delta vpos and y. */
12892 static int debug_dvpos
, debug_dy
;
12894 /* Delta in characters and bytes for try_window_id. */
12896 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12898 /* Values of window_end_pos and window_end_vpos at the end of
12901 static ptrdiff_t debug_end_vpos
;
12903 /* Append a string to W->desired_matrix->method. FMT is a printf
12904 format string. If trace_redisplay_p is true also printf the
12905 resulting string to stderr. */
12907 static void debug_method_add (struct window
*, char const *, ...)
12908 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12911 debug_method_add (struct window
*w
, char const *fmt
, ...)
12914 char *method
= w
->desired_matrix
->method
;
12915 int len
= strlen (method
);
12916 int size
= sizeof w
->desired_matrix
->method
;
12917 int remaining
= size
- len
- 1;
12920 if (len
&& remaining
)
12923 --remaining
, ++len
;
12926 va_start (ap
, fmt
);
12927 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12930 if (trace_redisplay_p
)
12931 fprintf (stderr
, "%p (%s): %s\n",
12933 ((BUFFERP (w
->contents
)
12934 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12935 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
12940 #endif /* GLYPH_DEBUG */
12943 /* Value is non-zero if all changes in window W, which displays
12944 current_buffer, are in the text between START and END. START is a
12945 buffer position, END is given as a distance from Z. Used in
12946 redisplay_internal for display optimization. */
12949 text_outside_line_unchanged_p (struct window
*w
,
12950 ptrdiff_t start
, ptrdiff_t end
)
12952 int unchanged_p
= 1;
12954 /* If text or overlays have changed, see where. */
12955 if (window_outdated (w
))
12957 /* Gap in the line? */
12958 if (GPT
< start
|| Z
- GPT
< end
)
12961 /* Changes start in front of the line, or end after it? */
12963 && (BEG_UNCHANGED
< start
- 1
12964 || END_UNCHANGED
< end
))
12967 /* If selective display, can't optimize if changes start at the
12968 beginning of the line. */
12970 && INTEGERP (BVAR (current_buffer
, selective_display
))
12971 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12972 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12975 /* If there are overlays at the start or end of the line, these
12976 may have overlay strings with newlines in them. A change at
12977 START, for instance, may actually concern the display of such
12978 overlay strings as well, and they are displayed on different
12979 lines. So, quickly rule out this case. (For the future, it
12980 might be desirable to implement something more telling than
12981 just BEG/END_UNCHANGED.) */
12984 if (BEG
+ BEG_UNCHANGED
== start
12985 && overlay_touches_p (start
))
12987 if (END_UNCHANGED
== end
12988 && overlay_touches_p (Z
- end
))
12992 /* Under bidi reordering, adding or deleting a character in the
12993 beginning of a paragraph, before the first strong directional
12994 character, can change the base direction of the paragraph (unless
12995 the buffer specifies a fixed paragraph direction), which will
12996 require to redisplay the whole paragraph. It might be worthwhile
12997 to find the paragraph limits and widen the range of redisplayed
12998 lines to that, but for now just give up this optimization. */
12999 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13000 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13004 return unchanged_p
;
13008 /* Do a frame update, taking possible shortcuts into account. This is
13009 the main external entry point for redisplay.
13011 If the last redisplay displayed an echo area message and that message
13012 is no longer requested, we clear the echo area or bring back the
13013 mini-buffer if that is in use. */
13018 redisplay_internal ();
13023 overlay_arrow_string_or_property (Lisp_Object var
)
13027 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13030 return Voverlay_arrow_string
;
13033 /* Return 1 if there are any overlay-arrows in current_buffer. */
13035 overlay_arrow_in_current_buffer_p (void)
13039 for (vlist
= Voverlay_arrow_variable_list
;
13041 vlist
= XCDR (vlist
))
13043 Lisp_Object var
= XCAR (vlist
);
13046 if (!SYMBOLP (var
))
13048 val
= find_symbol_value (var
);
13050 && current_buffer
== XMARKER (val
)->buffer
)
13057 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13061 overlay_arrows_changed_p (void)
13065 for (vlist
= Voverlay_arrow_variable_list
;
13067 vlist
= XCDR (vlist
))
13069 Lisp_Object var
= XCAR (vlist
);
13070 Lisp_Object val
, pstr
;
13072 if (!SYMBOLP (var
))
13074 val
= find_symbol_value (var
);
13075 if (!MARKERP (val
))
13077 if (! EQ (COERCE_MARKER (val
),
13078 Fget (var
, Qlast_arrow_position
))
13079 || ! (pstr
= overlay_arrow_string_or_property (var
),
13080 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13086 /* Mark overlay arrows to be updated on next redisplay. */
13089 update_overlay_arrows (int up_to_date
)
13093 for (vlist
= Voverlay_arrow_variable_list
;
13095 vlist
= XCDR (vlist
))
13097 Lisp_Object var
= XCAR (vlist
);
13099 if (!SYMBOLP (var
))
13102 if (up_to_date
> 0)
13104 Lisp_Object val
= find_symbol_value (var
);
13105 Fput (var
, Qlast_arrow_position
,
13106 COERCE_MARKER (val
));
13107 Fput (var
, Qlast_arrow_string
,
13108 overlay_arrow_string_or_property (var
));
13110 else if (up_to_date
< 0
13111 || !NILP (Fget (var
, Qlast_arrow_position
)))
13113 Fput (var
, Qlast_arrow_position
, Qt
);
13114 Fput (var
, Qlast_arrow_string
, Qt
);
13120 /* Return overlay arrow string to display at row.
13121 Return integer (bitmap number) for arrow bitmap in left fringe.
13122 Return nil if no overlay arrow. */
13125 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13129 for (vlist
= Voverlay_arrow_variable_list
;
13131 vlist
= XCDR (vlist
))
13133 Lisp_Object var
= XCAR (vlist
);
13136 if (!SYMBOLP (var
))
13139 val
= find_symbol_value (var
);
13142 && current_buffer
== XMARKER (val
)->buffer
13143 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13145 if (FRAME_WINDOW_P (it
->f
)
13146 /* FIXME: if ROW->reversed_p is set, this should test
13147 the right fringe, not the left one. */
13148 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13150 #ifdef HAVE_WINDOW_SYSTEM
13151 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13154 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13155 return make_number (fringe_bitmap
);
13158 return make_number (-1); /* Use default arrow bitmap. */
13160 return overlay_arrow_string_or_property (var
);
13167 /* Return 1 if point moved out of or into a composition. Otherwise
13168 return 0. PREV_BUF and PREV_PT are the last point buffer and
13169 position. BUF and PT are the current point buffer and position. */
13172 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13173 struct buffer
*buf
, ptrdiff_t pt
)
13175 ptrdiff_t start
, end
;
13177 Lisp_Object buffer
;
13179 XSETBUFFER (buffer
, buf
);
13180 /* Check a composition at the last point if point moved within the
13182 if (prev_buf
== buf
)
13185 /* Point didn't move. */
13188 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13189 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13190 && composition_valid_p (start
, end
, prop
)
13191 && start
< prev_pt
&& end
> prev_pt
)
13192 /* The last point was within the composition. Return 1 iff
13193 point moved out of the composition. */
13194 return (pt
<= start
|| pt
>= end
);
13197 /* Check a composition at the current point. */
13198 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13199 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13200 && composition_valid_p (start
, end
, prop
)
13201 && start
< pt
&& end
> pt
);
13204 /* Reconsider the clip changes of buffer which is displayed in W. */
13207 reconsider_clip_changes (struct window
*w
)
13209 struct buffer
*b
= XBUFFER (w
->contents
);
13211 if (b
->clip_changed
13212 && w
->window_end_valid
13213 && w
->current_matrix
->buffer
== b
13214 && w
->current_matrix
->zv
== BUF_ZV (b
)
13215 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13216 b
->clip_changed
= 0;
13218 /* If display wasn't paused, and W is not a tool bar window, see if
13219 point has been moved into or out of a composition. In that case,
13220 we set b->clip_changed to 1 to force updating the screen. If
13221 b->clip_changed has already been set to 1, we can skip this
13223 if (!b
->clip_changed
&& w
->window_end_valid
)
13225 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13226 ? PT
: marker_position (w
->pointm
));
13228 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13229 && check_point_in_composition (w
->current_matrix
->buffer
,
13230 w
->last_point
, b
, pt
))
13231 b
->clip_changed
= 1;
13236 propagate_buffer_redisplay (void)
13237 { /* Resetting b->text->redisplay is problematic!
13238 We can't just reset it in the case that some window that displays
13239 it has not been redisplayed; and such a window can stay
13240 unredisplayed for a long time if it's currently invisible.
13241 But we do want to reset it at the end of redisplay otherwise
13242 its displayed windows will keep being redisplayed over and over
13244 So we copy all b->text->redisplay flags up to their windows here,
13245 such that mark_window_display_accurate can safely reset
13246 b->text->redisplay. */
13247 Lisp_Object ws
= window_list ();
13248 for (; CONSP (ws
); ws
= XCDR (ws
))
13250 struct window
*thisw
= XWINDOW (XCAR (ws
));
13251 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13252 if (thisb
->text
->redisplay
)
13253 thisw
->redisplay
= true;
13257 #define STOP_POLLING \
13258 do { if (! polling_stopped_here) stop_polling (); \
13259 polling_stopped_here = 1; } while (0)
13261 #define RESUME_POLLING \
13262 do { if (polling_stopped_here) start_polling (); \
13263 polling_stopped_here = 0; } while (0)
13266 /* Perhaps in the future avoid recentering windows if it
13267 is not necessary; currently that causes some problems. */
13270 redisplay_internal (void)
13272 struct window
*w
= XWINDOW (selected_window
);
13276 bool must_finish
= 0, match_p
;
13277 struct text_pos tlbufpos
, tlendpos
;
13278 int number_of_visible_frames
;
13281 int polling_stopped_here
= 0;
13282 Lisp_Object tail
, frame
;
13284 /* True means redisplay has to consider all windows on all
13285 frames. False, only selected_window is considered. */
13286 bool consider_all_windows_p
;
13288 /* True means redisplay has to redisplay the miniwindow. */
13289 bool update_miniwindow_p
= false;
13291 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13293 /* No redisplay if running in batch mode or frame is not yet fully
13294 initialized, or redisplay is explicitly turned off by setting
13295 Vinhibit_redisplay. */
13296 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13297 || !NILP (Vinhibit_redisplay
))
13300 /* Don't examine these until after testing Vinhibit_redisplay.
13301 When Emacs is shutting down, perhaps because its connection to
13302 X has dropped, we should not look at them at all. */
13303 fr
= XFRAME (w
->frame
);
13304 sf
= SELECTED_FRAME ();
13306 if (!fr
->glyphs_initialized_p
)
13309 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13310 if (popup_activated ())
13314 /* I don't think this happens but let's be paranoid. */
13315 if (redisplaying_p
)
13318 /* Record a function that clears redisplaying_p
13319 when we leave this function. */
13320 count
= SPECPDL_INDEX ();
13321 record_unwind_protect_void (unwind_redisplay
);
13322 redisplaying_p
= 1;
13323 specbind (Qinhibit_free_realized_faces
, Qnil
);
13325 /* Record this function, so it appears on the profiler's backtraces. */
13326 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13328 FOR_EACH_FRAME (tail
, frame
)
13329 XFRAME (frame
)->already_hscrolled_p
= 0;
13332 /* Remember the currently selected window. */
13336 last_escape_glyph_frame
= NULL
;
13337 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13338 last_glyphless_glyph_frame
= NULL
;
13339 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13341 /* If face_change_count is non-zero, init_iterator will free all
13342 realized faces, which includes the faces referenced from current
13343 matrices. So, we can't reuse current matrices in this case. */
13344 if (face_change_count
)
13345 windows_or_buffers_changed
= 47;
13347 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13348 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13350 /* Since frames on a single ASCII terminal share the same
13351 display area, displaying a different frame means redisplay
13352 the whole thing. */
13353 SET_FRAME_GARBAGED (sf
);
13355 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13357 FRAME_TTY (sf
)->previous_frame
= sf
;
13360 /* Set the visible flags for all frames. Do this before checking for
13361 resized or garbaged frames; they want to know if their frames are
13362 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13363 number_of_visible_frames
= 0;
13365 FOR_EACH_FRAME (tail
, frame
)
13367 struct frame
*f
= XFRAME (frame
);
13369 if (FRAME_VISIBLE_P (f
))
13371 ++number_of_visible_frames
;
13372 /* Adjust matrices for visible frames only. */
13373 if (f
->fonts_changed
)
13375 adjust_frame_glyphs (f
);
13376 f
->fonts_changed
= 0;
13378 /* If cursor type has been changed on the frame
13379 other than selected, consider all frames. */
13380 if (f
!= sf
&& f
->cursor_type_changed
)
13381 update_mode_lines
= 31;
13383 clear_desired_matrices (f
);
13386 /* Notice any pending interrupt request to change frame size. */
13387 do_pending_window_change (1);
13389 /* do_pending_window_change could change the selected_window due to
13390 frame resizing which makes the selected window too small. */
13391 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13394 /* Clear frames marked as garbaged. */
13395 clear_garbaged_frames ();
13397 /* Build menubar and tool-bar items. */
13398 if (NILP (Vmemory_full
))
13399 prepare_menu_bars ();
13401 reconsider_clip_changes (w
);
13403 /* In most cases selected window displays current buffer. */
13404 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13407 /* Detect case that we need to write or remove a star in the mode line. */
13408 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13409 w
->update_mode_line
= 1;
13411 if (mode_line_update_needed (w
))
13412 w
->update_mode_line
= 1;
13415 /* Normally the message* functions will have already displayed and
13416 updated the echo area, but the frame may have been trashed, or
13417 the update may have been preempted, so display the echo area
13418 again here. Checking message_cleared_p captures the case that
13419 the echo area should be cleared. */
13420 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13421 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13422 || (message_cleared_p
13423 && minibuf_level
== 0
13424 /* If the mini-window is currently selected, this means the
13425 echo-area doesn't show through. */
13426 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13428 int window_height_changed_p
= echo_area_display (0);
13430 if (message_cleared_p
)
13431 update_miniwindow_p
= true;
13435 /* If we don't display the current message, don't clear the
13436 message_cleared_p flag, because, if we did, we wouldn't clear
13437 the echo area in the next redisplay which doesn't preserve
13439 if (!display_last_displayed_message_p
)
13440 message_cleared_p
= 0;
13442 if (window_height_changed_p
)
13444 windows_or_buffers_changed
= 50;
13446 /* If window configuration was changed, frames may have been
13447 marked garbaged. Clear them or we will experience
13448 surprises wrt scrolling. */
13449 clear_garbaged_frames ();
13452 else if (EQ (selected_window
, minibuf_window
)
13453 && (current_buffer
->clip_changed
|| window_outdated (w
))
13454 && resize_mini_window (w
, 0))
13456 /* Resized active mini-window to fit the size of what it is
13457 showing if its contents might have changed. */
13460 /* If window configuration was changed, frames may have been
13461 marked garbaged. Clear them or we will experience
13462 surprises wrt scrolling. */
13463 clear_garbaged_frames ();
13466 if (windows_or_buffers_changed
&& !update_mode_lines
)
13467 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13468 only the windows's contents needs to be refreshed, or whether the
13469 mode-lines also need a refresh. */
13470 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13471 ? REDISPLAY_SOME
: 32);
13473 /* If specs for an arrow have changed, do thorough redisplay
13474 to ensure we remove any arrow that should no longer exist. */
13475 if (overlay_arrows_changed_p ())
13476 /* Apparently, this is the only case where we update other windows,
13477 without updating other mode-lines. */
13478 windows_or_buffers_changed
= 49;
13480 consider_all_windows_p
= (update_mode_lines
13481 || windows_or_buffers_changed
);
13483 #define AINC(a,i) \
13484 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13485 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13487 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13488 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13490 /* Optimize the case that only the line containing the cursor in the
13491 selected window has changed. Variables starting with this_ are
13492 set in display_line and record information about the line
13493 containing the cursor. */
13494 tlbufpos
= this_line_start_pos
;
13495 tlendpos
= this_line_end_pos
;
13496 if (!consider_all_windows_p
13497 && CHARPOS (tlbufpos
) > 0
13498 && !w
->update_mode_line
13499 && !current_buffer
->clip_changed
13500 && !current_buffer
->prevent_redisplay_optimizations_p
13501 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13502 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13503 && !XFRAME (w
->frame
)->cursor_type_changed
13504 /* Make sure recorded data applies to current buffer, etc. */
13505 && this_line_buffer
== current_buffer
13508 && !w
->optional_new_start
13509 /* Point must be on the line that we have info recorded about. */
13510 && PT
>= CHARPOS (tlbufpos
)
13511 && PT
<= Z
- CHARPOS (tlendpos
)
13512 /* All text outside that line, including its final newline,
13513 must be unchanged. */
13514 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13515 CHARPOS (tlendpos
)))
13517 if (CHARPOS (tlbufpos
) > BEGV
13518 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13519 && (CHARPOS (tlbufpos
) == ZV
13520 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13521 /* Former continuation line has disappeared by becoming empty. */
13523 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13525 /* We have to handle the case of continuation around a
13526 wide-column character (see the comment in indent.c around
13529 For instance, in the following case:
13531 -------- Insert --------
13532 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13533 J_I_ ==> J_I_ `^^' are cursors.
13537 As we have to redraw the line above, we cannot use this
13541 int line_height_before
= this_line_pixel_height
;
13543 /* Note that start_display will handle the case that the
13544 line starting at tlbufpos is a continuation line. */
13545 start_display (&it
, w
, tlbufpos
);
13547 /* Implementation note: It this still necessary? */
13548 if (it
.current_x
!= this_line_start_x
)
13551 TRACE ((stderr
, "trying display optimization 1\n"));
13552 w
->cursor
.vpos
= -1;
13553 overlay_arrow_seen
= 0;
13554 it
.vpos
= this_line_vpos
;
13555 it
.current_y
= this_line_y
;
13556 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13557 display_line (&it
);
13559 /* If line contains point, is not continued,
13560 and ends at same distance from eob as before, we win. */
13561 if (w
->cursor
.vpos
>= 0
13562 /* Line is not continued, otherwise this_line_start_pos
13563 would have been set to 0 in display_line. */
13564 && CHARPOS (this_line_start_pos
)
13565 /* Line ends as before. */
13566 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13567 /* Line has same height as before. Otherwise other lines
13568 would have to be shifted up or down. */
13569 && this_line_pixel_height
== line_height_before
)
13571 /* If this is not the window's last line, we must adjust
13572 the charstarts of the lines below. */
13573 if (it
.current_y
< it
.last_visible_y
)
13575 struct glyph_row
*row
13576 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13577 ptrdiff_t delta
, delta_bytes
;
13579 /* We used to distinguish between two cases here,
13580 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13581 when the line ends in a newline or the end of the
13582 buffer's accessible portion. But both cases did
13583 the same, so they were collapsed. */
13585 - CHARPOS (tlendpos
)
13586 - MATRIX_ROW_START_CHARPOS (row
));
13587 delta_bytes
= (Z_BYTE
13588 - BYTEPOS (tlendpos
)
13589 - MATRIX_ROW_START_BYTEPOS (row
));
13591 increment_matrix_positions (w
->current_matrix
,
13592 this_line_vpos
+ 1,
13593 w
->current_matrix
->nrows
,
13594 delta
, delta_bytes
);
13597 /* If this row displays text now but previously didn't,
13598 or vice versa, w->window_end_vpos may have to be
13600 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13602 if (w
->window_end_vpos
< this_line_vpos
)
13603 w
->window_end_vpos
= this_line_vpos
;
13605 else if (w
->window_end_vpos
== this_line_vpos
13606 && this_line_vpos
> 0)
13607 w
->window_end_vpos
= this_line_vpos
- 1;
13608 w
->window_end_valid
= 0;
13610 /* Update hint: No need to try to scroll in update_window. */
13611 w
->desired_matrix
->no_scrolling_p
= 1;
13614 *w
->desired_matrix
->method
= 0;
13615 debug_method_add (w
, "optimization 1");
13617 #ifdef HAVE_WINDOW_SYSTEM
13618 update_window_fringes (w
, 0);
13625 else if (/* Cursor position hasn't changed. */
13626 PT
== w
->last_point
13627 /* Make sure the cursor was last displayed
13628 in this window. Otherwise we have to reposition it. */
13630 /* PXW: Must be converted to pixels, probably. */
13631 && 0 <= w
->cursor
.vpos
13632 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13636 do_pending_window_change (1);
13637 /* If selected_window changed, redisplay again. */
13638 if (WINDOWP (selected_window
)
13639 && (w
= XWINDOW (selected_window
)) != sw
)
13642 /* We used to always goto end_of_redisplay here, but this
13643 isn't enough if we have a blinking cursor. */
13644 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13645 goto end_of_redisplay
;
13649 /* If highlighting the region, or if the cursor is in the echo area,
13650 then we can't just move the cursor. */
13651 else if (NILP (Vshow_trailing_whitespace
)
13652 && !cursor_in_echo_area
)
13655 struct glyph_row
*row
;
13657 /* Skip from tlbufpos to PT and see where it is. Note that
13658 PT may be in invisible text. If so, we will end at the
13659 next visible position. */
13660 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13661 NULL
, DEFAULT_FACE_ID
);
13662 it
.current_x
= this_line_start_x
;
13663 it
.current_y
= this_line_y
;
13664 it
.vpos
= this_line_vpos
;
13666 /* The call to move_it_to stops in front of PT, but
13667 moves over before-strings. */
13668 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13670 if (it
.vpos
== this_line_vpos
13671 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13674 eassert (this_line_vpos
== it
.vpos
);
13675 eassert (this_line_y
== it
.current_y
);
13676 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13678 *w
->desired_matrix
->method
= 0;
13679 debug_method_add (w
, "optimization 3");
13688 /* Text changed drastically or point moved off of line. */
13689 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13692 CHARPOS (this_line_start_pos
) = 0;
13693 ++clear_face_cache_count
;
13694 #ifdef HAVE_WINDOW_SYSTEM
13695 ++clear_image_cache_count
;
13698 /* Build desired matrices, and update the display. If
13699 consider_all_windows_p is non-zero, do it for all windows on all
13700 frames. Otherwise do it for selected_window, only. */
13702 if (consider_all_windows_p
)
13704 FOR_EACH_FRAME (tail
, frame
)
13705 XFRAME (frame
)->updated_p
= 0;
13707 propagate_buffer_redisplay ();
13709 FOR_EACH_FRAME (tail
, frame
)
13711 struct frame
*f
= XFRAME (frame
);
13713 /* We don't have to do anything for unselected terminal
13715 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13716 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13721 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13724 /* Only GC scrollbars when we redisplay the whole frame. */
13725 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13726 /* Mark all the scroll bars to be removed; we'll redeem
13727 the ones we want when we redisplay their windows. */
13728 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13729 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13731 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13732 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13733 /* Remember that the invisible frames need to be redisplayed next
13734 time they're visible. */
13735 else if (!REDISPLAY_SOME_P ())
13736 f
->redisplay
= true;
13738 /* The X error handler may have deleted that frame. */
13739 if (!FRAME_LIVE_P (f
))
13742 /* Any scroll bars which redisplay_windows should have
13743 nuked should now go away. */
13744 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13745 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13747 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13749 /* If fonts changed on visible frame, display again. */
13750 if (f
->fonts_changed
)
13752 adjust_frame_glyphs (f
);
13753 f
->fonts_changed
= 0;
13757 /* See if we have to hscroll. */
13758 if (!f
->already_hscrolled_p
)
13760 f
->already_hscrolled_p
= 1;
13761 if (hscroll_windows (f
->root_window
))
13765 /* Prevent various kinds of signals during display
13766 update. stdio is not robust about handling
13767 signals, which can cause an apparent I/O error. */
13768 if (interrupt_input
)
13769 unrequest_sigio ();
13772 pending
|= update_frame (f
, 0, 0);
13773 f
->cursor_type_changed
= 0;
13779 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13783 /* Do the mark_window_display_accurate after all windows have
13784 been redisplayed because this call resets flags in buffers
13785 which are needed for proper redisplay. */
13786 FOR_EACH_FRAME (tail
, frame
)
13788 struct frame
*f
= XFRAME (frame
);
13791 f
->redisplay
= false;
13792 mark_window_display_accurate (f
->root_window
, 1);
13793 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13794 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13799 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13801 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13802 struct frame
*mini_frame
;
13804 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13805 /* Use list_of_error, not Qerror, so that
13806 we catch only errors and don't run the debugger. */
13807 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13809 redisplay_window_error
);
13810 if (update_miniwindow_p
)
13811 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13813 redisplay_window_error
);
13815 /* Compare desired and current matrices, perform output. */
13818 /* If fonts changed, display again. */
13819 if (sf
->fonts_changed
)
13822 /* Prevent various kinds of signals during display update.
13823 stdio is not robust about handling signals,
13824 which can cause an apparent I/O error. */
13825 if (interrupt_input
)
13826 unrequest_sigio ();
13829 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13831 if (hscroll_windows (selected_window
))
13834 XWINDOW (selected_window
)->must_be_updated_p
= true;
13835 pending
= update_frame (sf
, 0, 0);
13836 sf
->cursor_type_changed
= 0;
13839 /* We may have called echo_area_display at the top of this
13840 function. If the echo area is on another frame, that may
13841 have put text on a frame other than the selected one, so the
13842 above call to update_frame would not have caught it. Catch
13844 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13845 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13847 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13849 XWINDOW (mini_window
)->must_be_updated_p
= true;
13850 pending
|= update_frame (mini_frame
, 0, 0);
13851 mini_frame
->cursor_type_changed
= 0;
13852 if (!pending
&& hscroll_windows (mini_window
))
13857 /* If display was paused because of pending input, make sure we do a
13858 thorough update the next time. */
13861 /* Prevent the optimization at the beginning of
13862 redisplay_internal that tries a single-line update of the
13863 line containing the cursor in the selected window. */
13864 CHARPOS (this_line_start_pos
) = 0;
13866 /* Let the overlay arrow be updated the next time. */
13867 update_overlay_arrows (0);
13869 /* If we pause after scrolling, some rows in the current
13870 matrices of some windows are not valid. */
13871 if (!WINDOW_FULL_WIDTH_P (w
)
13872 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13873 update_mode_lines
= 36;
13877 if (!consider_all_windows_p
)
13879 /* This has already been done above if
13880 consider_all_windows_p is set. */
13881 if (XBUFFER (w
->contents
)->text
->redisplay
13882 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13883 /* This can happen if b->text->redisplay was set during
13885 propagate_buffer_redisplay ();
13886 mark_window_display_accurate_1 (w
, 1);
13888 /* Say overlay arrows are up to date. */
13889 update_overlay_arrows (1);
13891 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13892 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13895 update_mode_lines
= 0;
13896 windows_or_buffers_changed
= 0;
13899 /* Start SIGIO interrupts coming again. Having them off during the
13900 code above makes it less likely one will discard output, but not
13901 impossible, since there might be stuff in the system buffer here.
13902 But it is much hairier to try to do anything about that. */
13903 if (interrupt_input
)
13907 /* If a frame has become visible which was not before, redisplay
13908 again, so that we display it. Expose events for such a frame
13909 (which it gets when becoming visible) don't call the parts of
13910 redisplay constructing glyphs, so simply exposing a frame won't
13911 display anything in this case. So, we have to display these
13912 frames here explicitly. */
13917 FOR_EACH_FRAME (tail
, frame
)
13919 if (XFRAME (frame
)->visible
)
13923 if (new_count
!= number_of_visible_frames
)
13924 windows_or_buffers_changed
= 52;
13927 /* Change frame size now if a change is pending. */
13928 do_pending_window_change (1);
13930 /* If we just did a pending size change, or have additional
13931 visible frames, or selected_window changed, redisplay again. */
13932 if ((windows_or_buffers_changed
&& !pending
)
13933 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13936 /* Clear the face and image caches.
13938 We used to do this only if consider_all_windows_p. But the cache
13939 needs to be cleared if a timer creates images in the current
13940 buffer (e.g. the test case in Bug#6230). */
13942 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13944 clear_face_cache (0);
13945 clear_face_cache_count
= 0;
13948 #ifdef HAVE_WINDOW_SYSTEM
13949 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13951 clear_image_caches (Qnil
);
13952 clear_image_cache_count
= 0;
13954 #endif /* HAVE_WINDOW_SYSTEM */
13957 if (interrupt_input
&& interrupts_deferred
)
13960 unbind_to (count
, Qnil
);
13965 /* Redisplay, but leave alone any recent echo area message unless
13966 another message has been requested in its place.
13968 This is useful in situations where you need to redisplay but no
13969 user action has occurred, making it inappropriate for the message
13970 area to be cleared. See tracking_off and
13971 wait_reading_process_output for examples of these situations.
13973 FROM_WHERE is an integer saying from where this function was
13974 called. This is useful for debugging. */
13977 redisplay_preserve_echo_area (int from_where
)
13979 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13981 if (!NILP (echo_area_buffer
[1]))
13983 /* We have a previously displayed message, but no current
13984 message. Redisplay the previous message. */
13985 display_last_displayed_message_p
= 1;
13986 redisplay_internal ();
13987 display_last_displayed_message_p
= 0;
13990 redisplay_internal ();
13992 flush_frame (SELECTED_FRAME ());
13996 /* Function registered with record_unwind_protect in redisplay_internal. */
13999 unwind_redisplay (void)
14001 redisplaying_p
= 0;
14005 /* Mark the display of leaf window W as accurate or inaccurate.
14006 If ACCURATE_P is non-zero mark display of W as accurate. If
14007 ACCURATE_P is zero, arrange for W to be redisplayed the next
14008 time redisplay_internal is called. */
14011 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14013 struct buffer
*b
= XBUFFER (w
->contents
);
14015 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14016 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14017 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14021 b
->clip_changed
= false;
14022 b
->prevent_redisplay_optimizations_p
= false;
14023 eassert (buffer_window_count (b
) > 0);
14024 /* Resetting b->text->redisplay is problematic!
14025 In order to make it safer to do it here, redisplay_internal must
14026 have copied all b->text->redisplay to their respective windows. */
14027 b
->text
->redisplay
= false;
14029 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14030 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14031 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14032 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14034 w
->current_matrix
->buffer
= b
;
14035 w
->current_matrix
->begv
= BUF_BEGV (b
);
14036 w
->current_matrix
->zv
= BUF_ZV (b
);
14038 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14039 w
->last_cursor_off_p
= w
->cursor_off_p
;
14041 if (w
== XWINDOW (selected_window
))
14042 w
->last_point
= BUF_PT (b
);
14044 w
->last_point
= marker_position (w
->pointm
);
14046 w
->window_end_valid
= true;
14047 w
->update_mode_line
= false;
14050 w
->redisplay
= !accurate_p
;
14054 /* Mark the display of windows in the window tree rooted at WINDOW as
14055 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14056 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14057 be redisplayed the next time redisplay_internal is called. */
14060 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14064 for (; !NILP (window
); window
= w
->next
)
14066 w
= XWINDOW (window
);
14067 if (WINDOWP (w
->contents
))
14068 mark_window_display_accurate (w
->contents
, accurate_p
);
14070 mark_window_display_accurate_1 (w
, accurate_p
);
14074 update_overlay_arrows (1);
14076 /* Force a thorough redisplay the next time by setting
14077 last_arrow_position and last_arrow_string to t, which is
14078 unequal to any useful value of Voverlay_arrow_... */
14079 update_overlay_arrows (-1);
14083 /* Return value in display table DP (Lisp_Char_Table *) for character
14084 C. Since a display table doesn't have any parent, we don't have to
14085 follow parent. Do not call this function directly but use the
14086 macro DISP_CHAR_VECTOR. */
14089 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14093 if (ASCII_CHAR_P (c
))
14096 if (SUB_CHAR_TABLE_P (val
))
14097 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14103 XSETCHAR_TABLE (table
, dp
);
14104 val
= char_table_ref (table
, c
);
14113 /***********************************************************************
14115 ***********************************************************************/
14117 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14120 redisplay_windows (Lisp_Object window
)
14122 while (!NILP (window
))
14124 struct window
*w
= XWINDOW (window
);
14126 if (WINDOWP (w
->contents
))
14127 redisplay_windows (w
->contents
);
14128 else if (BUFFERP (w
->contents
))
14130 displayed_buffer
= XBUFFER (w
->contents
);
14131 /* Use list_of_error, not Qerror, so that
14132 we catch only errors and don't run the debugger. */
14133 internal_condition_case_1 (redisplay_window_0
, window
,
14135 redisplay_window_error
);
14143 redisplay_window_error (Lisp_Object ignore
)
14145 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14150 redisplay_window_0 (Lisp_Object window
)
14152 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14153 redisplay_window (window
, false);
14158 redisplay_window_1 (Lisp_Object window
)
14160 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14161 redisplay_window (window
, true);
14166 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14167 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14168 which positions recorded in ROW differ from current buffer
14171 Return 0 if cursor is not on this row, 1 otherwise. */
14174 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14175 struct glyph_matrix
*matrix
,
14176 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14179 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14180 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14181 struct glyph
*cursor
= NULL
;
14182 /* The last known character position in row. */
14183 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14185 ptrdiff_t pt_old
= PT
- delta
;
14186 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14187 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14188 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14189 /* A glyph beyond the edge of TEXT_AREA which we should never
14191 struct glyph
*glyphs_end
= end
;
14192 /* Non-zero means we've found a match for cursor position, but that
14193 glyph has the avoid_cursor_p flag set. */
14194 int match_with_avoid_cursor
= 0;
14195 /* Non-zero means we've seen at least one glyph that came from a
14197 int string_seen
= 0;
14198 /* Largest and smallest buffer positions seen so far during scan of
14200 ptrdiff_t bpos_max
= pos_before
;
14201 ptrdiff_t bpos_min
= pos_after
;
14202 /* Last buffer position covered by an overlay string with an integer
14203 `cursor' property. */
14204 ptrdiff_t bpos_covered
= 0;
14205 /* Non-zero means the display string on which to display the cursor
14206 comes from a text property, not from an overlay. */
14207 int string_from_text_prop
= 0;
14209 /* Don't even try doing anything if called for a mode-line or
14210 header-line row, since the rest of the code isn't prepared to
14211 deal with such calamities. */
14212 eassert (!row
->mode_line_p
);
14213 if (row
->mode_line_p
)
14216 /* Skip over glyphs not having an object at the start and the end of
14217 the row. These are special glyphs like truncation marks on
14218 terminal frames. */
14219 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14221 if (!row
->reversed_p
)
14224 && INTEGERP (glyph
->object
)
14225 && glyph
->charpos
< 0)
14227 x
+= glyph
->pixel_width
;
14231 && INTEGERP ((end
- 1)->object
)
14232 /* CHARPOS is zero for blanks and stretch glyphs
14233 inserted by extend_face_to_end_of_line. */
14234 && (end
- 1)->charpos
<= 0)
14236 glyph_before
= glyph
- 1;
14243 /* If the glyph row is reversed, we need to process it from back
14244 to front, so swap the edge pointers. */
14245 glyphs_end
= end
= glyph
- 1;
14246 glyph
+= row
->used
[TEXT_AREA
] - 1;
14248 while (glyph
> end
+ 1
14249 && INTEGERP (glyph
->object
)
14250 && glyph
->charpos
< 0)
14253 x
-= glyph
->pixel_width
;
14255 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14257 /* By default, in reversed rows we put the cursor on the
14258 rightmost (first in the reading order) glyph. */
14259 for (g
= end
+ 1; g
< glyph
; g
++)
14260 x
+= g
->pixel_width
;
14262 && INTEGERP ((end
+ 1)->object
)
14263 && (end
+ 1)->charpos
<= 0)
14265 glyph_before
= glyph
+ 1;
14269 else if (row
->reversed_p
)
14271 /* In R2L rows that don't display text, put the cursor on the
14272 rightmost glyph. Case in point: an empty last line that is
14273 part of an R2L paragraph. */
14275 /* Avoid placing the cursor on the last glyph of the row, where
14276 on terminal frames we hold the vertical border between
14277 adjacent windows. */
14278 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14279 && !WINDOW_RIGHTMOST_P (w
)
14280 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14282 x
= -1; /* will be computed below, at label compute_x */
14285 /* Step 1: Try to find the glyph whose character position
14286 corresponds to point. If that's not possible, find 2 glyphs
14287 whose character positions are the closest to point, one before
14288 point, the other after it. */
14289 if (!row
->reversed_p
)
14290 while (/* not marched to end of glyph row */
14292 /* glyph was not inserted by redisplay for internal purposes */
14293 && !INTEGERP (glyph
->object
))
14295 if (BUFFERP (glyph
->object
))
14297 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14299 if (glyph
->charpos
> bpos_max
)
14300 bpos_max
= glyph
->charpos
;
14301 if (glyph
->charpos
< bpos_min
)
14302 bpos_min
= glyph
->charpos
;
14303 if (!glyph
->avoid_cursor_p
)
14305 /* If we hit point, we've found the glyph on which to
14306 display the cursor. */
14309 match_with_avoid_cursor
= 0;
14312 /* See if we've found a better approximation to
14313 POS_BEFORE or to POS_AFTER. */
14314 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14316 pos_before
= glyph
->charpos
;
14317 glyph_before
= glyph
;
14319 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14321 pos_after
= glyph
->charpos
;
14322 glyph_after
= glyph
;
14325 else if (dpos
== 0)
14326 match_with_avoid_cursor
= 1;
14328 else if (STRINGP (glyph
->object
))
14330 Lisp_Object chprop
;
14331 ptrdiff_t glyph_pos
= glyph
->charpos
;
14333 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14335 if (!NILP (chprop
))
14337 /* If the string came from a `display' text property,
14338 look up the buffer position of that property and
14339 use that position to update bpos_max, as if we
14340 actually saw such a position in one of the row's
14341 glyphs. This helps with supporting integer values
14342 of `cursor' property on the display string in
14343 situations where most or all of the row's buffer
14344 text is completely covered by display properties,
14345 so that no glyph with valid buffer positions is
14346 ever seen in the row. */
14347 ptrdiff_t prop_pos
=
14348 string_buffer_position_lim (glyph
->object
, pos_before
,
14351 if (prop_pos
>= pos_before
)
14352 bpos_max
= prop_pos
- 1;
14354 if (INTEGERP (chprop
))
14356 bpos_covered
= bpos_max
+ XINT (chprop
);
14357 /* If the `cursor' property covers buffer positions up
14358 to and including point, we should display cursor on
14359 this glyph. Note that, if a `cursor' property on one
14360 of the string's characters has an integer value, we
14361 will break out of the loop below _before_ we get to
14362 the position match above. IOW, integer values of
14363 the `cursor' property override the "exact match for
14364 point" strategy of positioning the cursor. */
14365 /* Implementation note: bpos_max == pt_old when, e.g.,
14366 we are in an empty line, where bpos_max is set to
14367 MATRIX_ROW_START_CHARPOS, see above. */
14368 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14377 x
+= glyph
->pixel_width
;
14380 else if (glyph
> end
) /* row is reversed */
14381 while (!INTEGERP (glyph
->object
))
14383 if (BUFFERP (glyph
->object
))
14385 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14387 if (glyph
->charpos
> bpos_max
)
14388 bpos_max
= glyph
->charpos
;
14389 if (glyph
->charpos
< bpos_min
)
14390 bpos_min
= glyph
->charpos
;
14391 if (!glyph
->avoid_cursor_p
)
14395 match_with_avoid_cursor
= 0;
14398 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14400 pos_before
= glyph
->charpos
;
14401 glyph_before
= glyph
;
14403 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14405 pos_after
= glyph
->charpos
;
14406 glyph_after
= glyph
;
14409 else if (dpos
== 0)
14410 match_with_avoid_cursor
= 1;
14412 else if (STRINGP (glyph
->object
))
14414 Lisp_Object chprop
;
14415 ptrdiff_t glyph_pos
= glyph
->charpos
;
14417 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14419 if (!NILP (chprop
))
14421 ptrdiff_t prop_pos
=
14422 string_buffer_position_lim (glyph
->object
, pos_before
,
14425 if (prop_pos
>= pos_before
)
14426 bpos_max
= prop_pos
- 1;
14428 if (INTEGERP (chprop
))
14430 bpos_covered
= bpos_max
+ XINT (chprop
);
14431 /* If the `cursor' property covers buffer positions up
14432 to and including point, we should display cursor on
14434 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14443 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14445 x
--; /* can't use any pixel_width */
14448 x
-= glyph
->pixel_width
;
14451 /* Step 2: If we didn't find an exact match for point, we need to
14452 look for a proper place to put the cursor among glyphs between
14453 GLYPH_BEFORE and GLYPH_AFTER. */
14454 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14455 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14456 && !(bpos_max
< pt_old
&& pt_old
<= bpos_covered
))
14458 /* An empty line has a single glyph whose OBJECT is zero and
14459 whose CHARPOS is the position of a newline on that line.
14460 Note that on a TTY, there are more glyphs after that, which
14461 were produced by extend_face_to_end_of_line, but their
14462 CHARPOS is zero or negative. */
14464 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14465 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14466 /* On a TTY, continued and truncated rows also have a glyph at
14467 their end whose OBJECT is zero and whose CHARPOS is
14468 positive (the continuation and truncation glyphs), but such
14469 rows are obviously not "empty". */
14470 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14472 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14474 ptrdiff_t ellipsis_pos
;
14476 /* Scan back over the ellipsis glyphs. */
14477 if (!row
->reversed_p
)
14479 ellipsis_pos
= (glyph
- 1)->charpos
;
14480 while (glyph
> row
->glyphs
[TEXT_AREA
]
14481 && (glyph
- 1)->charpos
== ellipsis_pos
)
14482 glyph
--, x
-= glyph
->pixel_width
;
14483 /* That loop always goes one position too far, including
14484 the glyph before the ellipsis. So scan forward over
14486 x
+= glyph
->pixel_width
;
14489 else /* row is reversed */
14491 ellipsis_pos
= (glyph
+ 1)->charpos
;
14492 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14493 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14494 glyph
++, x
+= glyph
->pixel_width
;
14495 x
-= glyph
->pixel_width
;
14499 else if (match_with_avoid_cursor
)
14501 cursor
= glyph_after
;
14504 else if (string_seen
)
14506 int incr
= row
->reversed_p
? -1 : +1;
14508 /* Need to find the glyph that came out of a string which is
14509 present at point. That glyph is somewhere between
14510 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14511 positioned between POS_BEFORE and POS_AFTER in the
14513 struct glyph
*start
, *stop
;
14514 ptrdiff_t pos
= pos_before
;
14518 /* If the row ends in a newline from a display string,
14519 reordering could have moved the glyphs belonging to the
14520 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14521 in this case we extend the search to the last glyph in
14522 the row that was not inserted by redisplay. */
14523 if (row
->ends_in_newline_from_string_p
)
14526 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14529 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14530 correspond to POS_BEFORE and POS_AFTER, respectively. We
14531 need START and STOP in the order that corresponds to the
14532 row's direction as given by its reversed_p flag. If the
14533 directionality of characters between POS_BEFORE and
14534 POS_AFTER is the opposite of the row's base direction,
14535 these characters will have been reordered for display,
14536 and we need to reverse START and STOP. */
14537 if (!row
->reversed_p
)
14539 start
= min (glyph_before
, glyph_after
);
14540 stop
= max (glyph_before
, glyph_after
);
14544 start
= max (glyph_before
, glyph_after
);
14545 stop
= min (glyph_before
, glyph_after
);
14547 for (glyph
= start
+ incr
;
14548 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14551 /* Any glyphs that come from the buffer are here because
14552 of bidi reordering. Skip them, and only pay
14553 attention to glyphs that came from some string. */
14554 if (STRINGP (glyph
->object
))
14558 /* If the display property covers the newline, we
14559 need to search for it one position farther. */
14560 ptrdiff_t lim
= pos_after
14561 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14563 string_from_text_prop
= 0;
14564 str
= glyph
->object
;
14565 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14566 if (tem
== 0 /* from overlay */
14569 /* If the string from which this glyph came is
14570 found in the buffer at point, or at position
14571 that is closer to point than pos_after, then
14572 we've found the glyph we've been looking for.
14573 If it comes from an overlay (tem == 0), and
14574 it has the `cursor' property on one of its
14575 glyphs, record that glyph as a candidate for
14576 displaying the cursor. (As in the
14577 unidirectional version, we will display the
14578 cursor on the last candidate we find.) */
14581 || (tem
- pt_old
> 0 && tem
< pos_after
))
14583 /* The glyphs from this string could have
14584 been reordered. Find the one with the
14585 smallest string position. Or there could
14586 be a character in the string with the
14587 `cursor' property, which means display
14588 cursor on that character's glyph. */
14589 ptrdiff_t strpos
= glyph
->charpos
;
14594 string_from_text_prop
= 1;
14597 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14598 && EQ (glyph
->object
, str
);
14602 ptrdiff_t gpos
= glyph
->charpos
;
14604 cprop
= Fget_char_property (make_number (gpos
),
14612 if (tem
&& glyph
->charpos
< strpos
)
14614 strpos
= glyph
->charpos
;
14620 || (tem
- pt_old
> 0 && tem
< pos_after
))
14624 pos
= tem
+ 1; /* don't find previous instances */
14626 /* This string is not what we want; skip all of the
14627 glyphs that came from it. */
14628 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14629 && EQ (glyph
->object
, str
))
14636 /* If we reached the end of the line, and END was from a string,
14637 the cursor is not on this line. */
14639 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14640 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14641 && STRINGP (end
->object
)
14642 && row
->continued_p
)
14645 /* A truncated row may not include PT among its character positions.
14646 Setting the cursor inside the scroll margin will trigger
14647 recalculation of hscroll in hscroll_window_tree. But if a
14648 display string covers point, defer to the string-handling
14649 code below to figure this out. */
14650 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14652 cursor
= glyph_before
;
14655 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14656 /* Zero-width characters produce no glyphs. */
14658 && (row
->reversed_p
14659 ? glyph_after
> glyphs_end
14660 : glyph_after
< glyphs_end
)))
14662 cursor
= glyph_after
;
14668 if (cursor
!= NULL
)
14670 else if (glyph
== glyphs_end
14671 && pos_before
== pos_after
14672 && STRINGP ((row
->reversed_p
14673 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14674 : row
->glyphs
[TEXT_AREA
])->object
))
14676 /* If all the glyphs of this row came from strings, put the
14677 cursor on the first glyph of the row. This avoids having the
14678 cursor outside of the text area in this very rare and hard
14682 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14683 : row
->glyphs
[TEXT_AREA
];
14689 /* Need to compute x that corresponds to GLYPH. */
14690 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14692 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14694 x
+= g
->pixel_width
;
14698 /* ROW could be part of a continued line, which, under bidi
14699 reordering, might have other rows whose start and end charpos
14700 occlude point. Only set w->cursor if we found a better
14701 approximation to the cursor position than we have from previously
14702 examined candidate rows belonging to the same continued line. */
14703 if (/* We already have a candidate row. */
14704 w
->cursor
.vpos
>= 0
14705 /* That candidate is not the row we are processing. */
14706 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14707 /* Make sure cursor.vpos specifies a row whose start and end
14708 charpos occlude point, and it is valid candidate for being a
14709 cursor-row. This is because some callers of this function
14710 leave cursor.vpos at the row where the cursor was displayed
14711 during the last redisplay cycle. */
14712 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14713 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14714 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14717 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14719 /* Don't consider glyphs that are outside TEXT_AREA. */
14720 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14722 /* Keep the candidate whose buffer position is the closest to
14723 point or has the `cursor' property. */
14724 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14725 w
->cursor
.hpos
>= 0
14726 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14727 && ((BUFFERP (g1
->object
)
14728 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14729 || (BUFFERP (glyph
->object
)
14730 && eabs (g1
->charpos
- pt_old
)
14731 < eabs (glyph
->charpos
- pt_old
))))
14732 /* Previous candidate is a glyph from a string that has
14733 a non-nil `cursor' property. */
14734 || (STRINGP (g1
->object
)
14735 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14736 Qcursor
, g1
->object
))
14737 /* Previous candidate is from the same display
14738 string as this one, and the display string
14739 came from a text property. */
14740 || (EQ (g1
->object
, glyph
->object
)
14741 && string_from_text_prop
)
14742 /* this candidate is from newline and its
14743 position is not an exact match */
14744 || (INTEGERP (glyph
->object
)
14745 && glyph
->charpos
!= pt_old
)))))
14747 /* If this candidate gives an exact match, use that. */
14748 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14749 /* If this candidate is a glyph created for the
14750 terminating newline of a line, and point is on that
14751 newline, it wins because it's an exact match. */
14752 || (!row
->continued_p
14753 && INTEGERP (glyph
->object
)
14754 && glyph
->charpos
== 0
14755 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14756 /* Otherwise, keep the candidate that comes from a row
14757 spanning less buffer positions. This may win when one or
14758 both candidate positions are on glyphs that came from
14759 display strings, for which we cannot compare buffer
14761 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14762 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14763 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14766 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14768 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14769 w
->cursor
.y
= row
->y
+ dy
;
14771 if (w
== XWINDOW (selected_window
))
14773 if (!row
->continued_p
14774 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14777 this_line_buffer
= XBUFFER (w
->contents
);
14779 CHARPOS (this_line_start_pos
)
14780 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14781 BYTEPOS (this_line_start_pos
)
14782 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14784 CHARPOS (this_line_end_pos
)
14785 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14786 BYTEPOS (this_line_end_pos
)
14787 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14789 this_line_y
= w
->cursor
.y
;
14790 this_line_pixel_height
= row
->height
;
14791 this_line_vpos
= w
->cursor
.vpos
;
14792 this_line_start_x
= row
->x
;
14795 CHARPOS (this_line_start_pos
) = 0;
14802 /* Run window scroll functions, if any, for WINDOW with new window
14803 start STARTP. Sets the window start of WINDOW to that position.
14805 We assume that the window's buffer is really current. */
14807 static struct text_pos
14808 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14810 struct window
*w
= XWINDOW (window
);
14811 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14813 eassert (current_buffer
== XBUFFER (w
->contents
));
14815 if (!NILP (Vwindow_scroll_functions
))
14817 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14818 make_number (CHARPOS (startp
)));
14819 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14820 /* In case the hook functions switch buffers. */
14821 set_buffer_internal (XBUFFER (w
->contents
));
14828 /* Make sure the line containing the cursor is fully visible.
14829 A value of 1 means there is nothing to be done.
14830 (Either the line is fully visible, or it cannot be made so,
14831 or we cannot tell.)
14833 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14834 is higher than window.
14836 A value of 0 means the caller should do scrolling
14837 as if point had gone off the screen. */
14840 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14842 struct glyph_matrix
*matrix
;
14843 struct glyph_row
*row
;
14846 if (!make_cursor_line_fully_visible_p
)
14849 /* It's not always possible to find the cursor, e.g, when a window
14850 is full of overlay strings. Don't do anything in that case. */
14851 if (w
->cursor
.vpos
< 0)
14854 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14855 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14857 /* If the cursor row is not partially visible, there's nothing to do. */
14858 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14861 /* If the row the cursor is in is taller than the window's height,
14862 it's not clear what to do, so do nothing. */
14863 window_height
= window_box_height (w
);
14864 if (row
->height
>= window_height
)
14866 if (!force_p
|| MINI_WINDOW_P (w
)
14867 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14874 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14875 non-zero means only WINDOW is redisplayed in redisplay_internal.
14876 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14877 in redisplay_window to bring a partially visible line into view in
14878 the case that only the cursor has moved.
14880 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14881 last screen line's vertical height extends past the end of the screen.
14885 1 if scrolling succeeded
14887 0 if scrolling didn't find point.
14889 -1 if new fonts have been loaded so that we must interrupt
14890 redisplay, adjust glyph matrices, and try again. */
14896 SCROLLING_NEED_LARGER_MATRICES
14899 /* If scroll-conservatively is more than this, never recenter.
14901 If you change this, don't forget to update the doc string of
14902 `scroll-conservatively' and the Emacs manual. */
14903 #define SCROLL_LIMIT 100
14906 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14907 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14908 int temp_scroll_step
, int last_line_misfit
)
14910 struct window
*w
= XWINDOW (window
);
14911 struct frame
*f
= XFRAME (w
->frame
);
14912 struct text_pos pos
, startp
;
14914 int this_scroll_margin
, scroll_max
, rc
, height
;
14915 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14916 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14917 Lisp_Object aggressive
;
14918 /* We will never try scrolling more than this number of lines. */
14919 int scroll_limit
= SCROLL_LIMIT
;
14920 int frame_line_height
= default_line_pixel_height (w
);
14921 int window_total_lines
14922 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14925 debug_method_add (w
, "try_scrolling");
14928 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14930 /* Compute scroll margin height in pixels. We scroll when point is
14931 within this distance from the top or bottom of the window. */
14932 if (scroll_margin
> 0)
14933 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14934 * frame_line_height
;
14936 this_scroll_margin
= 0;
14938 /* Force arg_scroll_conservatively to have a reasonable value, to
14939 avoid scrolling too far away with slow move_it_* functions. Note
14940 that the user can supply scroll-conservatively equal to
14941 `most-positive-fixnum', which can be larger than INT_MAX. */
14942 if (arg_scroll_conservatively
> scroll_limit
)
14944 arg_scroll_conservatively
= scroll_limit
+ 1;
14945 scroll_max
= scroll_limit
* frame_line_height
;
14947 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14948 /* Compute how much we should try to scroll maximally to bring
14949 point into view. */
14950 scroll_max
= (max (scroll_step
,
14951 max (arg_scroll_conservatively
, temp_scroll_step
))
14952 * frame_line_height
);
14953 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14954 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14955 /* We're trying to scroll because of aggressive scrolling but no
14956 scroll_step is set. Choose an arbitrary one. */
14957 scroll_max
= 10 * frame_line_height
;
14963 /* Decide whether to scroll down. */
14964 if (PT
> CHARPOS (startp
))
14966 int scroll_margin_y
;
14968 /* Compute the pixel ypos of the scroll margin, then move IT to
14969 either that ypos or PT, whichever comes first. */
14970 start_display (&it
, w
, startp
);
14971 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14972 - frame_line_height
* extra_scroll_margin_lines
;
14973 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14974 (MOVE_TO_POS
| MOVE_TO_Y
));
14976 if (PT
> CHARPOS (it
.current
.pos
))
14978 int y0
= line_bottom_y (&it
);
14979 /* Compute how many pixels below window bottom to stop searching
14980 for PT. This avoids costly search for PT that is far away if
14981 the user limited scrolling by a small number of lines, but
14982 always finds PT if scroll_conservatively is set to a large
14983 number, such as most-positive-fixnum. */
14984 int slack
= max (scroll_max
, 10 * frame_line_height
);
14985 int y_to_move
= it
.last_visible_y
+ slack
;
14987 /* Compute the distance from the scroll margin to PT or to
14988 the scroll limit, whichever comes first. This should
14989 include the height of the cursor line, to make that line
14991 move_it_to (&it
, PT
, -1, y_to_move
,
14992 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14993 dy
= line_bottom_y (&it
) - y0
;
14995 if (dy
> scroll_max
)
14996 return SCROLLING_FAILED
;
15005 /* Point is in or below the bottom scroll margin, so move the
15006 window start down. If scrolling conservatively, move it just
15007 enough down to make point visible. If scroll_step is set,
15008 move it down by scroll_step. */
15009 if (arg_scroll_conservatively
)
15011 = min (max (dy
, frame_line_height
),
15012 frame_line_height
* arg_scroll_conservatively
);
15013 else if (scroll_step
|| temp_scroll_step
)
15014 amount_to_scroll
= scroll_max
;
15017 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15018 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15019 if (NUMBERP (aggressive
))
15021 double float_amount
= XFLOATINT (aggressive
) * height
;
15022 int aggressive_scroll
= float_amount
;
15023 if (aggressive_scroll
== 0 && float_amount
> 0)
15024 aggressive_scroll
= 1;
15025 /* Don't let point enter the scroll margin near top of
15026 the window. This could happen if the value of
15027 scroll_up_aggressively is too large and there are
15028 non-zero margins, because scroll_up_aggressively
15029 means put point that fraction of window height
15030 _from_the_bottom_margin_. */
15031 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15032 aggressive_scroll
= height
- 2*this_scroll_margin
;
15033 amount_to_scroll
= dy
+ aggressive_scroll
;
15037 if (amount_to_scroll
<= 0)
15038 return SCROLLING_FAILED
;
15040 start_display (&it
, w
, startp
);
15041 if (arg_scroll_conservatively
<= scroll_limit
)
15042 move_it_vertically (&it
, amount_to_scroll
);
15045 /* Extra precision for users who set scroll-conservatively
15046 to a large number: make sure the amount we scroll
15047 the window start is never less than amount_to_scroll,
15048 which was computed as distance from window bottom to
15049 point. This matters when lines at window top and lines
15050 below window bottom have different height. */
15052 void *it1data
= NULL
;
15053 /* We use a temporary it1 because line_bottom_y can modify
15054 its argument, if it moves one line down; see there. */
15057 SAVE_IT (it1
, it
, it1data
);
15058 start_y
= line_bottom_y (&it1
);
15060 RESTORE_IT (&it
, &it
, it1data
);
15061 move_it_by_lines (&it
, 1);
15062 SAVE_IT (it1
, it
, it1data
);
15063 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15066 /* If STARTP is unchanged, move it down another screen line. */
15067 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15068 move_it_by_lines (&it
, 1);
15069 startp
= it
.current
.pos
;
15073 struct text_pos scroll_margin_pos
= startp
;
15076 /* See if point is inside the scroll margin at the top of the
15078 if (this_scroll_margin
)
15082 start_display (&it
, w
, startp
);
15083 y_start
= it
.current_y
;
15084 move_it_vertically (&it
, this_scroll_margin
);
15085 scroll_margin_pos
= it
.current
.pos
;
15086 /* If we didn't move enough before hitting ZV, request
15087 additional amount of scroll, to move point out of the
15089 if (IT_CHARPOS (it
) == ZV
15090 && it
.current_y
- y_start
< this_scroll_margin
)
15091 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15094 if (PT
< CHARPOS (scroll_margin_pos
))
15096 /* Point is in the scroll margin at the top of the window or
15097 above what is displayed in the window. */
15100 /* Compute the vertical distance from PT to the scroll
15101 margin position. Move as far as scroll_max allows, or
15102 one screenful, or 10 screen lines, whichever is largest.
15103 Give up if distance is greater than scroll_max or if we
15104 didn't reach the scroll margin position. */
15105 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15106 start_display (&it
, w
, pos
);
15108 y_to_move
= max (it
.last_visible_y
,
15109 max (scroll_max
, 10 * frame_line_height
));
15110 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15112 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15113 dy
= it
.current_y
- y0
;
15114 if (dy
> scroll_max
15115 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15116 return SCROLLING_FAILED
;
15118 /* Additional scroll for when ZV was too close to point. */
15121 /* Compute new window start. */
15122 start_display (&it
, w
, startp
);
15124 if (arg_scroll_conservatively
)
15125 amount_to_scroll
= max (dy
, frame_line_height
*
15126 max (scroll_step
, temp_scroll_step
));
15127 else if (scroll_step
|| temp_scroll_step
)
15128 amount_to_scroll
= scroll_max
;
15131 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15132 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15133 if (NUMBERP (aggressive
))
15135 double float_amount
= XFLOATINT (aggressive
) * height
;
15136 int aggressive_scroll
= float_amount
;
15137 if (aggressive_scroll
== 0 && float_amount
> 0)
15138 aggressive_scroll
= 1;
15139 /* Don't let point enter the scroll margin near
15140 bottom of the window, if the value of
15141 scroll_down_aggressively happens to be too
15143 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15144 aggressive_scroll
= height
- 2*this_scroll_margin
;
15145 amount_to_scroll
= dy
+ aggressive_scroll
;
15149 if (amount_to_scroll
<= 0)
15150 return SCROLLING_FAILED
;
15152 move_it_vertically_backward (&it
, amount_to_scroll
);
15153 startp
= it
.current
.pos
;
15157 /* Run window scroll functions. */
15158 startp
= run_window_scroll_functions (window
, startp
);
15160 /* Display the window. Give up if new fonts are loaded, or if point
15162 if (!try_window (window
, startp
, 0))
15163 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15164 else if (w
->cursor
.vpos
< 0)
15166 clear_glyph_matrix (w
->desired_matrix
);
15167 rc
= SCROLLING_FAILED
;
15171 /* Maybe forget recorded base line for line number display. */
15172 if (!just_this_one_p
15173 || current_buffer
->clip_changed
15174 || BEG_UNCHANGED
< CHARPOS (startp
))
15175 w
->base_line_number
= 0;
15177 /* If cursor ends up on a partially visible line,
15178 treat that as being off the bottom of the screen. */
15179 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15180 /* It's possible that the cursor is on the first line of the
15181 buffer, which is partially obscured due to a vscroll
15182 (Bug#7537). In that case, avoid looping forever. */
15183 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15185 clear_glyph_matrix (w
->desired_matrix
);
15186 ++extra_scroll_margin_lines
;
15189 rc
= SCROLLING_SUCCESS
;
15196 /* Compute a suitable window start for window W if display of W starts
15197 on a continuation line. Value is non-zero if a new window start
15200 The new window start will be computed, based on W's width, starting
15201 from the start of the continued line. It is the start of the
15202 screen line with the minimum distance from the old start W->start. */
15205 compute_window_start_on_continuation_line (struct window
*w
)
15207 struct text_pos pos
, start_pos
;
15208 int window_start_changed_p
= 0;
15210 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15212 /* If window start is on a continuation line... Window start may be
15213 < BEGV in case there's invisible text at the start of the
15214 buffer (M-x rmail, for example). */
15215 if (CHARPOS (start_pos
) > BEGV
15216 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15219 struct glyph_row
*row
;
15221 /* Handle the case that the window start is out of range. */
15222 if (CHARPOS (start_pos
) < BEGV
)
15223 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15224 else if (CHARPOS (start_pos
) > ZV
)
15225 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15227 /* Find the start of the continued line. This should be fast
15228 because find_newline is fast (newline cache). */
15229 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15230 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15231 row
, DEFAULT_FACE_ID
);
15232 reseat_at_previous_visible_line_start (&it
);
15234 /* If the line start is "too far" away from the window start,
15235 say it takes too much time to compute a new window start. */
15236 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15237 /* PXW: Do we need upper bounds here? */
15238 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15240 int min_distance
, distance
;
15242 /* Move forward by display lines to find the new window
15243 start. If window width was enlarged, the new start can
15244 be expected to be > the old start. If window width was
15245 decreased, the new window start will be < the old start.
15246 So, we're looking for the display line start with the
15247 minimum distance from the old window start. */
15248 pos
= it
.current
.pos
;
15249 min_distance
= INFINITY
;
15250 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15251 distance
< min_distance
)
15253 min_distance
= distance
;
15254 pos
= it
.current
.pos
;
15255 if (it
.line_wrap
== WORD_WRAP
)
15257 /* Under WORD_WRAP, move_it_by_lines is likely to
15258 overshoot and stop not at the first, but the
15259 second character from the left margin. So in
15260 that case, we need a more tight control on the X
15261 coordinate of the iterator than move_it_by_lines
15262 promises in its contract. The method is to first
15263 go to the last (rightmost) visible character of a
15264 line, then move to the leftmost character on the
15265 next line in a separate call. */
15266 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15267 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15268 move_it_to (&it
, ZV
, 0,
15269 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15270 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15273 move_it_by_lines (&it
, 1);
15276 /* Set the window start there. */
15277 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15278 window_start_changed_p
= 1;
15282 return window_start_changed_p
;
15286 /* Try cursor movement in case text has not changed in window WINDOW,
15287 with window start STARTP. Value is
15289 CURSOR_MOVEMENT_SUCCESS if successful
15291 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15293 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15294 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15295 we want to scroll as if scroll-step were set to 1. See the code.
15297 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15298 which case we have to abort this redisplay, and adjust matrices
15303 CURSOR_MOVEMENT_SUCCESS
,
15304 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15305 CURSOR_MOVEMENT_MUST_SCROLL
,
15306 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15310 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15312 struct window
*w
= XWINDOW (window
);
15313 struct frame
*f
= XFRAME (w
->frame
);
15314 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15317 if (inhibit_try_cursor_movement
)
15321 /* Previously, there was a check for Lisp integer in the
15322 if-statement below. Now, this field is converted to
15323 ptrdiff_t, thus zero means invalid position in a buffer. */
15324 eassert (w
->last_point
> 0);
15325 /* Likewise there was a check whether window_end_vpos is nil or larger
15326 than the window. Now window_end_vpos is int and so never nil, but
15327 let's leave eassert to check whether it fits in the window. */
15328 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15330 /* Handle case where text has not changed, only point, and it has
15331 not moved off the frame. */
15332 if (/* Point may be in this window. */
15333 PT
>= CHARPOS (startp
)
15334 /* Selective display hasn't changed. */
15335 && !current_buffer
->clip_changed
15336 /* Function force-mode-line-update is used to force a thorough
15337 redisplay. It sets either windows_or_buffers_changed or
15338 update_mode_lines. So don't take a shortcut here for these
15340 && !update_mode_lines
15341 && !windows_or_buffers_changed
15342 && !f
->cursor_type_changed
15343 && NILP (Vshow_trailing_whitespace
)
15344 /* This code is not used for mini-buffer for the sake of the case
15345 of redisplaying to replace an echo area message; since in
15346 that case the mini-buffer contents per se are usually
15347 unchanged. This code is of no real use in the mini-buffer
15348 since the handling of this_line_start_pos, etc., in redisplay
15349 handles the same cases. */
15350 && !EQ (window
, minibuf_window
)
15351 && (FRAME_WINDOW_P (f
)
15352 || !overlay_arrow_in_current_buffer_p ()))
15354 int this_scroll_margin
, top_scroll_margin
;
15355 struct glyph_row
*row
= NULL
;
15356 int frame_line_height
= default_line_pixel_height (w
);
15357 int window_total_lines
15358 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15361 debug_method_add (w
, "cursor movement");
15364 /* Scroll if point within this distance from the top or bottom
15365 of the window. This is a pixel value. */
15366 if (scroll_margin
> 0)
15368 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15369 this_scroll_margin
*= frame_line_height
;
15372 this_scroll_margin
= 0;
15374 top_scroll_margin
= this_scroll_margin
;
15375 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15376 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15378 /* Start with the row the cursor was displayed during the last
15379 not paused redisplay. Give up if that row is not valid. */
15380 if (w
->last_cursor_vpos
< 0
15381 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15382 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15385 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15386 if (row
->mode_line_p
)
15388 if (!row
->enabled_p
)
15389 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15392 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15394 int scroll_p
= 0, must_scroll
= 0;
15395 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15397 if (PT
> w
->last_point
)
15399 /* Point has moved forward. */
15400 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15401 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15403 eassert (row
->enabled_p
);
15407 /* If the end position of a row equals the start
15408 position of the next row, and PT is at that position,
15409 we would rather display cursor in the next line. */
15410 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15411 && MATRIX_ROW_END_CHARPOS (row
) == PT
15412 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15413 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15414 && !cursor_row_p (row
))
15417 /* If within the scroll margin, scroll. Note that
15418 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15419 the next line would be drawn, and that
15420 this_scroll_margin can be zero. */
15421 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15422 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15423 /* Line is completely visible last line in window
15424 and PT is to be set in the next line. */
15425 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15426 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15427 && !row
->ends_at_zv_p
15428 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15431 else if (PT
< w
->last_point
)
15433 /* Cursor has to be moved backward. Note that PT >=
15434 CHARPOS (startp) because of the outer if-statement. */
15435 while (!row
->mode_line_p
15436 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15437 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15438 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15439 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15440 row
> w
->current_matrix
->rows
15441 && (row
-1)->ends_in_newline_from_string_p
))))
15442 && (row
->y
> top_scroll_margin
15443 || CHARPOS (startp
) == BEGV
))
15445 eassert (row
->enabled_p
);
15449 /* Consider the following case: Window starts at BEGV,
15450 there is invisible, intangible text at BEGV, so that
15451 display starts at some point START > BEGV. It can
15452 happen that we are called with PT somewhere between
15453 BEGV and START. Try to handle that case. */
15454 if (row
< w
->current_matrix
->rows
15455 || row
->mode_line_p
)
15457 row
= w
->current_matrix
->rows
;
15458 if (row
->mode_line_p
)
15462 /* Due to newlines in overlay strings, we may have to
15463 skip forward over overlay strings. */
15464 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15465 && MATRIX_ROW_END_CHARPOS (row
) == PT
15466 && !cursor_row_p (row
))
15469 /* If within the scroll margin, scroll. */
15470 if (row
->y
< top_scroll_margin
15471 && CHARPOS (startp
) != BEGV
)
15476 /* Cursor did not move. So don't scroll even if cursor line
15477 is partially visible, as it was so before. */
15478 rc
= CURSOR_MOVEMENT_SUCCESS
;
15481 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15482 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15484 /* if PT is not in the glyph row, give up. */
15485 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15488 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15489 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15491 struct glyph_row
*row1
;
15493 /* If rows are bidi-reordered and point moved, back up
15494 until we find a row that does not belong to a
15495 continuation line. This is because we must consider
15496 all rows of a continued line as candidates for the
15497 new cursor positioning, since row start and end
15498 positions change non-linearly with vertical position
15500 /* FIXME: Revisit this when glyph ``spilling'' in
15501 continuation lines' rows is implemented for
15502 bidi-reordered rows. */
15503 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15504 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15507 /* If we hit the beginning of the displayed portion
15508 without finding the first row of a continued
15512 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15515 eassert (row
->enabled_p
);
15520 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15521 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15522 /* Make sure this isn't a header line by any chance, since
15523 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15524 && !row
->mode_line_p
15525 && make_cursor_line_fully_visible_p
)
15527 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15528 && !row
->ends_at_zv_p
15529 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15530 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15531 else if (row
->height
> window_box_height (w
))
15533 /* If we end up in a partially visible line, let's
15534 make it fully visible, except when it's taller
15535 than the window, in which case we can't do much
15538 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15542 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15543 if (!cursor_row_fully_visible_p (w
, 0, 1))
15544 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15546 rc
= CURSOR_MOVEMENT_SUCCESS
;
15550 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15551 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15552 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15554 /* With bidi-reordered rows, there could be more than
15555 one candidate row whose start and end positions
15556 occlude point. We need to let set_cursor_from_row
15557 find the best candidate. */
15558 /* FIXME: Revisit this when glyph ``spilling'' in
15559 continuation lines' rows is implemented for
15560 bidi-reordered rows. */
15565 int at_zv_p
= 0, exact_match_p
= 0;
15567 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15568 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15569 && cursor_row_p (row
))
15570 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15572 /* As soon as we've found the exact match for point,
15573 or the first suitable row whose ends_at_zv_p flag
15574 is set, we are done. */
15577 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15578 w
->cursor
.vpos
)->ends_at_zv_p
;
15580 && w
->cursor
.hpos
>= 0
15581 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15584 struct glyph_row
*candidate
=
15585 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15587 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15588 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15591 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15592 || (INTEGERP (g
->object
)
15593 && (g
->charpos
== PT
15594 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15596 if (at_zv_p
|| exact_match_p
)
15598 rc
= CURSOR_MOVEMENT_SUCCESS
;
15602 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15606 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15607 || row
->continued_p
)
15608 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15609 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15610 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15611 /* If we didn't find any candidate rows, or exited the
15612 loop before all the candidates were examined, signal
15613 to the caller that this method failed. */
15614 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15616 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15617 && !row
->continued_p
))
15618 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15620 rc
= CURSOR_MOVEMENT_SUCCESS
;
15626 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15628 rc
= CURSOR_MOVEMENT_SUCCESS
;
15633 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15634 && MATRIX_ROW_START_CHARPOS (row
) == PT
15635 && cursor_row_p (row
));
15643 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15647 set_vertical_scroll_bar (struct window
*w
)
15649 ptrdiff_t start
, end
, whole
;
15651 /* Calculate the start and end positions for the current window.
15652 At some point, it would be nice to choose between scrollbars
15653 which reflect the whole buffer size, with special markers
15654 indicating narrowing, and scrollbars which reflect only the
15657 Note that mini-buffers sometimes aren't displaying any text. */
15658 if (!MINI_WINDOW_P (w
)
15659 || (w
== XWINDOW (minibuf_window
)
15660 && NILP (echo_area_buffer
[0])))
15662 struct buffer
*buf
= XBUFFER (w
->contents
);
15663 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15664 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15665 /* I don't think this is guaranteed to be right. For the
15666 moment, we'll pretend it is. */
15667 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15671 if (whole
< (end
- start
))
15672 whole
= end
- start
;
15675 start
= end
= whole
= 0;
15677 /* Indicate what this scroll bar ought to be displaying now. */
15678 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15679 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15680 (w
, end
- start
, whole
, start
);
15684 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15685 selected_window is redisplayed.
15687 We can return without actually redisplaying the window if fonts has been
15688 changed on window's frame. In that case, redisplay_internal will retry. */
15691 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15693 struct window
*w
= XWINDOW (window
);
15694 struct frame
*f
= XFRAME (w
->frame
);
15695 struct buffer
*buffer
= XBUFFER (w
->contents
);
15696 struct buffer
*old
= current_buffer
;
15697 struct text_pos lpoint
, opoint
, startp
;
15698 int update_mode_line
;
15701 /* Record it now because it's overwritten. */
15702 bool current_matrix_up_to_date_p
= false;
15703 bool used_current_matrix_p
= false;
15704 /* This is less strict than current_matrix_up_to_date_p.
15705 It indicates that the buffer contents and narrowing are unchanged. */
15706 bool buffer_unchanged_p
= false;
15707 int temp_scroll_step
= 0;
15708 ptrdiff_t count
= SPECPDL_INDEX ();
15710 int centering_position
= -1;
15711 int last_line_misfit
= 0;
15712 ptrdiff_t beg_unchanged
, end_unchanged
;
15713 int frame_line_height
;
15715 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15719 *w
->desired_matrix
->method
= 0;
15722 if (!just_this_one_p
15723 && REDISPLAY_SOME_P ()
15726 && !buffer
->text
->redisplay
15727 && BUF_PT (buffer
) == w
->last_point
)
15730 /* Make sure that both W's markers are valid. */
15731 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15732 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15735 reconsider_clip_changes (w
);
15736 frame_line_height
= default_line_pixel_height (w
);
15738 /* Has the mode line to be updated? */
15739 update_mode_line
= (w
->update_mode_line
15740 || update_mode_lines
15741 || buffer
->clip_changed
15742 || buffer
->prevent_redisplay_optimizations_p
);
15744 if (!just_this_one_p
)
15745 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15746 cleverly elsewhere. */
15747 w
->must_be_updated_p
= true;
15749 if (MINI_WINDOW_P (w
))
15751 if (w
== XWINDOW (echo_area_window
)
15752 && !NILP (echo_area_buffer
[0]))
15754 if (update_mode_line
)
15755 /* We may have to update a tty frame's menu bar or a
15756 tool-bar. Example `M-x C-h C-h C-g'. */
15757 goto finish_menu_bars
;
15759 /* We've already displayed the echo area glyphs in this window. */
15760 goto finish_scroll_bars
;
15762 else if ((w
!= XWINDOW (minibuf_window
)
15763 || minibuf_level
== 0)
15764 /* When buffer is nonempty, redisplay window normally. */
15765 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15766 /* Quail displays non-mini buffers in minibuffer window.
15767 In that case, redisplay the window normally. */
15768 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15770 /* W is a mini-buffer window, but it's not active, so clear
15772 int yb
= window_text_bottom_y (w
);
15773 struct glyph_row
*row
;
15776 for (y
= 0, row
= w
->desired_matrix
->rows
;
15778 y
+= row
->height
, ++row
)
15779 blank_row (w
, row
, y
);
15780 goto finish_scroll_bars
;
15783 clear_glyph_matrix (w
->desired_matrix
);
15786 /* Otherwise set up data on this window; select its buffer and point
15788 /* Really select the buffer, for the sake of buffer-local
15790 set_buffer_internal_1 (XBUFFER (w
->contents
));
15792 current_matrix_up_to_date_p
15793 = (w
->window_end_valid
15794 && !current_buffer
->clip_changed
15795 && !current_buffer
->prevent_redisplay_optimizations_p
15796 && !window_outdated (w
));
15798 /* Run the window-bottom-change-functions
15799 if it is possible that the text on the screen has changed
15800 (either due to modification of the text, or any other reason). */
15801 if (!current_matrix_up_to_date_p
15802 && !NILP (Vwindow_text_change_functions
))
15804 safe_run_hooks (Qwindow_text_change_functions
);
15808 beg_unchanged
= BEG_UNCHANGED
;
15809 end_unchanged
= END_UNCHANGED
;
15811 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15813 specbind (Qinhibit_point_motion_hooks
, Qt
);
15816 = (w
->window_end_valid
15817 && !current_buffer
->clip_changed
15818 && !window_outdated (w
));
15820 /* When windows_or_buffers_changed is non-zero, we can't rely
15821 on the window end being valid, so set it to zero there. */
15822 if (windows_or_buffers_changed
)
15824 /* If window starts on a continuation line, maybe adjust the
15825 window start in case the window's width changed. */
15826 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15827 compute_window_start_on_continuation_line (w
);
15829 w
->window_end_valid
= false;
15830 /* If so, we also can't rely on current matrix
15831 and should not fool try_cursor_movement below. */
15832 current_matrix_up_to_date_p
= false;
15835 /* Some sanity checks. */
15836 CHECK_WINDOW_END (w
);
15837 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15839 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15842 if (mode_line_update_needed (w
))
15843 update_mode_line
= 1;
15845 /* Point refers normally to the selected window. For any other
15846 window, set up appropriate value. */
15847 if (!EQ (window
, selected_window
))
15849 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15850 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15854 new_pt_byte
= BEGV_BYTE
;
15855 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15857 else if (new_pt
> (ZV
- 1))
15860 new_pt_byte
= ZV_BYTE
;
15861 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15864 /* We don't use SET_PT so that the point-motion hooks don't run. */
15865 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15868 /* If any of the character widths specified in the display table
15869 have changed, invalidate the width run cache. It's true that
15870 this may be a bit late to catch such changes, but the rest of
15871 redisplay goes (non-fatally) haywire when the display table is
15872 changed, so why should we worry about doing any better? */
15873 if (current_buffer
->width_run_cache
15874 || (current_buffer
->base_buffer
15875 && current_buffer
->base_buffer
->width_run_cache
))
15877 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15879 if (! disptab_matches_widthtab
15880 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15882 struct buffer
*buf
= current_buffer
;
15884 if (buf
->base_buffer
)
15885 buf
= buf
->base_buffer
;
15886 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
15887 recompute_width_table (current_buffer
, disptab
);
15891 /* If window-start is screwed up, choose a new one. */
15892 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15895 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15897 /* If someone specified a new starting point but did not insist,
15898 check whether it can be used. */
15899 if (w
->optional_new_start
15900 && CHARPOS (startp
) >= BEGV
15901 && CHARPOS (startp
) <= ZV
)
15903 w
->optional_new_start
= 0;
15904 start_display (&it
, w
, startp
);
15905 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15906 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15907 if (IT_CHARPOS (it
) == PT
)
15908 w
->force_start
= 1;
15909 /* IT may overshoot PT if text at PT is invisible. */
15910 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15911 w
->force_start
= 1;
15916 /* Handle case where place to start displaying has been specified,
15917 unless the specified location is outside the accessible range. */
15918 if (w
->force_start
|| window_frozen_p (w
))
15920 /* We set this later on if we have to adjust point. */
15923 w
->force_start
= 0;
15925 w
->window_end_valid
= 0;
15927 /* Forget any recorded base line for line number display. */
15928 if (!buffer_unchanged_p
)
15929 w
->base_line_number
= 0;
15931 /* Redisplay the mode line. Select the buffer properly for that.
15932 Also, run the hook window-scroll-functions
15933 because we have scrolled. */
15934 /* Note, we do this after clearing force_start because
15935 if there's an error, it is better to forget about force_start
15936 than to get into an infinite loop calling the hook functions
15937 and having them get more errors. */
15938 if (!update_mode_line
15939 || ! NILP (Vwindow_scroll_functions
))
15941 update_mode_line
= 1;
15942 w
->update_mode_line
= 1;
15943 startp
= run_window_scroll_functions (window
, startp
);
15946 if (CHARPOS (startp
) < BEGV
)
15947 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15948 else if (CHARPOS (startp
) > ZV
)
15949 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15951 /* Redisplay, then check if cursor has been set during the
15952 redisplay. Give up if new fonts were loaded. */
15953 /* We used to issue a CHECK_MARGINS argument to try_window here,
15954 but this causes scrolling to fail when point begins inside
15955 the scroll margin (bug#148) -- cyd */
15956 if (!try_window (window
, startp
, 0))
15958 w
->force_start
= 1;
15959 clear_glyph_matrix (w
->desired_matrix
);
15960 goto need_larger_matrices
;
15963 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
15965 /* If point does not appear, try to move point so it does
15966 appear. The desired matrix has been built above, so we
15967 can use it here. */
15968 new_vpos
= window_box_height (w
) / 2;
15971 if (!cursor_row_fully_visible_p (w
, 0, 0))
15973 /* Point does appear, but on a line partly visible at end of window.
15974 Move it back to a fully-visible line. */
15975 new_vpos
= window_box_height (w
);
15977 else if (w
->cursor
.vpos
>= 0)
15979 /* Some people insist on not letting point enter the scroll
15980 margin, even though this part handles windows that didn't
15982 int window_total_lines
15983 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15984 int margin
= min (scroll_margin
, window_total_lines
/ 4);
15985 int pixel_margin
= margin
* frame_line_height
;
15986 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
15988 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
15989 below, which finds the row to move point to, advances by
15990 the Y coordinate of the _next_ row, see the definition of
15991 MATRIX_ROW_BOTTOM_Y. */
15992 if (w
->cursor
.vpos
< margin
+ header_line
)
15994 w
->cursor
.vpos
= -1;
15995 clear_glyph_matrix (w
->desired_matrix
);
15996 goto try_to_scroll
;
16000 int window_height
= window_box_height (w
);
16003 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16004 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16006 w
->cursor
.vpos
= -1;
16007 clear_glyph_matrix (w
->desired_matrix
);
16008 goto try_to_scroll
;
16013 /* If we need to move point for either of the above reasons,
16014 now actually do it. */
16017 struct glyph_row
*row
;
16019 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16020 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16023 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16024 MATRIX_ROW_START_BYTEPOS (row
));
16026 if (w
!= XWINDOW (selected_window
))
16027 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16028 else if (current_buffer
== old
)
16029 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16031 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16033 /* If we are highlighting the region, then we just changed
16034 the region, so redisplay to show it. */
16035 /* FIXME: We need to (re)run pre-redisplay-function! */
16036 /* if (markpos_of_region () >= 0)
16038 clear_glyph_matrix (w->desired_matrix);
16039 if (!try_window (window, startp, 0))
16040 goto need_larger_matrices;
16046 debug_method_add (w
, "forced window start");
16051 /* Handle case where text has not changed, only point, and it has
16052 not moved off the frame, and we are not retrying after hscroll.
16053 (current_matrix_up_to_date_p is nonzero when retrying.) */
16054 if (current_matrix_up_to_date_p
16055 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16056 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16060 case CURSOR_MOVEMENT_SUCCESS
:
16061 used_current_matrix_p
= 1;
16064 case CURSOR_MOVEMENT_MUST_SCROLL
:
16065 goto try_to_scroll
;
16071 /* If current starting point was originally the beginning of a line
16072 but no longer is, find a new starting point. */
16073 else if (w
->start_at_line_beg
16074 && !(CHARPOS (startp
) <= BEGV
16075 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16078 debug_method_add (w
, "recenter 1");
16083 /* Try scrolling with try_window_id. Value is > 0 if update has
16084 been done, it is -1 if we know that the same window start will
16085 not work. It is 0 if unsuccessful for some other reason. */
16086 else if ((tem
= try_window_id (w
)) != 0)
16089 debug_method_add (w
, "try_window_id %d", tem
);
16092 if (f
->fonts_changed
)
16093 goto need_larger_matrices
;
16097 /* Otherwise try_window_id has returned -1 which means that we
16098 don't want the alternative below this comment to execute. */
16100 else if (CHARPOS (startp
) >= BEGV
16101 && CHARPOS (startp
) <= ZV
16102 && PT
>= CHARPOS (startp
)
16103 && (CHARPOS (startp
) < ZV
16104 /* Avoid starting at end of buffer. */
16105 || CHARPOS (startp
) == BEGV
16106 || !window_outdated (w
)))
16108 int d1
, d2
, d3
, d4
, d5
, d6
;
16110 /* If first window line is a continuation line, and window start
16111 is inside the modified region, but the first change is before
16112 current window start, we must select a new window start.
16114 However, if this is the result of a down-mouse event (e.g. by
16115 extending the mouse-drag-overlay), we don't want to select a
16116 new window start, since that would change the position under
16117 the mouse, resulting in an unwanted mouse-movement rather
16118 than a simple mouse-click. */
16119 if (!w
->start_at_line_beg
16120 && NILP (do_mouse_tracking
)
16121 && CHARPOS (startp
) > BEGV
16122 && CHARPOS (startp
) > BEG
+ beg_unchanged
16123 && CHARPOS (startp
) <= Z
- end_unchanged
16124 /* Even if w->start_at_line_beg is nil, a new window may
16125 start at a line_beg, since that's how set_buffer_window
16126 sets it. So, we need to check the return value of
16127 compute_window_start_on_continuation_line. (See also
16129 && XMARKER (w
->start
)->buffer
== current_buffer
16130 && compute_window_start_on_continuation_line (w
)
16131 /* It doesn't make sense to force the window start like we
16132 do at label force_start if it is already known that point
16133 will not be visible in the resulting window, because
16134 doing so will move point from its correct position
16135 instead of scrolling the window to bring point into view.
16137 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16139 w
->force_start
= 1;
16140 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16145 debug_method_add (w
, "same window start");
16148 /* Try to redisplay starting at same place as before.
16149 If point has not moved off frame, accept the results. */
16150 if (!current_matrix_up_to_date_p
16151 /* Don't use try_window_reusing_current_matrix in this case
16152 because a window scroll function can have changed the
16154 || !NILP (Vwindow_scroll_functions
)
16155 || MINI_WINDOW_P (w
)
16156 || !(used_current_matrix_p
16157 = try_window_reusing_current_matrix (w
)))
16159 IF_DEBUG (debug_method_add (w
, "1"));
16160 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16161 /* -1 means we need to scroll.
16162 0 means we need new matrices, but fonts_changed
16163 is set in that case, so we will detect it below. */
16164 goto try_to_scroll
;
16167 if (f
->fonts_changed
)
16168 goto need_larger_matrices
;
16170 if (w
->cursor
.vpos
>= 0)
16172 if (!just_this_one_p
16173 || current_buffer
->clip_changed
16174 || BEG_UNCHANGED
< CHARPOS (startp
))
16175 /* Forget any recorded base line for line number display. */
16176 w
->base_line_number
= 0;
16178 if (!cursor_row_fully_visible_p (w
, 1, 0))
16180 clear_glyph_matrix (w
->desired_matrix
);
16181 last_line_misfit
= 1;
16183 /* Drop through and scroll. */
16188 clear_glyph_matrix (w
->desired_matrix
);
16193 /* Redisplay the mode line. Select the buffer properly for that. */
16194 if (!update_mode_line
)
16196 update_mode_line
= 1;
16197 w
->update_mode_line
= 1;
16200 /* Try to scroll by specified few lines. */
16201 if ((scroll_conservatively
16202 || emacs_scroll_step
16203 || temp_scroll_step
16204 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16205 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16206 && CHARPOS (startp
) >= BEGV
16207 && CHARPOS (startp
) <= ZV
)
16209 /* The function returns -1 if new fonts were loaded, 1 if
16210 successful, 0 if not successful. */
16211 int ss
= try_scrolling (window
, just_this_one_p
,
16212 scroll_conservatively
,
16214 temp_scroll_step
, last_line_misfit
);
16217 case SCROLLING_SUCCESS
:
16220 case SCROLLING_NEED_LARGER_MATRICES
:
16221 goto need_larger_matrices
;
16223 case SCROLLING_FAILED
:
16231 /* Finally, just choose a place to start which positions point
16232 according to user preferences. */
16237 debug_method_add (w
, "recenter");
16240 /* Forget any previously recorded base line for line number display. */
16241 if (!buffer_unchanged_p
)
16242 w
->base_line_number
= 0;
16244 /* Determine the window start relative to point. */
16245 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16246 it
.current_y
= it
.last_visible_y
;
16247 if (centering_position
< 0)
16249 int window_total_lines
16250 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16253 ? min (scroll_margin
, window_total_lines
/ 4)
16255 ptrdiff_t margin_pos
= CHARPOS (startp
);
16256 Lisp_Object aggressive
;
16259 /* If there is a scroll margin at the top of the window, find
16260 its character position. */
16262 /* Cannot call start_display if startp is not in the
16263 accessible region of the buffer. This can happen when we
16264 have just switched to a different buffer and/or changed
16265 its restriction. In that case, startp is initialized to
16266 the character position 1 (BEGV) because we did not yet
16267 have chance to display the buffer even once. */
16268 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16271 void *it1data
= NULL
;
16273 SAVE_IT (it1
, it
, it1data
);
16274 start_display (&it1
, w
, startp
);
16275 move_it_vertically (&it1
, margin
* frame_line_height
);
16276 margin_pos
= IT_CHARPOS (it1
);
16277 RESTORE_IT (&it
, &it
, it1data
);
16279 scrolling_up
= PT
> margin_pos
;
16282 ? BVAR (current_buffer
, scroll_up_aggressively
)
16283 : BVAR (current_buffer
, scroll_down_aggressively
);
16285 if (!MINI_WINDOW_P (w
)
16286 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16290 /* Setting scroll-conservatively overrides
16291 scroll-*-aggressively. */
16292 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16294 double float_amount
= XFLOATINT (aggressive
);
16296 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16297 if (pt_offset
== 0 && float_amount
> 0)
16299 if (pt_offset
&& margin
> 0)
16302 /* Compute how much to move the window start backward from
16303 point so that point will be displayed where the user
16307 centering_position
= it
.last_visible_y
;
16309 centering_position
-= pt_offset
;
16310 centering_position
-=
16311 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16312 + WINDOW_HEADER_LINE_HEIGHT (w
);
16313 /* Don't let point enter the scroll margin near top of
16315 if (centering_position
< margin
* frame_line_height
)
16316 centering_position
= margin
* frame_line_height
;
16319 centering_position
= margin
* frame_line_height
+ pt_offset
;
16322 /* Set the window start half the height of the window backward
16324 centering_position
= window_box_height (w
) / 2;
16326 move_it_vertically_backward (&it
, centering_position
);
16328 eassert (IT_CHARPOS (it
) >= BEGV
);
16330 /* The function move_it_vertically_backward may move over more
16331 than the specified y-distance. If it->w is small, e.g. a
16332 mini-buffer window, we may end up in front of the window's
16333 display area. Start displaying at the start of the line
16334 containing PT in this case. */
16335 if (it
.current_y
<= 0)
16337 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16338 move_it_vertically_backward (&it
, 0);
16342 it
.current_x
= it
.hpos
= 0;
16344 /* Set the window start position here explicitly, to avoid an
16345 infinite loop in case the functions in window-scroll-functions
16347 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16349 /* Run scroll hooks. */
16350 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16352 /* Redisplay the window. */
16353 if (!current_matrix_up_to_date_p
16354 || windows_or_buffers_changed
16355 || f
->cursor_type_changed
16356 /* Don't use try_window_reusing_current_matrix in this case
16357 because it can have changed the buffer. */
16358 || !NILP (Vwindow_scroll_functions
)
16359 || !just_this_one_p
16360 || MINI_WINDOW_P (w
)
16361 || !(used_current_matrix_p
16362 = try_window_reusing_current_matrix (w
)))
16363 try_window (window
, startp
, 0);
16365 /* If new fonts have been loaded (due to fontsets), give up. We
16366 have to start a new redisplay since we need to re-adjust glyph
16368 if (f
->fonts_changed
)
16369 goto need_larger_matrices
;
16371 /* If cursor did not appear assume that the middle of the window is
16372 in the first line of the window. Do it again with the next line.
16373 (Imagine a window of height 100, displaying two lines of height
16374 60. Moving back 50 from it->last_visible_y will end in the first
16376 if (w
->cursor
.vpos
< 0)
16378 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16380 clear_glyph_matrix (w
->desired_matrix
);
16381 move_it_by_lines (&it
, 1);
16382 try_window (window
, it
.current
.pos
, 0);
16384 else if (PT
< IT_CHARPOS (it
))
16386 clear_glyph_matrix (w
->desired_matrix
);
16387 move_it_by_lines (&it
, -1);
16388 try_window (window
, it
.current
.pos
, 0);
16392 /* Not much we can do about it. */
16396 /* Consider the following case: Window starts at BEGV, there is
16397 invisible, intangible text at BEGV, so that display starts at
16398 some point START > BEGV. It can happen that we are called with
16399 PT somewhere between BEGV and START. Try to handle that case. */
16400 if (w
->cursor
.vpos
< 0)
16402 struct glyph_row
*row
= w
->current_matrix
->rows
;
16403 if (row
->mode_line_p
)
16405 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16408 if (!cursor_row_fully_visible_p (w
, 0, 0))
16410 /* If vscroll is enabled, disable it and try again. */
16414 clear_glyph_matrix (w
->desired_matrix
);
16418 /* Users who set scroll-conservatively to a large number want
16419 point just above/below the scroll margin. If we ended up
16420 with point's row partially visible, move the window start to
16421 make that row fully visible and out of the margin. */
16422 if (scroll_conservatively
> SCROLL_LIMIT
)
16424 int window_total_lines
16425 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16428 ? min (scroll_margin
, window_total_lines
/ 4)
16430 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16432 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16433 clear_glyph_matrix (w
->desired_matrix
);
16434 if (1 == try_window (window
, it
.current
.pos
,
16435 TRY_WINDOW_CHECK_MARGINS
))
16439 /* If centering point failed to make the whole line visible,
16440 put point at the top instead. That has to make the whole line
16441 visible, if it can be done. */
16442 if (centering_position
== 0)
16445 clear_glyph_matrix (w
->desired_matrix
);
16446 centering_position
= 0;
16452 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16453 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16454 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16456 /* Display the mode line, if we must. */
16457 if ((update_mode_line
16458 /* If window not full width, must redo its mode line
16459 if (a) the window to its side is being redone and
16460 (b) we do a frame-based redisplay. This is a consequence
16461 of how inverted lines are drawn in frame-based redisplay. */
16462 || (!just_this_one_p
16463 && !FRAME_WINDOW_P (f
)
16464 && !WINDOW_FULL_WIDTH_P (w
))
16465 /* Line number to display. */
16466 || w
->base_line_pos
> 0
16467 /* Column number is displayed and different from the one displayed. */
16468 || (w
->column_number_displayed
!= -1
16469 && (w
->column_number_displayed
!= current_column ())))
16470 /* This means that the window has a mode line. */
16471 && (WINDOW_WANTS_MODELINE_P (w
)
16472 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16475 display_mode_lines (w
);
16477 /* If mode line height has changed, arrange for a thorough
16478 immediate redisplay using the correct mode line height. */
16479 if (WINDOW_WANTS_MODELINE_P (w
)
16480 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16482 f
->fonts_changed
= 1;
16483 w
->mode_line_height
= -1;
16484 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16485 = DESIRED_MODE_LINE_HEIGHT (w
);
16488 /* If header line height has changed, arrange for a thorough
16489 immediate redisplay using the correct header line height. */
16490 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16491 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16493 f
->fonts_changed
= 1;
16494 w
->header_line_height
= -1;
16495 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16496 = DESIRED_HEADER_LINE_HEIGHT (w
);
16499 if (f
->fonts_changed
)
16500 goto need_larger_matrices
;
16503 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16505 w
->base_line_pos
= 0;
16506 w
->base_line_number
= 0;
16511 /* When we reach a frame's selected window, redo the frame's menu bar. */
16512 if (update_mode_line
16513 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16515 int redisplay_menu_p
= 0;
16517 if (FRAME_WINDOW_P (f
))
16519 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16520 || defined (HAVE_NS) || defined (USE_GTK)
16521 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16523 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16527 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16529 if (redisplay_menu_p
)
16530 display_menu_bar (w
);
16532 #ifdef HAVE_WINDOW_SYSTEM
16533 if (FRAME_WINDOW_P (f
))
16535 #if defined (USE_GTK) || defined (HAVE_NS)
16536 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16537 redisplay_tool_bar (f
);
16539 if (WINDOWP (f
->tool_bar_window
)
16540 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16541 || !NILP (Vauto_resize_tool_bars
))
16542 && redisplay_tool_bar (f
))
16543 ignore_mouse_drag_p
= 1;
16549 #ifdef HAVE_WINDOW_SYSTEM
16550 if (FRAME_WINDOW_P (f
)
16551 && update_window_fringes (w
, (just_this_one_p
16552 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16553 || w
->pseudo_window_p
)))
16557 if (draw_window_fringes (w
, 1))
16559 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16560 x_draw_right_divider (w
);
16562 x_draw_vertical_border (w
);
16568 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16569 x_draw_bottom_divider (w
);
16570 #endif /* HAVE_WINDOW_SYSTEM */
16572 /* We go to this label, with fonts_changed set, if it is
16573 necessary to try again using larger glyph matrices.
16574 We have to redeem the scroll bar even in this case,
16575 because the loop in redisplay_internal expects that. */
16576 need_larger_matrices
:
16578 finish_scroll_bars
:
16580 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16582 /* Set the thumb's position and size. */
16583 set_vertical_scroll_bar (w
);
16585 /* Note that we actually used the scroll bar attached to this
16586 window, so it shouldn't be deleted at the end of redisplay. */
16587 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16588 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16591 /* Restore current_buffer and value of point in it. The window
16592 update may have changed the buffer, so first make sure `opoint'
16593 is still valid (Bug#6177). */
16594 if (CHARPOS (opoint
) < BEGV
)
16595 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16596 else if (CHARPOS (opoint
) > ZV
)
16597 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16599 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16601 set_buffer_internal_1 (old
);
16602 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16603 shorter. This can be caused by log truncation in *Messages*. */
16604 if (CHARPOS (lpoint
) <= ZV
)
16605 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16607 unbind_to (count
, Qnil
);
16611 /* Build the complete desired matrix of WINDOW with a window start
16612 buffer position POS.
16614 Value is 1 if successful. It is zero if fonts were loaded during
16615 redisplay which makes re-adjusting glyph matrices necessary, and -1
16616 if point would appear in the scroll margins.
16617 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16618 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16622 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16624 struct window
*w
= XWINDOW (window
);
16626 struct glyph_row
*last_text_row
= NULL
;
16627 struct frame
*f
= XFRAME (w
->frame
);
16628 int frame_line_height
= default_line_pixel_height (w
);
16630 /* Make POS the new window start. */
16631 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16633 /* Mark cursor position as unknown. No overlay arrow seen. */
16634 w
->cursor
.vpos
= -1;
16635 overlay_arrow_seen
= 0;
16637 /* Initialize iterator and info to start at POS. */
16638 start_display (&it
, w
, pos
);
16640 /* Display all lines of W. */
16641 while (it
.current_y
< it
.last_visible_y
)
16643 if (display_line (&it
))
16644 last_text_row
= it
.glyph_row
- 1;
16645 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16649 /* Don't let the cursor end in the scroll margins. */
16650 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16651 && !MINI_WINDOW_P (w
))
16653 int this_scroll_margin
;
16654 int window_total_lines
16655 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16657 if (scroll_margin
> 0)
16659 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16660 this_scroll_margin
*= frame_line_height
;
16663 this_scroll_margin
= 0;
16665 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16666 && w
->cursor
.y
< this_scroll_margin
16667 && CHARPOS (pos
) > BEGV
16668 && IT_CHARPOS (it
) < ZV
)
16669 /* rms: considering make_cursor_line_fully_visible_p here
16670 seems to give wrong results. We don't want to recenter
16671 when the last line is partly visible, we want to allow
16672 that case to be handled in the usual way. */
16673 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16675 w
->cursor
.vpos
= -1;
16676 clear_glyph_matrix (w
->desired_matrix
);
16681 /* If bottom moved off end of frame, change mode line percentage. */
16682 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16683 w
->update_mode_line
= 1;
16685 /* Set window_end_pos to the offset of the last character displayed
16686 on the window from the end of current_buffer. Set
16687 window_end_vpos to its row number. */
16690 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16691 adjust_window_ends (w
, last_text_row
, 0);
16693 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16694 w
->window_end_vpos
)));
16698 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16699 w
->window_end_pos
= Z
- ZV
;
16700 w
->window_end_vpos
= 0;
16703 /* But that is not valid info until redisplay finishes. */
16704 w
->window_end_valid
= 0;
16710 /************************************************************************
16711 Window redisplay reusing current matrix when buffer has not changed
16712 ************************************************************************/
16714 /* Try redisplay of window W showing an unchanged buffer with a
16715 different window start than the last time it was displayed by
16716 reusing its current matrix. Value is non-zero if successful.
16717 W->start is the new window start. */
16720 try_window_reusing_current_matrix (struct window
*w
)
16722 struct frame
*f
= XFRAME (w
->frame
);
16723 struct glyph_row
*bottom_row
;
16726 struct text_pos start
, new_start
;
16727 int nrows_scrolled
, i
;
16728 struct glyph_row
*last_text_row
;
16729 struct glyph_row
*last_reused_text_row
;
16730 struct glyph_row
*start_row
;
16731 int start_vpos
, min_y
, max_y
;
16734 if (inhibit_try_window_reusing
)
16738 if (/* This function doesn't handle terminal frames. */
16739 !FRAME_WINDOW_P (f
)
16740 /* Don't try to reuse the display if windows have been split
16742 || windows_or_buffers_changed
16743 || f
->cursor_type_changed
)
16746 /* Can't do this if showing trailing whitespace. */
16747 if (!NILP (Vshow_trailing_whitespace
))
16750 /* If top-line visibility has changed, give up. */
16751 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16752 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16755 /* Give up if old or new display is scrolled vertically. We could
16756 make this function handle this, but right now it doesn't. */
16757 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16758 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16761 /* The variable new_start now holds the new window start. The old
16762 start `start' can be determined from the current matrix. */
16763 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16764 start
= start_row
->minpos
;
16765 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16767 /* Clear the desired matrix for the display below. */
16768 clear_glyph_matrix (w
->desired_matrix
);
16770 if (CHARPOS (new_start
) <= CHARPOS (start
))
16772 /* Don't use this method if the display starts with an ellipsis
16773 displayed for invisible text. It's not easy to handle that case
16774 below, and it's certainly not worth the effort since this is
16775 not a frequent case. */
16776 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16779 IF_DEBUG (debug_method_add (w
, "twu1"));
16781 /* Display up to a row that can be reused. The variable
16782 last_text_row is set to the last row displayed that displays
16783 text. Note that it.vpos == 0 if or if not there is a
16784 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16785 start_display (&it
, w
, new_start
);
16786 w
->cursor
.vpos
= -1;
16787 last_text_row
= last_reused_text_row
= NULL
;
16789 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16791 /* If we have reached into the characters in the START row,
16792 that means the line boundaries have changed. So we
16793 can't start copying with the row START. Maybe it will
16794 work to start copying with the following row. */
16795 while (IT_CHARPOS (it
) > CHARPOS (start
))
16797 /* Advance to the next row as the "start". */
16799 start
= start_row
->minpos
;
16800 /* If there are no more rows to try, or just one, give up. */
16801 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16802 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16803 || CHARPOS (start
) == ZV
)
16805 clear_glyph_matrix (w
->desired_matrix
);
16809 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16811 /* If we have reached alignment, we can copy the rest of the
16813 if (IT_CHARPOS (it
) == CHARPOS (start
)
16814 /* Don't accept "alignment" inside a display vector,
16815 since start_row could have started in the middle of
16816 that same display vector (thus their character
16817 positions match), and we have no way of telling if
16818 that is the case. */
16819 && it
.current
.dpvec_index
< 0)
16822 if (display_line (&it
))
16823 last_text_row
= it
.glyph_row
- 1;
16827 /* A value of current_y < last_visible_y means that we stopped
16828 at the previous window start, which in turn means that we
16829 have at least one reusable row. */
16830 if (it
.current_y
< it
.last_visible_y
)
16832 struct glyph_row
*row
;
16834 /* IT.vpos always starts from 0; it counts text lines. */
16835 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16837 /* Find PT if not already found in the lines displayed. */
16838 if (w
->cursor
.vpos
< 0)
16840 int dy
= it
.current_y
- start_row
->y
;
16842 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16843 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16845 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16846 dy
, nrows_scrolled
);
16849 clear_glyph_matrix (w
->desired_matrix
);
16854 /* Scroll the display. Do it before the current matrix is
16855 changed. The problem here is that update has not yet
16856 run, i.e. part of the current matrix is not up to date.
16857 scroll_run_hook will clear the cursor, and use the
16858 current matrix to get the height of the row the cursor is
16860 run
.current_y
= start_row
->y
;
16861 run
.desired_y
= it
.current_y
;
16862 run
.height
= it
.last_visible_y
- it
.current_y
;
16864 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16867 FRAME_RIF (f
)->update_window_begin_hook (w
);
16868 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16869 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16870 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16874 /* Shift current matrix down by nrows_scrolled lines. */
16875 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16876 rotate_matrix (w
->current_matrix
,
16878 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16881 /* Disable lines that must be updated. */
16882 for (i
= 0; i
< nrows_scrolled
; ++i
)
16883 (start_row
+ i
)->enabled_p
= false;
16885 /* Re-compute Y positions. */
16886 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16887 max_y
= it
.last_visible_y
;
16888 for (row
= start_row
+ nrows_scrolled
;
16892 row
->y
= it
.current_y
;
16893 row
->visible_height
= row
->height
;
16895 if (row
->y
< min_y
)
16896 row
->visible_height
-= min_y
- row
->y
;
16897 if (row
->y
+ row
->height
> max_y
)
16898 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16899 if (row
->fringe_bitmap_periodic_p
)
16900 row
->redraw_fringe_bitmaps_p
= 1;
16902 it
.current_y
+= row
->height
;
16904 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16905 last_reused_text_row
= row
;
16906 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16910 /* Disable lines in the current matrix which are now
16911 below the window. */
16912 for (++row
; row
< bottom_row
; ++row
)
16913 row
->enabled_p
= row
->mode_line_p
= 0;
16916 /* Update window_end_pos etc.; last_reused_text_row is the last
16917 reused row from the current matrix containing text, if any.
16918 The value of last_text_row is the last displayed line
16919 containing text. */
16920 if (last_reused_text_row
)
16921 adjust_window_ends (w
, last_reused_text_row
, 1);
16922 else if (last_text_row
)
16923 adjust_window_ends (w
, last_text_row
, 0);
16926 /* This window must be completely empty. */
16927 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16928 w
->window_end_pos
= Z
- ZV
;
16929 w
->window_end_vpos
= 0;
16931 w
->window_end_valid
= 0;
16933 /* Update hint: don't try scrolling again in update_window. */
16934 w
->desired_matrix
->no_scrolling_p
= 1;
16937 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16941 else if (CHARPOS (new_start
) > CHARPOS (start
))
16943 struct glyph_row
*pt_row
, *row
;
16944 struct glyph_row
*first_reusable_row
;
16945 struct glyph_row
*first_row_to_display
;
16947 int yb
= window_text_bottom_y (w
);
16949 /* Find the row starting at new_start, if there is one. Don't
16950 reuse a partially visible line at the end. */
16951 first_reusable_row
= start_row
;
16952 while (first_reusable_row
->enabled_p
16953 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16954 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16955 < CHARPOS (new_start
)))
16956 ++first_reusable_row
;
16958 /* Give up if there is no row to reuse. */
16959 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16960 || !first_reusable_row
->enabled_p
16961 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16962 != CHARPOS (new_start
)))
16965 /* We can reuse fully visible rows beginning with
16966 first_reusable_row to the end of the window. Set
16967 first_row_to_display to the first row that cannot be reused.
16968 Set pt_row to the row containing point, if there is any. */
16970 for (first_row_to_display
= first_reusable_row
;
16971 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16972 ++first_row_to_display
)
16974 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16975 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16976 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16977 && first_row_to_display
->ends_at_zv_p
16978 && pt_row
== NULL
)))
16979 pt_row
= first_row_to_display
;
16982 /* Start displaying at the start of first_row_to_display. */
16983 eassert (first_row_to_display
->y
< yb
);
16984 init_to_row_start (&it
, w
, first_row_to_display
);
16986 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16988 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16990 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16991 + WINDOW_HEADER_LINE_HEIGHT (w
));
16993 /* Display lines beginning with first_row_to_display in the
16994 desired matrix. Set last_text_row to the last row displayed
16995 that displays text. */
16996 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16997 if (pt_row
== NULL
)
16998 w
->cursor
.vpos
= -1;
16999 last_text_row
= NULL
;
17000 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17001 if (display_line (&it
))
17002 last_text_row
= it
.glyph_row
- 1;
17004 /* If point is in a reused row, adjust y and vpos of the cursor
17008 w
->cursor
.vpos
-= nrows_scrolled
;
17009 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17012 /* Give up if point isn't in a row displayed or reused. (This
17013 also handles the case where w->cursor.vpos < nrows_scrolled
17014 after the calls to display_line, which can happen with scroll
17015 margins. See bug#1295.) */
17016 if (w
->cursor
.vpos
< 0)
17018 clear_glyph_matrix (w
->desired_matrix
);
17022 /* Scroll the display. */
17023 run
.current_y
= first_reusable_row
->y
;
17024 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17025 run
.height
= it
.last_visible_y
- run
.current_y
;
17026 dy
= run
.current_y
- run
.desired_y
;
17031 FRAME_RIF (f
)->update_window_begin_hook (w
);
17032 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17033 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17034 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17038 /* Adjust Y positions of reused rows. */
17039 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17040 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17041 max_y
= it
.last_visible_y
;
17042 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17045 row
->visible_height
= row
->height
;
17046 if (row
->y
< min_y
)
17047 row
->visible_height
-= min_y
- row
->y
;
17048 if (row
->y
+ row
->height
> max_y
)
17049 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17050 if (row
->fringe_bitmap_periodic_p
)
17051 row
->redraw_fringe_bitmaps_p
= 1;
17054 /* Scroll the current matrix. */
17055 eassert (nrows_scrolled
> 0);
17056 rotate_matrix (w
->current_matrix
,
17058 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17061 /* Disable rows not reused. */
17062 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17063 row
->enabled_p
= false;
17065 /* Point may have moved to a different line, so we cannot assume that
17066 the previous cursor position is valid; locate the correct row. */
17069 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17071 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17072 && !row
->ends_at_zv_p
;
17076 w
->cursor
.y
= row
->y
;
17078 if (row
< bottom_row
)
17080 /* Can't simply scan the row for point with
17081 bidi-reordered glyph rows. Let set_cursor_from_row
17082 figure out where to put the cursor, and if it fails,
17084 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17086 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17089 clear_glyph_matrix (w
->desired_matrix
);
17095 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17096 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17099 && (!BUFFERP (glyph
->object
)
17100 || glyph
->charpos
< PT
);
17104 w
->cursor
.x
+= glyph
->pixel_width
;
17110 /* Adjust window end. A null value of last_text_row means that
17111 the window end is in reused rows which in turn means that
17112 only its vpos can have changed. */
17114 adjust_window_ends (w
, last_text_row
, 0);
17116 w
->window_end_vpos
-= nrows_scrolled
;
17118 w
->window_end_valid
= 0;
17119 w
->desired_matrix
->no_scrolling_p
= 1;
17122 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17132 /************************************************************************
17133 Window redisplay reusing current matrix when buffer has changed
17134 ************************************************************************/
17136 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17137 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17138 ptrdiff_t *, ptrdiff_t *);
17139 static struct glyph_row
*
17140 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17141 struct glyph_row
*);
17144 /* Return the last row in MATRIX displaying text. If row START is
17145 non-null, start searching with that row. IT gives the dimensions
17146 of the display. Value is null if matrix is empty; otherwise it is
17147 a pointer to the row found. */
17149 static struct glyph_row
*
17150 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17151 struct glyph_row
*start
)
17153 struct glyph_row
*row
, *row_found
;
17155 /* Set row_found to the last row in IT->w's current matrix
17156 displaying text. The loop looks funny but think of partially
17159 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17160 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17162 eassert (row
->enabled_p
);
17164 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17173 /* Return the last row in the current matrix of W that is not affected
17174 by changes at the start of current_buffer that occurred since W's
17175 current matrix was built. Value is null if no such row exists.
17177 BEG_UNCHANGED us the number of characters unchanged at the start of
17178 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17179 first changed character in current_buffer. Characters at positions <
17180 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17181 when the current matrix was built. */
17183 static struct glyph_row
*
17184 find_last_unchanged_at_beg_row (struct window
*w
)
17186 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17187 struct glyph_row
*row
;
17188 struct glyph_row
*row_found
= NULL
;
17189 int yb
= window_text_bottom_y (w
);
17191 /* Find the last row displaying unchanged text. */
17192 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17193 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17194 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17197 if (/* If row ends before first_changed_pos, it is unchanged,
17198 except in some case. */
17199 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17200 /* When row ends in ZV and we write at ZV it is not
17202 && !row
->ends_at_zv_p
17203 /* When first_changed_pos is the end of a continued line,
17204 row is not unchanged because it may be no longer
17206 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17207 && (row
->continued_p
17208 || row
->exact_window_width_line_p
))
17209 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17210 needs to be recomputed, so don't consider this row as
17211 unchanged. This happens when the last line was
17212 bidi-reordered and was killed immediately before this
17213 redisplay cycle. In that case, ROW->end stores the
17214 buffer position of the first visual-order character of
17215 the killed text, which is now beyond ZV. */
17216 && CHARPOS (row
->end
.pos
) <= ZV
)
17219 /* Stop if last visible row. */
17220 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17228 /* Find the first glyph row in the current matrix of W that is not
17229 affected by changes at the end of current_buffer since the
17230 time W's current matrix was built.
17232 Return in *DELTA the number of chars by which buffer positions in
17233 unchanged text at the end of current_buffer must be adjusted.
17235 Return in *DELTA_BYTES the corresponding number of bytes.
17237 Value is null if no such row exists, i.e. all rows are affected by
17240 static struct glyph_row
*
17241 find_first_unchanged_at_end_row (struct window
*w
,
17242 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17244 struct glyph_row
*row
;
17245 struct glyph_row
*row_found
= NULL
;
17247 *delta
= *delta_bytes
= 0;
17249 /* Display must not have been paused, otherwise the current matrix
17250 is not up to date. */
17251 eassert (w
->window_end_valid
);
17253 /* A value of window_end_pos >= END_UNCHANGED means that the window
17254 end is in the range of changed text. If so, there is no
17255 unchanged row at the end of W's current matrix. */
17256 if (w
->window_end_pos
>= END_UNCHANGED
)
17259 /* Set row to the last row in W's current matrix displaying text. */
17260 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17262 /* If matrix is entirely empty, no unchanged row exists. */
17263 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17265 /* The value of row is the last glyph row in the matrix having a
17266 meaningful buffer position in it. The end position of row
17267 corresponds to window_end_pos. This allows us to translate
17268 buffer positions in the current matrix to current buffer
17269 positions for characters not in changed text. */
17271 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17272 ptrdiff_t Z_BYTE_old
=
17273 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17274 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17275 struct glyph_row
*first_text_row
17276 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17278 *delta
= Z
- Z_old
;
17279 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17281 /* Set last_unchanged_pos to the buffer position of the last
17282 character in the buffer that has not been changed. Z is the
17283 index + 1 of the last character in current_buffer, i.e. by
17284 subtracting END_UNCHANGED we get the index of the last
17285 unchanged character, and we have to add BEG to get its buffer
17287 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17288 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17290 /* Search backward from ROW for a row displaying a line that
17291 starts at a minimum position >= last_unchanged_pos_old. */
17292 for (; row
> first_text_row
; --row
)
17294 /* This used to abort, but it can happen.
17295 It is ok to just stop the search instead here. KFS. */
17296 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17299 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17304 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17310 /* Make sure that glyph rows in the current matrix of window W
17311 reference the same glyph memory as corresponding rows in the
17312 frame's frame matrix. This function is called after scrolling W's
17313 current matrix on a terminal frame in try_window_id and
17314 try_window_reusing_current_matrix. */
17317 sync_frame_with_window_matrix_rows (struct window
*w
)
17319 struct frame
*f
= XFRAME (w
->frame
);
17320 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17322 /* Preconditions: W must be a leaf window and full-width. Its frame
17323 must have a frame matrix. */
17324 eassert (BUFFERP (w
->contents
));
17325 eassert (WINDOW_FULL_WIDTH_P (w
));
17326 eassert (!FRAME_WINDOW_P (f
));
17328 /* If W is a full-width window, glyph pointers in W's current matrix
17329 have, by definition, to be the same as glyph pointers in the
17330 corresponding frame matrix. Note that frame matrices have no
17331 marginal areas (see build_frame_matrix). */
17332 window_row
= w
->current_matrix
->rows
;
17333 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17334 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17335 while (window_row
< window_row_end
)
17337 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17338 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17340 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17341 frame_row
->glyphs
[TEXT_AREA
] = start
;
17342 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17343 frame_row
->glyphs
[LAST_AREA
] = end
;
17345 /* Disable frame rows whose corresponding window rows have
17346 been disabled in try_window_id. */
17347 if (!window_row
->enabled_p
)
17348 frame_row
->enabled_p
= false;
17350 ++window_row
, ++frame_row
;
17355 /* Find the glyph row in window W containing CHARPOS. Consider all
17356 rows between START and END (not inclusive). END null means search
17357 all rows to the end of the display area of W. Value is the row
17358 containing CHARPOS or null. */
17361 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17362 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17364 struct glyph_row
*row
= start
;
17365 struct glyph_row
*best_row
= NULL
;
17366 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17369 /* If we happen to start on a header-line, skip that. */
17370 if (row
->mode_line_p
)
17373 if ((end
&& row
>= end
) || !row
->enabled_p
)
17376 last_y
= window_text_bottom_y (w
) - dy
;
17380 /* Give up if we have gone too far. */
17381 if (end
&& row
>= end
)
17383 /* This formerly returned if they were equal.
17384 I think that both quantities are of a "last plus one" type;
17385 if so, when they are equal, the row is within the screen. -- rms. */
17386 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17389 /* If it is in this row, return this row. */
17390 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17391 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17392 /* The end position of a row equals the start
17393 position of the next row. If CHARPOS is there, we
17394 would rather consider it displayed in the next
17395 line, except when this line ends in ZV. */
17396 && !row_for_charpos_p (row
, charpos
)))
17397 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17401 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17402 || (!best_row
&& !row
->continued_p
))
17404 /* In bidi-reordered rows, there could be several rows whose
17405 edges surround CHARPOS, all of these rows belonging to
17406 the same continued line. We need to find the row which
17407 fits CHARPOS the best. */
17408 for (g
= row
->glyphs
[TEXT_AREA
];
17409 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17412 if (!STRINGP (g
->object
))
17414 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17416 mindif
= eabs (g
->charpos
- charpos
);
17418 /* Exact match always wins. */
17425 else if (best_row
&& !row
->continued_p
)
17432 /* Try to redisplay window W by reusing its existing display. W's
17433 current matrix must be up to date when this function is called,
17434 i.e. window_end_valid must be nonzero.
17438 >= 1 if successful, i.e. display has been updated
17440 1 means the changes were in front of a newline that precedes
17441 the window start, and the whole current matrix was reused
17442 2 means the changes were after the last position displayed
17443 in the window, and the whole current matrix was reused
17444 3 means portions of the current matrix were reused, while
17445 some of the screen lines were redrawn
17446 -1 if redisplay with same window start is known not to succeed
17447 0 if otherwise unsuccessful
17449 The following steps are performed:
17451 1. Find the last row in the current matrix of W that is not
17452 affected by changes at the start of current_buffer. If no such row
17455 2. Find the first row in W's current matrix that is not affected by
17456 changes at the end of current_buffer. Maybe there is no such row.
17458 3. Display lines beginning with the row + 1 found in step 1 to the
17459 row found in step 2 or, if step 2 didn't find a row, to the end of
17462 4. If cursor is not known to appear on the window, give up.
17464 5. If display stopped at the row found in step 2, scroll the
17465 display and current matrix as needed.
17467 6. Maybe display some lines at the end of W, if we must. This can
17468 happen under various circumstances, like a partially visible line
17469 becoming fully visible, or because newly displayed lines are displayed
17470 in smaller font sizes.
17472 7. Update W's window end information. */
17475 try_window_id (struct window
*w
)
17477 struct frame
*f
= XFRAME (w
->frame
);
17478 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17479 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17480 struct glyph_row
*last_unchanged_at_beg_row
;
17481 struct glyph_row
*first_unchanged_at_end_row
;
17482 struct glyph_row
*row
;
17483 struct glyph_row
*bottom_row
;
17486 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17488 struct text_pos start_pos
;
17490 int first_unchanged_at_end_vpos
= 0;
17491 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17492 struct text_pos start
;
17493 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17496 if (inhibit_try_window_id
)
17500 /* This is handy for debugging. */
17502 #define GIVE_UP(X) \
17504 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17508 #define GIVE_UP(X) return 0
17511 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17513 /* Don't use this for mini-windows because these can show
17514 messages and mini-buffers, and we don't handle that here. */
17515 if (MINI_WINDOW_P (w
))
17518 /* This flag is used to prevent redisplay optimizations. */
17519 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17522 /* This function's optimizations cannot be used if overlays have
17523 changed in the buffer displayed by the window, so give up if they
17525 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17528 /* Verify that narrowing has not changed.
17529 Also verify that we were not told to prevent redisplay optimizations.
17530 It would be nice to further
17531 reduce the number of cases where this prevents try_window_id. */
17532 if (current_buffer
->clip_changed
17533 || current_buffer
->prevent_redisplay_optimizations_p
)
17536 /* Window must either use window-based redisplay or be full width. */
17537 if (!FRAME_WINDOW_P (f
)
17538 && (!FRAME_LINE_INS_DEL_OK (f
)
17539 || !WINDOW_FULL_WIDTH_P (w
)))
17542 /* Give up if point is known NOT to appear in W. */
17543 if (PT
< CHARPOS (start
))
17546 /* Another way to prevent redisplay optimizations. */
17547 if (w
->last_modified
== 0)
17550 /* Verify that window is not hscrolled. */
17551 if (w
->hscroll
!= 0)
17554 /* Verify that display wasn't paused. */
17555 if (!w
->window_end_valid
)
17558 /* Likewise if highlighting trailing whitespace. */
17559 if (!NILP (Vshow_trailing_whitespace
))
17562 /* Can't use this if overlay arrow position and/or string have
17564 if (overlay_arrows_changed_p ())
17567 /* When word-wrap is on, adding a space to the first word of a
17568 wrapped line can change the wrap position, altering the line
17569 above it. It might be worthwhile to handle this more
17570 intelligently, but for now just redisplay from scratch. */
17571 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17574 /* Under bidi reordering, adding or deleting a character in the
17575 beginning of a paragraph, before the first strong directional
17576 character, can change the base direction of the paragraph (unless
17577 the buffer specifies a fixed paragraph direction), which will
17578 require to redisplay the whole paragraph. It might be worthwhile
17579 to find the paragraph limits and widen the range of redisplayed
17580 lines to that, but for now just give up this optimization and
17581 redisplay from scratch. */
17582 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17583 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17586 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17587 only if buffer has really changed. The reason is that the gap is
17588 initially at Z for freshly visited files. The code below would
17589 set end_unchanged to 0 in that case. */
17590 if (MODIFF
> SAVE_MODIFF
17591 /* This seems to happen sometimes after saving a buffer. */
17592 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17594 if (GPT
- BEG
< BEG_UNCHANGED
)
17595 BEG_UNCHANGED
= GPT
- BEG
;
17596 if (Z
- GPT
< END_UNCHANGED
)
17597 END_UNCHANGED
= Z
- GPT
;
17600 /* The position of the first and last character that has been changed. */
17601 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17602 last_changed_charpos
= Z
- END_UNCHANGED
;
17604 /* If window starts after a line end, and the last change is in
17605 front of that newline, then changes don't affect the display.
17606 This case happens with stealth-fontification. Note that although
17607 the display is unchanged, glyph positions in the matrix have to
17608 be adjusted, of course. */
17609 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17610 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17611 && ((last_changed_charpos
< CHARPOS (start
)
17612 && CHARPOS (start
) == BEGV
)
17613 || (last_changed_charpos
< CHARPOS (start
) - 1
17614 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17616 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17617 struct glyph_row
*r0
;
17619 /* Compute how many chars/bytes have been added to or removed
17620 from the buffer. */
17621 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17622 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17623 Z_delta
= Z
- Z_old
;
17624 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17626 /* Give up if PT is not in the window. Note that it already has
17627 been checked at the start of try_window_id that PT is not in
17628 front of the window start. */
17629 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17632 /* If window start is unchanged, we can reuse the whole matrix
17633 as is, after adjusting glyph positions. No need to compute
17634 the window end again, since its offset from Z hasn't changed. */
17635 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17636 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17637 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17638 /* PT must not be in a partially visible line. */
17639 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17640 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17642 /* Adjust positions in the glyph matrix. */
17643 if (Z_delta
|| Z_delta_bytes
)
17645 struct glyph_row
*r1
17646 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17647 increment_matrix_positions (w
->current_matrix
,
17648 MATRIX_ROW_VPOS (r0
, current_matrix
),
17649 MATRIX_ROW_VPOS (r1
, current_matrix
),
17650 Z_delta
, Z_delta_bytes
);
17653 /* Set the cursor. */
17654 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17656 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17661 /* Handle the case that changes are all below what is displayed in
17662 the window, and that PT is in the window. This shortcut cannot
17663 be taken if ZV is visible in the window, and text has been added
17664 there that is visible in the window. */
17665 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17666 /* ZV is not visible in the window, or there are no
17667 changes at ZV, actually. */
17668 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17669 || first_changed_charpos
== last_changed_charpos
))
17671 struct glyph_row
*r0
;
17673 /* Give up if PT is not in the window. Note that it already has
17674 been checked at the start of try_window_id that PT is not in
17675 front of the window start. */
17676 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17679 /* If window start is unchanged, we can reuse the whole matrix
17680 as is, without changing glyph positions since no text has
17681 been added/removed in front of the window end. */
17682 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17683 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17684 /* PT must not be in a partially visible line. */
17685 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17686 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17688 /* We have to compute the window end anew since text
17689 could have been added/removed after it. */
17690 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17691 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17693 /* Set the cursor. */
17694 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17696 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17701 /* Give up if window start is in the changed area.
17703 The condition used to read
17705 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17707 but why that was tested escapes me at the moment. */
17708 if (CHARPOS (start
) >= first_changed_charpos
17709 && CHARPOS (start
) <= last_changed_charpos
)
17712 /* Check that window start agrees with the start of the first glyph
17713 row in its current matrix. Check this after we know the window
17714 start is not in changed text, otherwise positions would not be
17716 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17717 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17720 /* Give up if the window ends in strings. Overlay strings
17721 at the end are difficult to handle, so don't try. */
17722 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17723 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17726 /* Compute the position at which we have to start displaying new
17727 lines. Some of the lines at the top of the window might be
17728 reusable because they are not displaying changed text. Find the
17729 last row in W's current matrix not affected by changes at the
17730 start of current_buffer. Value is null if changes start in the
17731 first line of window. */
17732 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17733 if (last_unchanged_at_beg_row
)
17735 /* Avoid starting to display in the middle of a character, a TAB
17736 for instance. This is easier than to set up the iterator
17737 exactly, and it's not a frequent case, so the additional
17738 effort wouldn't really pay off. */
17739 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17740 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17741 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17742 --last_unchanged_at_beg_row
;
17744 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17747 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17749 start_pos
= it
.current
.pos
;
17751 /* Start displaying new lines in the desired matrix at the same
17752 vpos we would use in the current matrix, i.e. below
17753 last_unchanged_at_beg_row. */
17754 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17756 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17757 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17759 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17763 /* There are no reusable lines at the start of the window.
17764 Start displaying in the first text line. */
17765 start_display (&it
, w
, start
);
17766 it
.vpos
= it
.first_vpos
;
17767 start_pos
= it
.current
.pos
;
17770 /* Find the first row that is not affected by changes at the end of
17771 the buffer. Value will be null if there is no unchanged row, in
17772 which case we must redisplay to the end of the window. delta
17773 will be set to the value by which buffer positions beginning with
17774 first_unchanged_at_end_row have to be adjusted due to text
17776 first_unchanged_at_end_row
17777 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17778 IF_DEBUG (debug_delta
= delta
);
17779 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17781 /* Set stop_pos to the buffer position up to which we will have to
17782 display new lines. If first_unchanged_at_end_row != NULL, this
17783 is the buffer position of the start of the line displayed in that
17784 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17785 that we don't stop at a buffer position. */
17787 if (first_unchanged_at_end_row
)
17789 eassert (last_unchanged_at_beg_row
== NULL
17790 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17792 /* If this is a continuation line, move forward to the next one
17793 that isn't. Changes in lines above affect this line.
17794 Caution: this may move first_unchanged_at_end_row to a row
17795 not displaying text. */
17796 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17797 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17798 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17799 < it
.last_visible_y
))
17800 ++first_unchanged_at_end_row
;
17802 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17803 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17804 >= it
.last_visible_y
))
17805 first_unchanged_at_end_row
= NULL
;
17808 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17810 first_unchanged_at_end_vpos
17811 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17812 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17815 else if (last_unchanged_at_beg_row
== NULL
)
17821 /* Either there is no unchanged row at the end, or the one we have
17822 now displays text. This is a necessary condition for the window
17823 end pos calculation at the end of this function. */
17824 eassert (first_unchanged_at_end_row
== NULL
17825 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17827 debug_last_unchanged_at_beg_vpos
17828 = (last_unchanged_at_beg_row
17829 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17831 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17833 #endif /* GLYPH_DEBUG */
17836 /* Display new lines. Set last_text_row to the last new line
17837 displayed which has text on it, i.e. might end up as being the
17838 line where the window_end_vpos is. */
17839 w
->cursor
.vpos
= -1;
17840 last_text_row
= NULL
;
17841 overlay_arrow_seen
= 0;
17842 while (it
.current_y
< it
.last_visible_y
17843 && !f
->fonts_changed
17844 && (first_unchanged_at_end_row
== NULL
17845 || IT_CHARPOS (it
) < stop_pos
))
17847 if (display_line (&it
))
17848 last_text_row
= it
.glyph_row
- 1;
17851 if (f
->fonts_changed
)
17855 /* Compute differences in buffer positions, y-positions etc. for
17856 lines reused at the bottom of the window. Compute what we can
17858 if (first_unchanged_at_end_row
17859 /* No lines reused because we displayed everything up to the
17860 bottom of the window. */
17861 && it
.current_y
< it
.last_visible_y
)
17864 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17866 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17867 run
.current_y
= first_unchanged_at_end_row
->y
;
17868 run
.desired_y
= run
.current_y
+ dy
;
17869 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17873 delta
= delta_bytes
= dvpos
= dy
17874 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17875 first_unchanged_at_end_row
= NULL
;
17877 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
17880 /* Find the cursor if not already found. We have to decide whether
17881 PT will appear on this window (it sometimes doesn't, but this is
17882 not a very frequent case.) This decision has to be made before
17883 the current matrix is altered. A value of cursor.vpos < 0 means
17884 that PT is either in one of the lines beginning at
17885 first_unchanged_at_end_row or below the window. Don't care for
17886 lines that might be displayed later at the window end; as
17887 mentioned, this is not a frequent case. */
17888 if (w
->cursor
.vpos
< 0)
17890 /* Cursor in unchanged rows at the top? */
17891 if (PT
< CHARPOS (start_pos
)
17892 && last_unchanged_at_beg_row
)
17894 row
= row_containing_pos (w
, PT
,
17895 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17896 last_unchanged_at_beg_row
+ 1, 0);
17898 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17901 /* Start from first_unchanged_at_end_row looking for PT. */
17902 else if (first_unchanged_at_end_row
)
17904 row
= row_containing_pos (w
, PT
- delta
,
17905 first_unchanged_at_end_row
, NULL
, 0);
17907 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17908 delta_bytes
, dy
, dvpos
);
17911 /* Give up if cursor was not found. */
17912 if (w
->cursor
.vpos
< 0)
17914 clear_glyph_matrix (w
->desired_matrix
);
17919 /* Don't let the cursor end in the scroll margins. */
17921 int this_scroll_margin
, cursor_height
;
17922 int frame_line_height
= default_line_pixel_height (w
);
17923 int window_total_lines
17924 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
17926 this_scroll_margin
=
17927 max (0, min (scroll_margin
, window_total_lines
/ 4));
17928 this_scroll_margin
*= frame_line_height
;
17929 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17931 if ((w
->cursor
.y
< this_scroll_margin
17932 && CHARPOS (start
) > BEGV
)
17933 /* Old redisplay didn't take scroll margin into account at the bottom,
17934 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17935 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17936 ? cursor_height
+ this_scroll_margin
17937 : 1)) > it
.last_visible_y
)
17939 w
->cursor
.vpos
= -1;
17940 clear_glyph_matrix (w
->desired_matrix
);
17945 /* Scroll the display. Do it before changing the current matrix so
17946 that xterm.c doesn't get confused about where the cursor glyph is
17948 if (dy
&& run
.height
)
17952 if (FRAME_WINDOW_P (f
))
17954 FRAME_RIF (f
)->update_window_begin_hook (w
);
17955 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17956 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17957 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17961 /* Terminal frame. In this case, dvpos gives the number of
17962 lines to scroll by; dvpos < 0 means scroll up. */
17964 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17965 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17966 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17967 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17968 + window_internal_height (w
));
17970 #if defined (HAVE_GPM) || defined (MSDOS)
17971 x_clear_window_mouse_face (w
);
17973 /* Perform the operation on the screen. */
17976 /* Scroll last_unchanged_at_beg_row to the end of the
17977 window down dvpos lines. */
17978 set_terminal_window (f
, end
);
17980 /* On dumb terminals delete dvpos lines at the end
17981 before inserting dvpos empty lines. */
17982 if (!FRAME_SCROLL_REGION_OK (f
))
17983 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17985 /* Insert dvpos empty lines in front of
17986 last_unchanged_at_beg_row. */
17987 ins_del_lines (f
, from
, dvpos
);
17989 else if (dvpos
< 0)
17991 /* Scroll up last_unchanged_at_beg_vpos to the end of
17992 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17993 set_terminal_window (f
, end
);
17995 /* Delete dvpos lines in front of
17996 last_unchanged_at_beg_vpos. ins_del_lines will set
17997 the cursor to the given vpos and emit |dvpos| delete
17999 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18001 /* On a dumb terminal insert dvpos empty lines at the
18003 if (!FRAME_SCROLL_REGION_OK (f
))
18004 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18007 set_terminal_window (f
, 0);
18013 /* Shift reused rows of the current matrix to the right position.
18014 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18016 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18017 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18020 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18021 bottom_vpos
, dvpos
);
18022 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18025 else if (dvpos
> 0)
18027 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18028 bottom_vpos
, dvpos
);
18029 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18030 first_unchanged_at_end_vpos
+ dvpos
);
18033 /* For frame-based redisplay, make sure that current frame and window
18034 matrix are in sync with respect to glyph memory. */
18035 if (!FRAME_WINDOW_P (f
))
18036 sync_frame_with_window_matrix_rows (w
);
18038 /* Adjust buffer positions in reused rows. */
18039 if (delta
|| delta_bytes
)
18040 increment_matrix_positions (current_matrix
,
18041 first_unchanged_at_end_vpos
+ dvpos
,
18042 bottom_vpos
, delta
, delta_bytes
);
18044 /* Adjust Y positions. */
18046 shift_glyph_matrix (w
, current_matrix
,
18047 first_unchanged_at_end_vpos
+ dvpos
,
18050 if (first_unchanged_at_end_row
)
18052 first_unchanged_at_end_row
+= dvpos
;
18053 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18054 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18055 first_unchanged_at_end_row
= NULL
;
18058 /* If scrolling up, there may be some lines to display at the end of
18060 last_text_row_at_end
= NULL
;
18063 /* Scrolling up can leave for example a partially visible line
18064 at the end of the window to be redisplayed. */
18065 /* Set last_row to the glyph row in the current matrix where the
18066 window end line is found. It has been moved up or down in
18067 the matrix by dvpos. */
18068 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18069 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18071 /* If last_row is the window end line, it should display text. */
18072 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18074 /* If window end line was partially visible before, begin
18075 displaying at that line. Otherwise begin displaying with the
18076 line following it. */
18077 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18079 init_to_row_start (&it
, w
, last_row
);
18080 it
.vpos
= last_vpos
;
18081 it
.current_y
= last_row
->y
;
18085 init_to_row_end (&it
, w
, last_row
);
18086 it
.vpos
= 1 + last_vpos
;
18087 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18091 /* We may start in a continuation line. If so, we have to
18092 get the right continuation_lines_width and current_x. */
18093 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18094 it
.hpos
= it
.current_x
= 0;
18096 /* Display the rest of the lines at the window end. */
18097 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18098 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18100 /* Is it always sure that the display agrees with lines in
18101 the current matrix? I don't think so, so we mark rows
18102 displayed invalid in the current matrix by setting their
18103 enabled_p flag to zero. */
18104 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18105 if (display_line (&it
))
18106 last_text_row_at_end
= it
.glyph_row
- 1;
18110 /* Update window_end_pos and window_end_vpos. */
18111 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18113 /* Window end line if one of the preserved rows from the current
18114 matrix. Set row to the last row displaying text in current
18115 matrix starting at first_unchanged_at_end_row, after
18117 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18118 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18119 first_unchanged_at_end_row
);
18120 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18121 adjust_window_ends (w
, row
, 1);
18122 eassert (w
->window_end_bytepos
>= 0);
18123 IF_DEBUG (debug_method_add (w
, "A"));
18125 else if (last_text_row_at_end
)
18127 adjust_window_ends (w
, last_text_row_at_end
, 0);
18128 eassert (w
->window_end_bytepos
>= 0);
18129 IF_DEBUG (debug_method_add (w
, "B"));
18131 else if (last_text_row
)
18133 /* We have displayed either to the end of the window or at the
18134 end of the window, i.e. the last row with text is to be found
18135 in the desired matrix. */
18136 adjust_window_ends (w
, last_text_row
, 0);
18137 eassert (w
->window_end_bytepos
>= 0);
18139 else if (first_unchanged_at_end_row
== NULL
18140 && last_text_row
== NULL
18141 && last_text_row_at_end
== NULL
)
18143 /* Displayed to end of window, but no line containing text was
18144 displayed. Lines were deleted at the end of the window. */
18145 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18146 int vpos
= w
->window_end_vpos
;
18147 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18148 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18151 row
== NULL
&& vpos
>= first_vpos
;
18152 --vpos
, --current_row
, --desired_row
)
18154 if (desired_row
->enabled_p
)
18156 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18159 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18163 eassert (row
!= NULL
);
18164 w
->window_end_vpos
= vpos
+ 1;
18165 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18166 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18167 eassert (w
->window_end_bytepos
>= 0);
18168 IF_DEBUG (debug_method_add (w
, "C"));
18173 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18174 debug_end_vpos
= w
->window_end_vpos
));
18176 /* Record that display has not been completed. */
18177 w
->window_end_valid
= 0;
18178 w
->desired_matrix
->no_scrolling_p
= 1;
18186 /***********************************************************************
18187 More debugging support
18188 ***********************************************************************/
18192 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18193 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18194 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18197 /* Dump the contents of glyph matrix MATRIX on stderr.
18199 GLYPHS 0 means don't show glyph contents.
18200 GLYPHS 1 means show glyphs in short form
18201 GLYPHS > 1 means show glyphs in long form. */
18204 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18207 for (i
= 0; i
< matrix
->nrows
; ++i
)
18208 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18212 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18213 the glyph row and area where the glyph comes from. */
18216 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18218 if (glyph
->type
== CHAR_GLYPH
18219 || glyph
->type
== GLYPHLESS_GLYPH
)
18222 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18223 glyph
- row
->glyphs
[TEXT_AREA
],
18224 (glyph
->type
== CHAR_GLYPH
18228 (BUFFERP (glyph
->object
)
18230 : (STRINGP (glyph
->object
)
18232 : (INTEGERP (glyph
->object
)
18235 glyph
->pixel_width
,
18237 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18241 glyph
->left_box_line_p
,
18242 glyph
->right_box_line_p
);
18244 else if (glyph
->type
== STRETCH_GLYPH
)
18247 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18248 glyph
- row
->glyphs
[TEXT_AREA
],
18251 (BUFFERP (glyph
->object
)
18253 : (STRINGP (glyph
->object
)
18255 : (INTEGERP (glyph
->object
)
18258 glyph
->pixel_width
,
18262 glyph
->left_box_line_p
,
18263 glyph
->right_box_line_p
);
18265 else if (glyph
->type
== IMAGE_GLYPH
)
18268 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18269 glyph
- row
->glyphs
[TEXT_AREA
],
18272 (BUFFERP (glyph
->object
)
18274 : (STRINGP (glyph
->object
)
18276 : (INTEGERP (glyph
->object
)
18279 glyph
->pixel_width
,
18283 glyph
->left_box_line_p
,
18284 glyph
->right_box_line_p
);
18286 else if (glyph
->type
== COMPOSITE_GLYPH
)
18289 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18290 glyph
- row
->glyphs
[TEXT_AREA
],
18293 (BUFFERP (glyph
->object
)
18295 : (STRINGP (glyph
->object
)
18297 : (INTEGERP (glyph
->object
)
18300 glyph
->pixel_width
,
18302 if (glyph
->u
.cmp
.automatic
)
18305 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18306 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18308 glyph
->left_box_line_p
,
18309 glyph
->right_box_line_p
);
18314 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18315 GLYPHS 0 means don't show glyph contents.
18316 GLYPHS 1 means show glyphs in short form
18317 GLYPHS > 1 means show glyphs in long form. */
18320 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18324 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18325 fprintf (stderr
, "==============================================================================\n");
18327 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18328 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18330 MATRIX_ROW_START_CHARPOS (row
),
18331 MATRIX_ROW_END_CHARPOS (row
),
18332 row
->used
[TEXT_AREA
],
18333 row
->contains_overlapping_glyphs_p
,
18335 row
->truncated_on_left_p
,
18336 row
->truncated_on_right_p
,
18338 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18339 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18342 row
->ends_in_middle_of_char_p
,
18343 row
->starts_in_middle_of_char_p
,
18349 row
->visible_height
,
18352 /* The next 3 lines should align to "Start" in the header. */
18353 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18354 row
->end
.overlay_string_index
,
18355 row
->continuation_lines_width
);
18356 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18357 CHARPOS (row
->start
.string_pos
),
18358 CHARPOS (row
->end
.string_pos
));
18359 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18360 row
->end
.dpvec_index
);
18367 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18369 struct glyph
*glyph
= row
->glyphs
[area
];
18370 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18372 /* Glyph for a line end in text. */
18373 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18376 if (glyph
< glyph_end
)
18377 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18379 for (; glyph
< glyph_end
; ++glyph
)
18380 dump_glyph (row
, glyph
, area
);
18383 else if (glyphs
== 1)
18387 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18389 char *s
= alloca (row
->used
[area
] + 4);
18392 for (i
= 0; i
< row
->used
[area
]; ++i
)
18394 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18395 if (i
== row
->used
[area
] - 1
18396 && area
== TEXT_AREA
18397 && INTEGERP (glyph
->object
)
18398 && glyph
->type
== CHAR_GLYPH
18399 && glyph
->u
.ch
== ' ')
18401 strcpy (&s
[i
], "[\\n]");
18404 else if (glyph
->type
== CHAR_GLYPH
18405 && glyph
->u
.ch
< 0x80
18406 && glyph
->u
.ch
>= ' ')
18407 s
[i
] = glyph
->u
.ch
;
18413 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18419 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18420 Sdump_glyph_matrix
, 0, 1, "p",
18421 doc
: /* Dump the current matrix of the selected window to stderr.
18422 Shows contents of glyph row structures. With non-nil
18423 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18424 glyphs in short form, otherwise show glyphs in long form. */)
18425 (Lisp_Object glyphs
)
18427 struct window
*w
= XWINDOW (selected_window
);
18428 struct buffer
*buffer
= XBUFFER (w
->contents
);
18430 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18431 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18432 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18433 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18434 fprintf (stderr
, "=============================================\n");
18435 dump_glyph_matrix (w
->current_matrix
,
18436 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18441 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18442 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18445 struct frame
*f
= XFRAME (selected_frame
);
18446 dump_glyph_matrix (f
->current_matrix
, 1);
18451 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18452 doc
: /* Dump glyph row ROW to stderr.
18453 GLYPH 0 means don't dump glyphs.
18454 GLYPH 1 means dump glyphs in short form.
18455 GLYPH > 1 or omitted means dump glyphs in long form. */)
18456 (Lisp_Object row
, Lisp_Object glyphs
)
18458 struct glyph_matrix
*matrix
;
18461 CHECK_NUMBER (row
);
18462 matrix
= XWINDOW (selected_window
)->current_matrix
;
18464 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18465 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18467 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18472 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18473 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18474 GLYPH 0 means don't dump glyphs.
18475 GLYPH 1 means dump glyphs in short form.
18476 GLYPH > 1 or omitted means dump glyphs in long form.
18478 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18480 (Lisp_Object row
, Lisp_Object glyphs
)
18482 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18483 struct frame
*sf
= SELECTED_FRAME ();
18484 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18487 CHECK_NUMBER (row
);
18489 if (vpos
>= 0 && vpos
< m
->nrows
)
18490 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18491 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18497 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18498 doc
: /* Toggle tracing of redisplay.
18499 With ARG, turn tracing on if and only if ARG is positive. */)
18503 trace_redisplay_p
= !trace_redisplay_p
;
18506 arg
= Fprefix_numeric_value (arg
);
18507 trace_redisplay_p
= XINT (arg
) > 0;
18514 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18515 doc
: /* Like `format', but print result to stderr.
18516 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18517 (ptrdiff_t nargs
, Lisp_Object
*args
)
18519 Lisp_Object s
= Fformat (nargs
, args
);
18520 fprintf (stderr
, "%s", SDATA (s
));
18524 #endif /* GLYPH_DEBUG */
18528 /***********************************************************************
18529 Building Desired Matrix Rows
18530 ***********************************************************************/
18532 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18533 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18535 static struct glyph_row
*
18536 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18538 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18539 struct buffer
*buffer
= XBUFFER (w
->contents
);
18540 struct buffer
*old
= current_buffer
;
18541 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18542 int arrow_len
= SCHARS (overlay_arrow_string
);
18543 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18544 const unsigned char *p
;
18547 int n_glyphs_before
;
18549 set_buffer_temp (buffer
);
18550 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18551 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18552 SET_TEXT_POS (it
.position
, 0, 0);
18554 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18556 while (p
< arrow_end
)
18558 Lisp_Object face
, ilisp
;
18560 /* Get the next character. */
18562 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18565 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18566 if (! ASCII_CHAR_P (it
.c
))
18567 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18571 /* Get its face. */
18572 ilisp
= make_number (p
- arrow_string
);
18573 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18574 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18576 /* Compute its width, get its glyphs. */
18577 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18578 SET_TEXT_POS (it
.position
, -1, -1);
18579 PRODUCE_GLYPHS (&it
);
18581 /* If this character doesn't fit any more in the line, we have
18582 to remove some glyphs. */
18583 if (it
.current_x
> it
.last_visible_x
)
18585 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18590 set_buffer_temp (old
);
18591 return it
.glyph_row
;
18595 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18596 glyphs to insert is determined by produce_special_glyphs. */
18599 insert_left_trunc_glyphs (struct it
*it
)
18601 struct it truncate_it
;
18602 struct glyph
*from
, *end
, *to
, *toend
;
18604 eassert (!FRAME_WINDOW_P (it
->f
)
18605 || (!it
->glyph_row
->reversed_p
18606 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18607 || (it
->glyph_row
->reversed_p
18608 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18610 /* Get the truncation glyphs. */
18612 truncate_it
.current_x
= 0;
18613 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18614 truncate_it
.glyph_row
= &scratch_glyph_row
;
18615 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18616 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18617 truncate_it
.object
= make_number (0);
18618 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18620 /* Overwrite glyphs from IT with truncation glyphs. */
18621 if (!it
->glyph_row
->reversed_p
)
18623 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18625 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18626 end
= from
+ tused
;
18627 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18628 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18629 if (FRAME_WINDOW_P (it
->f
))
18631 /* On GUI frames, when variable-size fonts are displayed,
18632 the truncation glyphs may need more pixels than the row's
18633 glyphs they overwrite. We overwrite more glyphs to free
18634 enough screen real estate, and enlarge the stretch glyph
18635 on the right (see display_line), if there is one, to
18636 preserve the screen position of the truncation glyphs on
18639 struct glyph
*g
= to
;
18642 /* The first glyph could be partially visible, in which case
18643 it->glyph_row->x will be negative. But we want the left
18644 truncation glyphs to be aligned at the left margin of the
18645 window, so we override the x coordinate at which the row
18647 it
->glyph_row
->x
= 0;
18648 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18650 w
+= g
->pixel_width
;
18653 if (g
- to
- tused
> 0)
18655 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18656 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18658 used
= it
->glyph_row
->used
[TEXT_AREA
];
18659 if (it
->glyph_row
->truncated_on_right_p
18660 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18661 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18664 int extra
= w
- it
->truncation_pixel_width
;
18666 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18673 /* There may be padding glyphs left over. Overwrite them too. */
18674 if (!FRAME_WINDOW_P (it
->f
))
18676 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18678 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18685 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18689 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18691 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18692 that back to front. */
18693 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18694 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18695 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18696 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18697 if (FRAME_WINDOW_P (it
->f
))
18700 struct glyph
*g
= to
;
18702 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18704 w
+= g
->pixel_width
;
18707 if (to
- g
- tused
> 0)
18709 if (it
->glyph_row
->truncated_on_right_p
18710 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18711 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18713 int extra
= w
- it
->truncation_pixel_width
;
18715 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18719 while (from
>= end
&& to
>= toend
)
18721 if (!FRAME_WINDOW_P (it
->f
))
18723 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18726 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18727 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18728 while (from
>= end
&& to
>= toend
)
18734 /* Need to free some room before prepending additional
18736 int move_by
= from
- end
+ 1;
18737 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18738 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18740 for ( ; g
>= g0
; g
--)
18742 while (from
>= end
)
18744 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18749 /* Compute the hash code for ROW. */
18751 row_hash (struct glyph_row
*row
)
18754 unsigned hashval
= 0;
18756 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18757 for (k
= 0; k
< row
->used
[area
]; ++k
)
18758 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18759 + row
->glyphs
[area
][k
].u
.val
18760 + row
->glyphs
[area
][k
].face_id
18761 + row
->glyphs
[area
][k
].padding_p
18762 + (row
->glyphs
[area
][k
].type
<< 2));
18767 /* Compute the pixel height and width of IT->glyph_row.
18769 Most of the time, ascent and height of a display line will be equal
18770 to the max_ascent and max_height values of the display iterator
18771 structure. This is not the case if
18773 1. We hit ZV without displaying anything. In this case, max_ascent
18774 and max_height will be zero.
18776 2. We have some glyphs that don't contribute to the line height.
18777 (The glyph row flag contributes_to_line_height_p is for future
18778 pixmap extensions).
18780 The first case is easily covered by using default values because in
18781 these cases, the line height does not really matter, except that it
18782 must not be zero. */
18785 compute_line_metrics (struct it
*it
)
18787 struct glyph_row
*row
= it
->glyph_row
;
18789 if (FRAME_WINDOW_P (it
->f
))
18791 int i
, min_y
, max_y
;
18793 /* The line may consist of one space only, that was added to
18794 place the cursor on it. If so, the row's height hasn't been
18796 if (row
->height
== 0)
18798 if (it
->max_ascent
+ it
->max_descent
== 0)
18799 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18800 row
->ascent
= it
->max_ascent
;
18801 row
->height
= it
->max_ascent
+ it
->max_descent
;
18802 row
->phys_ascent
= it
->max_phys_ascent
;
18803 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18804 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18807 /* Compute the width of this line. */
18808 row
->pixel_width
= row
->x
;
18809 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18810 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18812 eassert (row
->pixel_width
>= 0);
18813 eassert (row
->ascent
>= 0 && row
->height
> 0);
18815 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18816 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18818 /* If first line's physical ascent is larger than its logical
18819 ascent, use the physical ascent, and make the row taller.
18820 This makes accented characters fully visible. */
18821 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18822 && row
->phys_ascent
> row
->ascent
)
18824 row
->height
+= row
->phys_ascent
- row
->ascent
;
18825 row
->ascent
= row
->phys_ascent
;
18828 /* Compute how much of the line is visible. */
18829 row
->visible_height
= row
->height
;
18831 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18832 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18834 if (row
->y
< min_y
)
18835 row
->visible_height
-= min_y
- row
->y
;
18836 if (row
->y
+ row
->height
> max_y
)
18837 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18841 row
->pixel_width
= row
->used
[TEXT_AREA
];
18842 if (row
->continued_p
)
18843 row
->pixel_width
-= it
->continuation_pixel_width
;
18844 else if (row
->truncated_on_right_p
)
18845 row
->pixel_width
-= it
->truncation_pixel_width
;
18846 row
->ascent
= row
->phys_ascent
= 0;
18847 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18848 row
->extra_line_spacing
= 0;
18851 /* Compute a hash code for this row. */
18852 row
->hash
= row_hash (row
);
18854 it
->max_ascent
= it
->max_descent
= 0;
18855 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18859 /* Append one space to the glyph row of iterator IT if doing a
18860 window-based redisplay. The space has the same face as
18861 IT->face_id. Value is non-zero if a space was added.
18863 This function is called to make sure that there is always one glyph
18864 at the end of a glyph row that the cursor can be set on under
18865 window-systems. (If there weren't such a glyph we would not know
18866 how wide and tall a box cursor should be displayed).
18868 At the same time this space let's a nicely handle clearing to the
18869 end of the line if the row ends in italic text. */
18872 append_space_for_newline (struct it
*it
, int default_face_p
)
18874 if (FRAME_WINDOW_P (it
->f
))
18876 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18878 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18879 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18881 /* Save some values that must not be changed.
18882 Must save IT->c and IT->len because otherwise
18883 ITERATOR_AT_END_P wouldn't work anymore after
18884 append_space_for_newline has been called. */
18885 enum display_element_type saved_what
= it
->what
;
18886 int saved_c
= it
->c
, saved_len
= it
->len
;
18887 int saved_char_to_display
= it
->char_to_display
;
18888 int saved_x
= it
->current_x
;
18889 int saved_face_id
= it
->face_id
;
18890 int saved_box_end
= it
->end_of_box_run_p
;
18891 struct text_pos saved_pos
;
18892 Lisp_Object saved_object
;
18895 saved_object
= it
->object
;
18896 saved_pos
= it
->position
;
18898 it
->what
= IT_CHARACTER
;
18899 memset (&it
->position
, 0, sizeof it
->position
);
18900 it
->object
= make_number (0);
18901 it
->c
= it
->char_to_display
= ' ';
18904 /* If the default face was remapped, be sure to use the
18905 remapped face for the appended newline. */
18906 if (default_face_p
)
18907 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18908 else if (it
->face_before_selective_p
)
18909 it
->face_id
= it
->saved_face_id
;
18910 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18911 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18912 /* In R2L rows, we will prepend a stretch glyph that will
18913 have the end_of_box_run_p flag set for it, so there's no
18914 need for the appended newline glyph to have that flag
18916 if (it
->glyph_row
->reversed_p
18917 /* But if the appended newline glyph goes all the way to
18918 the end of the row, there will be no stretch glyph,
18919 so leave the box flag set. */
18920 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
18921 it
->end_of_box_run_p
= 0;
18923 PRODUCE_GLYPHS (it
);
18925 it
->override_ascent
= -1;
18926 it
->constrain_row_ascent_descent_p
= 0;
18927 it
->current_x
= saved_x
;
18928 it
->object
= saved_object
;
18929 it
->position
= saved_pos
;
18930 it
->what
= saved_what
;
18931 it
->face_id
= saved_face_id
;
18932 it
->len
= saved_len
;
18934 it
->char_to_display
= saved_char_to_display
;
18935 it
->end_of_box_run_p
= saved_box_end
;
18944 /* Extend the face of the last glyph in the text area of IT->glyph_row
18945 to the end of the display line. Called from display_line. If the
18946 glyph row is empty, add a space glyph to it so that we know the
18947 face to draw. Set the glyph row flag fill_line_p. If the glyph
18948 row is R2L, prepend a stretch glyph to cover the empty space to the
18949 left of the leftmost glyph. */
18952 extend_face_to_end_of_line (struct it
*it
)
18954 struct face
*face
, *default_face
;
18955 struct frame
*f
= it
->f
;
18957 /* If line is already filled, do nothing. Non window-system frames
18958 get a grace of one more ``pixel'' because their characters are
18959 1-``pixel'' wide, so they hit the equality too early. This grace
18960 is needed only for R2L rows that are not continued, to produce
18961 one extra blank where we could display the cursor. */
18962 if ((it
->current_x
>= it
->last_visible_x
18963 + (!FRAME_WINDOW_P (f
)
18964 && it
->glyph_row
->reversed_p
18965 && !it
->glyph_row
->continued_p
))
18966 /* If the window has display margins, we will need to extend
18967 their face even if the text area is filled. */
18968 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
18969 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
18972 /* The default face, possibly remapped. */
18973 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18975 /* Face extension extends the background and box of IT->face_id
18976 to the end of the line. If the background equals the background
18977 of the frame, we don't have to do anything. */
18978 if (it
->face_before_selective_p
)
18979 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18981 face
= FACE_FROM_ID (f
, it
->face_id
);
18983 if (FRAME_WINDOW_P (f
)
18984 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
18985 && face
->box
== FACE_NO_BOX
18986 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18987 #ifdef HAVE_WINDOW_SYSTEM
18990 && !it
->glyph_row
->reversed_p
)
18993 /* Set the glyph row flag indicating that the face of the last glyph
18994 in the text area has to be drawn to the end of the text area. */
18995 it
->glyph_row
->fill_line_p
= 1;
18997 /* If current character of IT is not ASCII, make sure we have the
18998 ASCII face. This will be automatically undone the next time
18999 get_next_display_element returns a multibyte character. Note
19000 that the character will always be single byte in unibyte
19002 if (!ASCII_CHAR_P (it
->c
))
19004 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19007 if (FRAME_WINDOW_P (f
))
19009 /* If the row is empty, add a space with the current face of IT,
19010 so that we know which face to draw. */
19011 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19013 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19014 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19015 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19017 /* Mode line and the header line don't have margins, and
19018 likewise the frame's tool-bar window, if there is any. */
19019 if (!(it
->glyph_row
->mode_line_p
19020 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19021 || (WINDOWP (f
->tool_bar_window
)
19022 && it
->w
== XWINDOW (f
->tool_bar_window
))
19026 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19027 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19029 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19030 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19032 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19034 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19035 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19037 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19038 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19040 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19043 #ifdef HAVE_WINDOW_SYSTEM
19044 if (it
->glyph_row
->reversed_p
)
19046 /* Prepend a stretch glyph to the row, such that the
19047 rightmost glyph will be drawn flushed all the way to the
19048 right margin of the window. The stretch glyph that will
19049 occupy the empty space, if any, to the left of the
19051 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19052 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19053 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19055 int row_width
, stretch_ascent
, stretch_width
;
19056 struct text_pos saved_pos
;
19057 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19059 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19060 row_width
+= g
->pixel_width
;
19061 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19062 if (stretch_width
> 0)
19065 (((it
->ascent
+ it
->descent
)
19066 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19067 saved_pos
= it
->position
;
19068 memset (&it
->position
, 0, sizeof it
->position
);
19069 saved_avoid_cursor
= it
->avoid_cursor_p
;
19070 it
->avoid_cursor_p
= 1;
19071 saved_face_id
= it
->face_id
;
19072 saved_box_start
= it
->start_of_box_run_p
;
19073 /* The last row's stretch glyph should get the default
19074 face, to avoid painting the rest of the window with
19075 the region face, if the region ends at ZV. */
19076 if (it
->glyph_row
->ends_at_zv_p
)
19077 it
->face_id
= default_face
->id
;
19079 it
->face_id
= face
->id
;
19080 it
->start_of_box_run_p
= 0;
19081 append_stretch_glyph (it
, make_number (0), stretch_width
,
19082 it
->ascent
+ it
->descent
, stretch_ascent
);
19083 it
->position
= saved_pos
;
19084 it
->avoid_cursor_p
= saved_avoid_cursor
;
19085 it
->face_id
= saved_face_id
;
19086 it
->start_of_box_run_p
= saved_box_start
;
19089 #endif /* HAVE_WINDOW_SYSTEM */
19093 /* Save some values that must not be changed. */
19094 int saved_x
= it
->current_x
;
19095 struct text_pos saved_pos
;
19096 Lisp_Object saved_object
;
19097 enum display_element_type saved_what
= it
->what
;
19098 int saved_face_id
= it
->face_id
;
19100 saved_object
= it
->object
;
19101 saved_pos
= it
->position
;
19103 it
->what
= IT_CHARACTER
;
19104 memset (&it
->position
, 0, sizeof it
->position
);
19105 it
->object
= make_number (0);
19106 it
->c
= it
->char_to_display
= ' ';
19109 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19110 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19111 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19112 && !it
->glyph_row
->mode_line_p
19113 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19115 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19116 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19118 for (it
->current_x
= 0; g
< e
; g
++)
19119 it
->current_x
+= g
->pixel_width
;
19121 it
->area
= LEFT_MARGIN_AREA
;
19122 it
->face_id
= default_face
->id
;
19123 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19124 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19126 PRODUCE_GLYPHS (it
);
19127 /* term.c:produce_glyphs advances it->current_x only for
19129 it
->current_x
+= it
->pixel_width
;
19132 it
->current_x
= saved_x
;
19133 it
->area
= TEXT_AREA
;
19136 /* The last row's blank glyphs should get the default face, to
19137 avoid painting the rest of the window with the region face,
19138 if the region ends at ZV. */
19139 if (it
->glyph_row
->ends_at_zv_p
)
19140 it
->face_id
= default_face
->id
;
19142 it
->face_id
= face
->id
;
19143 PRODUCE_GLYPHS (it
);
19145 while (it
->current_x
<= it
->last_visible_x
)
19146 PRODUCE_GLYPHS (it
);
19148 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19149 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19150 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19151 && !it
->glyph_row
->mode_line_p
19152 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19154 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19155 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19157 for ( ; g
< e
; g
++)
19158 it
->current_x
+= g
->pixel_width
;
19160 it
->area
= RIGHT_MARGIN_AREA
;
19161 it
->face_id
= default_face
->id
;
19162 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19163 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19165 PRODUCE_GLYPHS (it
);
19166 it
->current_x
+= it
->pixel_width
;
19169 it
->area
= TEXT_AREA
;
19172 /* Don't count these blanks really. It would let us insert a left
19173 truncation glyph below and make us set the cursor on them, maybe. */
19174 it
->current_x
= saved_x
;
19175 it
->object
= saved_object
;
19176 it
->position
= saved_pos
;
19177 it
->what
= saved_what
;
19178 it
->face_id
= saved_face_id
;
19183 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19184 trailing whitespace. */
19187 trailing_whitespace_p (ptrdiff_t charpos
)
19189 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19192 while (bytepos
< ZV_BYTE
19193 && (c
= FETCH_CHAR (bytepos
),
19194 c
== ' ' || c
== '\t'))
19197 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19199 if (bytepos
!= PT_BYTE
)
19206 /* Highlight trailing whitespace, if any, in ROW. */
19209 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19211 int used
= row
->used
[TEXT_AREA
];
19215 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19216 struct glyph
*glyph
= start
+ used
- 1;
19218 if (row
->reversed_p
)
19220 /* Right-to-left rows need to be processed in the opposite
19221 direction, so swap the edge pointers. */
19223 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19226 /* Skip over glyphs inserted to display the cursor at the
19227 end of a line, for extending the face of the last glyph
19228 to the end of the line on terminals, and for truncation
19229 and continuation glyphs. */
19230 if (!row
->reversed_p
)
19232 while (glyph
>= start
19233 && glyph
->type
== CHAR_GLYPH
19234 && INTEGERP (glyph
->object
))
19239 while (glyph
<= start
19240 && glyph
->type
== CHAR_GLYPH
19241 && INTEGERP (glyph
->object
))
19245 /* If last glyph is a space or stretch, and it's trailing
19246 whitespace, set the face of all trailing whitespace glyphs in
19247 IT->glyph_row to `trailing-whitespace'. */
19248 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19249 && BUFFERP (glyph
->object
)
19250 && (glyph
->type
== STRETCH_GLYPH
19251 || (glyph
->type
== CHAR_GLYPH
19252 && glyph
->u
.ch
== ' '))
19253 && trailing_whitespace_p (glyph
->charpos
))
19255 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19259 if (!row
->reversed_p
)
19261 while (glyph
>= start
19262 && BUFFERP (glyph
->object
)
19263 && (glyph
->type
== STRETCH_GLYPH
19264 || (glyph
->type
== CHAR_GLYPH
19265 && glyph
->u
.ch
== ' ')))
19266 (glyph
--)->face_id
= face_id
;
19270 while (glyph
<= start
19271 && BUFFERP (glyph
->object
)
19272 && (glyph
->type
== STRETCH_GLYPH
19273 || (glyph
->type
== CHAR_GLYPH
19274 && glyph
->u
.ch
== ' ')))
19275 (glyph
++)->face_id
= face_id
;
19282 /* Value is non-zero if glyph row ROW should be
19283 considered to hold the buffer position CHARPOS. */
19286 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19290 if (charpos
== CHARPOS (row
->end
.pos
)
19291 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19293 /* Suppose the row ends on a string.
19294 Unless the row is continued, that means it ends on a newline
19295 in the string. If it's anything other than a display string
19296 (e.g., a before-string from an overlay), we don't want the
19297 cursor there. (This heuristic seems to give the optimal
19298 behavior for the various types of multi-line strings.)
19299 One exception: if the string has `cursor' property on one of
19300 its characters, we _do_ want the cursor there. */
19301 if (CHARPOS (row
->end
.string_pos
) >= 0)
19303 if (row
->continued_p
)
19307 /* Check for `display' property. */
19308 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19309 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19310 struct glyph
*glyph
;
19313 for (glyph
= end
; glyph
>= beg
; --glyph
)
19314 if (STRINGP (glyph
->object
))
19317 = Fget_char_property (make_number (charpos
),
19321 && display_prop_string_p (prop
, glyph
->object
));
19322 /* If there's a `cursor' property on one of the
19323 string's characters, this row is a cursor row,
19324 even though this is not a display string. */
19327 Lisp_Object s
= glyph
->object
;
19329 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19331 ptrdiff_t gpos
= glyph
->charpos
;
19333 if (!NILP (Fget_char_property (make_number (gpos
),
19345 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19347 /* If the row ends in middle of a real character,
19348 and the line is continued, we want the cursor here.
19349 That's because CHARPOS (ROW->end.pos) would equal
19350 PT if PT is before the character. */
19351 if (!row
->ends_in_ellipsis_p
)
19352 result
= row
->continued_p
;
19354 /* If the row ends in an ellipsis, then
19355 CHARPOS (ROW->end.pos) will equal point after the
19356 invisible text. We want that position to be displayed
19357 after the ellipsis. */
19360 /* If the row ends at ZV, display the cursor at the end of that
19361 row instead of at the start of the row below. */
19362 else if (row
->ends_at_zv_p
)
19371 /* Value is non-zero if glyph row ROW should be
19372 used to hold the cursor. */
19375 cursor_row_p (struct glyph_row
*row
)
19377 return row_for_charpos_p (row
, PT
);
19382 /* Push the property PROP so that it will be rendered at the current
19383 position in IT. Return 1 if PROP was successfully pushed, 0
19384 otherwise. Called from handle_line_prefix to handle the
19385 `line-prefix' and `wrap-prefix' properties. */
19388 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19390 struct text_pos pos
=
19391 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19393 eassert (it
->method
== GET_FROM_BUFFER
19394 || it
->method
== GET_FROM_DISPLAY_VECTOR
19395 || it
->method
== GET_FROM_STRING
);
19397 /* We need to save the current buffer/string position, so it will be
19398 restored by pop_it, because iterate_out_of_display_property
19399 depends on that being set correctly, but some situations leave
19400 it->position not yet set when this function is called. */
19401 push_it (it
, &pos
);
19403 if (STRINGP (prop
))
19405 if (SCHARS (prop
) == 0)
19412 it
->string_from_prefix_prop_p
= 1;
19413 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19414 it
->current
.overlay_string_index
= -1;
19415 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19416 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19417 it
->method
= GET_FROM_STRING
;
19418 it
->stop_charpos
= 0;
19420 it
->base_level_stop
= 0;
19422 /* Force paragraph direction to be that of the parent
19424 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19425 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19427 it
->paragraph_embedding
= L2R
;
19429 /* Set up the bidi iterator for this display string. */
19432 it
->bidi_it
.string
.lstring
= it
->string
;
19433 it
->bidi_it
.string
.s
= NULL
;
19434 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19435 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19436 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19437 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19438 it
->bidi_it
.w
= it
->w
;
19439 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19442 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19444 it
->method
= GET_FROM_STRETCH
;
19447 #ifdef HAVE_WINDOW_SYSTEM
19448 else if (IMAGEP (prop
))
19450 it
->what
= IT_IMAGE
;
19451 it
->image_id
= lookup_image (it
->f
, prop
);
19452 it
->method
= GET_FROM_IMAGE
;
19454 #endif /* HAVE_WINDOW_SYSTEM */
19457 pop_it (it
); /* bogus display property, give up */
19464 /* Return the character-property PROP at the current position in IT. */
19467 get_it_property (struct it
*it
, Lisp_Object prop
)
19469 Lisp_Object position
, object
= it
->object
;
19471 if (STRINGP (object
))
19472 position
= make_number (IT_STRING_CHARPOS (*it
));
19473 else if (BUFFERP (object
))
19475 position
= make_number (IT_CHARPOS (*it
));
19476 object
= it
->window
;
19481 return Fget_char_property (position
, prop
, object
);
19484 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19487 handle_line_prefix (struct it
*it
)
19489 Lisp_Object prefix
;
19491 if (it
->continuation_lines_width
> 0)
19493 prefix
= get_it_property (it
, Qwrap_prefix
);
19495 prefix
= Vwrap_prefix
;
19499 prefix
= get_it_property (it
, Qline_prefix
);
19501 prefix
= Vline_prefix
;
19503 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19505 /* If the prefix is wider than the window, and we try to wrap
19506 it, it would acquire its own wrap prefix, and so on till the
19507 iterator stack overflows. So, don't wrap the prefix. */
19508 it
->line_wrap
= TRUNCATE
;
19509 it
->avoid_cursor_p
= 1;
19515 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19516 only for R2L lines from display_line and display_string, when they
19517 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19518 the line/string needs to be continued on the next glyph row. */
19520 unproduce_glyphs (struct it
*it
, int n
)
19522 struct glyph
*glyph
, *end
;
19524 eassert (it
->glyph_row
);
19525 eassert (it
->glyph_row
->reversed_p
);
19526 eassert (it
->area
== TEXT_AREA
);
19527 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19529 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19530 n
= it
->glyph_row
->used
[TEXT_AREA
];
19531 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19532 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19533 for ( ; glyph
< end
; glyph
++)
19534 glyph
[-n
] = *glyph
;
19537 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19538 and ROW->maxpos. */
19540 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19541 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19542 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19544 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19545 lines' rows is implemented for bidi-reordered rows. */
19547 /* ROW->minpos is the value of min_pos, the minimal buffer position
19548 we have in ROW, or ROW->start.pos if that is smaller. */
19549 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19550 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19552 /* We didn't find buffer positions smaller than ROW->start, or
19553 didn't find _any_ valid buffer positions in any of the glyphs,
19554 so we must trust the iterator's computed positions. */
19555 row
->minpos
= row
->start
.pos
;
19558 max_pos
= CHARPOS (it
->current
.pos
);
19559 max_bpos
= BYTEPOS (it
->current
.pos
);
19562 /* Here are the various use-cases for ending the row, and the
19563 corresponding values for ROW->maxpos:
19565 Line ends in a newline from buffer eol_pos + 1
19566 Line is continued from buffer max_pos + 1
19567 Line is truncated on right it->current.pos
19568 Line ends in a newline from string max_pos + 1(*)
19569 (*) + 1 only when line ends in a forward scan
19570 Line is continued from string max_pos
19571 Line is continued from display vector max_pos
19572 Line is entirely from a string min_pos == max_pos
19573 Line is entirely from a display vector min_pos == max_pos
19574 Line that ends at ZV ZV
19576 If you discover other use-cases, please add them here as
19578 if (row
->ends_at_zv_p
)
19579 row
->maxpos
= it
->current
.pos
;
19580 else if (row
->used
[TEXT_AREA
])
19582 int seen_this_string
= 0;
19583 struct glyph_row
*r1
= row
- 1;
19585 /* Did we see the same display string on the previous row? */
19586 if (STRINGP (it
->object
)
19587 /* this is not the first row */
19588 && row
> it
->w
->desired_matrix
->rows
19589 /* previous row is not the header line */
19590 && !r1
->mode_line_p
19591 /* previous row also ends in a newline from a string */
19592 && r1
->ends_in_newline_from_string_p
)
19594 struct glyph
*start
, *end
;
19596 /* Search for the last glyph of the previous row that came
19597 from buffer or string. Depending on whether the row is
19598 L2R or R2L, we need to process it front to back or the
19599 other way round. */
19600 if (!r1
->reversed_p
)
19602 start
= r1
->glyphs
[TEXT_AREA
];
19603 end
= start
+ r1
->used
[TEXT_AREA
];
19604 /* Glyphs inserted by redisplay have an integer (zero)
19605 as their object. */
19607 && INTEGERP ((end
- 1)->object
)
19608 && (end
- 1)->charpos
<= 0)
19612 if (EQ ((end
- 1)->object
, it
->object
))
19613 seen_this_string
= 1;
19616 /* If all the glyphs of the previous row were inserted
19617 by redisplay, it means the previous row was
19618 produced from a single newline, which is only
19619 possible if that newline came from the same string
19620 as the one which produced this ROW. */
19621 seen_this_string
= 1;
19625 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19626 start
= end
+ r1
->used
[TEXT_AREA
];
19628 && INTEGERP ((end
+ 1)->object
)
19629 && (end
+ 1)->charpos
<= 0)
19633 if (EQ ((end
+ 1)->object
, it
->object
))
19634 seen_this_string
= 1;
19637 seen_this_string
= 1;
19640 /* Take note of each display string that covers a newline only
19641 once, the first time we see it. This is for when a display
19642 string includes more than one newline in it. */
19643 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19645 /* If we were scanning the buffer forward when we displayed
19646 the string, we want to account for at least one buffer
19647 position that belongs to this row (position covered by
19648 the display string), so that cursor positioning will
19649 consider this row as a candidate when point is at the end
19650 of the visual line represented by this row. This is not
19651 required when scanning back, because max_pos will already
19652 have a much larger value. */
19653 if (CHARPOS (row
->end
.pos
) > max_pos
)
19654 INC_BOTH (max_pos
, max_bpos
);
19655 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19657 else if (CHARPOS (it
->eol_pos
) > 0)
19658 SET_TEXT_POS (row
->maxpos
,
19659 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19660 else if (row
->continued_p
)
19662 /* If max_pos is different from IT's current position, it
19663 means IT->method does not belong to the display element
19664 at max_pos. However, it also means that the display
19665 element at max_pos was displayed in its entirety on this
19666 line, which is equivalent to saying that the next line
19667 starts at the next buffer position. */
19668 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19669 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19672 INC_BOTH (max_pos
, max_bpos
);
19673 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19676 else if (row
->truncated_on_right_p
)
19677 /* display_line already called reseat_at_next_visible_line_start,
19678 which puts the iterator at the beginning of the next line, in
19679 the logical order. */
19680 row
->maxpos
= it
->current
.pos
;
19681 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19682 /* A line that is entirely from a string/image/stretch... */
19683 row
->maxpos
= row
->minpos
;
19688 row
->maxpos
= it
->current
.pos
;
19691 /* Construct the glyph row IT->glyph_row in the desired matrix of
19692 IT->w from text at the current position of IT. See dispextern.h
19693 for an overview of struct it. Value is non-zero if
19694 IT->glyph_row displays text, as opposed to a line displaying ZV
19698 display_line (struct it
*it
)
19700 struct glyph_row
*row
= it
->glyph_row
;
19701 Lisp_Object overlay_arrow_string
;
19703 void *wrap_data
= NULL
;
19704 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19705 int wrap_row_used
= -1;
19706 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19707 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19708 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19709 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19710 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19712 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19713 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19715 /* We always start displaying at hpos zero even if hscrolled. */
19716 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19718 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19719 >= it
->w
->desired_matrix
->nrows
)
19721 it
->w
->nrows_scale_factor
++;
19722 it
->f
->fonts_changed
= 1;
19726 /* Clear the result glyph row and enable it. */
19727 prepare_desired_row (row
);
19729 row
->y
= it
->current_y
;
19730 row
->start
= it
->start
;
19731 row
->continuation_lines_width
= it
->continuation_lines_width
;
19732 row
->displays_text_p
= 1;
19733 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19734 it
->starts_in_middle_of_char_p
= 0;
19736 /* Arrange the overlays nicely for our purposes. Usually, we call
19737 display_line on only one line at a time, in which case this
19738 can't really hurt too much, or we call it on lines which appear
19739 one after another in the buffer, in which case all calls to
19740 recenter_overlay_lists but the first will be pretty cheap. */
19741 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19743 /* Move over display elements that are not visible because we are
19744 hscrolled. This may stop at an x-position < IT->first_visible_x
19745 if the first glyph is partially visible or if we hit a line end. */
19746 if (it
->current_x
< it
->first_visible_x
)
19748 enum move_it_result move_result
;
19750 this_line_min_pos
= row
->start
.pos
;
19751 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19752 MOVE_TO_POS
| MOVE_TO_X
);
19753 /* If we are under a large hscroll, move_it_in_display_line_to
19754 could hit the end of the line without reaching
19755 it->first_visible_x. Pretend that we did reach it. This is
19756 especially important on a TTY, where we will call
19757 extend_face_to_end_of_line, which needs to know how many
19758 blank glyphs to produce. */
19759 if (it
->current_x
< it
->first_visible_x
19760 && (move_result
== MOVE_NEWLINE_OR_CR
19761 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19762 it
->current_x
= it
->first_visible_x
;
19764 /* Record the smallest positions seen while we moved over
19765 display elements that are not visible. This is needed by
19766 redisplay_internal for optimizing the case where the cursor
19767 stays inside the same line. The rest of this function only
19768 considers positions that are actually displayed, so
19769 RECORD_MAX_MIN_POS will not otherwise record positions that
19770 are hscrolled to the left of the left edge of the window. */
19771 min_pos
= CHARPOS (this_line_min_pos
);
19772 min_bpos
= BYTEPOS (this_line_min_pos
);
19776 /* We only do this when not calling `move_it_in_display_line_to'
19777 above, because move_it_in_display_line_to calls
19778 handle_line_prefix itself. */
19779 handle_line_prefix (it
);
19782 /* Get the initial row height. This is either the height of the
19783 text hscrolled, if there is any, or zero. */
19784 row
->ascent
= it
->max_ascent
;
19785 row
->height
= it
->max_ascent
+ it
->max_descent
;
19786 row
->phys_ascent
= it
->max_phys_ascent
;
19787 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19788 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19790 /* Utility macro to record max and min buffer positions seen until now. */
19791 #define RECORD_MAX_MIN_POS(IT) \
19794 int composition_p = !STRINGP ((IT)->string) \
19795 && ((IT)->what == IT_COMPOSITION); \
19796 ptrdiff_t current_pos = \
19797 composition_p ? (IT)->cmp_it.charpos \
19798 : IT_CHARPOS (*(IT)); \
19799 ptrdiff_t current_bpos = \
19800 composition_p ? CHAR_TO_BYTE (current_pos) \
19801 : IT_BYTEPOS (*(IT)); \
19802 if (current_pos < min_pos) \
19804 min_pos = current_pos; \
19805 min_bpos = current_bpos; \
19807 if (IT_CHARPOS (*it) > max_pos) \
19809 max_pos = IT_CHARPOS (*it); \
19810 max_bpos = IT_BYTEPOS (*it); \
19815 /* Loop generating characters. The loop is left with IT on the next
19816 character to display. */
19819 int n_glyphs_before
, hpos_before
, x_before
;
19821 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19823 /* Retrieve the next thing to display. Value is zero if end of
19825 if (!get_next_display_element (it
))
19827 /* Maybe add a space at the end of this line that is used to
19828 display the cursor there under X. Set the charpos of the
19829 first glyph of blank lines not corresponding to any text
19831 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19832 row
->exact_window_width_line_p
= 1;
19833 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19834 || row
->used
[TEXT_AREA
] == 0)
19836 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19837 row
->displays_text_p
= 0;
19839 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19840 && (!MINI_WINDOW_P (it
->w
)
19841 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19842 row
->indicate_empty_line_p
= 1;
19845 it
->continuation_lines_width
= 0;
19846 row
->ends_at_zv_p
= 1;
19847 /* A row that displays right-to-left text must always have
19848 its last face extended all the way to the end of line,
19849 even if this row ends in ZV, because we still write to
19850 the screen left to right. We also need to extend the
19851 last face if the default face is remapped to some
19852 different face, otherwise the functions that clear
19853 portions of the screen will clear with the default face's
19854 background color. */
19855 if (row
->reversed_p
19856 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19857 extend_face_to_end_of_line (it
);
19861 /* Now, get the metrics of what we want to display. This also
19862 generates glyphs in `row' (which is IT->glyph_row). */
19863 n_glyphs_before
= row
->used
[TEXT_AREA
];
19866 /* Remember the line height so far in case the next element doesn't
19867 fit on the line. */
19868 if (it
->line_wrap
!= TRUNCATE
)
19870 ascent
= it
->max_ascent
;
19871 descent
= it
->max_descent
;
19872 phys_ascent
= it
->max_phys_ascent
;
19873 phys_descent
= it
->max_phys_descent
;
19875 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19877 if (IT_DISPLAYING_WHITESPACE (it
))
19881 SAVE_IT (wrap_it
, *it
, wrap_data
);
19883 wrap_row_used
= row
->used
[TEXT_AREA
];
19884 wrap_row_ascent
= row
->ascent
;
19885 wrap_row_height
= row
->height
;
19886 wrap_row_phys_ascent
= row
->phys_ascent
;
19887 wrap_row_phys_height
= row
->phys_height
;
19888 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19889 wrap_row_min_pos
= min_pos
;
19890 wrap_row_min_bpos
= min_bpos
;
19891 wrap_row_max_pos
= max_pos
;
19892 wrap_row_max_bpos
= max_bpos
;
19898 PRODUCE_GLYPHS (it
);
19900 /* If this display element was in marginal areas, continue with
19902 if (it
->area
!= TEXT_AREA
)
19904 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19905 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19906 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19907 row
->phys_height
= max (row
->phys_height
,
19908 it
->max_phys_ascent
+ it
->max_phys_descent
);
19909 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19910 it
->max_extra_line_spacing
);
19911 set_iterator_to_next (it
, 1);
19915 /* Does the display element fit on the line? If we truncate
19916 lines, we should draw past the right edge of the window. If
19917 we don't truncate, we want to stop so that we can display the
19918 continuation glyph before the right margin. If lines are
19919 continued, there are two possible strategies for characters
19920 resulting in more than 1 glyph (e.g. tabs): Display as many
19921 glyphs as possible in this line and leave the rest for the
19922 continuation line, or display the whole element in the next
19923 line. Original redisplay did the former, so we do it also. */
19924 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19925 hpos_before
= it
->hpos
;
19928 if (/* Not a newline. */
19930 /* Glyphs produced fit entirely in the line. */
19931 && it
->current_x
< it
->last_visible_x
)
19933 it
->hpos
+= nglyphs
;
19934 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19935 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19936 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19937 row
->phys_height
= max (row
->phys_height
,
19938 it
->max_phys_ascent
+ it
->max_phys_descent
);
19939 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19940 it
->max_extra_line_spacing
);
19941 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19942 row
->x
= x
- it
->first_visible_x
;
19943 /* Record the maximum and minimum buffer positions seen so
19944 far in glyphs that will be displayed by this row. */
19946 RECORD_MAX_MIN_POS (it
);
19951 struct glyph
*glyph
;
19953 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19955 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19956 new_x
= x
+ glyph
->pixel_width
;
19958 if (/* Lines are continued. */
19959 it
->line_wrap
!= TRUNCATE
19960 && (/* Glyph doesn't fit on the line. */
19961 new_x
> it
->last_visible_x
19962 /* Or it fits exactly on a window system frame. */
19963 || (new_x
== it
->last_visible_x
19964 && FRAME_WINDOW_P (it
->f
)
19965 && (row
->reversed_p
19966 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19967 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
19969 /* End of a continued line. */
19972 || (new_x
== it
->last_visible_x
19973 && FRAME_WINDOW_P (it
->f
)
19974 && (row
->reversed_p
19975 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
19976 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
19978 /* Current glyph is the only one on the line or
19979 fits exactly on the line. We must continue
19980 the line because we can't draw the cursor
19981 after the glyph. */
19982 row
->continued_p
= 1;
19983 it
->current_x
= new_x
;
19984 it
->continuation_lines_width
+= new_x
;
19986 if (i
== nglyphs
- 1)
19988 /* If line-wrap is on, check if a previous
19989 wrap point was found. */
19990 if (wrap_row_used
> 0
19991 /* Even if there is a previous wrap
19992 point, continue the line here as
19993 usual, if (i) the previous character
19994 was a space or tab AND (ii) the
19995 current character is not. */
19997 || IT_DISPLAYING_WHITESPACE (it
)))
20000 /* Record the maximum and minimum buffer
20001 positions seen so far in glyphs that will be
20002 displayed by this row. */
20004 RECORD_MAX_MIN_POS (it
);
20005 set_iterator_to_next (it
, 1);
20006 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20008 if (!get_next_display_element (it
))
20010 row
->exact_window_width_line_p
= 1;
20011 it
->continuation_lines_width
= 0;
20012 row
->continued_p
= 0;
20013 row
->ends_at_zv_p
= 1;
20015 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20017 row
->continued_p
= 0;
20018 row
->exact_window_width_line_p
= 1;
20022 else if (it
->bidi_p
)
20023 RECORD_MAX_MIN_POS (it
);
20024 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20025 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20026 extend_face_to_end_of_line (it
);
20028 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20029 && !FRAME_WINDOW_P (it
->f
))
20031 /* A padding glyph that doesn't fit on this line.
20032 This means the whole character doesn't fit
20034 if (row
->reversed_p
)
20035 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20036 - n_glyphs_before
);
20037 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20039 /* Fill the rest of the row with continuation
20040 glyphs like in 20.x. */
20041 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20042 < row
->glyphs
[1 + TEXT_AREA
])
20043 produce_special_glyphs (it
, IT_CONTINUATION
);
20045 row
->continued_p
= 1;
20046 it
->current_x
= x_before
;
20047 it
->continuation_lines_width
+= x_before
;
20049 /* Restore the height to what it was before the
20050 element not fitting on the line. */
20051 it
->max_ascent
= ascent
;
20052 it
->max_descent
= descent
;
20053 it
->max_phys_ascent
= phys_ascent
;
20054 it
->max_phys_descent
= phys_descent
;
20055 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20056 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20057 extend_face_to_end_of_line (it
);
20059 else if (wrap_row_used
> 0)
20062 if (row
->reversed_p
)
20063 unproduce_glyphs (it
,
20064 row
->used
[TEXT_AREA
] - wrap_row_used
);
20065 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20066 it
->continuation_lines_width
+= wrap_x
;
20067 row
->used
[TEXT_AREA
] = wrap_row_used
;
20068 row
->ascent
= wrap_row_ascent
;
20069 row
->height
= wrap_row_height
;
20070 row
->phys_ascent
= wrap_row_phys_ascent
;
20071 row
->phys_height
= wrap_row_phys_height
;
20072 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20073 min_pos
= wrap_row_min_pos
;
20074 min_bpos
= wrap_row_min_bpos
;
20075 max_pos
= wrap_row_max_pos
;
20076 max_bpos
= wrap_row_max_bpos
;
20077 row
->continued_p
= 1;
20078 row
->ends_at_zv_p
= 0;
20079 row
->exact_window_width_line_p
= 0;
20080 it
->continuation_lines_width
+= x
;
20082 /* Make sure that a non-default face is extended
20083 up to the right margin of the window. */
20084 extend_face_to_end_of_line (it
);
20086 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20088 /* A TAB that extends past the right edge of the
20089 window. This produces a single glyph on
20090 window system frames. We leave the glyph in
20091 this row and let it fill the row, but don't
20092 consume the TAB. */
20093 if ((row
->reversed_p
20094 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20095 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20096 produce_special_glyphs (it
, IT_CONTINUATION
);
20097 it
->continuation_lines_width
+= it
->last_visible_x
;
20098 row
->ends_in_middle_of_char_p
= 1;
20099 row
->continued_p
= 1;
20100 glyph
->pixel_width
= it
->last_visible_x
- x
;
20101 it
->starts_in_middle_of_char_p
= 1;
20102 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20103 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20104 extend_face_to_end_of_line (it
);
20108 /* Something other than a TAB that draws past
20109 the right edge of the window. Restore
20110 positions to values before the element. */
20111 if (row
->reversed_p
)
20112 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20113 - (n_glyphs_before
+ i
));
20114 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20116 /* Display continuation glyphs. */
20117 it
->current_x
= x_before
;
20118 it
->continuation_lines_width
+= x
;
20119 if (!FRAME_WINDOW_P (it
->f
)
20120 || (row
->reversed_p
20121 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20122 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20123 produce_special_glyphs (it
, IT_CONTINUATION
);
20124 row
->continued_p
= 1;
20126 extend_face_to_end_of_line (it
);
20128 if (nglyphs
> 1 && i
> 0)
20130 row
->ends_in_middle_of_char_p
= 1;
20131 it
->starts_in_middle_of_char_p
= 1;
20134 /* Restore the height to what it was before the
20135 element not fitting on the line. */
20136 it
->max_ascent
= ascent
;
20137 it
->max_descent
= descent
;
20138 it
->max_phys_ascent
= phys_ascent
;
20139 it
->max_phys_descent
= phys_descent
;
20144 else if (new_x
> it
->first_visible_x
)
20146 /* Increment number of glyphs actually displayed. */
20149 /* Record the maximum and minimum buffer positions
20150 seen so far in glyphs that will be displayed by
20153 RECORD_MAX_MIN_POS (it
);
20155 if (x
< it
->first_visible_x
)
20156 /* Glyph is partially visible, i.e. row starts at
20157 negative X position. */
20158 row
->x
= x
- it
->first_visible_x
;
20162 /* Glyph is completely off the left margin of the
20163 window. This should not happen because of the
20164 move_it_in_display_line at the start of this
20165 function, unless the text display area of the
20166 window is empty. */
20167 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20170 /* Even if this display element produced no glyphs at all,
20171 we want to record its position. */
20172 if (it
->bidi_p
&& nglyphs
== 0)
20173 RECORD_MAX_MIN_POS (it
);
20175 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20176 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20177 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20178 row
->phys_height
= max (row
->phys_height
,
20179 it
->max_phys_ascent
+ it
->max_phys_descent
);
20180 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20181 it
->max_extra_line_spacing
);
20183 /* End of this display line if row is continued. */
20184 if (row
->continued_p
|| row
->ends_at_zv_p
)
20189 /* Is this a line end? If yes, we're also done, after making
20190 sure that a non-default face is extended up to the right
20191 margin of the window. */
20192 if (ITERATOR_AT_END_OF_LINE_P (it
))
20194 int used_before
= row
->used
[TEXT_AREA
];
20196 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20198 /* Add a space at the end of the line that is used to
20199 display the cursor there. */
20200 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20201 append_space_for_newline (it
, 0);
20203 /* Extend the face to the end of the line. */
20204 extend_face_to_end_of_line (it
);
20206 /* Make sure we have the position. */
20207 if (used_before
== 0)
20208 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20210 /* Record the position of the newline, for use in
20212 it
->eol_pos
= it
->current
.pos
;
20214 /* Consume the line end. This skips over invisible lines. */
20215 set_iterator_to_next (it
, 1);
20216 it
->continuation_lines_width
= 0;
20220 /* Proceed with next display element. Note that this skips
20221 over lines invisible because of selective display. */
20222 set_iterator_to_next (it
, 1);
20224 /* If we truncate lines, we are done when the last displayed
20225 glyphs reach past the right margin of the window. */
20226 if (it
->line_wrap
== TRUNCATE
20227 && ((FRAME_WINDOW_P (it
->f
)
20228 /* Images are preprocessed in produce_image_glyph such
20229 that they are cropped at the right edge of the
20230 window, so an image glyph will always end exactly at
20231 last_visible_x, even if there's no right fringe. */
20232 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20233 ? (it
->current_x
>= it
->last_visible_x
)
20234 : (it
->current_x
> it
->last_visible_x
)))
20236 /* Maybe add truncation glyphs. */
20237 if (!FRAME_WINDOW_P (it
->f
)
20238 || (row
->reversed_p
20239 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20240 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20244 if (!row
->reversed_p
)
20246 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20247 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20252 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20253 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20255 /* Remove any padding glyphs at the front of ROW, to
20256 make room for the truncation glyphs we will be
20257 adding below. The loop below always inserts at
20258 least one truncation glyph, so also remove the
20259 last glyph added to ROW. */
20260 unproduce_glyphs (it
, i
+ 1);
20261 /* Adjust i for the loop below. */
20262 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20265 /* produce_special_glyphs overwrites the last glyph, so
20266 we don't want that if we want to keep that last
20267 glyph, which means it's an image. */
20268 if (it
->current_x
> it
->last_visible_x
)
20270 it
->current_x
= x_before
;
20271 if (!FRAME_WINDOW_P (it
->f
))
20273 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20275 row
->used
[TEXT_AREA
] = i
;
20276 produce_special_glyphs (it
, IT_TRUNCATION
);
20281 row
->used
[TEXT_AREA
] = i
;
20282 produce_special_glyphs (it
, IT_TRUNCATION
);
20284 it
->hpos
= hpos_before
;
20287 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20289 /* Don't truncate if we can overflow newline into fringe. */
20290 if (!get_next_display_element (it
))
20292 it
->continuation_lines_width
= 0;
20293 row
->ends_at_zv_p
= 1;
20294 row
->exact_window_width_line_p
= 1;
20297 if (ITERATOR_AT_END_OF_LINE_P (it
))
20299 row
->exact_window_width_line_p
= 1;
20300 goto at_end_of_line
;
20302 it
->current_x
= x_before
;
20303 it
->hpos
= hpos_before
;
20306 row
->truncated_on_right_p
= 1;
20307 it
->continuation_lines_width
= 0;
20308 reseat_at_next_visible_line_start (it
, 0);
20309 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20315 bidi_unshelve_cache (wrap_data
, 1);
20317 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20318 at the left window margin. */
20319 if (it
->first_visible_x
20320 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20322 if (!FRAME_WINDOW_P (it
->f
)
20323 || (((row
->reversed_p
20324 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20325 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20326 /* Don't let insert_left_trunc_glyphs overwrite the
20327 first glyph of the row if it is an image. */
20328 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20329 insert_left_trunc_glyphs (it
);
20330 row
->truncated_on_left_p
= 1;
20333 /* Remember the position at which this line ends.
20335 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20336 cannot be before the call to find_row_edges below, since that is
20337 where these positions are determined. */
20338 row
->end
= it
->current
;
20341 row
->minpos
= row
->start
.pos
;
20342 row
->maxpos
= row
->end
.pos
;
20346 /* ROW->minpos and ROW->maxpos must be the smallest and
20347 `1 + the largest' buffer positions in ROW. But if ROW was
20348 bidi-reordered, these two positions can be anywhere in the
20349 row, so we must determine them now. */
20350 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20353 /* If the start of this line is the overlay arrow-position, then
20354 mark this glyph row as the one containing the overlay arrow.
20355 This is clearly a mess with variable size fonts. It would be
20356 better to let it be displayed like cursors under X. */
20357 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20358 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20359 !NILP (overlay_arrow_string
)))
20361 /* Overlay arrow in window redisplay is a fringe bitmap. */
20362 if (STRINGP (overlay_arrow_string
))
20364 struct glyph_row
*arrow_row
20365 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20366 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20367 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20368 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20369 struct glyph
*p2
, *end
;
20371 /* Copy the arrow glyphs. */
20372 while (glyph
< arrow_end
)
20375 /* Throw away padding glyphs. */
20377 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20378 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20384 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20389 eassert (INTEGERP (overlay_arrow_string
));
20390 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20392 overlay_arrow_seen
= 1;
20395 /* Highlight trailing whitespace. */
20396 if (!NILP (Vshow_trailing_whitespace
))
20397 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20399 /* Compute pixel dimensions of this line. */
20400 compute_line_metrics (it
);
20402 /* Implementation note: No changes in the glyphs of ROW or in their
20403 faces can be done past this point, because compute_line_metrics
20404 computes ROW's hash value and stores it within the glyph_row
20407 /* Record whether this row ends inside an ellipsis. */
20408 row
->ends_in_ellipsis_p
20409 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20410 && it
->ellipsis_p
);
20412 /* Save fringe bitmaps in this row. */
20413 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20414 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20415 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20416 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20418 it
->left_user_fringe_bitmap
= 0;
20419 it
->left_user_fringe_face_id
= 0;
20420 it
->right_user_fringe_bitmap
= 0;
20421 it
->right_user_fringe_face_id
= 0;
20423 /* Maybe set the cursor. */
20424 cvpos
= it
->w
->cursor
.vpos
;
20426 /* In bidi-reordered rows, keep checking for proper cursor
20427 position even if one has been found already, because buffer
20428 positions in such rows change non-linearly with ROW->VPOS,
20429 when a line is continued. One exception: when we are at ZV,
20430 display cursor on the first suitable glyph row, since all
20431 the empty rows after that also have their position set to ZV. */
20432 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20433 lines' rows is implemented for bidi-reordered rows. */
20435 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20436 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20437 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20438 && cursor_row_p (row
))
20439 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20441 /* Prepare for the next line. This line starts horizontally at (X
20442 HPOS) = (0 0). Vertical positions are incremented. As a
20443 convenience for the caller, IT->glyph_row is set to the next
20445 it
->current_x
= it
->hpos
= 0;
20446 it
->current_y
+= row
->height
;
20447 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20450 /* The next row should by default use the same value of the
20451 reversed_p flag as this one. set_iterator_to_next decides when
20452 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20453 the flag accordingly. */
20454 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20455 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20456 it
->start
= row
->end
;
20457 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20459 #undef RECORD_MAX_MIN_POS
20462 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20463 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20464 doc
: /* Return paragraph direction at point in BUFFER.
20465 Value is either `left-to-right' or `right-to-left'.
20466 If BUFFER is omitted or nil, it defaults to the current buffer.
20468 Paragraph direction determines how the text in the paragraph is displayed.
20469 In left-to-right paragraphs, text begins at the left margin of the window
20470 and the reading direction is generally left to right. In right-to-left
20471 paragraphs, text begins at the right margin and is read from right to left.
20473 See also `bidi-paragraph-direction'. */)
20474 (Lisp_Object buffer
)
20476 struct buffer
*buf
= current_buffer
;
20477 struct buffer
*old
= buf
;
20479 if (! NILP (buffer
))
20481 CHECK_BUFFER (buffer
);
20482 buf
= XBUFFER (buffer
);
20485 if (NILP (BVAR (buf
, bidi_display_reordering
))
20486 || NILP (BVAR (buf
, enable_multibyte_characters
))
20487 /* When we are loading loadup.el, the character property tables
20488 needed for bidi iteration are not yet available. */
20489 || !NILP (Vpurify_flag
))
20490 return Qleft_to_right
;
20491 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20492 return BVAR (buf
, bidi_paragraph_direction
);
20495 /* Determine the direction from buffer text. We could try to
20496 use current_matrix if it is up to date, but this seems fast
20497 enough as it is. */
20498 struct bidi_it itb
;
20499 ptrdiff_t pos
= BUF_PT (buf
);
20500 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20502 void *itb_data
= bidi_shelve_cache ();
20504 set_buffer_temp (buf
);
20505 /* bidi_paragraph_init finds the base direction of the paragraph
20506 by searching forward from paragraph start. We need the base
20507 direction of the current or _previous_ paragraph, so we need
20508 to make sure we are within that paragraph. To that end, find
20509 the previous non-empty line. */
20510 if (pos
>= ZV
&& pos
> BEGV
)
20511 DEC_BOTH (pos
, bytepos
);
20512 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20513 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20515 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20516 || c
== ' ' || c
== '\t' || c
== '\f')
20518 if (bytepos
<= BEGV_BYTE
)
20523 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20526 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20527 itb
.paragraph_dir
= NEUTRAL_DIR
;
20528 itb
.string
.s
= NULL
;
20529 itb
.string
.lstring
= Qnil
;
20530 itb
.string
.bufpos
= 0;
20531 itb
.string
.from_disp_str
= 0;
20532 itb
.string
.unibyte
= 0;
20533 /* We have no window to use here for ignoring window-specific
20534 overlays. Using NULL for window pointer will cause
20535 compute_display_string_pos to use the current buffer. */
20537 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20538 bidi_unshelve_cache (itb_data
, 0);
20539 set_buffer_temp (old
);
20540 switch (itb
.paragraph_dir
)
20543 return Qleft_to_right
;
20546 return Qright_to_left
;
20554 DEFUN ("move-point-visually", Fmove_point_visually
,
20555 Smove_point_visually
, 1, 1, 0,
20556 doc
: /* Move point in the visual order in the specified DIRECTION.
20557 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20560 Value is the new character position of point. */)
20561 (Lisp_Object direction
)
20563 struct window
*w
= XWINDOW (selected_window
);
20564 struct buffer
*b
= XBUFFER (w
->contents
);
20565 struct glyph_row
*row
;
20567 Lisp_Object paragraph_dir
;
20569 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20570 (!(ROW)->continued_p \
20571 && INTEGERP ((GLYPH)->object) \
20572 && (GLYPH)->type == CHAR_GLYPH \
20573 && (GLYPH)->u.ch == ' ' \
20574 && (GLYPH)->charpos >= 0 \
20575 && !(GLYPH)->avoid_cursor_p)
20577 CHECK_NUMBER (direction
);
20578 dir
= XINT (direction
);
20584 /* If current matrix is up-to-date, we can use the information
20585 recorded in the glyphs, at least as long as the goal is on the
20587 if (w
->window_end_valid
20588 && !windows_or_buffers_changed
20590 && !b
->clip_changed
20591 && !b
->prevent_redisplay_optimizations_p
20592 && !window_outdated (w
)
20593 && w
->cursor
.vpos
>= 0
20594 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20595 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20597 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20598 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20599 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20601 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20603 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20605 SET_PT (g
->charpos
);
20606 w
->cursor
.vpos
= -1;
20607 return make_number (PT
);
20609 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20613 if (BUFFERP (gpt
->object
))
20616 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20617 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20619 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20621 else if (BUFFERP (g
->object
))
20622 new_pos
= g
->charpos
;
20626 w
->cursor
.vpos
= -1;
20627 return make_number (PT
);
20629 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20631 /* Glyphs inserted at the end of a non-empty line for
20632 positioning the cursor have zero charpos, so we must
20633 deduce the value of point by other means. */
20634 if (g
->charpos
> 0)
20635 SET_PT (g
->charpos
);
20636 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20638 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20639 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20642 w
->cursor
.vpos
= -1;
20643 return make_number (PT
);
20646 if (g
== e
|| INTEGERP (g
->object
))
20648 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20649 goto simulate_display
;
20650 if (!row
->reversed_p
)
20654 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20655 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20656 goto simulate_display
;
20660 if (row
->reversed_p
&& !row
->continued_p
)
20662 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20663 w
->cursor
.vpos
= -1;
20664 return make_number (PT
);
20666 g
= row
->glyphs
[TEXT_AREA
];
20667 e
= g
+ row
->used
[TEXT_AREA
];
20668 for ( ; g
< e
; g
++)
20670 if (BUFFERP (g
->object
)
20671 /* Empty lines have only one glyph, which stands
20672 for the newline, and whose charpos is the
20673 buffer position of the newline. */
20674 || ROW_GLYPH_NEWLINE_P (row
, g
)
20675 /* When the buffer ends in a newline, the line at
20676 EOB also has one glyph, but its charpos is -1. */
20677 || (row
->ends_at_zv_p
20678 && !row
->reversed_p
20679 && INTEGERP (g
->object
)
20680 && g
->type
== CHAR_GLYPH
20681 && g
->u
.ch
== ' '))
20683 if (g
->charpos
> 0)
20684 SET_PT (g
->charpos
);
20685 else if (!row
->reversed_p
20686 && row
->ends_at_zv_p
20691 w
->cursor
.vpos
= -1;
20692 return make_number (PT
);
20698 if (!row
->reversed_p
&& !row
->continued_p
)
20700 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20701 w
->cursor
.vpos
= -1;
20702 return make_number (PT
);
20704 e
= row
->glyphs
[TEXT_AREA
];
20705 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20706 for ( ; g
>= e
; g
--)
20708 if (BUFFERP (g
->object
)
20709 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20711 /* Empty R2L lines on GUI frames have the buffer
20712 position of the newline stored in the stretch
20714 || g
->type
== STRETCH_GLYPH
20715 || (row
->ends_at_zv_p
20717 && INTEGERP (g
->object
)
20718 && g
->type
== CHAR_GLYPH
20719 && g
->u
.ch
== ' '))
20721 if (g
->charpos
> 0)
20722 SET_PT (g
->charpos
);
20723 else if (row
->reversed_p
20724 && row
->ends_at_zv_p
20729 w
->cursor
.vpos
= -1;
20730 return make_number (PT
);
20739 /* If we wind up here, we failed to move by using the glyphs, so we
20740 need to simulate display instead. */
20743 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20745 paragraph_dir
= Qleft_to_right
;
20746 if (EQ (paragraph_dir
, Qright_to_left
))
20748 if (PT
<= BEGV
&& dir
< 0)
20749 xsignal0 (Qbeginning_of_buffer
);
20750 else if (PT
>= ZV
&& dir
> 0)
20751 xsignal0 (Qend_of_buffer
);
20754 struct text_pos pt
;
20756 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20758 bool overshoot_expected
= false;
20759 bool target_is_eol_p
= false;
20761 /* Setup the arena. */
20762 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20763 start_display (&it
, w
, pt
);
20765 if (it
.cmp_it
.id
< 0
20766 && it
.method
== GET_FROM_STRING
20767 && it
.area
== TEXT_AREA
20768 && it
.string_from_display_prop_p
20769 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20770 overshoot_expected
= true;
20772 /* Find the X coordinate of point. We start from the beginning
20773 of this or previous line to make sure we are before point in
20774 the logical order (since the move_it_* functions can only
20777 reseat_at_previous_visible_line_start (&it
);
20778 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20779 if (IT_CHARPOS (it
) != PT
)
20781 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20782 -1, -1, -1, MOVE_TO_POS
);
20783 /* If we missed point because the character there is
20784 displayed out of a display vector that has more than one
20785 glyph, retry expecting overshoot. */
20786 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20787 && it
.current
.dpvec_index
> 0
20788 && !overshoot_expected
)
20790 overshoot_expected
= true;
20793 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20794 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20796 pt_x
= it
.current_x
;
20798 if (dir
> 0 || overshoot_expected
)
20800 struct glyph_row
*row
= it
.glyph_row
;
20802 /* When point is at beginning of line, we don't have
20803 information about the glyph there loaded into struct
20804 it. Calling get_next_display_element fixes that. */
20806 get_next_display_element (&it
);
20807 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20808 it
.glyph_row
= NULL
;
20809 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
20810 it
.glyph_row
= row
;
20811 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20812 it, lest it will become out of sync with it's buffer
20814 it
.current_x
= pt_x
;
20817 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20818 pixel_width
= it
.pixel_width
;
20819 if (overshoot_expected
&& at_eol_p
)
20821 else if (pixel_width
<= 0)
20824 /* If there's a display string (or something similar) at point,
20825 we are actually at the glyph to the left of point, so we need
20826 to correct the X coordinate. */
20827 if (overshoot_expected
)
20830 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
20832 pt_x
+= pixel_width
;
20835 /* Compute target X coordinate, either to the left or to the
20836 right of point. On TTY frames, all characters have the same
20837 pixel width of 1, so we can use that. On GUI frames we don't
20838 have an easy way of getting at the pixel width of the
20839 character to the left of point, so we use a different method
20840 of getting to that place. */
20842 target_x
= pt_x
+ pixel_width
;
20844 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
20846 /* Target X coordinate could be one line above or below the line
20847 of point, in which case we need to adjust the target X
20848 coordinate. Also, if moving to the left, we need to begin at
20849 the left edge of the point's screen line. */
20854 start_display (&it
, w
, pt
);
20855 reseat_at_previous_visible_line_start (&it
);
20856 it
.current_x
= it
.current_y
= it
.hpos
= 0;
20858 move_it_by_lines (&it
, pt_vpos
);
20862 move_it_by_lines (&it
, -1);
20863 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
20864 target_is_eol_p
= true;
20865 /* Under word-wrap, we don't know the x coordinate of
20866 the last character displayed on the previous line,
20867 which immediately precedes the wrap point. To find
20868 out its x coordinate, we try moving to the right
20869 margin of the window, which will stop at the wrap
20870 point, and then reset target_x to point at the
20871 character that precedes the wrap point. This is not
20872 needed on GUI frames, because (see below) there we
20873 move from the left margin one grapheme cluster at a
20874 time, and stop when we hit the wrap point. */
20875 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
20877 void *it_data
= NULL
;
20880 SAVE_IT (it2
, it
, it_data
);
20881 move_it_in_display_line_to (&it
, ZV
, target_x
,
20882 MOVE_TO_POS
| MOVE_TO_X
);
20883 target_x
= it
.current_x
- 1;
20884 RESTORE_IT (&it
, &it2
, it_data
);
20891 || (target_x
>= it
.last_visible_x
20892 && it
.line_wrap
!= TRUNCATE
))
20895 move_it_by_lines (&it
, 0);
20896 move_it_by_lines (&it
, 1);
20901 /* Move to the target X coordinate. */
20902 #ifdef HAVE_WINDOW_SYSTEM
20903 /* On GUI frames, as we don't know the X coordinate of the
20904 character to the left of point, moving point to the left
20905 requires walking, one grapheme cluster at a time, until we
20906 find ourself at a place immediately to the left of the
20907 character at point. */
20908 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
20910 struct text_pos new_pos
;
20911 enum move_it_result rc
= MOVE_X_REACHED
;
20913 if (it
.current_x
== 0)
20914 get_next_display_element (&it
);
20915 if (it
.what
== IT_COMPOSITION
)
20917 new_pos
.charpos
= it
.cmp_it
.charpos
;
20918 new_pos
.bytepos
= -1;
20921 new_pos
= it
.current
.pos
;
20923 while (it
.current_x
+ it
.pixel_width
<= target_x
20924 && (rc
== MOVE_X_REACHED
20925 /* Under word-wrap, move_it_in_display_line_to
20926 stops at correct coordinates, but sometimes
20927 returns MOVE_POS_MATCH_OR_ZV. */
20928 || (it
.line_wrap
== WORD_WRAP
20929 && rc
== MOVE_POS_MATCH_OR_ZV
)))
20931 int new_x
= it
.current_x
+ it
.pixel_width
;
20933 /* For composed characters, we want the position of the
20934 first character in the grapheme cluster (usually, the
20935 composition's base character), whereas it.current
20936 might give us the position of the _last_ one, e.g. if
20937 the composition is rendered in reverse due to bidi
20939 if (it
.what
== IT_COMPOSITION
)
20941 new_pos
.charpos
= it
.cmp_it
.charpos
;
20942 new_pos
.bytepos
= -1;
20945 new_pos
= it
.current
.pos
;
20946 if (new_x
== it
.current_x
)
20948 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
20949 MOVE_TO_POS
| MOVE_TO_X
);
20950 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
20953 /* The previous position we saw in the loop is the one we
20955 if (new_pos
.bytepos
== -1)
20956 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
20957 it
.current
.pos
= new_pos
;
20961 if (it
.current_x
!= target_x
)
20962 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
20964 /* When lines are truncated, the above loop will stop at the
20965 window edge. But we want to get to the end of line, even if
20966 it is beyond the window edge; automatic hscroll will then
20967 scroll the window to show point as appropriate. */
20968 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
20969 && get_next_display_element (&it
))
20971 struct text_pos new_pos
= it
.current
.pos
;
20973 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
20975 set_iterator_to_next (&it
, 0);
20976 if (it
.method
== GET_FROM_BUFFER
)
20977 new_pos
= it
.current
.pos
;
20978 if (!get_next_display_element (&it
))
20982 it
.current
.pos
= new_pos
;
20985 /* If we ended up in a display string that covers point, move to
20986 buffer position to the right in the visual order. */
20989 while (IT_CHARPOS (it
) == PT
)
20991 set_iterator_to_next (&it
, 0);
20992 if (!get_next_display_element (&it
))
20997 /* Move point to that position. */
20998 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21001 return make_number (PT
);
21003 #undef ROW_GLYPH_NEWLINE_P
21007 /***********************************************************************
21009 ***********************************************************************/
21011 /* Redisplay the menu bar in the frame for window W.
21013 The menu bar of X frames that don't have X toolkit support is
21014 displayed in a special window W->frame->menu_bar_window.
21016 The menu bar of terminal frames is treated specially as far as
21017 glyph matrices are concerned. Menu bar lines are not part of
21018 windows, so the update is done directly on the frame matrix rows
21019 for the menu bar. */
21022 display_menu_bar (struct window
*w
)
21024 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21029 /* Don't do all this for graphical frames. */
21031 if (FRAME_W32_P (f
))
21034 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21040 if (FRAME_NS_P (f
))
21042 #endif /* HAVE_NS */
21044 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21045 eassert (!FRAME_WINDOW_P (f
));
21046 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21047 it
.first_visible_x
= 0;
21048 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21049 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21050 if (FRAME_WINDOW_P (f
))
21052 /* Menu bar lines are displayed in the desired matrix of the
21053 dummy window menu_bar_window. */
21054 struct window
*menu_w
;
21055 menu_w
= XWINDOW (f
->menu_bar_window
);
21056 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21058 it
.first_visible_x
= 0;
21059 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21062 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21064 /* This is a TTY frame, i.e. character hpos/vpos are used as
21066 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21068 it
.first_visible_x
= 0;
21069 it
.last_visible_x
= FRAME_COLS (f
);
21072 /* FIXME: This should be controlled by a user option. See the
21073 comments in redisplay_tool_bar and display_mode_line about
21075 it
.paragraph_embedding
= L2R
;
21077 /* Clear all rows of the menu bar. */
21078 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21080 struct glyph_row
*row
= it
.glyph_row
+ i
;
21081 clear_glyph_row (row
);
21082 row
->enabled_p
= true;
21083 row
->full_width_p
= 1;
21086 /* Display all items of the menu bar. */
21087 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21088 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21090 Lisp_Object string
;
21092 /* Stop at nil string. */
21093 string
= AREF (items
, i
+ 1);
21097 /* Remember where item was displayed. */
21098 ASET (items
, i
+ 3, make_number (it
.hpos
));
21100 /* Display the item, pad with one space. */
21101 if (it
.current_x
< it
.last_visible_x
)
21102 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21103 SCHARS (string
) + 1, 0, 0, -1);
21106 /* Fill out the line with spaces. */
21107 if (it
.current_x
< it
.last_visible_x
)
21108 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21110 /* Compute the total height of the lines. */
21111 compute_line_metrics (&it
);
21114 /* Deep copy of a glyph row, including the glyphs. */
21116 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21118 struct glyph
*pointers
[1 + LAST_AREA
];
21119 int to_used
= to
->used
[TEXT_AREA
];
21121 /* Save glyph pointers of TO. */
21122 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21124 /* Do a structure assignment. */
21127 /* Restore original glyph pointers of TO. */
21128 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21130 /* Copy the glyphs. */
21131 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21132 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21134 /* If we filled only part of the TO row, fill the rest with
21135 space_glyph (which will display as empty space). */
21136 if (to_used
> from
->used
[TEXT_AREA
])
21137 fill_up_frame_row_with_spaces (to
, to_used
);
21140 /* Display one menu item on a TTY, by overwriting the glyphs in the
21141 frame F's desired glyph matrix with glyphs produced from the menu
21142 item text. Called from term.c to display TTY drop-down menus one
21145 ITEM_TEXT is the menu item text as a C string.
21147 FACE_ID is the face ID to be used for this menu item. FACE_ID
21148 could specify one of 3 faces: a face for an enabled item, a face
21149 for a disabled item, or a face for a selected item.
21151 X and Y are coordinates of the first glyph in the frame's desired
21152 matrix to be overwritten by the menu item. Since this is a TTY, Y
21153 is the zero-based number of the glyph row and X is the zero-based
21154 glyph number in the row, starting from left, where to start
21155 displaying the item.
21157 SUBMENU non-zero means this menu item drops down a submenu, which
21158 should be indicated by displaying a proper visual cue after the
21162 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21163 int x
, int y
, int submenu
)
21166 struct frame
*f
= SELECTED_FRAME ();
21167 struct window
*w
= XWINDOW (f
->selected_window
);
21168 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21169 struct glyph_row
*row
;
21170 size_t item_len
= strlen (item_text
);
21172 eassert (FRAME_TERMCAP_P (f
));
21174 /* Don't write beyond the matrix's last row. This can happen for
21175 TTY screens that are not high enough to show the entire menu.
21176 (This is actually a bit of defensive programming, as
21177 tty_menu_display already limits the number of menu items to one
21178 less than the number of screen lines.) */
21179 if (y
>= f
->desired_matrix
->nrows
)
21182 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21183 it
.first_visible_x
= 0;
21184 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21185 row
= it
.glyph_row
;
21186 /* Start with the row contents from the current matrix. */
21187 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21188 saved_width
= row
->full_width_p
;
21189 row
->full_width_p
= 1;
21190 saved_reversed
= row
->reversed_p
;
21191 row
->reversed_p
= 0;
21192 row
->enabled_p
= true;
21194 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21196 eassert (x
< f
->desired_matrix
->matrix_w
);
21197 it
.current_x
= it
.hpos
= x
;
21198 it
.current_y
= it
.vpos
= y
;
21199 saved_used
= row
->used
[TEXT_AREA
];
21200 saved_truncated
= row
->truncated_on_right_p
;
21201 row
->used
[TEXT_AREA
] = x
;
21202 it
.face_id
= face_id
;
21203 it
.line_wrap
= TRUNCATE
;
21205 /* FIXME: This should be controlled by a user option. See the
21206 comments in redisplay_tool_bar and display_mode_line about this.
21207 Also, if paragraph_embedding could ever be R2L, changes will be
21208 needed to avoid shifting to the right the row characters in
21209 term.c:append_glyph. */
21210 it
.paragraph_embedding
= L2R
;
21212 /* Pad with a space on the left. */
21213 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21215 /* Display the menu item, pad with spaces to WIDTH. */
21218 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21219 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21221 /* Indicate with " >" that there's a submenu. */
21222 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21223 FRAME_COLS (f
) - 1, -1);
21226 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21227 width
, 0, FRAME_COLS (f
) - 1, -1);
21229 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21230 row
->truncated_on_right_p
= saved_truncated
;
21231 row
->hash
= row_hash (row
);
21232 row
->full_width_p
= saved_width
;
21233 row
->reversed_p
= saved_reversed
;
21236 /***********************************************************************
21238 ***********************************************************************/
21240 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21241 FORCE is non-zero, redisplay mode lines unconditionally.
21242 Otherwise, redisplay only mode lines that are garbaged. Value is
21243 the number of windows whose mode lines were redisplayed. */
21246 redisplay_mode_lines (Lisp_Object window
, bool force
)
21250 while (!NILP (window
))
21252 struct window
*w
= XWINDOW (window
);
21254 if (WINDOWP (w
->contents
))
21255 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21257 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21258 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21260 struct text_pos lpoint
;
21261 struct buffer
*old
= current_buffer
;
21263 /* Set the window's buffer for the mode line display. */
21264 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21265 set_buffer_internal_1 (XBUFFER (w
->contents
));
21267 /* Point refers normally to the selected window. For any
21268 other window, set up appropriate value. */
21269 if (!EQ (window
, selected_window
))
21271 struct text_pos pt
;
21273 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21274 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21277 /* Display mode lines. */
21278 clear_glyph_matrix (w
->desired_matrix
);
21279 if (display_mode_lines (w
))
21282 /* Restore old settings. */
21283 set_buffer_internal_1 (old
);
21284 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21294 /* Display the mode and/or header line of window W. Value is the
21295 sum number of mode lines and header lines displayed. */
21298 display_mode_lines (struct window
*w
)
21300 Lisp_Object old_selected_window
= selected_window
;
21301 Lisp_Object old_selected_frame
= selected_frame
;
21302 Lisp_Object new_frame
= w
->frame
;
21303 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21306 selected_frame
= new_frame
;
21307 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21308 or window's point, then we'd need select_window_1 here as well. */
21309 XSETWINDOW (selected_window
, w
);
21310 XFRAME (new_frame
)->selected_window
= selected_window
;
21312 /* These will be set while the mode line specs are processed. */
21313 line_number_displayed
= 0;
21314 w
->column_number_displayed
= -1;
21316 if (WINDOW_WANTS_MODELINE_P (w
))
21318 struct window
*sel_w
= XWINDOW (old_selected_window
);
21320 /* Select mode line face based on the real selected window. */
21321 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21322 BVAR (current_buffer
, mode_line_format
));
21326 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21328 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21329 BVAR (current_buffer
, header_line_format
));
21333 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21334 selected_frame
= old_selected_frame
;
21335 selected_window
= old_selected_window
;
21337 w
->must_be_updated_p
= true;
21342 /* Display mode or header line of window W. FACE_ID specifies which
21343 line to display; it is either MODE_LINE_FACE_ID or
21344 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21345 display. Value is the pixel height of the mode/header line
21349 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21353 ptrdiff_t count
= SPECPDL_INDEX ();
21355 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21356 /* Don't extend on a previously drawn mode-line.
21357 This may happen if called from pos_visible_p. */
21358 it
.glyph_row
->enabled_p
= false;
21359 prepare_desired_row (it
.glyph_row
);
21361 it
.glyph_row
->mode_line_p
= 1;
21363 /* FIXME: This should be controlled by a user option. But
21364 supporting such an option is not trivial, since the mode line is
21365 made up of many separate strings. */
21366 it
.paragraph_embedding
= L2R
;
21368 record_unwind_protect (unwind_format_mode_line
,
21369 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21371 mode_line_target
= MODE_LINE_DISPLAY
;
21373 /* Temporarily make frame's keyboard the current kboard so that
21374 kboard-local variables in the mode_line_format will get the right
21376 push_kboard (FRAME_KBOARD (it
.f
));
21377 record_unwind_save_match_data ();
21378 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21381 unbind_to (count
, Qnil
);
21383 /* Fill up with spaces. */
21384 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21386 compute_line_metrics (&it
);
21387 it
.glyph_row
->full_width_p
= 1;
21388 it
.glyph_row
->continued_p
= 0;
21389 it
.glyph_row
->truncated_on_left_p
= 0;
21390 it
.glyph_row
->truncated_on_right_p
= 0;
21392 /* Make a 3D mode-line have a shadow at its right end. */
21393 face
= FACE_FROM_ID (it
.f
, face_id
);
21394 extend_face_to_end_of_line (&it
);
21395 if (face
->box
!= FACE_NO_BOX
)
21397 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21398 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21399 last
->right_box_line_p
= 1;
21402 return it
.glyph_row
->height
;
21405 /* Move element ELT in LIST to the front of LIST.
21406 Return the updated list. */
21409 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21411 register Lisp_Object tail
, prev
;
21412 register Lisp_Object tem
;
21416 while (CONSP (tail
))
21422 /* Splice out the link TAIL. */
21424 list
= XCDR (tail
);
21426 Fsetcdr (prev
, XCDR (tail
));
21428 /* Now make it the first. */
21429 Fsetcdr (tail
, list
);
21434 tail
= XCDR (tail
);
21438 /* Not found--return unchanged LIST. */
21442 /* Contribute ELT to the mode line for window IT->w. How it
21443 translates into text depends on its data type.
21445 IT describes the display environment in which we display, as usual.
21447 DEPTH is the depth in recursion. It is used to prevent
21448 infinite recursion here.
21450 FIELD_WIDTH is the number of characters the display of ELT should
21451 occupy in the mode line, and PRECISION is the maximum number of
21452 characters to display from ELT's representation. See
21453 display_string for details.
21455 Returns the hpos of the end of the text generated by ELT.
21457 PROPS is a property list to add to any string we encounter.
21459 If RISKY is nonzero, remove (disregard) any properties in any string
21460 we encounter, and ignore :eval and :propertize.
21462 The global variable `mode_line_target' determines whether the
21463 output is passed to `store_mode_line_noprop',
21464 `store_mode_line_string', or `display_string'. */
21467 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21468 Lisp_Object elt
, Lisp_Object props
, int risky
)
21470 int n
= 0, field
, prec
;
21475 elt
= build_string ("*too-deep*");
21479 switch (XTYPE (elt
))
21483 /* A string: output it and check for %-constructs within it. */
21485 ptrdiff_t offset
= 0;
21487 if (SCHARS (elt
) > 0
21488 && (!NILP (props
) || risky
))
21490 Lisp_Object oprops
, aelt
;
21491 oprops
= Ftext_properties_at (make_number (0), elt
);
21493 /* If the starting string's properties are not what
21494 we want, translate the string. Also, if the string
21495 is risky, do that anyway. */
21497 if (NILP (Fequal (props
, oprops
)) || risky
)
21499 /* If the starting string has properties,
21500 merge the specified ones onto the existing ones. */
21501 if (! NILP (oprops
) && !risky
)
21505 oprops
= Fcopy_sequence (oprops
);
21507 while (CONSP (tem
))
21509 oprops
= Fplist_put (oprops
, XCAR (tem
),
21510 XCAR (XCDR (tem
)));
21511 tem
= XCDR (XCDR (tem
));
21516 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21517 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21519 /* AELT is what we want. Move it to the front
21520 without consing. */
21522 mode_line_proptrans_alist
21523 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21529 /* If AELT has the wrong props, it is useless.
21530 so get rid of it. */
21532 mode_line_proptrans_alist
21533 = Fdelq (aelt
, mode_line_proptrans_alist
);
21535 elt
= Fcopy_sequence (elt
);
21536 Fset_text_properties (make_number (0), Flength (elt
),
21538 /* Add this item to mode_line_proptrans_alist. */
21539 mode_line_proptrans_alist
21540 = Fcons (Fcons (elt
, props
),
21541 mode_line_proptrans_alist
);
21542 /* Truncate mode_line_proptrans_alist
21543 to at most 50 elements. */
21544 tem
= Fnthcdr (make_number (50),
21545 mode_line_proptrans_alist
);
21547 XSETCDR (tem
, Qnil
);
21556 prec
= precision
- n
;
21557 switch (mode_line_target
)
21559 case MODE_LINE_NOPROP
:
21560 case MODE_LINE_TITLE
:
21561 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21563 case MODE_LINE_STRING
:
21564 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21566 case MODE_LINE_DISPLAY
:
21567 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21568 0, prec
, 0, STRING_MULTIBYTE (elt
));
21575 /* Handle the non-literal case. */
21577 while ((precision
<= 0 || n
< precision
)
21578 && SREF (elt
, offset
) != 0
21579 && (mode_line_target
!= MODE_LINE_DISPLAY
21580 || it
->current_x
< it
->last_visible_x
))
21582 ptrdiff_t last_offset
= offset
;
21584 /* Advance to end of string or next format specifier. */
21585 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21588 if (offset
- 1 != last_offset
)
21590 ptrdiff_t nchars
, nbytes
;
21592 /* Output to end of string or up to '%'. Field width
21593 is length of string. Don't output more than
21594 PRECISION allows us. */
21597 prec
= c_string_width (SDATA (elt
) + last_offset
,
21598 offset
- last_offset
, precision
- n
,
21601 switch (mode_line_target
)
21603 case MODE_LINE_NOPROP
:
21604 case MODE_LINE_TITLE
:
21605 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21607 case MODE_LINE_STRING
:
21609 ptrdiff_t bytepos
= last_offset
;
21610 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21611 ptrdiff_t endpos
= (precision
<= 0
21612 ? string_byte_to_char (elt
, offset
)
21613 : charpos
+ nchars
);
21615 n
+= store_mode_line_string (NULL
,
21616 Fsubstring (elt
, make_number (charpos
),
21617 make_number (endpos
)),
21621 case MODE_LINE_DISPLAY
:
21623 ptrdiff_t bytepos
= last_offset
;
21624 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21626 if (precision
<= 0)
21627 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21628 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21630 STRING_MULTIBYTE (elt
));
21635 else /* c == '%' */
21637 ptrdiff_t percent_position
= offset
;
21639 /* Get the specified minimum width. Zero means
21642 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21643 field
= field
* 10 + c
- '0';
21645 /* Don't pad beyond the total padding allowed. */
21646 if (field_width
- n
> 0 && field
> field_width
- n
)
21647 field
= field_width
- n
;
21649 /* Note that either PRECISION <= 0 or N < PRECISION. */
21650 prec
= precision
- n
;
21653 n
+= display_mode_element (it
, depth
, field
, prec
,
21654 Vglobal_mode_string
, props
,
21659 ptrdiff_t bytepos
, charpos
;
21661 Lisp_Object string
;
21663 bytepos
= percent_position
;
21664 charpos
= (STRING_MULTIBYTE (elt
)
21665 ? string_byte_to_char (elt
, bytepos
)
21667 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21668 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21670 switch (mode_line_target
)
21672 case MODE_LINE_NOPROP
:
21673 case MODE_LINE_TITLE
:
21674 n
+= store_mode_line_noprop (spec
, field
, prec
);
21676 case MODE_LINE_STRING
:
21678 Lisp_Object tem
= build_string (spec
);
21679 props
= Ftext_properties_at (make_number (charpos
), elt
);
21680 /* Should only keep face property in props */
21681 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21684 case MODE_LINE_DISPLAY
:
21686 int nglyphs_before
, nwritten
;
21688 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21689 nwritten
= display_string (spec
, string
, elt
,
21694 /* Assign to the glyphs written above the
21695 string where the `%x' came from, position
21699 struct glyph
*glyph
21700 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21704 for (i
= 0; i
< nwritten
; ++i
)
21706 glyph
[i
].object
= elt
;
21707 glyph
[i
].charpos
= charpos
;
21724 /* A symbol: process the value of the symbol recursively
21725 as if it appeared here directly. Avoid error if symbol void.
21726 Special case: if value of symbol is a string, output the string
21729 register Lisp_Object tem
;
21731 /* If the variable is not marked as risky to set
21732 then its contents are risky to use. */
21733 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21736 tem
= Fboundp (elt
);
21739 tem
= Fsymbol_value (elt
);
21740 /* If value is a string, output that string literally:
21741 don't check for % within it. */
21745 if (!EQ (tem
, elt
))
21747 /* Give up right away for nil or t. */
21757 register Lisp_Object car
, tem
;
21759 /* A cons cell: five distinct cases.
21760 If first element is :eval or :propertize, do something special.
21761 If first element is a string or a cons, process all the elements
21762 and effectively concatenate them.
21763 If first element is a negative number, truncate displaying cdr to
21764 at most that many characters. If positive, pad (with spaces)
21765 to at least that many characters.
21766 If first element is a symbol, process the cadr or caddr recursively
21767 according to whether the symbol's value is non-nil or nil. */
21769 if (EQ (car
, QCeval
))
21771 /* An element of the form (:eval FORM) means evaluate FORM
21772 and use the result as mode line elements. */
21777 if (CONSP (XCDR (elt
)))
21780 spec
= safe_eval (XCAR (XCDR (elt
)));
21781 n
+= display_mode_element (it
, depth
, field_width
- n
,
21782 precision
- n
, spec
, props
,
21786 else if (EQ (car
, QCpropertize
))
21788 /* An element of the form (:propertize ELT PROPS...)
21789 means display ELT but applying properties PROPS. */
21794 if (CONSP (XCDR (elt
)))
21795 n
+= display_mode_element (it
, depth
, field_width
- n
,
21796 precision
- n
, XCAR (XCDR (elt
)),
21797 XCDR (XCDR (elt
)), risky
);
21799 else if (SYMBOLP (car
))
21801 tem
= Fboundp (car
);
21805 /* elt is now the cdr, and we know it is a cons cell.
21806 Use its car if CAR has a non-nil value. */
21809 tem
= Fsymbol_value (car
);
21816 /* Symbol's value is nil (or symbol is unbound)
21817 Get the cddr of the original list
21818 and if possible find the caddr and use that. */
21822 else if (!CONSP (elt
))
21827 else if (INTEGERP (car
))
21829 register int lim
= XINT (car
);
21833 /* Negative int means reduce maximum width. */
21834 if (precision
<= 0)
21837 precision
= min (precision
, -lim
);
21841 /* Padding specified. Don't let it be more than
21842 current maximum. */
21844 lim
= min (precision
, lim
);
21846 /* If that's more padding than already wanted, queue it.
21847 But don't reduce padding already specified even if
21848 that is beyond the current truncation point. */
21849 field_width
= max (lim
, field_width
);
21853 else if (STRINGP (car
) || CONSP (car
))
21855 Lisp_Object halftail
= elt
;
21859 && (precision
<= 0 || n
< precision
))
21861 n
+= display_mode_element (it
, depth
,
21862 /* Do padding only after the last
21863 element in the list. */
21864 (! CONSP (XCDR (elt
))
21867 precision
- n
, XCAR (elt
),
21871 if ((len
& 1) == 0)
21872 halftail
= XCDR (halftail
);
21873 /* Check for cycle. */
21874 if (EQ (halftail
, elt
))
21883 elt
= build_string ("*invalid*");
21887 /* Pad to FIELD_WIDTH. */
21888 if (field_width
> 0 && n
< field_width
)
21890 switch (mode_line_target
)
21892 case MODE_LINE_NOPROP
:
21893 case MODE_LINE_TITLE
:
21894 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
21896 case MODE_LINE_STRING
:
21897 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
21899 case MODE_LINE_DISPLAY
:
21900 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
21909 /* Store a mode-line string element in mode_line_string_list.
21911 If STRING is non-null, display that C string. Otherwise, the Lisp
21912 string LISP_STRING is displayed.
21914 FIELD_WIDTH is the minimum number of output glyphs to produce.
21915 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21916 with spaces. FIELD_WIDTH <= 0 means don't pad.
21918 PRECISION is the maximum number of characters to output from
21919 STRING. PRECISION <= 0 means don't truncate the string.
21921 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
21922 properties to the string.
21924 PROPS are the properties to add to the string.
21925 The mode_line_string_face face property is always added to the string.
21929 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
21930 int field_width
, int precision
, Lisp_Object props
)
21935 if (string
!= NULL
)
21937 len
= strlen (string
);
21938 if (precision
> 0 && len
> precision
)
21940 lisp_string
= make_string (string
, len
);
21942 props
= mode_line_string_face_prop
;
21943 else if (!NILP (mode_line_string_face
))
21945 Lisp_Object face
= Fplist_get (props
, Qface
);
21946 props
= Fcopy_sequence (props
);
21948 face
= mode_line_string_face
;
21950 face
= list2 (face
, mode_line_string_face
);
21951 props
= Fplist_put (props
, Qface
, face
);
21953 Fadd_text_properties (make_number (0), make_number (len
),
21954 props
, lisp_string
);
21958 len
= XFASTINT (Flength (lisp_string
));
21959 if (precision
> 0 && len
> precision
)
21962 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
21965 if (!NILP (mode_line_string_face
))
21969 props
= Ftext_properties_at (make_number (0), lisp_string
);
21970 face
= Fplist_get (props
, Qface
);
21972 face
= mode_line_string_face
;
21974 face
= list2 (face
, mode_line_string_face
);
21975 props
= list2 (Qface
, face
);
21977 lisp_string
= Fcopy_sequence (lisp_string
);
21980 Fadd_text_properties (make_number (0), make_number (len
),
21981 props
, lisp_string
);
21986 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
21990 if (field_width
> len
)
21992 field_width
-= len
;
21993 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
21995 Fadd_text_properties (make_number (0), make_number (field_width
),
21996 props
, lisp_string
);
21997 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22005 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22007 doc
: /* Format a string out of a mode line format specification.
22008 First arg FORMAT specifies the mode line format (see `mode-line-format'
22009 for details) to use.
22011 By default, the format is evaluated for the currently selected window.
22013 Optional second arg FACE specifies the face property to put on all
22014 characters for which no face is specified. The value nil means the
22015 default face. The value t means whatever face the window's mode line
22016 currently uses (either `mode-line' or `mode-line-inactive',
22017 depending on whether the window is the selected window or not).
22018 An integer value means the value string has no text
22021 Optional third and fourth args WINDOW and BUFFER specify the window
22022 and buffer to use as the context for the formatting (defaults
22023 are the selected window and the WINDOW's buffer). */)
22024 (Lisp_Object format
, Lisp_Object face
,
22025 Lisp_Object window
, Lisp_Object buffer
)
22030 struct buffer
*old_buffer
= NULL
;
22032 int no_props
= INTEGERP (face
);
22033 ptrdiff_t count
= SPECPDL_INDEX ();
22035 int string_start
= 0;
22037 w
= decode_any_window (window
);
22038 XSETWINDOW (window
, w
);
22041 buffer
= w
->contents
;
22042 CHECK_BUFFER (buffer
);
22044 /* Make formatting the modeline a non-op when noninteractive, otherwise
22045 there will be problems later caused by a partially initialized frame. */
22046 if (NILP (format
) || noninteractive
)
22047 return empty_unibyte_string
;
22052 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22053 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22054 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22055 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22056 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22057 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22058 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22061 old_buffer
= current_buffer
;
22063 /* Save things including mode_line_proptrans_alist,
22064 and set that to nil so that we don't alter the outer value. */
22065 record_unwind_protect (unwind_format_mode_line
,
22066 format_mode_line_unwind_data
22067 (XFRAME (WINDOW_FRAME (w
)),
22068 old_buffer
, selected_window
, 1));
22069 mode_line_proptrans_alist
= Qnil
;
22071 Fselect_window (window
, Qt
);
22072 set_buffer_internal_1 (XBUFFER (buffer
));
22074 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22078 mode_line_target
= MODE_LINE_NOPROP
;
22079 mode_line_string_face_prop
= Qnil
;
22080 mode_line_string_list
= Qnil
;
22081 string_start
= MODE_LINE_NOPROP_LEN (0);
22085 mode_line_target
= MODE_LINE_STRING
;
22086 mode_line_string_list
= Qnil
;
22087 mode_line_string_face
= face
;
22088 mode_line_string_face_prop
22089 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22092 push_kboard (FRAME_KBOARD (it
.f
));
22093 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22098 len
= MODE_LINE_NOPROP_LEN (string_start
);
22099 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22103 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22104 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22105 empty_unibyte_string
);
22108 unbind_to (count
, Qnil
);
22112 /* Write a null-terminated, right justified decimal representation of
22113 the positive integer D to BUF using a minimal field width WIDTH. */
22116 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22118 register char *p
= buf
;
22126 *p
++ = d
% 10 + '0';
22131 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22142 /* Write a null-terminated, right justified decimal and "human
22143 readable" representation of the nonnegative integer D to BUF using
22144 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22146 static const char power_letter
[] =
22160 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22162 /* We aim to represent the nonnegative integer D as
22163 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22164 ptrdiff_t quotient
= d
;
22166 /* -1 means: do not use TENTHS. */
22170 /* Length of QUOTIENT.TENTHS as a string. */
22176 if (quotient
>= 1000)
22178 /* Scale to the appropriate EXPONENT. */
22181 remainder
= quotient
% 1000;
22185 while (quotient
>= 1000);
22187 /* Round to nearest and decide whether to use TENTHS or not. */
22190 tenths
= remainder
/ 100;
22191 if (remainder
% 100 >= 50)
22198 if (quotient
== 10)
22206 if (remainder
>= 500)
22208 if (quotient
< 999)
22219 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22220 if (tenths
== -1 && quotient
<= 99)
22227 p
= psuffix
= buf
+ max (width
, length
);
22229 /* Print EXPONENT. */
22230 *psuffix
++ = power_letter
[exponent
];
22233 /* Print TENTHS. */
22236 *--p
= '0' + tenths
;
22240 /* Print QUOTIENT. */
22243 int digit
= quotient
% 10;
22244 *--p
= '0' + digit
;
22246 while ((quotient
/= 10) != 0);
22248 /* Print leading spaces. */
22253 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22254 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22255 type of CODING_SYSTEM. Return updated pointer into BUF. */
22257 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22260 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22263 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22264 const unsigned char *eol_str
;
22266 /* The EOL conversion we are using. */
22267 Lisp_Object eoltype
;
22269 val
= CODING_SYSTEM_SPEC (coding_system
);
22272 if (!VECTORP (val
)) /* Not yet decided. */
22274 *buf
++ = multibyte
? '-' : ' ';
22276 eoltype
= eol_mnemonic_undecided
;
22277 /* Don't mention EOL conversion if it isn't decided. */
22282 Lisp_Object eolvalue
;
22284 attrs
= AREF (val
, 0);
22285 eolvalue
= AREF (val
, 2);
22288 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22293 /* The EOL conversion that is normal on this system. */
22295 if (NILP (eolvalue
)) /* Not yet decided. */
22296 eoltype
= eol_mnemonic_undecided
;
22297 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22298 eoltype
= eol_mnemonic_undecided
;
22299 else /* eolvalue is Qunix, Qdos, or Qmac. */
22300 eoltype
= (EQ (eolvalue
, Qunix
)
22301 ? eol_mnemonic_unix
22302 : (EQ (eolvalue
, Qdos
) == 1
22303 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22309 /* Mention the EOL conversion if it is not the usual one. */
22310 if (STRINGP (eoltype
))
22312 eol_str
= SDATA (eoltype
);
22313 eol_str_len
= SBYTES (eoltype
);
22315 else if (CHARACTERP (eoltype
))
22317 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22318 int c
= XFASTINT (eoltype
);
22319 eol_str_len
= CHAR_STRING (c
, tmp
);
22324 eol_str
= invalid_eol_type
;
22325 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22327 memcpy (buf
, eol_str
, eol_str_len
);
22328 buf
+= eol_str_len
;
22334 /* Return a string for the output of a mode line %-spec for window W,
22335 generated by character C. FIELD_WIDTH > 0 means pad the string
22336 returned with spaces to that value. Return a Lisp string in
22337 *STRING if the resulting string is taken from that Lisp string.
22339 Note we operate on the current buffer for most purposes. */
22341 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22343 static const char *
22344 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22345 Lisp_Object
*string
)
22348 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22349 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22350 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22351 produce strings from numerical values, so limit preposterously
22352 large values of FIELD_WIDTH to avoid overrunning the buffer's
22353 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22354 bytes plus the terminating null. */
22355 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22356 struct buffer
*b
= current_buffer
;
22364 if (!NILP (BVAR (b
, read_only
)))
22366 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22371 /* This differs from %* only for a modified read-only buffer. */
22372 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22374 if (!NILP (BVAR (b
, read_only
)))
22379 /* This differs from %* in ignoring read-only-ness. */
22380 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22392 if (command_loop_level
> 5)
22394 p
= decode_mode_spec_buf
;
22395 for (i
= 0; i
< command_loop_level
; i
++)
22398 return decode_mode_spec_buf
;
22406 if (command_loop_level
> 5)
22408 p
= decode_mode_spec_buf
;
22409 for (i
= 0; i
< command_loop_level
; i
++)
22412 return decode_mode_spec_buf
;
22419 /* Let lots_of_dashes be a string of infinite length. */
22420 if (mode_line_target
== MODE_LINE_NOPROP
22421 || mode_line_target
== MODE_LINE_STRING
)
22423 if (field_width
<= 0
22424 || field_width
> sizeof (lots_of_dashes
))
22426 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22427 decode_mode_spec_buf
[i
] = '-';
22428 decode_mode_spec_buf
[i
] = '\0';
22429 return decode_mode_spec_buf
;
22432 return lots_of_dashes
;
22436 obj
= BVAR (b
, name
);
22440 /* %c and %l are ignored in `frame-title-format'.
22441 (In redisplay_internal, the frame title is drawn _before_ the
22442 windows are updated, so the stuff which depends on actual
22443 window contents (such as %l) may fail to render properly, or
22444 even crash emacs.) */
22445 if (mode_line_target
== MODE_LINE_TITLE
)
22449 ptrdiff_t col
= current_column ();
22450 w
->column_number_displayed
= col
;
22451 pint2str (decode_mode_spec_buf
, width
, col
);
22452 return decode_mode_spec_buf
;
22456 #ifndef SYSTEM_MALLOC
22458 if (NILP (Vmemory_full
))
22461 return "!MEM FULL! ";
22468 /* %F displays the frame name. */
22469 if (!NILP (f
->title
))
22470 return SSDATA (f
->title
);
22471 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22472 return SSDATA (f
->name
);
22476 obj
= BVAR (b
, filename
);
22481 ptrdiff_t size
= ZV
- BEGV
;
22482 pint2str (decode_mode_spec_buf
, width
, size
);
22483 return decode_mode_spec_buf
;
22488 ptrdiff_t size
= ZV
- BEGV
;
22489 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22490 return decode_mode_spec_buf
;
22495 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22496 ptrdiff_t topline
, nlines
, height
;
22499 /* %c and %l are ignored in `frame-title-format'. */
22500 if (mode_line_target
== MODE_LINE_TITLE
)
22503 startpos
= marker_position (w
->start
);
22504 startpos_byte
= marker_byte_position (w
->start
);
22505 height
= WINDOW_TOTAL_LINES (w
);
22507 /* If we decided that this buffer isn't suitable for line numbers,
22508 don't forget that too fast. */
22509 if (w
->base_line_pos
== -1)
22512 /* If the buffer is very big, don't waste time. */
22513 if (INTEGERP (Vline_number_display_limit
)
22514 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22516 w
->base_line_pos
= 0;
22517 w
->base_line_number
= 0;
22521 if (w
->base_line_number
> 0
22522 && w
->base_line_pos
> 0
22523 && w
->base_line_pos
<= startpos
)
22525 line
= w
->base_line_number
;
22526 linepos
= w
->base_line_pos
;
22527 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22532 linepos
= BUF_BEGV (b
);
22533 linepos_byte
= BUF_BEGV_BYTE (b
);
22536 /* Count lines from base line to window start position. */
22537 nlines
= display_count_lines (linepos_byte
,
22541 topline
= nlines
+ line
;
22543 /* Determine a new base line, if the old one is too close
22544 or too far away, or if we did not have one.
22545 "Too close" means it's plausible a scroll-down would
22546 go back past it. */
22547 if (startpos
== BUF_BEGV (b
))
22549 w
->base_line_number
= topline
;
22550 w
->base_line_pos
= BUF_BEGV (b
);
22552 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22553 || linepos
== BUF_BEGV (b
))
22555 ptrdiff_t limit
= BUF_BEGV (b
);
22556 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22557 ptrdiff_t position
;
22558 ptrdiff_t distance
=
22559 (height
* 2 + 30) * line_number_display_limit_width
;
22561 if (startpos
- distance
> limit
)
22563 limit
= startpos
- distance
;
22564 limit_byte
= CHAR_TO_BYTE (limit
);
22567 nlines
= display_count_lines (startpos_byte
,
22569 - (height
* 2 + 30),
22571 /* If we couldn't find the lines we wanted within
22572 line_number_display_limit_width chars per line,
22573 give up on line numbers for this window. */
22574 if (position
== limit_byte
&& limit
== startpos
- distance
)
22576 w
->base_line_pos
= -1;
22577 w
->base_line_number
= 0;
22581 w
->base_line_number
= topline
- nlines
;
22582 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22585 /* Now count lines from the start pos to point. */
22586 nlines
= display_count_lines (startpos_byte
,
22587 PT_BYTE
, PT
, &junk
);
22589 /* Record that we did display the line number. */
22590 line_number_displayed
= 1;
22592 /* Make the string to show. */
22593 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22594 return decode_mode_spec_buf
;
22597 char* p
= decode_mode_spec_buf
;
22598 int pad
= width
- 2;
22604 return decode_mode_spec_buf
;
22610 obj
= BVAR (b
, mode_name
);
22614 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22620 ptrdiff_t pos
= marker_position (w
->start
);
22621 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22623 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22625 if (pos
<= BUF_BEGV (b
))
22630 else if (pos
<= BUF_BEGV (b
))
22634 if (total
> 1000000)
22635 /* Do it differently for a large value, to avoid overflow. */
22636 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22638 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22639 /* We can't normally display a 3-digit number,
22640 so get us a 2-digit number that is close. */
22643 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22644 return decode_mode_spec_buf
;
22648 /* Display percentage of size above the bottom of the screen. */
22651 ptrdiff_t toppos
= marker_position (w
->start
);
22652 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22653 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22655 if (botpos
>= BUF_ZV (b
))
22657 if (toppos
<= BUF_BEGV (b
))
22664 if (total
> 1000000)
22665 /* Do it differently for a large value, to avoid overflow. */
22666 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22668 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22669 /* We can't normally display a 3-digit number,
22670 so get us a 2-digit number that is close. */
22673 if (toppos
<= BUF_BEGV (b
))
22674 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22676 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22677 return decode_mode_spec_buf
;
22682 /* status of process */
22683 obj
= Fget_buffer_process (Fcurrent_buffer ());
22685 return "no process";
22687 obj
= Fsymbol_name (Fprocess_status (obj
));
22693 ptrdiff_t count
= inhibit_garbage_collection ();
22694 Lisp_Object val
= call1 (intern ("file-remote-p"),
22695 BVAR (current_buffer
, directory
));
22696 unbind_to (count
, Qnil
);
22705 /* coding-system (not including end-of-line format) */
22707 /* coding-system (including end-of-line type) */
22709 int eol_flag
= (c
== 'Z');
22710 char *p
= decode_mode_spec_buf
;
22712 if (! FRAME_WINDOW_P (f
))
22714 /* No need to mention EOL here--the terminal never needs
22715 to do EOL conversion. */
22716 p
= decode_mode_spec_coding (CODING_ID_NAME
22717 (FRAME_KEYBOARD_CODING (f
)->id
),
22719 p
= decode_mode_spec_coding (CODING_ID_NAME
22720 (FRAME_TERMINAL_CODING (f
)->id
),
22723 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22726 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22727 #ifdef subprocesses
22728 obj
= Fget_buffer_process (Fcurrent_buffer ());
22729 if (PROCESSP (obj
))
22731 p
= decode_mode_spec_coding
22732 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22733 p
= decode_mode_spec_coding
22734 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22736 #endif /* subprocesses */
22739 return decode_mode_spec_buf
;
22746 return SSDATA (obj
);
22753 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22754 means count lines back from START_BYTE. But don't go beyond
22755 LIMIT_BYTE. Return the number of lines thus found (always
22758 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22759 either the position COUNT lines after/before START_BYTE, if we
22760 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22764 display_count_lines (ptrdiff_t start_byte
,
22765 ptrdiff_t limit_byte
, ptrdiff_t count
,
22766 ptrdiff_t *byte_pos_ptr
)
22768 register unsigned char *cursor
;
22769 unsigned char *base
;
22771 register ptrdiff_t ceiling
;
22772 register unsigned char *ceiling_addr
;
22773 ptrdiff_t orig_count
= count
;
22775 /* If we are not in selective display mode,
22776 check only for newlines. */
22777 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22778 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22782 while (start_byte
< limit_byte
)
22784 ceiling
= BUFFER_CEILING_OF (start_byte
);
22785 ceiling
= min (limit_byte
- 1, ceiling
);
22786 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22787 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22791 if (selective_display
)
22793 while (*cursor
!= '\n' && *cursor
!= 015
22794 && ++cursor
!= ceiling_addr
)
22796 if (cursor
== ceiling_addr
)
22801 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
22810 start_byte
+= cursor
- base
;
22811 *byte_pos_ptr
= start_byte
;
22815 while (cursor
< ceiling_addr
);
22817 start_byte
+= ceiling_addr
- base
;
22822 while (start_byte
> limit_byte
)
22824 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
22825 ceiling
= max (limit_byte
, ceiling
);
22826 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
22827 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
22830 if (selective_display
)
22832 while (--cursor
>= ceiling_addr
22833 && *cursor
!= '\n' && *cursor
!= 015)
22835 if (cursor
< ceiling_addr
)
22840 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
22847 start_byte
+= cursor
- base
+ 1;
22848 *byte_pos_ptr
= start_byte
;
22849 /* When scanning backwards, we should
22850 not count the newline posterior to which we stop. */
22851 return - orig_count
- 1;
22854 start_byte
+= ceiling_addr
- base
;
22858 *byte_pos_ptr
= limit_byte
;
22861 return - orig_count
+ count
;
22862 return orig_count
- count
;
22868 /***********************************************************************
22870 ***********************************************************************/
22872 /* Display a NUL-terminated string, starting with index START.
22874 If STRING is non-null, display that C string. Otherwise, the Lisp
22875 string LISP_STRING is displayed. There's a case that STRING is
22876 non-null and LISP_STRING is not nil. It means STRING is a string
22877 data of LISP_STRING. In that case, we display LISP_STRING while
22878 ignoring its text properties.
22880 If FACE_STRING is not nil, FACE_STRING_POS is a position in
22881 FACE_STRING. Display STRING or LISP_STRING with the face at
22882 FACE_STRING_POS in FACE_STRING:
22884 Display the string in the environment given by IT, but use the
22885 standard display table, temporarily.
22887 FIELD_WIDTH is the minimum number of output glyphs to produce.
22888 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22889 with spaces. If STRING has more characters, more than FIELD_WIDTH
22890 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
22892 PRECISION is the maximum number of characters to output from
22893 STRING. PRECISION < 0 means don't truncate the string.
22895 This is roughly equivalent to printf format specifiers:
22897 FIELD_WIDTH PRECISION PRINTF
22898 ----------------------------------------
22904 MULTIBYTE zero means do not display multibyte chars, > 0 means do
22905 display them, and < 0 means obey the current buffer's value of
22906 enable_multibyte_characters.
22908 Value is the number of columns displayed. */
22911 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
22912 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
22913 int field_width
, int precision
, int max_x
, int multibyte
)
22915 int hpos_at_start
= it
->hpos
;
22916 int saved_face_id
= it
->face_id
;
22917 struct glyph_row
*row
= it
->glyph_row
;
22918 ptrdiff_t it_charpos
;
22920 /* Initialize the iterator IT for iteration over STRING beginning
22921 with index START. */
22922 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
22923 precision
, field_width
, multibyte
);
22924 if (string
&& STRINGP (lisp_string
))
22925 /* LISP_STRING is the one returned by decode_mode_spec. We should
22926 ignore its text properties. */
22927 it
->stop_charpos
= it
->end_charpos
;
22929 /* If displaying STRING, set up the face of the iterator from
22930 FACE_STRING, if that's given. */
22931 if (STRINGP (face_string
))
22937 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
22938 0, &endptr
, it
->base_face_id
, 0);
22939 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22940 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
22943 /* Set max_x to the maximum allowed X position. Don't let it go
22944 beyond the right edge of the window. */
22946 max_x
= it
->last_visible_x
;
22948 max_x
= min (max_x
, it
->last_visible_x
);
22950 /* Skip over display elements that are not visible. because IT->w is
22952 if (it
->current_x
< it
->first_visible_x
)
22953 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
22954 MOVE_TO_POS
| MOVE_TO_X
);
22956 row
->ascent
= it
->max_ascent
;
22957 row
->height
= it
->max_ascent
+ it
->max_descent
;
22958 row
->phys_ascent
= it
->max_phys_ascent
;
22959 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
22960 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
22962 if (STRINGP (it
->string
))
22963 it_charpos
= IT_STRING_CHARPOS (*it
);
22965 it_charpos
= IT_CHARPOS (*it
);
22967 /* This condition is for the case that we are called with current_x
22968 past last_visible_x. */
22969 while (it
->current_x
< max_x
)
22971 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
22973 /* Get the next display element. */
22974 if (!get_next_display_element (it
))
22977 /* Produce glyphs. */
22978 x_before
= it
->current_x
;
22979 n_glyphs_before
= row
->used
[TEXT_AREA
];
22980 PRODUCE_GLYPHS (it
);
22982 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
22985 while (i
< nglyphs
)
22987 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
22989 if (it
->line_wrap
!= TRUNCATE
22990 && x
+ glyph
->pixel_width
> max_x
)
22992 /* End of continued line or max_x reached. */
22993 if (CHAR_GLYPH_PADDING_P (*glyph
))
22995 /* A wide character is unbreakable. */
22996 if (row
->reversed_p
)
22997 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
22998 - n_glyphs_before
);
22999 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23000 it
->current_x
= x_before
;
23004 if (row
->reversed_p
)
23005 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23006 - (n_glyphs_before
+ i
));
23007 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23012 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23014 /* Glyph is at least partially visible. */
23016 if (x
< it
->first_visible_x
)
23017 row
->x
= x
- it
->first_visible_x
;
23021 /* Glyph is off the left margin of the display area.
23022 Should not happen. */
23026 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23027 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23028 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23029 row
->phys_height
= max (row
->phys_height
,
23030 it
->max_phys_ascent
+ it
->max_phys_descent
);
23031 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23032 it
->max_extra_line_spacing
);
23033 x
+= glyph
->pixel_width
;
23037 /* Stop if max_x reached. */
23041 /* Stop at line ends. */
23042 if (ITERATOR_AT_END_OF_LINE_P (it
))
23044 it
->continuation_lines_width
= 0;
23048 set_iterator_to_next (it
, 1);
23049 if (STRINGP (it
->string
))
23050 it_charpos
= IT_STRING_CHARPOS (*it
);
23052 it_charpos
= IT_CHARPOS (*it
);
23054 /* Stop if truncating at the right edge. */
23055 if (it
->line_wrap
== TRUNCATE
23056 && it
->current_x
>= it
->last_visible_x
)
23058 /* Add truncation mark, but don't do it if the line is
23059 truncated at a padding space. */
23060 if (it_charpos
< it
->string_nchars
)
23062 if (!FRAME_WINDOW_P (it
->f
))
23066 if (it
->current_x
> it
->last_visible_x
)
23068 if (!row
->reversed_p
)
23070 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23071 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23076 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23077 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23079 unproduce_glyphs (it
, ii
+ 1);
23080 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23082 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23084 row
->used
[TEXT_AREA
] = ii
;
23085 produce_special_glyphs (it
, IT_TRUNCATION
);
23088 produce_special_glyphs (it
, IT_TRUNCATION
);
23090 row
->truncated_on_right_p
= 1;
23096 /* Maybe insert a truncation at the left. */
23097 if (it
->first_visible_x
23100 if (!FRAME_WINDOW_P (it
->f
)
23101 || (row
->reversed_p
23102 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23103 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23104 insert_left_trunc_glyphs (it
);
23105 row
->truncated_on_left_p
= 1;
23108 it
->face_id
= saved_face_id
;
23110 /* Value is number of columns displayed. */
23111 return it
->hpos
- hpos_at_start
;
23116 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23117 appears as an element of LIST or as the car of an element of LIST.
23118 If PROPVAL is a list, compare each element against LIST in that
23119 way, and return 1/2 if any element of PROPVAL is found in LIST.
23120 Otherwise return 0. This function cannot quit.
23121 The return value is 2 if the text is invisible but with an ellipsis
23122 and 1 if it's invisible and without an ellipsis. */
23125 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23127 register Lisp_Object tail
, proptail
;
23129 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23131 register Lisp_Object tem
;
23133 if (EQ (propval
, tem
))
23135 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23136 return NILP (XCDR (tem
)) ? 1 : 2;
23139 if (CONSP (propval
))
23141 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23143 Lisp_Object propelt
;
23144 propelt
= XCAR (proptail
);
23145 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23147 register Lisp_Object tem
;
23149 if (EQ (propelt
, tem
))
23151 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23152 return NILP (XCDR (tem
)) ? 1 : 2;
23160 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23161 doc
: /* Non-nil if the property makes the text invisible.
23162 POS-OR-PROP can be a marker or number, in which case it is taken to be
23163 a position in the current buffer and the value of the `invisible' property
23164 is checked; or it can be some other value, which is then presumed to be the
23165 value of the `invisible' property of the text of interest.
23166 The non-nil value returned can be t for truly invisible text or something
23167 else if the text is replaced by an ellipsis. */)
23168 (Lisp_Object pos_or_prop
)
23171 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23172 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23174 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23175 return (invis
== 0 ? Qnil
23177 : make_number (invis
));
23180 /* Calculate a width or height in pixels from a specification using
23181 the following elements:
23184 NUM - a (fractional) multiple of the default font width/height
23185 (NUM) - specifies exactly NUM pixels
23186 UNIT - a fixed number of pixels, see below.
23187 ELEMENT - size of a display element in pixels, see below.
23188 (NUM . SPEC) - equals NUM * SPEC
23189 (+ SPEC SPEC ...) - add pixel values
23190 (- SPEC SPEC ...) - subtract pixel values
23191 (- SPEC) - negate pixel value
23194 INT or FLOAT - a number constant
23195 SYMBOL - use symbol's (buffer local) variable binding.
23198 in - pixels per inch *)
23199 mm - pixels per 1/1000 meter *)
23200 cm - pixels per 1/100 meter *)
23201 width - width of current font in pixels.
23202 height - height of current font in pixels.
23204 *) using the ratio(s) defined in display-pixels-per-inch.
23208 left-fringe - left fringe width in pixels
23209 right-fringe - right fringe width in pixels
23211 left-margin - left margin width in pixels
23212 right-margin - right margin width in pixels
23214 scroll-bar - scroll-bar area width in pixels
23218 Pixels corresponding to 5 inches:
23221 Total width of non-text areas on left side of window (if scroll-bar is on left):
23222 '(space :width (+ left-fringe left-margin scroll-bar))
23224 Align to first text column (in header line):
23225 '(space :align-to 0)
23227 Align to middle of text area minus half the width of variable `my-image'
23228 containing a loaded image:
23229 '(space :align-to (0.5 . (- text my-image)))
23231 Width of left margin minus width of 1 character in the default font:
23232 '(space :width (- left-margin 1))
23234 Width of left margin minus width of 2 characters in the current font:
23235 '(space :width (- left-margin (2 . width)))
23237 Center 1 character over left-margin (in header line):
23238 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23240 Different ways to express width of left fringe plus left margin minus one pixel:
23241 '(space :width (- (+ left-fringe left-margin) (1)))
23242 '(space :width (+ left-fringe left-margin (- (1))))
23243 '(space :width (+ left-fringe left-margin (-1)))
23248 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23249 struct font
*font
, int width_p
, int *align_to
)
23253 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23254 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23257 return OK_PIXELS (0);
23259 eassert (FRAME_LIVE_P (it
->f
));
23261 if (SYMBOLP (prop
))
23263 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23265 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23267 if (unit
[0] == 'i' && unit
[1] == 'n')
23269 else if (unit
[0] == 'm' && unit
[1] == 'm')
23271 else if (unit
[0] == 'c' && unit
[1] == 'm')
23277 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23278 : FRAME_RES_Y (it
->f
));
23281 return OK_PIXELS (ppi
/ pixels
);
23286 #ifdef HAVE_WINDOW_SYSTEM
23287 if (EQ (prop
, Qheight
))
23288 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23289 if (EQ (prop
, Qwidth
))
23290 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23292 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23293 return OK_PIXELS (1);
23296 if (EQ (prop
, Qtext
))
23297 return OK_PIXELS (width_p
23298 ? window_box_width (it
->w
, TEXT_AREA
)
23299 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23301 if (align_to
&& *align_to
< 0)
23304 if (EQ (prop
, Qleft
))
23305 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23306 if (EQ (prop
, Qright
))
23307 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23308 if (EQ (prop
, Qcenter
))
23309 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23310 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23311 if (EQ (prop
, Qleft_fringe
))
23312 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23313 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23314 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23315 if (EQ (prop
, Qright_fringe
))
23316 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23317 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23318 : window_box_right_offset (it
->w
, TEXT_AREA
));
23319 if (EQ (prop
, Qleft_margin
))
23320 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23321 if (EQ (prop
, Qright_margin
))
23322 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23323 if (EQ (prop
, Qscroll_bar
))
23324 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23326 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23327 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23328 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23333 if (EQ (prop
, Qleft_fringe
))
23334 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23335 if (EQ (prop
, Qright_fringe
))
23336 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23337 if (EQ (prop
, Qleft_margin
))
23338 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23339 if (EQ (prop
, Qright_margin
))
23340 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23341 if (EQ (prop
, Qscroll_bar
))
23342 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23345 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23346 if (EQ (prop
, Qunbound
))
23350 if (INTEGERP (prop
) || FLOATP (prop
))
23352 int base_unit
= (width_p
23353 ? FRAME_COLUMN_WIDTH (it
->f
)
23354 : FRAME_LINE_HEIGHT (it
->f
));
23355 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23360 Lisp_Object car
= XCAR (prop
);
23361 Lisp_Object cdr
= XCDR (prop
);
23365 #ifdef HAVE_WINDOW_SYSTEM
23366 if (FRAME_WINDOW_P (it
->f
)
23367 && valid_image_p (prop
))
23369 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23370 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23372 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23375 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23381 while (CONSP (cdr
))
23383 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23384 font
, width_p
, align_to
))
23387 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23392 if (EQ (car
, Qminus
))
23394 return OK_PIXELS (pixels
);
23397 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23398 if (EQ (car
, Qunbound
))
23402 if (INTEGERP (car
) || FLOATP (car
))
23405 pixels
= XFLOATINT (car
);
23407 return OK_PIXELS (pixels
);
23408 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23409 font
, width_p
, align_to
))
23410 return OK_PIXELS (pixels
* fact
);
23421 /***********************************************************************
23423 ***********************************************************************/
23425 #ifdef HAVE_WINDOW_SYSTEM
23430 dump_glyph_string (struct glyph_string
*s
)
23432 fprintf (stderr
, "glyph string\n");
23433 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23434 s
->x
, s
->y
, s
->width
, s
->height
);
23435 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23436 fprintf (stderr
, " hl = %d\n", s
->hl
);
23437 fprintf (stderr
, " left overhang = %d, right = %d\n",
23438 s
->left_overhang
, s
->right_overhang
);
23439 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23440 fprintf (stderr
, " extends to end of line = %d\n",
23441 s
->extends_to_end_of_line_p
);
23442 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23443 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23446 #endif /* GLYPH_DEBUG */
23448 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23449 of XChar2b structures for S; it can't be allocated in
23450 init_glyph_string because it must be allocated via `alloca'. W
23451 is the window on which S is drawn. ROW and AREA are the glyph row
23452 and area within the row from which S is constructed. START is the
23453 index of the first glyph structure covered by S. HL is a
23454 face-override for drawing S. */
23457 #define OPTIONAL_HDC(hdc) HDC hdc,
23458 #define DECLARE_HDC(hdc) HDC hdc;
23459 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23460 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23463 #ifndef OPTIONAL_HDC
23464 #define OPTIONAL_HDC(hdc)
23465 #define DECLARE_HDC(hdc)
23466 #define ALLOCATE_HDC(hdc, f)
23467 #define RELEASE_HDC(hdc, f)
23471 init_glyph_string (struct glyph_string
*s
,
23473 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23474 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23476 memset (s
, 0, sizeof *s
);
23478 s
->f
= XFRAME (w
->frame
);
23482 s
->display
= FRAME_X_DISPLAY (s
->f
);
23483 s
->window
= FRAME_X_WINDOW (s
->f
);
23484 s
->char2b
= char2b
;
23488 s
->first_glyph
= row
->glyphs
[area
] + start
;
23489 s
->height
= row
->height
;
23490 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23491 s
->ybase
= s
->y
+ row
->ascent
;
23495 /* Append the list of glyph strings with head H and tail T to the list
23496 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23499 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23500 struct glyph_string
*h
, struct glyph_string
*t
)
23514 /* Prepend the list of glyph strings with head H and tail T to the
23515 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23519 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23520 struct glyph_string
*h
, struct glyph_string
*t
)
23534 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23535 Set *HEAD and *TAIL to the resulting list. */
23538 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23539 struct glyph_string
*s
)
23541 s
->next
= s
->prev
= NULL
;
23542 append_glyph_string_lists (head
, tail
, s
, s
);
23546 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23547 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23548 make sure that X resources for the face returned are allocated.
23549 Value is a pointer to a realized face that is ready for display if
23550 DISPLAY_P is non-zero. */
23552 static struct face
*
23553 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23554 XChar2b
*char2b
, int display_p
)
23556 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23561 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23563 if (code
== FONT_INVALID_CODE
)
23566 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23568 /* Make sure X resources of the face are allocated. */
23569 #ifdef HAVE_X_WINDOWS
23573 eassert (face
!= NULL
);
23574 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23581 /* Get face and two-byte form of character glyph GLYPH on frame F.
23582 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23583 a pointer to a realized face that is ready for display. */
23585 static struct face
*
23586 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23587 XChar2b
*char2b
, int *two_byte_p
)
23592 eassert (glyph
->type
== CHAR_GLYPH
);
23593 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23595 /* Make sure X resources of the face are allocated. */
23596 eassert (face
!= NULL
);
23597 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23604 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23605 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23607 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23609 if (code
== FONT_INVALID_CODE
)
23613 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23618 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23619 Return 1 if FONT has a glyph for C, otherwise return 0. */
23622 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23626 if (CHAR_BYTE8_P (c
))
23627 code
= CHAR_TO_BYTE8 (c
);
23629 code
= font
->driver
->encode_char (font
, c
);
23631 if (code
== FONT_INVALID_CODE
)
23633 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23638 /* Fill glyph string S with composition components specified by S->cmp.
23640 BASE_FACE is the base face of the composition.
23641 S->cmp_from is the index of the first component for S.
23643 OVERLAPS non-zero means S should draw the foreground only, and use
23644 its physical height for clipping. See also draw_glyphs.
23646 Value is the index of a component not in S. */
23649 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23653 /* For all glyphs of this composition, starting at the offset
23654 S->cmp_from, until we reach the end of the definition or encounter a
23655 glyph that requires the different face, add it to S. */
23660 s
->for_overlaps
= overlaps
;
23663 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23665 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23667 /* TAB in a composition means display glyphs with padding space
23668 on the left or right. */
23671 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23674 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23681 s
->font
= s
->face
->font
;
23683 else if (s
->face
!= face
)
23691 if (s
->face
== NULL
)
23693 s
->face
= base_face
->ascii_face
;
23694 s
->font
= s
->face
->font
;
23697 /* All glyph strings for the same composition has the same width,
23698 i.e. the width set for the first component of the composition. */
23699 s
->width
= s
->first_glyph
->pixel_width
;
23701 /* If the specified font could not be loaded, use the frame's
23702 default font, but record the fact that we couldn't load it in
23703 the glyph string so that we can draw rectangles for the
23704 characters of the glyph string. */
23705 if (s
->font
== NULL
)
23707 s
->font_not_found_p
= 1;
23708 s
->font
= FRAME_FONT (s
->f
);
23711 /* Adjust base line for subscript/superscript text. */
23712 s
->ybase
+= s
->first_glyph
->voffset
;
23714 /* This glyph string must always be drawn with 16-bit functions. */
23721 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23722 int start
, int end
, int overlaps
)
23724 struct glyph
*glyph
, *last
;
23725 Lisp_Object lgstring
;
23728 s
->for_overlaps
= overlaps
;
23729 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23730 last
= s
->row
->glyphs
[s
->area
] + end
;
23731 s
->cmp_id
= glyph
->u
.cmp
.id
;
23732 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23733 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23734 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23735 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23736 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23738 while (glyph
< last
23739 && glyph
->u
.cmp
.automatic
23740 && glyph
->u
.cmp
.id
== s
->cmp_id
23741 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23742 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23744 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23746 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23747 unsigned code
= LGLYPH_CODE (lglyph
);
23749 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23751 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23752 return glyph
- s
->row
->glyphs
[s
->area
];
23756 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23757 See the comment of fill_glyph_string for arguments.
23758 Value is the index of the first glyph not in S. */
23762 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23763 int start
, int end
, int overlaps
)
23765 struct glyph
*glyph
, *last
;
23768 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23769 s
->for_overlaps
= overlaps
;
23770 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23771 last
= s
->row
->glyphs
[s
->area
] + end
;
23772 voffset
= glyph
->voffset
;
23773 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23774 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23776 s
->width
= glyph
->pixel_width
;
23778 while (glyph
< last
23779 && glyph
->type
== GLYPHLESS_GLYPH
23780 && glyph
->voffset
== voffset
23781 && glyph
->face_id
== face_id
)
23784 s
->width
+= glyph
->pixel_width
;
23787 s
->ybase
+= voffset
;
23788 return glyph
- s
->row
->glyphs
[s
->area
];
23792 /* Fill glyph string S from a sequence of character glyphs.
23794 FACE_ID is the face id of the string. START is the index of the
23795 first glyph to consider, END is the index of the last + 1.
23796 OVERLAPS non-zero means S should draw the foreground only, and use
23797 its physical height for clipping. See also draw_glyphs.
23799 Value is the index of the first glyph not in S. */
23802 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23803 int start
, int end
, int overlaps
)
23805 struct glyph
*glyph
, *last
;
23807 int glyph_not_available_p
;
23809 eassert (s
->f
== XFRAME (s
->w
->frame
));
23810 eassert (s
->nchars
== 0);
23811 eassert (start
>= 0 && end
> start
);
23813 s
->for_overlaps
= overlaps
;
23814 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23815 last
= s
->row
->glyphs
[s
->area
] + end
;
23816 voffset
= glyph
->voffset
;
23817 s
->padding_p
= glyph
->padding_p
;
23818 glyph_not_available_p
= glyph
->glyph_not_available_p
;
23820 while (glyph
< last
23821 && glyph
->type
== CHAR_GLYPH
23822 && glyph
->voffset
== voffset
23823 /* Same face id implies same font, nowadays. */
23824 && glyph
->face_id
== face_id
23825 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
23829 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
23830 s
->char2b
+ s
->nchars
,
23832 s
->two_byte_p
= two_byte_p
;
23834 eassert (s
->nchars
<= end
- start
);
23835 s
->width
+= glyph
->pixel_width
;
23836 if (glyph
++->padding_p
!= s
->padding_p
)
23840 s
->font
= s
->face
->font
;
23842 /* If the specified font could not be loaded, use the frame's font,
23843 but record the fact that we couldn't load it in
23844 S->font_not_found_p so that we can draw rectangles for the
23845 characters of the glyph string. */
23846 if (s
->font
== NULL
|| glyph_not_available_p
)
23848 s
->font_not_found_p
= 1;
23849 s
->font
= FRAME_FONT (s
->f
);
23852 /* Adjust base line for subscript/superscript text. */
23853 s
->ybase
+= voffset
;
23855 eassert (s
->face
&& s
->face
->gc
);
23856 return glyph
- s
->row
->glyphs
[s
->area
];
23860 /* Fill glyph string S from image glyph S->first_glyph. */
23863 fill_image_glyph_string (struct glyph_string
*s
)
23865 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
23866 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
23868 s
->slice
= s
->first_glyph
->slice
.img
;
23869 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23870 s
->font
= s
->face
->font
;
23871 s
->width
= s
->first_glyph
->pixel_width
;
23873 /* Adjust base line for subscript/superscript text. */
23874 s
->ybase
+= s
->first_glyph
->voffset
;
23878 /* Fill glyph string S from a sequence of stretch glyphs.
23880 START is the index of the first glyph to consider,
23881 END is the index of the last + 1.
23883 Value is the index of the first glyph not in S. */
23886 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
23888 struct glyph
*glyph
, *last
;
23889 int voffset
, face_id
;
23891 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
23893 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23894 last
= s
->row
->glyphs
[s
->area
] + end
;
23895 face_id
= glyph
->face_id
;
23896 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23897 s
->font
= s
->face
->font
;
23898 s
->width
= glyph
->pixel_width
;
23900 voffset
= glyph
->voffset
;
23904 && glyph
->type
== STRETCH_GLYPH
23905 && glyph
->voffset
== voffset
23906 && glyph
->face_id
== face_id
);
23908 s
->width
+= glyph
->pixel_width
;
23910 /* Adjust base line for subscript/superscript text. */
23911 s
->ybase
+= voffset
;
23913 /* The case that face->gc == 0 is handled when drawing the glyph
23914 string by calling PREPARE_FACE_FOR_DISPLAY. */
23916 return glyph
- s
->row
->glyphs
[s
->area
];
23919 static struct font_metrics
*
23920 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
23922 static struct font_metrics metrics
;
23927 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
23928 if (code
== FONT_INVALID_CODE
)
23930 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
23935 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
23936 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
23937 assumed to be zero. */
23940 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
23942 *left
= *right
= 0;
23944 if (glyph
->type
== CHAR_GLYPH
)
23948 struct font_metrics
*pcm
;
23950 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
23951 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
23953 if (pcm
->rbearing
> pcm
->width
)
23954 *right
= pcm
->rbearing
- pcm
->width
;
23955 if (pcm
->lbearing
< 0)
23956 *left
= -pcm
->lbearing
;
23959 else if (glyph
->type
== COMPOSITE_GLYPH
)
23961 if (! glyph
->u
.cmp
.automatic
)
23963 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
23965 if (cmp
->rbearing
> cmp
->pixel_width
)
23966 *right
= cmp
->rbearing
- cmp
->pixel_width
;
23967 if (cmp
->lbearing
< 0)
23968 *left
= - cmp
->lbearing
;
23972 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
23973 struct font_metrics metrics
;
23975 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
23976 glyph
->slice
.cmp
.to
+ 1, &metrics
);
23977 if (metrics
.rbearing
> metrics
.width
)
23978 *right
= metrics
.rbearing
- metrics
.width
;
23979 if (metrics
.lbearing
< 0)
23980 *left
= - metrics
.lbearing
;
23986 /* Return the index of the first glyph preceding glyph string S that
23987 is overwritten by S because of S's left overhang. Value is -1
23988 if no glyphs are overwritten. */
23991 left_overwritten (struct glyph_string
*s
)
23995 if (s
->left_overhang
)
23998 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
23999 int first
= s
->first_glyph
- glyphs
;
24001 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24002 x
-= glyphs
[i
].pixel_width
;
24013 /* Return the index of the first glyph preceding glyph string S that
24014 is overwriting S because of its right overhang. Value is -1 if no
24015 glyph in front of S overwrites S. */
24018 left_overwriting (struct glyph_string
*s
)
24021 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24022 int first
= s
->first_glyph
- glyphs
;
24026 for (i
= first
- 1; i
>= 0; --i
)
24029 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24032 x
-= glyphs
[i
].pixel_width
;
24039 /* Return the index of the last glyph following glyph string S that is
24040 overwritten by S because of S's right overhang. Value is -1 if
24041 no such glyph is found. */
24044 right_overwritten (struct glyph_string
*s
)
24048 if (s
->right_overhang
)
24051 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24052 int first
= (s
->first_glyph
- glyphs
24053 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24054 int end
= s
->row
->used
[s
->area
];
24056 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24057 x
+= glyphs
[i
].pixel_width
;
24066 /* Return the index of the last glyph following glyph string S that
24067 overwrites S because of its left overhang. Value is negative
24068 if no such glyph is found. */
24071 right_overwriting (struct glyph_string
*s
)
24074 int end
= s
->row
->used
[s
->area
];
24075 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24076 int first
= (s
->first_glyph
- glyphs
24077 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24081 for (i
= first
; i
< end
; ++i
)
24084 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24087 x
+= glyphs
[i
].pixel_width
;
24094 /* Set background width of glyph string S. START is the index of the
24095 first glyph following S. LAST_X is the right-most x-position + 1
24096 in the drawing area. */
24099 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24101 /* If the face of this glyph string has to be drawn to the end of
24102 the drawing area, set S->extends_to_end_of_line_p. */
24104 if (start
== s
->row
->used
[s
->area
]
24105 && ((s
->row
->fill_line_p
24106 && (s
->hl
== DRAW_NORMAL_TEXT
24107 || s
->hl
== DRAW_IMAGE_RAISED
24108 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24109 || s
->hl
== DRAW_MOUSE_FACE
))
24110 s
->extends_to_end_of_line_p
= 1;
24112 /* If S extends its face to the end of the line, set its
24113 background_width to the distance to the right edge of the drawing
24115 if (s
->extends_to_end_of_line_p
)
24116 s
->background_width
= last_x
- s
->x
+ 1;
24118 s
->background_width
= s
->width
;
24122 /* Compute overhangs and x-positions for glyph string S and its
24123 predecessors, or successors. X is the starting x-position for S.
24124 BACKWARD_P non-zero means process predecessors. */
24127 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24133 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24134 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24144 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24145 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24155 /* The following macros are only called from draw_glyphs below.
24156 They reference the following parameters of that function directly:
24157 `w', `row', `area', and `overlap_p'
24158 as well as the following local variables:
24159 `s', `f', and `hdc' (in W32) */
24162 /* On W32, silently add local `hdc' variable to argument list of
24163 init_glyph_string. */
24164 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24165 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24167 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24168 init_glyph_string (s, char2b, w, row, area, start, hl)
24171 /* Add a glyph string for a stretch glyph to the list of strings
24172 between HEAD and TAIL. START is the index of the stretch glyph in
24173 row area AREA of glyph row ROW. END is the index of the last glyph
24174 in that glyph row area. X is the current output position assigned
24175 to the new glyph string constructed. HL overrides that face of the
24176 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24177 is the right-most x-position of the drawing area. */
24179 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24180 and below -- keep them on one line. */
24181 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24184 s = alloca (sizeof *s); \
24185 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24186 START = fill_stretch_glyph_string (s, START, END); \
24187 append_glyph_string (&HEAD, &TAIL, s); \
24193 /* Add a glyph string for an image glyph to the list of strings
24194 between HEAD and TAIL. START is the index of the image glyph in
24195 row area AREA of glyph row ROW. END is the index of the last glyph
24196 in that glyph row area. X is the current output position assigned
24197 to the new glyph string constructed. HL overrides that face of the
24198 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24199 is the right-most x-position of the drawing area. */
24201 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24204 s = alloca (sizeof *s); \
24205 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24206 fill_image_glyph_string (s); \
24207 append_glyph_string (&HEAD, &TAIL, s); \
24214 /* Add a glyph string for a sequence of character glyphs to the list
24215 of strings between HEAD and TAIL. START is the index of the first
24216 glyph in row area AREA of glyph row ROW that is part of the new
24217 glyph string. END is the index of the last glyph in that glyph row
24218 area. X is the current output position assigned to the new glyph
24219 string constructed. HL overrides that face of the glyph; e.g. it
24220 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24221 right-most x-position of the drawing area. */
24223 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24229 face_id = (row)->glyphs[area][START].face_id; \
24231 s = alloca (sizeof *s); \
24232 char2b = alloca ((END - START) * sizeof *char2b); \
24233 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24234 append_glyph_string (&HEAD, &TAIL, s); \
24236 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24241 /* Add a glyph string for a composite sequence to the list of strings
24242 between HEAD and TAIL. START is the index of the first glyph in
24243 row area AREA of glyph row ROW that is part of the new glyph
24244 string. END is the index of the last glyph in that glyph row area.
24245 X is the current output position assigned to the new glyph string
24246 constructed. HL overrides that face of the glyph; e.g. it is
24247 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24248 x-position of the drawing area. */
24250 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24252 int face_id = (row)->glyphs[area][START].face_id; \
24253 struct face *base_face = FACE_FROM_ID (f, face_id); \
24254 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24255 struct composition *cmp = composition_table[cmp_id]; \
24257 struct glyph_string *first_s = NULL; \
24260 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24262 /* Make glyph_strings for each glyph sequence that is drawable by \
24263 the same face, and append them to HEAD/TAIL. */ \
24264 for (n = 0; n < cmp->glyph_len;) \
24266 s = alloca (sizeof *s); \
24267 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24268 append_glyph_string (&(HEAD), &(TAIL), s); \
24274 n = fill_composite_glyph_string (s, base_face, overlaps); \
24282 /* Add a glyph string for a glyph-string sequence to the list of strings
24283 between HEAD and TAIL. */
24285 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24289 Lisp_Object gstring; \
24291 face_id = (row)->glyphs[area][START].face_id; \
24292 gstring = (composition_gstring_from_id \
24293 ((row)->glyphs[area][START].u.cmp.id)); \
24294 s = alloca (sizeof *s); \
24295 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24296 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24297 append_glyph_string (&(HEAD), &(TAIL), s); \
24299 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24303 /* Add a glyph string for a sequence of glyphless character's glyphs
24304 to the list of strings between HEAD and TAIL. The meanings of
24305 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24307 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24312 face_id = (row)->glyphs[area][START].face_id; \
24314 s = alloca (sizeof *s); \
24315 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24316 append_glyph_string (&HEAD, &TAIL, s); \
24318 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24324 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24325 of AREA of glyph row ROW on window W between indices START and END.
24326 HL overrides the face for drawing glyph strings, e.g. it is
24327 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24328 x-positions of the drawing area.
24330 This is an ugly monster macro construct because we must use alloca
24331 to allocate glyph strings (because draw_glyphs can be called
24332 asynchronously). */
24334 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24337 HEAD = TAIL = NULL; \
24338 while (START < END) \
24340 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24341 switch (first_glyph->type) \
24344 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24348 case COMPOSITE_GLYPH: \
24349 if (first_glyph->u.cmp.automatic) \
24350 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24353 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24357 case STRETCH_GLYPH: \
24358 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24362 case IMAGE_GLYPH: \
24363 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24367 case GLYPHLESS_GLYPH: \
24368 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24378 set_glyph_string_background_width (s, START, LAST_X); \
24385 /* Draw glyphs between START and END in AREA of ROW on window W,
24386 starting at x-position X. X is relative to AREA in W. HL is a
24387 face-override with the following meaning:
24389 DRAW_NORMAL_TEXT draw normally
24390 DRAW_CURSOR draw in cursor face
24391 DRAW_MOUSE_FACE draw in mouse face.
24392 DRAW_INVERSE_VIDEO draw in mode line face
24393 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24394 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24396 If OVERLAPS is non-zero, draw only the foreground of characters and
24397 clip to the physical height of ROW. Non-zero value also defines
24398 the overlapping part to be drawn:
24400 OVERLAPS_PRED overlap with preceding rows
24401 OVERLAPS_SUCC overlap with succeeding rows
24402 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24403 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24405 Value is the x-position reached, relative to AREA of W. */
24408 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24409 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24410 enum draw_glyphs_face hl
, int overlaps
)
24412 struct glyph_string
*head
, *tail
;
24413 struct glyph_string
*s
;
24414 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24415 int i
, j
, x_reached
, last_x
, area_left
= 0;
24416 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24419 ALLOCATE_HDC (hdc
, f
);
24421 /* Let's rather be paranoid than getting a SEGV. */
24422 end
= min (end
, row
->used
[area
]);
24423 start
= clip_to_bounds (0, start
, end
);
24425 /* Translate X to frame coordinates. Set last_x to the right
24426 end of the drawing area. */
24427 if (row
->full_width_p
)
24429 /* X is relative to the left edge of W, without scroll bars
24431 area_left
= WINDOW_LEFT_EDGE_X (w
);
24432 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24433 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24437 area_left
= window_box_left (w
, area
);
24438 last_x
= area_left
+ window_box_width (w
, area
);
24442 /* Build a doubly-linked list of glyph_string structures between
24443 head and tail from what we have to draw. Note that the macro
24444 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24445 the reason we use a separate variable `i'. */
24447 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24449 x_reached
= tail
->x
+ tail
->background_width
;
24453 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24454 the row, redraw some glyphs in front or following the glyph
24455 strings built above. */
24456 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24458 struct glyph_string
*h
, *t
;
24459 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24460 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24461 int check_mouse_face
= 0;
24464 /* If mouse highlighting is on, we may need to draw adjacent
24465 glyphs using mouse-face highlighting. */
24466 if (area
== TEXT_AREA
&& row
->mouse_face_p
24467 && hlinfo
->mouse_face_beg_row
>= 0
24468 && hlinfo
->mouse_face_end_row
>= 0)
24470 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24472 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24473 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24475 check_mouse_face
= 1;
24476 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24477 ? hlinfo
->mouse_face_beg_col
: 0;
24478 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24479 ? hlinfo
->mouse_face_end_col
24480 : row
->used
[TEXT_AREA
];
24484 /* Compute overhangs for all glyph strings. */
24485 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24486 for (s
= head
; s
; s
= s
->next
)
24487 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24489 /* Prepend glyph strings for glyphs in front of the first glyph
24490 string that are overwritten because of the first glyph
24491 string's left overhang. The background of all strings
24492 prepended must be drawn because the first glyph string
24494 i
= left_overwritten (head
);
24497 enum draw_glyphs_face overlap_hl
;
24499 /* If this row contains mouse highlighting, attempt to draw
24500 the overlapped glyphs with the correct highlight. This
24501 code fails if the overlap encompasses more than one glyph
24502 and mouse-highlight spans only some of these glyphs.
24503 However, making it work perfectly involves a lot more
24504 code, and I don't know if the pathological case occurs in
24505 practice, so we'll stick to this for now. --- cyd */
24506 if (check_mouse_face
24507 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24508 overlap_hl
= DRAW_MOUSE_FACE
;
24510 overlap_hl
= DRAW_NORMAL_TEXT
;
24513 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24514 overlap_hl
, dummy_x
, last_x
);
24516 compute_overhangs_and_x (t
, head
->x
, 1);
24517 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24521 /* Prepend glyph strings for glyphs in front of the first glyph
24522 string that overwrite that glyph string because of their
24523 right overhang. For these strings, only the foreground must
24524 be drawn, because it draws over the glyph string at `head'.
24525 The background must not be drawn because this would overwrite
24526 right overhangs of preceding glyphs for which no glyph
24528 i
= left_overwriting (head
);
24531 enum draw_glyphs_face overlap_hl
;
24533 if (check_mouse_face
24534 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24535 overlap_hl
= DRAW_MOUSE_FACE
;
24537 overlap_hl
= DRAW_NORMAL_TEXT
;
24540 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24541 overlap_hl
, dummy_x
, last_x
);
24542 for (s
= h
; s
; s
= s
->next
)
24543 s
->background_filled_p
= 1;
24544 compute_overhangs_and_x (t
, head
->x
, 1);
24545 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24548 /* Append glyphs strings for glyphs following the last glyph
24549 string tail that are overwritten by tail. The background of
24550 these strings has to be drawn because tail's foreground draws
24552 i
= right_overwritten (tail
);
24555 enum draw_glyphs_face overlap_hl
;
24557 if (check_mouse_face
24558 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24559 overlap_hl
= DRAW_MOUSE_FACE
;
24561 overlap_hl
= DRAW_NORMAL_TEXT
;
24563 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24564 overlap_hl
, x
, last_x
);
24565 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24566 we don't have `end = i;' here. */
24567 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24568 append_glyph_string_lists (&head
, &tail
, h
, t
);
24572 /* Append glyph strings for glyphs following the last glyph
24573 string tail that overwrite tail. The foreground of such
24574 glyphs has to be drawn because it writes into the background
24575 of tail. The background must not be drawn because it could
24576 paint over the foreground of following glyphs. */
24577 i
= right_overwriting (tail
);
24580 enum draw_glyphs_face overlap_hl
;
24581 if (check_mouse_face
24582 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24583 overlap_hl
= DRAW_MOUSE_FACE
;
24585 overlap_hl
= DRAW_NORMAL_TEXT
;
24588 i
++; /* We must include the Ith glyph. */
24589 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24590 overlap_hl
, x
, last_x
);
24591 for (s
= h
; s
; s
= s
->next
)
24592 s
->background_filled_p
= 1;
24593 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24594 append_glyph_string_lists (&head
, &tail
, h
, t
);
24596 if (clip_head
|| clip_tail
)
24597 for (s
= head
; s
; s
= s
->next
)
24599 s
->clip_head
= clip_head
;
24600 s
->clip_tail
= clip_tail
;
24604 /* Draw all strings. */
24605 for (s
= head
; s
; s
= s
->next
)
24606 FRAME_RIF (f
)->draw_glyph_string (s
);
24609 /* When focus a sole frame and move horizontally, this sets on_p to 0
24610 causing a failure to erase prev cursor position. */
24611 if (area
== TEXT_AREA
24612 && !row
->full_width_p
24613 /* When drawing overlapping rows, only the glyph strings'
24614 foreground is drawn, which doesn't erase a cursor
24618 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24619 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24620 : (tail
? tail
->x
+ tail
->background_width
: x
));
24624 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24625 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24629 /* Value is the x-position up to which drawn, relative to AREA of W.
24630 This doesn't include parts drawn because of overhangs. */
24631 if (row
->full_width_p
)
24632 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24634 x_reached
-= area_left
;
24636 RELEASE_HDC (hdc
, f
);
24641 /* Expand row matrix if too narrow. Don't expand if area
24644 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24646 if (!it->f->fonts_changed \
24647 && (it->glyph_row->glyphs[area] \
24648 < it->glyph_row->glyphs[area + 1])) \
24650 it->w->ncols_scale_factor++; \
24651 it->f->fonts_changed = 1; \
24655 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24656 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24659 append_glyph (struct it
*it
)
24661 struct glyph
*glyph
;
24662 enum glyph_row_area area
= it
->area
;
24664 eassert (it
->glyph_row
);
24665 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24667 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24668 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24670 /* If the glyph row is reversed, we need to prepend the glyph
24671 rather than append it. */
24672 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24676 /* Make room for the additional glyph. */
24677 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24679 glyph
= it
->glyph_row
->glyphs
[area
];
24681 glyph
->charpos
= CHARPOS (it
->position
);
24682 glyph
->object
= it
->object
;
24683 if (it
->pixel_width
> 0)
24685 glyph
->pixel_width
= it
->pixel_width
;
24686 glyph
->padding_p
= 0;
24690 /* Assure at least 1-pixel width. Otherwise, cursor can't
24691 be displayed correctly. */
24692 glyph
->pixel_width
= 1;
24693 glyph
->padding_p
= 1;
24695 glyph
->ascent
= it
->ascent
;
24696 glyph
->descent
= it
->descent
;
24697 glyph
->voffset
= it
->voffset
;
24698 glyph
->type
= CHAR_GLYPH
;
24699 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24700 glyph
->multibyte_p
= it
->multibyte_p
;
24701 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24703 /* In R2L rows, the left and the right box edges need to be
24704 drawn in reverse direction. */
24705 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24706 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24710 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24711 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24713 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24714 || it
->phys_descent
> it
->descent
);
24715 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24716 glyph
->face_id
= it
->face_id
;
24717 glyph
->u
.ch
= it
->char_to_display
;
24718 glyph
->slice
.img
= null_glyph_slice
;
24719 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24722 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24723 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24725 glyph
->bidi_type
= it
->bidi_it
.type
;
24729 glyph
->resolved_level
= 0;
24730 glyph
->bidi_type
= UNKNOWN_BT
;
24732 ++it
->glyph_row
->used
[area
];
24735 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24738 /* Store one glyph for the composition IT->cmp_it.id in
24739 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24743 append_composite_glyph (struct it
*it
)
24745 struct glyph
*glyph
;
24746 enum glyph_row_area area
= it
->area
;
24748 eassert (it
->glyph_row
);
24750 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24751 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24753 /* If the glyph row is reversed, we need to prepend the glyph
24754 rather than append it. */
24755 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24759 /* Make room for the new glyph. */
24760 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24762 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24764 glyph
->charpos
= it
->cmp_it
.charpos
;
24765 glyph
->object
= it
->object
;
24766 glyph
->pixel_width
= it
->pixel_width
;
24767 glyph
->ascent
= it
->ascent
;
24768 glyph
->descent
= it
->descent
;
24769 glyph
->voffset
= it
->voffset
;
24770 glyph
->type
= COMPOSITE_GLYPH
;
24771 if (it
->cmp_it
.ch
< 0)
24773 glyph
->u
.cmp
.automatic
= 0;
24774 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24775 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24779 glyph
->u
.cmp
.automatic
= 1;
24780 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24781 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24782 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24784 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24785 glyph
->multibyte_p
= it
->multibyte_p
;
24786 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24788 /* In R2L rows, the left and the right box edges need to be
24789 drawn in reverse direction. */
24790 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24791 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24795 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24796 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24798 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24799 || it
->phys_descent
> it
->descent
);
24800 glyph
->padding_p
= 0;
24801 glyph
->glyph_not_available_p
= 0;
24802 glyph
->face_id
= it
->face_id
;
24803 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24806 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24807 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24809 glyph
->bidi_type
= it
->bidi_it
.type
;
24811 ++it
->glyph_row
->used
[area
];
24814 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24818 /* Change IT->ascent and IT->height according to the setting of
24822 take_vertical_position_into_account (struct it
*it
)
24826 if (it
->voffset
< 0)
24827 /* Increase the ascent so that we can display the text higher
24829 it
->ascent
-= it
->voffset
;
24831 /* Increase the descent so that we can display the text lower
24833 it
->descent
+= it
->voffset
;
24838 /* Produce glyphs/get display metrics for the image IT is loaded with.
24839 See the description of struct display_iterator in dispextern.h for
24840 an overview of struct display_iterator. */
24843 produce_image_glyph (struct it
*it
)
24847 int glyph_ascent
, crop
;
24848 struct glyph_slice slice
;
24850 eassert (it
->what
== IT_IMAGE
);
24852 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24854 /* Make sure X resources of the face is loaded. */
24855 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24857 if (it
->image_id
< 0)
24859 /* Fringe bitmap. */
24860 it
->ascent
= it
->phys_ascent
= 0;
24861 it
->descent
= it
->phys_descent
= 0;
24862 it
->pixel_width
= 0;
24867 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24869 /* Make sure X resources of the image is loaded. */
24870 prepare_image_for_display (it
->f
, img
);
24872 slice
.x
= slice
.y
= 0;
24873 slice
.width
= img
->width
;
24874 slice
.height
= img
->height
;
24876 if (INTEGERP (it
->slice
.x
))
24877 slice
.x
= XINT (it
->slice
.x
);
24878 else if (FLOATP (it
->slice
.x
))
24879 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
24881 if (INTEGERP (it
->slice
.y
))
24882 slice
.y
= XINT (it
->slice
.y
);
24883 else if (FLOATP (it
->slice
.y
))
24884 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
24886 if (INTEGERP (it
->slice
.width
))
24887 slice
.width
= XINT (it
->slice
.width
);
24888 else if (FLOATP (it
->slice
.width
))
24889 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
24891 if (INTEGERP (it
->slice
.height
))
24892 slice
.height
= XINT (it
->slice
.height
);
24893 else if (FLOATP (it
->slice
.height
))
24894 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
24896 if (slice
.x
>= img
->width
)
24897 slice
.x
= img
->width
;
24898 if (slice
.y
>= img
->height
)
24899 slice
.y
= img
->height
;
24900 if (slice
.x
+ slice
.width
>= img
->width
)
24901 slice
.width
= img
->width
- slice
.x
;
24902 if (slice
.y
+ slice
.height
> img
->height
)
24903 slice
.height
= img
->height
- slice
.y
;
24905 if (slice
.width
== 0 || slice
.height
== 0)
24908 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
24910 it
->descent
= slice
.height
- glyph_ascent
;
24912 it
->descent
+= img
->vmargin
;
24913 if (slice
.y
+ slice
.height
== img
->height
)
24914 it
->descent
+= img
->vmargin
;
24915 it
->phys_descent
= it
->descent
;
24917 it
->pixel_width
= slice
.width
;
24919 it
->pixel_width
+= img
->hmargin
;
24920 if (slice
.x
+ slice
.width
== img
->width
)
24921 it
->pixel_width
+= img
->hmargin
;
24923 /* It's quite possible for images to have an ascent greater than
24924 their height, so don't get confused in that case. */
24925 if (it
->descent
< 0)
24930 if (face
->box
!= FACE_NO_BOX
)
24932 if (face
->box_line_width
> 0)
24935 it
->ascent
+= face
->box_line_width
;
24936 if (slice
.y
+ slice
.height
== img
->height
)
24937 it
->descent
+= face
->box_line_width
;
24940 if (it
->start_of_box_run_p
&& slice
.x
== 0)
24941 it
->pixel_width
+= eabs (face
->box_line_width
);
24942 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
24943 it
->pixel_width
+= eabs (face
->box_line_width
);
24946 take_vertical_position_into_account (it
);
24948 /* Automatically crop wide image glyphs at right edge so we can
24949 draw the cursor on same display row. */
24950 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
24951 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
24953 it
->pixel_width
-= crop
;
24954 slice
.width
-= crop
;
24959 struct glyph
*glyph
;
24960 enum glyph_row_area area
= it
->area
;
24962 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24963 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24965 glyph
->charpos
= CHARPOS (it
->position
);
24966 glyph
->object
= it
->object
;
24967 glyph
->pixel_width
= it
->pixel_width
;
24968 glyph
->ascent
= glyph_ascent
;
24969 glyph
->descent
= it
->descent
;
24970 glyph
->voffset
= it
->voffset
;
24971 glyph
->type
= IMAGE_GLYPH
;
24972 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24973 glyph
->multibyte_p
= it
->multibyte_p
;
24974 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24976 /* In R2L rows, the left and the right box edges need to be
24977 drawn in reverse direction. */
24978 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24979 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24983 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24984 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24986 glyph
->overlaps_vertically_p
= 0;
24987 glyph
->padding_p
= 0;
24988 glyph
->glyph_not_available_p
= 0;
24989 glyph
->face_id
= it
->face_id
;
24990 glyph
->u
.img_id
= img
->id
;
24991 glyph
->slice
.img
= slice
;
24992 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24995 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24996 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24998 glyph
->bidi_type
= it
->bidi_it
.type
;
25000 ++it
->glyph_row
->used
[area
];
25003 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25008 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25009 of the glyph, WIDTH and HEIGHT are the width and height of the
25010 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25013 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25014 int width
, int height
, int ascent
)
25016 struct glyph
*glyph
;
25017 enum glyph_row_area area
= it
->area
;
25019 eassert (ascent
>= 0 && ascent
<= height
);
25021 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25022 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25024 /* If the glyph row is reversed, we need to prepend the glyph
25025 rather than append it. */
25026 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25030 /* Make room for the additional glyph. */
25031 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25033 glyph
= it
->glyph_row
->glyphs
[area
];
25035 glyph
->charpos
= CHARPOS (it
->position
);
25036 glyph
->object
= object
;
25037 glyph
->pixel_width
= width
;
25038 glyph
->ascent
= ascent
;
25039 glyph
->descent
= height
- ascent
;
25040 glyph
->voffset
= it
->voffset
;
25041 glyph
->type
= STRETCH_GLYPH
;
25042 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25043 glyph
->multibyte_p
= it
->multibyte_p
;
25044 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25046 /* In R2L rows, the left and the right box edges need to be
25047 drawn in reverse direction. */
25048 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25049 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25053 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25054 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25056 glyph
->overlaps_vertically_p
= 0;
25057 glyph
->padding_p
= 0;
25058 glyph
->glyph_not_available_p
= 0;
25059 glyph
->face_id
= it
->face_id
;
25060 glyph
->u
.stretch
.ascent
= ascent
;
25061 glyph
->u
.stretch
.height
= height
;
25062 glyph
->slice
.img
= null_glyph_slice
;
25063 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25066 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25067 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25069 glyph
->bidi_type
= it
->bidi_it
.type
;
25073 glyph
->resolved_level
= 0;
25074 glyph
->bidi_type
= UNKNOWN_BT
;
25076 ++it
->glyph_row
->used
[area
];
25079 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25082 #endif /* HAVE_WINDOW_SYSTEM */
25084 /* Produce a stretch glyph for iterator IT. IT->object is the value
25085 of the glyph property displayed. The value must be a list
25086 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25089 1. `:width WIDTH' specifies that the space should be WIDTH *
25090 canonical char width wide. WIDTH may be an integer or floating
25093 2. `:relative-width FACTOR' specifies that the width of the stretch
25094 should be computed from the width of the first character having the
25095 `glyph' property, and should be FACTOR times that width.
25097 3. `:align-to HPOS' specifies that the space should be wide enough
25098 to reach HPOS, a value in canonical character units.
25100 Exactly one of the above pairs must be present.
25102 4. `:height HEIGHT' specifies that the height of the stretch produced
25103 should be HEIGHT, measured in canonical character units.
25105 5. `:relative-height FACTOR' specifies that the height of the
25106 stretch should be FACTOR times the height of the characters having
25107 the glyph property.
25109 Either none or exactly one of 4 or 5 must be present.
25111 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25112 of the stretch should be used for the ascent of the stretch.
25113 ASCENT must be in the range 0 <= ASCENT <= 100. */
25116 produce_stretch_glyph (struct it
*it
)
25118 /* (space :width WIDTH :height HEIGHT ...) */
25119 Lisp_Object prop
, plist
;
25120 int width
= 0, height
= 0, align_to
= -1;
25121 int zero_width_ok_p
= 0;
25123 struct font
*font
= NULL
;
25125 #ifdef HAVE_WINDOW_SYSTEM
25127 int zero_height_ok_p
= 0;
25129 if (FRAME_WINDOW_P (it
->f
))
25131 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25132 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25133 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25137 /* List should start with `space'. */
25138 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25139 plist
= XCDR (it
->object
);
25141 /* Compute the width of the stretch. */
25142 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25143 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25145 /* Absolute width `:width WIDTH' specified and valid. */
25146 zero_width_ok_p
= 1;
25149 #ifdef HAVE_WINDOW_SYSTEM
25150 else if (FRAME_WINDOW_P (it
->f
)
25151 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25153 /* Relative width `:relative-width FACTOR' specified and valid.
25154 Compute the width of the characters having the `glyph'
25157 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25160 if (it
->multibyte_p
)
25161 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25164 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25165 if (! ASCII_CHAR_P (it2
.c
))
25166 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25169 it2
.glyph_row
= NULL
;
25170 it2
.what
= IT_CHARACTER
;
25171 x_produce_glyphs (&it2
);
25172 width
= NUMVAL (prop
) * it2
.pixel_width
;
25174 #endif /* HAVE_WINDOW_SYSTEM */
25175 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25176 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25178 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25179 align_to
= (align_to
< 0
25181 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25182 else if (align_to
< 0)
25183 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25184 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25185 zero_width_ok_p
= 1;
25188 /* Nothing specified -> width defaults to canonical char width. */
25189 width
= FRAME_COLUMN_WIDTH (it
->f
);
25191 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25194 #ifdef HAVE_WINDOW_SYSTEM
25195 /* Compute height. */
25196 if (FRAME_WINDOW_P (it
->f
))
25198 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25199 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25202 zero_height_ok_p
= 1;
25204 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25206 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25208 height
= FONT_HEIGHT (font
);
25210 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25213 /* Compute percentage of height used for ascent. If
25214 `:ascent ASCENT' is present and valid, use that. Otherwise,
25215 derive the ascent from the font in use. */
25216 if (prop
= Fplist_get (plist
, QCascent
),
25217 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25218 ascent
= height
* NUMVAL (prop
) / 100.0;
25219 else if (!NILP (prop
)
25220 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25221 ascent
= min (max (0, (int)tem
), height
);
25223 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25226 #endif /* HAVE_WINDOW_SYSTEM */
25229 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25230 && it
->current_x
+ width
> it
->last_visible_x
)
25232 width
= it
->last_visible_x
- it
->current_x
;
25233 #ifdef HAVE_WINDOW_SYSTEM
25234 /* Subtract one more pixel from the stretch width, but only on
25235 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25236 width
-= FRAME_WINDOW_P (it
->f
);
25240 if (width
> 0 && height
> 0 && it
->glyph_row
)
25242 Lisp_Object o_object
= it
->object
;
25243 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25246 if (!STRINGP (object
))
25247 object
= it
->w
->contents
;
25248 #ifdef HAVE_WINDOW_SYSTEM
25249 if (FRAME_WINDOW_P (it
->f
))
25250 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25254 it
->object
= object
;
25255 it
->char_to_display
= ' ';
25256 it
->pixel_width
= it
->len
= 1;
25258 tty_append_glyph (it
);
25259 it
->object
= o_object
;
25263 it
->pixel_width
= width
;
25264 #ifdef HAVE_WINDOW_SYSTEM
25265 if (FRAME_WINDOW_P (it
->f
))
25267 it
->ascent
= it
->phys_ascent
= ascent
;
25268 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25269 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25270 take_vertical_position_into_account (it
);
25274 it
->nglyphs
= width
;
25277 /* Get information about special display element WHAT in an
25278 environment described by IT. WHAT is one of IT_TRUNCATION or
25279 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25280 non-null glyph_row member. This function ensures that fields like
25281 face_id, c, len of IT are left untouched. */
25284 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25291 temp_it
.object
= make_number (0);
25292 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25294 if (what
== IT_CONTINUATION
)
25296 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25297 if (it
->bidi_it
.paragraph_dir
== R2L
)
25298 SET_GLYPH_FROM_CHAR (glyph
, '/');
25300 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25302 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25304 /* FIXME: Should we mirror GC for R2L lines? */
25305 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25306 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25309 else if (what
== IT_TRUNCATION
)
25311 /* Truncation glyph. */
25312 SET_GLYPH_FROM_CHAR (glyph
, '$');
25314 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25316 /* FIXME: Should we mirror GC for R2L lines? */
25317 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25318 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25324 #ifdef HAVE_WINDOW_SYSTEM
25325 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25326 is turned off, we precede the truncation/continuation glyphs by a
25327 stretch glyph whose width is computed such that these special
25328 glyphs are aligned at the window margin, even when very different
25329 fonts are used in different glyph rows. */
25330 if (FRAME_WINDOW_P (temp_it
.f
)
25331 /* init_iterator calls this with it->glyph_row == NULL, and it
25332 wants only the pixel width of the truncation/continuation
25334 && temp_it
.glyph_row
25335 /* insert_left_trunc_glyphs calls us at the beginning of the
25336 row, and it has its own calculation of the stretch glyph
25338 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25339 && (temp_it
.glyph_row
->reversed_p
25340 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25341 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25343 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25345 if (stretch_width
> 0)
25347 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25348 struct font
*font
=
25349 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25350 int stretch_ascent
=
25351 (((temp_it
.ascent
+ temp_it
.descent
)
25352 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25354 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25355 temp_it
.ascent
+ temp_it
.descent
,
25362 temp_it
.what
= IT_CHARACTER
;
25364 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25365 temp_it
.face_id
= GLYPH_FACE (glyph
);
25366 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25368 PRODUCE_GLYPHS (&temp_it
);
25369 it
->pixel_width
= temp_it
.pixel_width
;
25370 it
->nglyphs
= temp_it
.pixel_width
;
25373 #ifdef HAVE_WINDOW_SYSTEM
25375 /* Calculate line-height and line-spacing properties.
25376 An integer value specifies explicit pixel value.
25377 A float value specifies relative value to current face height.
25378 A cons (float . face-name) specifies relative value to
25379 height of specified face font.
25381 Returns height in pixels, or nil. */
25385 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25386 int boff
, int override
)
25388 Lisp_Object face_name
= Qnil
;
25389 int ascent
, descent
, height
;
25391 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25396 face_name
= XCAR (val
);
25398 if (!NUMBERP (val
))
25399 val
= make_number (1);
25400 if (NILP (face_name
))
25402 height
= it
->ascent
+ it
->descent
;
25407 if (NILP (face_name
))
25409 font
= FRAME_FONT (it
->f
);
25410 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25412 else if (EQ (face_name
, Qt
))
25421 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25423 return make_number (-1);
25425 face
= FACE_FROM_ID (it
->f
, face_id
);
25428 return make_number (-1);
25429 boff
= font
->baseline_offset
;
25430 if (font
->vertical_centering
)
25431 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25434 ascent
= FONT_BASE (font
) + boff
;
25435 descent
= FONT_DESCENT (font
) - boff
;
25439 it
->override_ascent
= ascent
;
25440 it
->override_descent
= descent
;
25441 it
->override_boff
= boff
;
25444 height
= ascent
+ descent
;
25448 height
= (int)(XFLOAT_DATA (val
) * height
);
25449 else if (INTEGERP (val
))
25450 height
*= XINT (val
);
25452 return make_number (height
);
25456 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25457 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25458 and only if this is for a character for which no font was found.
25460 If the display method (it->glyphless_method) is
25461 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25462 length of the acronym or the hexadecimal string, UPPER_XOFF and
25463 UPPER_YOFF are pixel offsets for the upper part of the string,
25464 LOWER_XOFF and LOWER_YOFF are for the lower part.
25466 For the other display methods, LEN through LOWER_YOFF are zero. */
25469 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25470 short upper_xoff
, short upper_yoff
,
25471 short lower_xoff
, short lower_yoff
)
25473 struct glyph
*glyph
;
25474 enum glyph_row_area area
= it
->area
;
25476 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25477 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25479 /* If the glyph row is reversed, we need to prepend the glyph
25480 rather than append it. */
25481 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25485 /* Make room for the additional glyph. */
25486 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25488 glyph
= it
->glyph_row
->glyphs
[area
];
25490 glyph
->charpos
= CHARPOS (it
->position
);
25491 glyph
->object
= it
->object
;
25492 glyph
->pixel_width
= it
->pixel_width
;
25493 glyph
->ascent
= it
->ascent
;
25494 glyph
->descent
= it
->descent
;
25495 glyph
->voffset
= it
->voffset
;
25496 glyph
->type
= GLYPHLESS_GLYPH
;
25497 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25498 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25499 glyph
->u
.glyphless
.len
= len
;
25500 glyph
->u
.glyphless
.ch
= it
->c
;
25501 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25502 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25503 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25504 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25505 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25506 glyph
->multibyte_p
= it
->multibyte_p
;
25507 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25509 /* In R2L rows, the left and the right box edges need to be
25510 drawn in reverse direction. */
25511 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25512 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25516 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25517 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25519 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25520 || it
->phys_descent
> it
->descent
);
25521 glyph
->padding_p
= 0;
25522 glyph
->glyph_not_available_p
= 0;
25523 glyph
->face_id
= face_id
;
25524 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25527 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25528 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25530 glyph
->bidi_type
= it
->bidi_it
.type
;
25532 ++it
->glyph_row
->used
[area
];
25535 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25539 /* Produce a glyph for a glyphless character for iterator IT.
25540 IT->glyphless_method specifies which method to use for displaying
25541 the character. See the description of enum
25542 glyphless_display_method in dispextern.h for the detail.
25544 FOR_NO_FONT is nonzero if and only if this is for a character for
25545 which no font was found. ACRONYM, if non-nil, is an acronym string
25546 for the character. */
25549 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25554 int base_width
, base_height
, width
, height
;
25555 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25558 /* Get the metrics of the base font. We always refer to the current
25560 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25561 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25562 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25563 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25564 base_height
= it
->ascent
+ it
->descent
;
25565 base_width
= font
->average_width
;
25567 face_id
= merge_glyphless_glyph_face (it
);
25569 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25571 it
->pixel_width
= THIN_SPACE_WIDTH
;
25573 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25575 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25577 width
= CHAR_WIDTH (it
->c
);
25580 else if (width
> 4)
25582 it
->pixel_width
= base_width
* width
;
25584 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25590 unsigned int code
[6];
25592 int ascent
, descent
;
25593 struct font_metrics metrics_upper
, metrics_lower
;
25595 face
= FACE_FROM_ID (it
->f
, face_id
);
25596 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25597 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25599 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25601 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25602 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25603 if (CONSP (acronym
))
25604 acronym
= XCAR (acronym
);
25605 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25609 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25610 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25613 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
25614 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25615 upper_len
= (len
+ 1) / 2;
25616 font
->driver
->text_extents (font
, code
, upper_len
,
25618 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25623 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25624 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25625 upper_xoff
= upper_yoff
= 2; /* the typical case */
25626 if (base_width
>= width
)
25628 /* Align the upper to the left, the lower to the right. */
25629 it
->pixel_width
= base_width
;
25630 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25634 /* Center the shorter one. */
25635 it
->pixel_width
= width
;
25636 if (metrics_upper
.width
>= metrics_lower
.width
)
25637 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25640 /* FIXME: This code doesn't look right. It formerly was
25641 missing the "lower_xoff = 0;", which couldn't have
25642 been right since it left lower_xoff uninitialized. */
25644 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25648 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25649 top, bottom, and between upper and lower strings. */
25650 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25651 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25652 /* Center vertically.
25653 H:base_height, D:base_descent
25654 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25656 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25657 descent = D - H/2 + h/2;
25658 lower_yoff = descent - 2 - ld;
25659 upper_yoff = lower_yoff - la - 1 - ud; */
25660 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25661 descent
= it
->descent
- (base_height
- height
) / 2;
25662 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25663 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25664 - metrics_upper
.descent
);
25665 /* Don't make the height shorter than the base height. */
25666 if (height
> base_height
)
25668 it
->ascent
= ascent
;
25669 it
->descent
= descent
;
25673 it
->phys_ascent
= it
->ascent
;
25674 it
->phys_descent
= it
->descent
;
25676 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25677 upper_xoff
, upper_yoff
,
25678 lower_xoff
, lower_yoff
);
25680 take_vertical_position_into_account (it
);
25685 Produce glyphs/get display metrics for the display element IT is
25686 loaded with. See the description of struct it in dispextern.h
25687 for an overview of struct it. */
25690 x_produce_glyphs (struct it
*it
)
25692 int extra_line_spacing
= it
->extra_line_spacing
;
25694 it
->glyph_not_available_p
= 0;
25696 if (it
->what
== IT_CHARACTER
)
25699 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25700 struct font
*font
= face
->font
;
25701 struct font_metrics
*pcm
= NULL
;
25702 int boff
; /* Baseline offset. */
25706 /* When no suitable font is found, display this character by
25707 the method specified in the first extra slot of
25708 Vglyphless_char_display. */
25709 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25711 eassert (it
->what
== IT_GLYPHLESS
);
25712 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25716 boff
= font
->baseline_offset
;
25717 if (font
->vertical_centering
)
25718 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25720 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25726 if (it
->override_ascent
>= 0)
25728 it
->ascent
= it
->override_ascent
;
25729 it
->descent
= it
->override_descent
;
25730 boff
= it
->override_boff
;
25734 it
->ascent
= FONT_BASE (font
) + boff
;
25735 it
->descent
= FONT_DESCENT (font
) - boff
;
25738 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25740 pcm
= get_per_char_metric (font
, &char2b
);
25741 if (pcm
->width
== 0
25742 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25748 it
->phys_ascent
= pcm
->ascent
+ boff
;
25749 it
->phys_descent
= pcm
->descent
- boff
;
25750 it
->pixel_width
= pcm
->width
;
25754 it
->glyph_not_available_p
= 1;
25755 it
->phys_ascent
= it
->ascent
;
25756 it
->phys_descent
= it
->descent
;
25757 it
->pixel_width
= font
->space_width
;
25760 if (it
->constrain_row_ascent_descent_p
)
25762 if (it
->descent
> it
->max_descent
)
25764 it
->ascent
+= it
->descent
- it
->max_descent
;
25765 it
->descent
= it
->max_descent
;
25767 if (it
->ascent
> it
->max_ascent
)
25769 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25770 it
->ascent
= it
->max_ascent
;
25772 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25773 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25774 extra_line_spacing
= 0;
25777 /* If this is a space inside a region of text with
25778 `space-width' property, change its width. */
25779 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25781 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25783 /* If face has a box, add the box thickness to the character
25784 height. If character has a box line to the left and/or
25785 right, add the box line width to the character's width. */
25786 if (face
->box
!= FACE_NO_BOX
)
25788 int thick
= face
->box_line_width
;
25792 it
->ascent
+= thick
;
25793 it
->descent
+= thick
;
25798 if (it
->start_of_box_run_p
)
25799 it
->pixel_width
+= thick
;
25800 if (it
->end_of_box_run_p
)
25801 it
->pixel_width
+= thick
;
25804 /* If face has an overline, add the height of the overline
25805 (1 pixel) and a 1 pixel margin to the character height. */
25806 if (face
->overline_p
)
25807 it
->ascent
+= overline_margin
;
25809 if (it
->constrain_row_ascent_descent_p
)
25811 if (it
->ascent
> it
->max_ascent
)
25812 it
->ascent
= it
->max_ascent
;
25813 if (it
->descent
> it
->max_descent
)
25814 it
->descent
= it
->max_descent
;
25817 take_vertical_position_into_account (it
);
25819 /* If we have to actually produce glyphs, do it. */
25824 /* Translate a space with a `space-width' property
25825 into a stretch glyph. */
25826 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25827 / FONT_HEIGHT (font
));
25828 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25829 it
->ascent
+ it
->descent
, ascent
);
25834 /* If characters with lbearing or rbearing are displayed
25835 in this line, record that fact in a flag of the
25836 glyph row. This is used to optimize X output code. */
25837 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25838 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25840 if (! stretched_p
&& it
->pixel_width
== 0)
25841 /* We assure that all visible glyphs have at least 1-pixel
25843 it
->pixel_width
= 1;
25845 else if (it
->char_to_display
== '\n')
25847 /* A newline has no width, but we need the height of the
25848 line. But if previous part of the line sets a height,
25849 don't increase that height. */
25851 Lisp_Object height
;
25852 Lisp_Object total_height
= Qnil
;
25854 it
->override_ascent
= -1;
25855 it
->pixel_width
= 0;
25858 height
= get_it_property (it
, Qline_height
);
25859 /* Split (line-height total-height) list. */
25861 && CONSP (XCDR (height
))
25862 && NILP (XCDR (XCDR (height
))))
25864 total_height
= XCAR (XCDR (height
));
25865 height
= XCAR (height
);
25867 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25869 if (it
->override_ascent
>= 0)
25871 it
->ascent
= it
->override_ascent
;
25872 it
->descent
= it
->override_descent
;
25873 boff
= it
->override_boff
;
25877 it
->ascent
= FONT_BASE (font
) + boff
;
25878 it
->descent
= FONT_DESCENT (font
) - boff
;
25881 if (EQ (height
, Qt
))
25883 if (it
->descent
> it
->max_descent
)
25885 it
->ascent
+= it
->descent
- it
->max_descent
;
25886 it
->descent
= it
->max_descent
;
25888 if (it
->ascent
> it
->max_ascent
)
25890 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25891 it
->ascent
= it
->max_ascent
;
25893 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25894 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25895 it
->constrain_row_ascent_descent_p
= 1;
25896 extra_line_spacing
= 0;
25900 Lisp_Object spacing
;
25902 it
->phys_ascent
= it
->ascent
;
25903 it
->phys_descent
= it
->descent
;
25905 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
25906 && face
->box
!= FACE_NO_BOX
25907 && face
->box_line_width
> 0)
25909 it
->ascent
+= face
->box_line_width
;
25910 it
->descent
+= face
->box_line_width
;
25913 && XINT (height
) > it
->ascent
+ it
->descent
)
25914 it
->ascent
= XINT (height
) - it
->descent
;
25916 if (!NILP (total_height
))
25917 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
25920 spacing
= get_it_property (it
, Qline_spacing
);
25921 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
25923 if (INTEGERP (spacing
))
25925 extra_line_spacing
= XINT (spacing
);
25926 if (!NILP (total_height
))
25927 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
25931 else /* i.e. (it->char_to_display == '\t') */
25933 if (font
->space_width
> 0)
25935 int tab_width
= it
->tab_width
* font
->space_width
;
25936 int x
= it
->current_x
+ it
->continuation_lines_width
;
25937 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
25939 /* If the distance from the current position to the next tab
25940 stop is less than a space character width, use the
25941 tab stop after that. */
25942 if (next_tab_x
- x
< font
->space_width
)
25943 next_tab_x
+= tab_width
;
25945 it
->pixel_width
= next_tab_x
- x
;
25947 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
25948 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
25952 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25953 it
->ascent
+ it
->descent
, it
->ascent
);
25958 it
->pixel_width
= 0;
25963 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
25965 /* A static composition.
25967 Note: A composition is represented as one glyph in the
25968 glyph matrix. There are no padding glyphs.
25970 Important note: pixel_width, ascent, and descent are the
25971 values of what is drawn by draw_glyphs (i.e. the values of
25972 the overall glyphs composed). */
25973 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25974 int boff
; /* baseline offset */
25975 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
25976 int glyph_len
= cmp
->glyph_len
;
25977 struct font
*font
= face
->font
;
25981 /* If we have not yet calculated pixel size data of glyphs of
25982 the composition for the current face font, calculate them
25983 now. Theoretically, we have to check all fonts for the
25984 glyphs, but that requires much time and memory space. So,
25985 here we check only the font of the first glyph. This may
25986 lead to incorrect display, but it's very rare, and C-l
25987 (recenter-top-bottom) can correct the display anyway. */
25988 if (! cmp
->font
|| cmp
->font
!= font
)
25990 /* Ascent and descent of the font of the first character
25991 of this composition (adjusted by baseline offset).
25992 Ascent and descent of overall glyphs should not be less
25993 than these, respectively. */
25994 int font_ascent
, font_descent
, font_height
;
25995 /* Bounding box of the overall glyphs. */
25996 int leftmost
, rightmost
, lowest
, highest
;
25997 int lbearing
, rbearing
;
25998 int i
, width
, ascent
, descent
;
25999 int left_padded
= 0, right_padded
= 0;
26000 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26002 struct font_metrics
*pcm
;
26003 int font_not_found_p
;
26006 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26007 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26009 if (glyph_len
< cmp
->glyph_len
)
26011 for (i
= 0; i
< glyph_len
; i
++)
26013 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26015 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26020 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26021 : IT_CHARPOS (*it
));
26022 /* If no suitable font is found, use the default font. */
26023 font_not_found_p
= font
== NULL
;
26024 if (font_not_found_p
)
26026 face
= face
->ascii_face
;
26029 boff
= font
->baseline_offset
;
26030 if (font
->vertical_centering
)
26031 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26032 font_ascent
= FONT_BASE (font
) + boff
;
26033 font_descent
= FONT_DESCENT (font
) - boff
;
26034 font_height
= FONT_HEIGHT (font
);
26039 if (! font_not_found_p
)
26041 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26043 pcm
= get_per_char_metric (font
, &char2b
);
26046 /* Initialize the bounding box. */
26049 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26050 ascent
= pcm
->ascent
;
26051 descent
= pcm
->descent
;
26052 lbearing
= pcm
->lbearing
;
26053 rbearing
= pcm
->rbearing
;
26057 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26058 ascent
= FONT_BASE (font
);
26059 descent
= FONT_DESCENT (font
);
26066 lowest
= - descent
+ boff
;
26067 highest
= ascent
+ boff
;
26069 if (! font_not_found_p
26070 && font
->default_ascent
26071 && CHAR_TABLE_P (Vuse_default_ascent
)
26072 && !NILP (Faref (Vuse_default_ascent
,
26073 make_number (it
->char_to_display
))))
26074 highest
= font
->default_ascent
+ boff
;
26076 /* Draw the first glyph at the normal position. It may be
26077 shifted to right later if some other glyphs are drawn
26079 cmp
->offsets
[i
* 2] = 0;
26080 cmp
->offsets
[i
* 2 + 1] = boff
;
26081 cmp
->lbearing
= lbearing
;
26082 cmp
->rbearing
= rbearing
;
26084 /* Set cmp->offsets for the remaining glyphs. */
26085 for (i
++; i
< glyph_len
; i
++)
26087 int left
, right
, btm
, top
;
26088 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26090 struct face
*this_face
;
26094 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26095 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26096 font
= this_face
->font
;
26102 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26104 pcm
= get_per_char_metric (font
, &char2b
);
26107 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26110 width
= pcm
->width
;
26111 ascent
= pcm
->ascent
;
26112 descent
= pcm
->descent
;
26113 lbearing
= pcm
->lbearing
;
26114 rbearing
= pcm
->rbearing
;
26115 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26117 /* Relative composition with or without
26118 alternate chars. */
26119 left
= (leftmost
+ rightmost
- width
) / 2;
26120 btm
= - descent
+ boff
;
26121 if (font
->relative_compose
26122 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26123 || NILP (Faref (Vignore_relative_composition
,
26124 make_number (ch
)))))
26127 if (- descent
>= font
->relative_compose
)
26128 /* One extra pixel between two glyphs. */
26130 else if (ascent
<= 0)
26131 /* One extra pixel between two glyphs. */
26132 btm
= lowest
- 1 - ascent
- descent
;
26137 /* A composition rule is specified by an integer
26138 value that encodes global and new reference
26139 points (GREF and NREF). GREF and NREF are
26140 specified by numbers as below:
26142 0---1---2 -- ascent
26146 9--10--11 -- center
26148 ---3---4---5--- baseline
26150 6---7---8 -- descent
26152 int rule
= COMPOSITION_RULE (cmp
, i
);
26153 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26155 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26156 grefx
= gref
% 3, nrefx
= nref
% 3;
26157 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26159 xoff
= font_height
* (xoff
- 128) / 256;
26161 yoff
= font_height
* (yoff
- 128) / 256;
26164 + grefx
* (rightmost
- leftmost
) / 2
26165 - nrefx
* width
/ 2
26168 btm
= ((grefy
== 0 ? highest
26170 : grefy
== 2 ? lowest
26171 : (highest
+ lowest
) / 2)
26172 - (nrefy
== 0 ? ascent
+ descent
26173 : nrefy
== 1 ? descent
- boff
26175 : (ascent
+ descent
) / 2)
26179 cmp
->offsets
[i
* 2] = left
;
26180 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26182 /* Update the bounding box of the overall glyphs. */
26185 right
= left
+ width
;
26186 if (left
< leftmost
)
26188 if (right
> rightmost
)
26191 top
= btm
+ descent
+ ascent
;
26197 if (cmp
->lbearing
> left
+ lbearing
)
26198 cmp
->lbearing
= left
+ lbearing
;
26199 if (cmp
->rbearing
< left
+ rbearing
)
26200 cmp
->rbearing
= left
+ rbearing
;
26204 /* If there are glyphs whose x-offsets are negative,
26205 shift all glyphs to the right and make all x-offsets
26209 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26210 cmp
->offsets
[i
* 2] -= leftmost
;
26211 rightmost
-= leftmost
;
26212 cmp
->lbearing
-= leftmost
;
26213 cmp
->rbearing
-= leftmost
;
26216 if (left_padded
&& cmp
->lbearing
< 0)
26218 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26219 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26220 rightmost
-= cmp
->lbearing
;
26221 cmp
->rbearing
-= cmp
->lbearing
;
26224 if (right_padded
&& rightmost
< cmp
->rbearing
)
26226 rightmost
= cmp
->rbearing
;
26229 cmp
->pixel_width
= rightmost
;
26230 cmp
->ascent
= highest
;
26231 cmp
->descent
= - lowest
;
26232 if (cmp
->ascent
< font_ascent
)
26233 cmp
->ascent
= font_ascent
;
26234 if (cmp
->descent
< font_descent
)
26235 cmp
->descent
= font_descent
;
26239 && (cmp
->lbearing
< 0
26240 || cmp
->rbearing
> cmp
->pixel_width
))
26241 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26243 it
->pixel_width
= cmp
->pixel_width
;
26244 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26245 it
->descent
= it
->phys_descent
= cmp
->descent
;
26246 if (face
->box
!= FACE_NO_BOX
)
26248 int thick
= face
->box_line_width
;
26252 it
->ascent
+= thick
;
26253 it
->descent
+= thick
;
26258 if (it
->start_of_box_run_p
)
26259 it
->pixel_width
+= thick
;
26260 if (it
->end_of_box_run_p
)
26261 it
->pixel_width
+= thick
;
26264 /* If face has an overline, add the height of the overline
26265 (1 pixel) and a 1 pixel margin to the character height. */
26266 if (face
->overline_p
)
26267 it
->ascent
+= overline_margin
;
26269 take_vertical_position_into_account (it
);
26270 if (it
->ascent
< 0)
26272 if (it
->descent
< 0)
26275 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26276 append_composite_glyph (it
);
26278 else if (it
->what
== IT_COMPOSITION
)
26280 /* A dynamic (automatic) composition. */
26281 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26282 Lisp_Object gstring
;
26283 struct font_metrics metrics
;
26287 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26289 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26292 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26293 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26294 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26295 it
->descent
= it
->phys_descent
= metrics
.descent
;
26296 if (face
->box
!= FACE_NO_BOX
)
26298 int thick
= face
->box_line_width
;
26302 it
->ascent
+= thick
;
26303 it
->descent
+= thick
;
26308 if (it
->start_of_box_run_p
)
26309 it
->pixel_width
+= thick
;
26310 if (it
->end_of_box_run_p
)
26311 it
->pixel_width
+= thick
;
26313 /* If face has an overline, add the height of the overline
26314 (1 pixel) and a 1 pixel margin to the character height. */
26315 if (face
->overline_p
)
26316 it
->ascent
+= overline_margin
;
26317 take_vertical_position_into_account (it
);
26318 if (it
->ascent
< 0)
26320 if (it
->descent
< 0)
26324 append_composite_glyph (it
);
26326 else if (it
->what
== IT_GLYPHLESS
)
26327 produce_glyphless_glyph (it
, 0, Qnil
);
26328 else if (it
->what
== IT_IMAGE
)
26329 produce_image_glyph (it
);
26330 else if (it
->what
== IT_STRETCH
)
26331 produce_stretch_glyph (it
);
26334 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26335 because this isn't true for images with `:ascent 100'. */
26336 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26337 if (it
->area
== TEXT_AREA
)
26338 it
->current_x
+= it
->pixel_width
;
26340 if (extra_line_spacing
> 0)
26342 it
->descent
+= extra_line_spacing
;
26343 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26344 it
->max_extra_line_spacing
= extra_line_spacing
;
26347 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26348 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26349 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26350 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26354 Output LEN glyphs starting at START at the nominal cursor position.
26355 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26356 being updated, and UPDATED_AREA is the area of that row being updated. */
26359 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26360 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26362 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26364 eassert (updated_row
);
26365 /* When the window is hscrolled, cursor hpos can legitimately be out
26366 of bounds, but we draw the cursor at the corresponding window
26367 margin in that case. */
26368 if (!updated_row
->reversed_p
&& chpos
< 0)
26370 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26371 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26375 /* Write glyphs. */
26377 hpos
= start
- updated_row
->glyphs
[updated_area
];
26378 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26379 updated_row
, updated_area
,
26381 DRAW_NORMAL_TEXT
, 0);
26383 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26384 if (updated_area
== TEXT_AREA
26385 && w
->phys_cursor_on_p
26386 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26388 && chpos
< hpos
+ len
)
26389 w
->phys_cursor_on_p
= 0;
26393 /* Advance the output cursor. */
26394 w
->output_cursor
.hpos
+= len
;
26395 w
->output_cursor
.x
= x
;
26400 Insert LEN glyphs from START at the nominal cursor position. */
26403 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26404 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26407 int line_height
, shift_by_width
, shifted_region_width
;
26408 struct glyph_row
*row
;
26409 struct glyph
*glyph
;
26410 int frame_x
, frame_y
;
26413 eassert (updated_row
);
26415 f
= XFRAME (WINDOW_FRAME (w
));
26417 /* Get the height of the line we are in. */
26419 line_height
= row
->height
;
26421 /* Get the width of the glyphs to insert. */
26422 shift_by_width
= 0;
26423 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26424 shift_by_width
+= glyph
->pixel_width
;
26426 /* Get the width of the region to shift right. */
26427 shifted_region_width
= (window_box_width (w
, updated_area
)
26428 - w
->output_cursor
.x
26432 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26433 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26435 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26436 line_height
, shift_by_width
);
26438 /* Write the glyphs. */
26439 hpos
= start
- row
->glyphs
[updated_area
];
26440 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26442 DRAW_NORMAL_TEXT
, 0);
26444 /* Advance the output cursor. */
26445 w
->output_cursor
.hpos
+= len
;
26446 w
->output_cursor
.x
+= shift_by_width
;
26452 Erase the current text line from the nominal cursor position
26453 (inclusive) to pixel column TO_X (exclusive). The idea is that
26454 everything from TO_X onward is already erased.
26456 TO_X is a pixel position relative to UPDATED_AREA of currently
26457 updated window W. TO_X == -1 means clear to the end of this area. */
26460 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26461 enum glyph_row_area updated_area
, int to_x
)
26464 int max_x
, min_y
, max_y
;
26465 int from_x
, from_y
, to_y
;
26467 eassert (updated_row
);
26468 f
= XFRAME (w
->frame
);
26470 if (updated_row
->full_width_p
)
26471 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26472 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26474 max_x
= window_box_width (w
, updated_area
);
26475 max_y
= window_text_bottom_y (w
);
26477 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26478 of window. For TO_X > 0, truncate to end of drawing area. */
26484 to_x
= min (to_x
, max_x
);
26486 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26488 /* Notice if the cursor will be cleared by this operation. */
26489 if (!updated_row
->full_width_p
)
26490 notice_overwritten_cursor (w
, updated_area
,
26491 w
->output_cursor
.x
, -1,
26493 MATRIX_ROW_BOTTOM_Y (updated_row
));
26495 from_x
= w
->output_cursor
.x
;
26497 /* Translate to frame coordinates. */
26498 if (updated_row
->full_width_p
)
26500 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26501 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26505 int area_left
= window_box_left (w
, updated_area
);
26506 from_x
+= area_left
;
26510 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26511 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26512 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26514 /* Prevent inadvertently clearing to end of the X window. */
26515 if (to_x
> from_x
&& to_y
> from_y
)
26518 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26519 to_x
- from_x
, to_y
- from_y
);
26524 #endif /* HAVE_WINDOW_SYSTEM */
26528 /***********************************************************************
26530 ***********************************************************************/
26532 /* Value is the internal representation of the specified cursor type
26533 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26534 of the bar cursor. */
26536 static enum text_cursor_kinds
26537 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26539 enum text_cursor_kinds type
;
26544 if (EQ (arg
, Qbox
))
26545 return FILLED_BOX_CURSOR
;
26547 if (EQ (arg
, Qhollow
))
26548 return HOLLOW_BOX_CURSOR
;
26550 if (EQ (arg
, Qbar
))
26557 && EQ (XCAR (arg
), Qbar
)
26558 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26560 *width
= XINT (XCDR (arg
));
26564 if (EQ (arg
, Qhbar
))
26567 return HBAR_CURSOR
;
26571 && EQ (XCAR (arg
), Qhbar
)
26572 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26574 *width
= XINT (XCDR (arg
));
26575 return HBAR_CURSOR
;
26578 /* Treat anything unknown as "hollow box cursor".
26579 It was bad to signal an error; people have trouble fixing
26580 .Xdefaults with Emacs, when it has something bad in it. */
26581 type
= HOLLOW_BOX_CURSOR
;
26586 /* Set the default cursor types for specified frame. */
26588 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26593 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26594 FRAME_CURSOR_WIDTH (f
) = width
;
26596 /* By default, set up the blink-off state depending on the on-state. */
26598 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26601 FRAME_BLINK_OFF_CURSOR (f
)
26602 = get_specified_cursor_type (XCDR (tem
), &width
);
26603 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26606 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26608 /* Make sure the cursor gets redrawn. */
26609 f
->cursor_type_changed
= 1;
26613 #ifdef HAVE_WINDOW_SYSTEM
26615 /* Return the cursor we want to be displayed in window W. Return
26616 width of bar/hbar cursor through WIDTH arg. Return with
26617 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26618 (i.e. if the `system caret' should track this cursor).
26620 In a mini-buffer window, we want the cursor only to appear if we
26621 are reading input from this window. For the selected window, we
26622 want the cursor type given by the frame parameter or buffer local
26623 setting of cursor-type. If explicitly marked off, draw no cursor.
26624 In all other cases, we want a hollow box cursor. */
26626 static enum text_cursor_kinds
26627 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26628 int *active_cursor
)
26630 struct frame
*f
= XFRAME (w
->frame
);
26631 struct buffer
*b
= XBUFFER (w
->contents
);
26632 int cursor_type
= DEFAULT_CURSOR
;
26633 Lisp_Object alt_cursor
;
26634 int non_selected
= 0;
26636 *active_cursor
= 1;
26639 if (cursor_in_echo_area
26640 && FRAME_HAS_MINIBUF_P (f
)
26641 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26643 if (w
== XWINDOW (echo_area_window
))
26645 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26647 *width
= FRAME_CURSOR_WIDTH (f
);
26648 return FRAME_DESIRED_CURSOR (f
);
26651 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26654 *active_cursor
= 0;
26658 /* Detect a nonselected window or nonselected frame. */
26659 else if (w
!= XWINDOW (f
->selected_window
)
26660 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26662 *active_cursor
= 0;
26664 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26670 /* Never display a cursor in a window in which cursor-type is nil. */
26671 if (NILP (BVAR (b
, cursor_type
)))
26674 /* Get the normal cursor type for this window. */
26675 if (EQ (BVAR (b
, cursor_type
), Qt
))
26677 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26678 *width
= FRAME_CURSOR_WIDTH (f
);
26681 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26683 /* Use cursor-in-non-selected-windows instead
26684 for non-selected window or frame. */
26687 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26688 if (!EQ (Qt
, alt_cursor
))
26689 return get_specified_cursor_type (alt_cursor
, width
);
26690 /* t means modify the normal cursor type. */
26691 if (cursor_type
== FILLED_BOX_CURSOR
)
26692 cursor_type
= HOLLOW_BOX_CURSOR
;
26693 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26695 return cursor_type
;
26698 /* Use normal cursor if not blinked off. */
26699 if (!w
->cursor_off_p
)
26701 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26703 if (cursor_type
== FILLED_BOX_CURSOR
)
26705 /* Using a block cursor on large images can be very annoying.
26706 So use a hollow cursor for "large" images.
26707 If image is not transparent (no mask), also use hollow cursor. */
26708 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26709 if (img
!= NULL
&& IMAGEP (img
->spec
))
26711 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26712 where N = size of default frame font size.
26713 This should cover most of the "tiny" icons people may use. */
26715 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26716 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26717 cursor_type
= HOLLOW_BOX_CURSOR
;
26720 else if (cursor_type
!= NO_CURSOR
)
26722 /* Display current only supports BOX and HOLLOW cursors for images.
26723 So for now, unconditionally use a HOLLOW cursor when cursor is
26724 not a solid box cursor. */
26725 cursor_type
= HOLLOW_BOX_CURSOR
;
26728 return cursor_type
;
26731 /* Cursor is blinked off, so determine how to "toggle" it. */
26733 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26734 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26735 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26737 /* Then see if frame has specified a specific blink off cursor type. */
26738 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26740 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26741 return FRAME_BLINK_OFF_CURSOR (f
);
26745 /* Some people liked having a permanently visible blinking cursor,
26746 while others had very strong opinions against it. So it was
26747 decided to remove it. KFS 2003-09-03 */
26749 /* Finally perform built-in cursor blinking:
26750 filled box <-> hollow box
26751 wide [h]bar <-> narrow [h]bar
26752 narrow [h]bar <-> no cursor
26753 other type <-> no cursor */
26755 if (cursor_type
== FILLED_BOX_CURSOR
)
26756 return HOLLOW_BOX_CURSOR
;
26758 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26761 return cursor_type
;
26769 /* Notice when the text cursor of window W has been completely
26770 overwritten by a drawing operation that outputs glyphs in AREA
26771 starting at X0 and ending at X1 in the line starting at Y0 and
26772 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26773 the rest of the line after X0 has been written. Y coordinates
26774 are window-relative. */
26777 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26778 int x0
, int x1
, int y0
, int y1
)
26780 int cx0
, cx1
, cy0
, cy1
;
26781 struct glyph_row
*row
;
26783 if (!w
->phys_cursor_on_p
)
26785 if (area
!= TEXT_AREA
)
26788 if (w
->phys_cursor
.vpos
< 0
26789 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26790 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26791 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26794 if (row
->cursor_in_fringe_p
)
26796 row
->cursor_in_fringe_p
= 0;
26797 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26798 w
->phys_cursor_on_p
= 0;
26802 cx0
= w
->phys_cursor
.x
;
26803 cx1
= cx0
+ w
->phys_cursor_width
;
26804 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26807 /* The cursor image will be completely removed from the
26808 screen if the output area intersects the cursor area in
26809 y-direction. When we draw in [y0 y1[, and some part of
26810 the cursor is at y < y0, that part must have been drawn
26811 before. When scrolling, the cursor is erased before
26812 actually scrolling, so we don't come here. When not
26813 scrolling, the rows above the old cursor row must have
26814 changed, and in this case these rows must have written
26815 over the cursor image.
26817 Likewise if part of the cursor is below y1, with the
26818 exception of the cursor being in the first blank row at
26819 the buffer and window end because update_text_area
26820 doesn't draw that row. (Except when it does, but
26821 that's handled in update_text_area.) */
26823 cy0
= w
->phys_cursor
.y
;
26824 cy1
= cy0
+ w
->phys_cursor_height
;
26825 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26828 w
->phys_cursor_on_p
= 0;
26831 #endif /* HAVE_WINDOW_SYSTEM */
26834 /************************************************************************
26836 ************************************************************************/
26838 #ifdef HAVE_WINDOW_SYSTEM
26841 Fix the display of area AREA of overlapping row ROW in window W
26842 with respect to the overlapping part OVERLAPS. */
26845 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26846 enum glyph_row_area area
, int overlaps
)
26853 for (i
= 0; i
< row
->used
[area
];)
26855 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26857 int start
= i
, start_x
= x
;
26861 x
+= row
->glyphs
[area
][i
].pixel_width
;
26864 while (i
< row
->used
[area
]
26865 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26867 draw_glyphs (w
, start_x
, row
, area
,
26869 DRAW_NORMAL_TEXT
, overlaps
);
26873 x
+= row
->glyphs
[area
][i
].pixel_width
;
26883 Draw the cursor glyph of window W in glyph row ROW. See the
26884 comment of draw_glyphs for the meaning of HL. */
26887 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
26888 enum draw_glyphs_face hl
)
26890 /* If cursor hpos is out of bounds, don't draw garbage. This can
26891 happen in mini-buffer windows when switching between echo area
26892 glyphs and mini-buffer. */
26893 if ((row
->reversed_p
26894 ? (w
->phys_cursor
.hpos
>= 0)
26895 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
26897 int on_p
= w
->phys_cursor_on_p
;
26899 int hpos
= w
->phys_cursor
.hpos
;
26901 /* When the window is hscrolled, cursor hpos can legitimately be
26902 out of bounds, but we draw the cursor at the corresponding
26903 window margin in that case. */
26904 if (!row
->reversed_p
&& hpos
< 0)
26906 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
26907 hpos
= row
->used
[TEXT_AREA
] - 1;
26909 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
26911 w
->phys_cursor_on_p
= on_p
;
26913 if (hl
== DRAW_CURSOR
)
26914 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26915 /* When we erase the cursor, and ROW is overlapped by other
26916 rows, make sure that these overlapping parts of other rows
26918 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
26920 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
26922 if (row
> w
->current_matrix
->rows
26923 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
26924 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
26925 OVERLAPS_ERASED_CURSOR
);
26927 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
26928 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
26929 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
26930 OVERLAPS_ERASED_CURSOR
);
26936 /* Erase the image of a cursor of window W from the screen. */
26942 erase_phys_cursor (struct window
*w
)
26944 struct frame
*f
= XFRAME (w
->frame
);
26945 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26946 int hpos
= w
->phys_cursor
.hpos
;
26947 int vpos
= w
->phys_cursor
.vpos
;
26948 int mouse_face_here_p
= 0;
26949 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
26950 struct glyph_row
*cursor_row
;
26951 struct glyph
*cursor_glyph
;
26952 enum draw_glyphs_face hl
;
26954 /* No cursor displayed or row invalidated => nothing to do on the
26956 if (w
->phys_cursor_type
== NO_CURSOR
)
26957 goto mark_cursor_off
;
26959 /* VPOS >= active_glyphs->nrows means that window has been resized.
26960 Don't bother to erase the cursor. */
26961 if (vpos
>= active_glyphs
->nrows
)
26962 goto mark_cursor_off
;
26964 /* If row containing cursor is marked invalid, there is nothing we
26966 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
26967 if (!cursor_row
->enabled_p
)
26968 goto mark_cursor_off
;
26970 /* If line spacing is > 0, old cursor may only be partially visible in
26971 window after split-window. So adjust visible height. */
26972 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
26973 window_text_bottom_y (w
) - cursor_row
->y
);
26975 /* If row is completely invisible, don't attempt to delete a cursor which
26976 isn't there. This can happen if cursor is at top of a window, and
26977 we switch to a buffer with a header line in that window. */
26978 if (cursor_row
->visible_height
<= 0)
26979 goto mark_cursor_off
;
26981 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
26982 if (cursor_row
->cursor_in_fringe_p
)
26984 cursor_row
->cursor_in_fringe_p
= 0;
26985 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
26986 goto mark_cursor_off
;
26989 /* This can happen when the new row is shorter than the old one.
26990 In this case, either draw_glyphs or clear_end_of_line
26991 should have cleared the cursor. Note that we wouldn't be
26992 able to erase the cursor in this case because we don't have a
26993 cursor glyph at hand. */
26994 if ((cursor_row
->reversed_p
26995 ? (w
->phys_cursor
.hpos
< 0)
26996 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
26997 goto mark_cursor_off
;
26999 /* When the window is hscrolled, cursor hpos can legitimately be out
27000 of bounds, but we draw the cursor at the corresponding window
27001 margin in that case. */
27002 if (!cursor_row
->reversed_p
&& hpos
< 0)
27004 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27005 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27007 /* If the cursor is in the mouse face area, redisplay that when
27008 we clear the cursor. */
27009 if (! NILP (hlinfo
->mouse_face_window
)
27010 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27011 /* Don't redraw the cursor's spot in mouse face if it is at the
27012 end of a line (on a newline). The cursor appears there, but
27013 mouse highlighting does not. */
27014 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27015 mouse_face_here_p
= 1;
27017 /* Maybe clear the display under the cursor. */
27018 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27021 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27024 cursor_glyph
= get_phys_cursor_glyph (w
);
27025 if (cursor_glyph
== NULL
)
27026 goto mark_cursor_off
;
27028 width
= cursor_glyph
->pixel_width
;
27029 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27030 x
= w
->phys_cursor
.x
;
27032 width
-= left_x
- x
;
27033 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27034 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27035 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27038 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27041 /* Erase the cursor by redrawing the character underneath it. */
27042 if (mouse_face_here_p
)
27043 hl
= DRAW_MOUSE_FACE
;
27045 hl
= DRAW_NORMAL_TEXT
;
27046 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27049 w
->phys_cursor_on_p
= 0;
27050 w
->phys_cursor_type
= NO_CURSOR
;
27055 Display or clear cursor of window W. If ON is zero, clear the
27056 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27057 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27060 display_and_set_cursor (struct window
*w
, bool on
,
27061 int hpos
, int vpos
, int x
, int y
)
27063 struct frame
*f
= XFRAME (w
->frame
);
27064 int new_cursor_type
;
27065 int new_cursor_width
;
27067 struct glyph_row
*glyph_row
;
27068 struct glyph
*glyph
;
27070 /* This is pointless on invisible frames, and dangerous on garbaged
27071 windows and frames; in the latter case, the frame or window may
27072 be in the midst of changing its size, and x and y may be off the
27074 if (! FRAME_VISIBLE_P (f
)
27075 || FRAME_GARBAGED_P (f
)
27076 || vpos
>= w
->current_matrix
->nrows
27077 || hpos
>= w
->current_matrix
->matrix_w
)
27080 /* If cursor is off and we want it off, return quickly. */
27081 if (!on
&& !w
->phys_cursor_on_p
)
27084 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27085 /* If cursor row is not enabled, we don't really know where to
27086 display the cursor. */
27087 if (!glyph_row
->enabled_p
)
27089 w
->phys_cursor_on_p
= 0;
27094 if (!glyph_row
->exact_window_width_line_p
27095 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27096 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27098 eassert (input_blocked_p ());
27100 /* Set new_cursor_type to the cursor we want to be displayed. */
27101 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27102 &new_cursor_width
, &active_cursor
);
27104 /* If cursor is currently being shown and we don't want it to be or
27105 it is in the wrong place, or the cursor type is not what we want,
27107 if (w
->phys_cursor_on_p
27109 || w
->phys_cursor
.x
!= x
27110 || w
->phys_cursor
.y
!= y
27111 || new_cursor_type
!= w
->phys_cursor_type
27112 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27113 && new_cursor_width
!= w
->phys_cursor_width
)))
27114 erase_phys_cursor (w
);
27116 /* Don't check phys_cursor_on_p here because that flag is only set
27117 to zero in some cases where we know that the cursor has been
27118 completely erased, to avoid the extra work of erasing the cursor
27119 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27120 still not be visible, or it has only been partly erased. */
27123 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27124 w
->phys_cursor_height
= glyph_row
->height
;
27126 /* Set phys_cursor_.* before x_draw_.* is called because some
27127 of them may need the information. */
27128 w
->phys_cursor
.x
= x
;
27129 w
->phys_cursor
.y
= glyph_row
->y
;
27130 w
->phys_cursor
.hpos
= hpos
;
27131 w
->phys_cursor
.vpos
= vpos
;
27134 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27135 new_cursor_type
, new_cursor_width
,
27136 on
, active_cursor
);
27140 /* Switch the display of W's cursor on or off, according to the value
27144 update_window_cursor (struct window
*w
, bool on
)
27146 /* Don't update cursor in windows whose frame is in the process
27147 of being deleted. */
27148 if (w
->current_matrix
)
27150 int hpos
= w
->phys_cursor
.hpos
;
27151 int vpos
= w
->phys_cursor
.vpos
;
27152 struct glyph_row
*row
;
27154 if (vpos
>= w
->current_matrix
->nrows
27155 || hpos
>= w
->current_matrix
->matrix_w
)
27158 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27160 /* When the window is hscrolled, cursor hpos can legitimately be
27161 out of bounds, but we draw the cursor at the corresponding
27162 window margin in that case. */
27163 if (!row
->reversed_p
&& hpos
< 0)
27165 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27166 hpos
= row
->used
[TEXT_AREA
] - 1;
27169 display_and_set_cursor (w
, on
, hpos
, vpos
,
27170 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27176 /* Call update_window_cursor with parameter ON_P on all leaf windows
27177 in the window tree rooted at W. */
27180 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27184 if (WINDOWP (w
->contents
))
27185 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27187 update_window_cursor (w
, on_p
);
27189 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27195 Display the cursor on window W, or clear it, according to ON_P.
27196 Don't change the cursor's position. */
27199 x_update_cursor (struct frame
*f
, bool on_p
)
27201 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27206 Clear the cursor of window W to background color, and mark the
27207 cursor as not shown. This is used when the text where the cursor
27208 is about to be rewritten. */
27211 x_clear_cursor (struct window
*w
)
27213 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27214 update_window_cursor (w
, 0);
27217 #endif /* HAVE_WINDOW_SYSTEM */
27219 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27222 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27223 int start_hpos
, int end_hpos
,
27224 enum draw_glyphs_face draw
)
27226 #ifdef HAVE_WINDOW_SYSTEM
27227 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27229 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27233 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27234 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27238 /* Display the active region described by mouse_face_* according to DRAW. */
27241 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27243 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27244 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27246 if (/* If window is in the process of being destroyed, don't bother
27248 w
->current_matrix
!= NULL
27249 /* Don't update mouse highlight if hidden */
27250 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27251 /* Recognize when we are called to operate on rows that don't exist
27252 anymore. This can happen when a window is split. */
27253 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27255 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27256 struct glyph_row
*row
, *first
, *last
;
27258 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27259 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27261 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27263 int start_hpos
, end_hpos
, start_x
;
27265 /* For all but the first row, the highlight starts at column 0. */
27268 /* R2L rows have BEG and END in reversed order, but the
27269 screen drawing geometry is always left to right. So
27270 we need to mirror the beginning and end of the
27271 highlighted area in R2L rows. */
27272 if (!row
->reversed_p
)
27274 start_hpos
= hlinfo
->mouse_face_beg_col
;
27275 start_x
= hlinfo
->mouse_face_beg_x
;
27277 else if (row
== last
)
27279 start_hpos
= hlinfo
->mouse_face_end_col
;
27280 start_x
= hlinfo
->mouse_face_end_x
;
27288 else if (row
->reversed_p
&& row
== last
)
27290 start_hpos
= hlinfo
->mouse_face_end_col
;
27291 start_x
= hlinfo
->mouse_face_end_x
;
27301 if (!row
->reversed_p
)
27302 end_hpos
= hlinfo
->mouse_face_end_col
;
27303 else if (row
== first
)
27304 end_hpos
= hlinfo
->mouse_face_beg_col
;
27307 end_hpos
= row
->used
[TEXT_AREA
];
27308 if (draw
== DRAW_NORMAL_TEXT
)
27309 row
->fill_line_p
= 1; /* Clear to end of line */
27312 else if (row
->reversed_p
&& row
== first
)
27313 end_hpos
= hlinfo
->mouse_face_beg_col
;
27316 end_hpos
= row
->used
[TEXT_AREA
];
27317 if (draw
== DRAW_NORMAL_TEXT
)
27318 row
->fill_line_p
= 1; /* Clear to end of line */
27321 if (end_hpos
> start_hpos
)
27323 draw_row_with_mouse_face (w
, start_x
, row
,
27324 start_hpos
, end_hpos
, draw
);
27327 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27331 #ifdef HAVE_WINDOW_SYSTEM
27332 /* When we've written over the cursor, arrange for it to
27333 be displayed again. */
27334 if (FRAME_WINDOW_P (f
)
27335 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27337 int hpos
= w
->phys_cursor
.hpos
;
27339 /* When the window is hscrolled, cursor hpos can legitimately be
27340 out of bounds, but we draw the cursor at the corresponding
27341 window margin in that case. */
27342 if (!row
->reversed_p
&& hpos
< 0)
27344 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27345 hpos
= row
->used
[TEXT_AREA
] - 1;
27348 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27349 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27352 #endif /* HAVE_WINDOW_SYSTEM */
27355 #ifdef HAVE_WINDOW_SYSTEM
27356 /* Change the mouse cursor. */
27357 if (FRAME_WINDOW_P (f
))
27359 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27360 if (draw
== DRAW_NORMAL_TEXT
27361 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27362 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27365 if (draw
== DRAW_MOUSE_FACE
)
27366 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27368 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27370 #endif /* HAVE_WINDOW_SYSTEM */
27374 Clear out the mouse-highlighted active region.
27375 Redraw it un-highlighted first. Value is non-zero if mouse
27376 face was actually drawn unhighlighted. */
27379 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27383 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27385 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27389 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27390 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27391 hlinfo
->mouse_face_window
= Qnil
;
27392 hlinfo
->mouse_face_overlay
= Qnil
;
27396 /* Return true if the coordinates HPOS and VPOS on windows W are
27397 within the mouse face on that window. */
27399 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27401 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27403 /* Quickly resolve the easy cases. */
27404 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27405 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27407 if (vpos
< hlinfo
->mouse_face_beg_row
27408 || vpos
> hlinfo
->mouse_face_end_row
)
27410 if (vpos
> hlinfo
->mouse_face_beg_row
27411 && vpos
< hlinfo
->mouse_face_end_row
)
27414 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27416 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27418 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27421 else if ((vpos
== hlinfo
->mouse_face_beg_row
27422 && hpos
>= hlinfo
->mouse_face_beg_col
)
27423 || (vpos
== hlinfo
->mouse_face_end_row
27424 && hpos
< hlinfo
->mouse_face_end_col
))
27429 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27431 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27434 else if ((vpos
== hlinfo
->mouse_face_beg_row
27435 && hpos
<= hlinfo
->mouse_face_beg_col
)
27436 || (vpos
== hlinfo
->mouse_face_end_row
27437 && hpos
> hlinfo
->mouse_face_end_col
))
27445 True if physical cursor of window W is within mouse face. */
27448 cursor_in_mouse_face_p (struct window
*w
)
27450 int hpos
= w
->phys_cursor
.hpos
;
27451 int vpos
= w
->phys_cursor
.vpos
;
27452 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27454 /* When the window is hscrolled, cursor hpos can legitimately be out
27455 of bounds, but we draw the cursor at the corresponding window
27456 margin in that case. */
27457 if (!row
->reversed_p
&& hpos
< 0)
27459 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27460 hpos
= row
->used
[TEXT_AREA
] - 1;
27462 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27467 /* Find the glyph rows START_ROW and END_ROW of window W that display
27468 characters between buffer positions START_CHARPOS and END_CHARPOS
27469 (excluding END_CHARPOS). DISP_STRING is a display string that
27470 covers these buffer positions. This is similar to
27471 row_containing_pos, but is more accurate when bidi reordering makes
27472 buffer positions change non-linearly with glyph rows. */
27474 rows_from_pos_range (struct window
*w
,
27475 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27476 Lisp_Object disp_string
,
27477 struct glyph_row
**start
, struct glyph_row
**end
)
27479 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27480 int last_y
= window_text_bottom_y (w
);
27481 struct glyph_row
*row
;
27486 while (!first
->enabled_p
27487 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27490 /* Find the START row. */
27492 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27495 /* A row can potentially be the START row if the range of the
27496 characters it displays intersects the range
27497 [START_CHARPOS..END_CHARPOS). */
27498 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27499 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27500 /* See the commentary in row_containing_pos, for the
27501 explanation of the complicated way to check whether
27502 some position is beyond the end of the characters
27503 displayed by a row. */
27504 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27505 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27506 && !row
->ends_at_zv_p
27507 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27508 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27509 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27510 && !row
->ends_at_zv_p
27511 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27513 /* Found a candidate row. Now make sure at least one of the
27514 glyphs it displays has a charpos from the range
27515 [START_CHARPOS..END_CHARPOS).
27517 This is not obvious because bidi reordering could make
27518 buffer positions of a row be 1,2,3,102,101,100, and if we
27519 want to highlight characters in [50..60), we don't want
27520 this row, even though [50..60) does intersect [1..103),
27521 the range of character positions given by the row's start
27522 and end positions. */
27523 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27524 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27528 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27529 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27530 /* A glyph that comes from DISP_STRING is by
27531 definition to be highlighted. */
27532 || EQ (g
->object
, disp_string
))
27541 /* Find the END row. */
27543 /* If the last row is partially visible, start looking for END
27544 from that row, instead of starting from FIRST. */
27545 && !(row
->enabled_p
27546 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27548 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27550 struct glyph_row
*next
= row
+ 1;
27551 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27553 if (!next
->enabled_p
27554 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27555 /* The first row >= START whose range of displayed characters
27556 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27557 is the row END + 1. */
27558 || (start_charpos
< next_start
27559 && end_charpos
< next_start
)
27560 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27561 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27562 && !next
->ends_at_zv_p
27563 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27564 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27565 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27566 && !next
->ends_at_zv_p
27567 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27574 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27575 but none of the characters it displays are in the range, it is
27577 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27578 struct glyph
*s
= g
;
27579 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27583 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27584 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27585 /* If the buffer position of the first glyph in
27586 the row is equal to END_CHARPOS, it means
27587 the last character to be highlighted is the
27588 newline of ROW, and we must consider NEXT as
27590 || (((!next
->reversed_p
&& g
== s
)
27591 || (next
->reversed_p
&& g
== e
- 1))
27592 && (g
->charpos
== end_charpos
27593 /* Special case for when NEXT is an
27594 empty line at ZV. */
27595 || (g
->charpos
== -1
27596 && !row
->ends_at_zv_p
27597 && next_start
== end_charpos
)))))
27598 /* A glyph that comes from DISP_STRING is by
27599 definition to be highlighted. */
27600 || EQ (g
->object
, disp_string
))
27609 /* The first row that ends at ZV must be the last to be
27611 else if (next
->ends_at_zv_p
)
27620 /* This function sets the mouse_face_* elements of HLINFO, assuming
27621 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27622 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27623 for the overlay or run of text properties specifying the mouse
27624 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27625 before-string and after-string that must also be highlighted.
27626 DISP_STRING, if non-nil, is a display string that may cover some
27627 or all of the highlighted text. */
27630 mouse_face_from_buffer_pos (Lisp_Object window
,
27631 Mouse_HLInfo
*hlinfo
,
27632 ptrdiff_t mouse_charpos
,
27633 ptrdiff_t start_charpos
,
27634 ptrdiff_t end_charpos
,
27635 Lisp_Object before_string
,
27636 Lisp_Object after_string
,
27637 Lisp_Object disp_string
)
27639 struct window
*w
= XWINDOW (window
);
27640 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27641 struct glyph_row
*r1
, *r2
;
27642 struct glyph
*glyph
, *end
;
27643 ptrdiff_t ignore
, pos
;
27646 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27647 eassert (NILP (before_string
) || STRINGP (before_string
));
27648 eassert (NILP (after_string
) || STRINGP (after_string
));
27650 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27651 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27653 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27654 /* If the before-string or display-string contains newlines,
27655 rows_from_pos_range skips to its last row. Move back. */
27656 if (!NILP (before_string
) || !NILP (disp_string
))
27658 struct glyph_row
*prev
;
27659 while ((prev
= r1
- 1, prev
>= first
)
27660 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27661 && prev
->used
[TEXT_AREA
] > 0)
27663 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27664 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27665 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27667 || !(EQ (glyph
->object
, before_string
)
27668 || EQ (glyph
->object
, disp_string
)))
27675 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27676 hlinfo
->mouse_face_past_end
= 1;
27678 else if (!NILP (after_string
))
27680 /* If the after-string has newlines, advance to its last row. */
27681 struct glyph_row
*next
;
27682 struct glyph_row
*last
27683 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27685 for (next
= r2
+ 1;
27687 && next
->used
[TEXT_AREA
] > 0
27688 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27692 /* The rest of the display engine assumes that mouse_face_beg_row is
27693 either above mouse_face_end_row or identical to it. But with
27694 bidi-reordered continued lines, the row for START_CHARPOS could
27695 be below the row for END_CHARPOS. If so, swap the rows and store
27696 them in correct order. */
27699 struct glyph_row
*tem
= r2
;
27705 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27706 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27708 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27709 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27710 could be anywhere in the row and in any order. The strategy
27711 below is to find the leftmost and the rightmost glyph that
27712 belongs to either of these 3 strings, or whose position is
27713 between START_CHARPOS and END_CHARPOS, and highlight all the
27714 glyphs between those two. This may cover more than just the text
27715 between START_CHARPOS and END_CHARPOS if the range of characters
27716 strides the bidi level boundary, e.g. if the beginning is in R2L
27717 text while the end is in L2R text or vice versa. */
27718 if (!r1
->reversed_p
)
27720 /* This row is in a left to right paragraph. Scan it left to
27722 glyph
= r1
->glyphs
[TEXT_AREA
];
27723 end
= glyph
+ r1
->used
[TEXT_AREA
];
27726 /* Skip truncation glyphs at the start of the glyph row. */
27727 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27729 && INTEGERP (glyph
->object
)
27730 && glyph
->charpos
< 0;
27732 x
+= glyph
->pixel_width
;
27734 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27735 or DISP_STRING, and the first glyph from buffer whose
27736 position is between START_CHARPOS and END_CHARPOS. */
27738 && !INTEGERP (glyph
->object
)
27739 && !EQ (glyph
->object
, disp_string
)
27740 && !(BUFFERP (glyph
->object
)
27741 && (glyph
->charpos
>= start_charpos
27742 && glyph
->charpos
< end_charpos
));
27745 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27746 are present at buffer positions between START_CHARPOS and
27747 END_CHARPOS, or if they come from an overlay. */
27748 if (EQ (glyph
->object
, before_string
))
27750 pos
= string_buffer_position (before_string
,
27752 /* If pos == 0, it means before_string came from an
27753 overlay, not from a buffer position. */
27754 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27757 else if (EQ (glyph
->object
, after_string
))
27759 pos
= string_buffer_position (after_string
, end_charpos
);
27760 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27763 x
+= glyph
->pixel_width
;
27765 hlinfo
->mouse_face_beg_x
= x
;
27766 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27770 /* This row is in a right to left paragraph. Scan it right to
27774 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27775 glyph
= end
+ r1
->used
[TEXT_AREA
];
27777 /* Skip truncation glyphs at the start of the glyph row. */
27778 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27780 && INTEGERP (glyph
->object
)
27781 && glyph
->charpos
< 0;
27785 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27786 or DISP_STRING, and the first glyph from buffer whose
27787 position is between START_CHARPOS and END_CHARPOS. */
27789 && !INTEGERP (glyph
->object
)
27790 && !EQ (glyph
->object
, disp_string
)
27791 && !(BUFFERP (glyph
->object
)
27792 && (glyph
->charpos
>= start_charpos
27793 && glyph
->charpos
< end_charpos
));
27796 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27797 are present at buffer positions between START_CHARPOS and
27798 END_CHARPOS, or if they come from an overlay. */
27799 if (EQ (glyph
->object
, before_string
))
27801 pos
= string_buffer_position (before_string
, start_charpos
);
27802 /* If pos == 0, it means before_string came from an
27803 overlay, not from a buffer position. */
27804 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27807 else if (EQ (glyph
->object
, after_string
))
27809 pos
= string_buffer_position (after_string
, end_charpos
);
27810 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27815 glyph
++; /* first glyph to the right of the highlighted area */
27816 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27817 x
+= g
->pixel_width
;
27818 hlinfo
->mouse_face_beg_x
= x
;
27819 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27822 /* If the highlight ends in a different row, compute GLYPH and END
27823 for the end row. Otherwise, reuse the values computed above for
27824 the row where the highlight begins. */
27827 if (!r2
->reversed_p
)
27829 glyph
= r2
->glyphs
[TEXT_AREA
];
27830 end
= glyph
+ r2
->used
[TEXT_AREA
];
27835 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27836 glyph
= end
+ r2
->used
[TEXT_AREA
];
27840 if (!r2
->reversed_p
)
27842 /* Skip truncation and continuation glyphs near the end of the
27843 row, and also blanks and stretch glyphs inserted by
27844 extend_face_to_end_of_line. */
27846 && INTEGERP ((end
- 1)->object
))
27848 /* Scan the rest of the glyph row from the end, looking for the
27849 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27850 DISP_STRING, or whose position is between START_CHARPOS
27854 && !INTEGERP (end
->object
)
27855 && !EQ (end
->object
, disp_string
)
27856 && !(BUFFERP (end
->object
)
27857 && (end
->charpos
>= start_charpos
27858 && end
->charpos
< end_charpos
));
27861 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27862 are present at buffer positions between START_CHARPOS and
27863 END_CHARPOS, or if they come from an overlay. */
27864 if (EQ (end
->object
, before_string
))
27866 pos
= string_buffer_position (before_string
, start_charpos
);
27867 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27870 else if (EQ (end
->object
, after_string
))
27872 pos
= string_buffer_position (after_string
, end_charpos
);
27873 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27877 /* Find the X coordinate of the last glyph to be highlighted. */
27878 for (; glyph
<= end
; ++glyph
)
27879 x
+= glyph
->pixel_width
;
27881 hlinfo
->mouse_face_end_x
= x
;
27882 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
27886 /* Skip truncation and continuation glyphs near the end of the
27887 row, and also blanks and stretch glyphs inserted by
27888 extend_face_to_end_of_line. */
27892 && INTEGERP (end
->object
))
27894 x
+= end
->pixel_width
;
27897 /* Scan the rest of the glyph row from the end, looking for the
27898 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27899 DISP_STRING, or whose position is between START_CHARPOS
27903 && !INTEGERP (end
->object
)
27904 && !EQ (end
->object
, disp_string
)
27905 && !(BUFFERP (end
->object
)
27906 && (end
->charpos
>= start_charpos
27907 && end
->charpos
< end_charpos
));
27910 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27911 are present at buffer positions between START_CHARPOS and
27912 END_CHARPOS, or if they come from an overlay. */
27913 if (EQ (end
->object
, before_string
))
27915 pos
= string_buffer_position (before_string
, start_charpos
);
27916 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27919 else if (EQ (end
->object
, after_string
))
27921 pos
= string_buffer_position (after_string
, end_charpos
);
27922 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27925 x
+= end
->pixel_width
;
27927 /* If we exited the above loop because we arrived at the last
27928 glyph of the row, and its buffer position is still not in
27929 range, it means the last character in range is the preceding
27930 newline. Bump the end column and x values to get past the
27933 && BUFFERP (end
->object
)
27934 && (end
->charpos
< start_charpos
27935 || end
->charpos
>= end_charpos
))
27937 x
+= end
->pixel_width
;
27940 hlinfo
->mouse_face_end_x
= x
;
27941 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
27944 hlinfo
->mouse_face_window
= window
;
27945 hlinfo
->mouse_face_face_id
27946 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
27948 !hlinfo
->mouse_face_hidden
, -1);
27949 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27952 /* The following function is not used anymore (replaced with
27953 mouse_face_from_string_pos), but I leave it here for the time
27954 being, in case someone would. */
27956 #if 0 /* not used */
27958 /* Find the position of the glyph for position POS in OBJECT in
27959 window W's current matrix, and return in *X, *Y the pixel
27960 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
27962 RIGHT_P non-zero means return the position of the right edge of the
27963 glyph, RIGHT_P zero means return the left edge position.
27965 If no glyph for POS exists in the matrix, return the position of
27966 the glyph with the next smaller position that is in the matrix, if
27967 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
27968 exists in the matrix, return the position of the glyph with the
27969 next larger position in OBJECT.
27971 Value is non-zero if a glyph was found. */
27974 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
27975 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
27977 int yb
= window_text_bottom_y (w
);
27978 struct glyph_row
*r
;
27979 struct glyph
*best_glyph
= NULL
;
27980 struct glyph_row
*best_row
= NULL
;
27983 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27984 r
->enabled_p
&& r
->y
< yb
;
27987 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
27988 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
27991 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
27992 if (EQ (g
->object
, object
))
27994 if (g
->charpos
== pos
)
28001 else if (best_glyph
== NULL
28002 || ((eabs (g
->charpos
- pos
)
28003 < eabs (best_glyph
->charpos
- pos
))
28006 : g
->charpos
> pos
)))
28020 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28024 *x
+= best_glyph
->pixel_width
;
28029 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28032 return best_glyph
!= NULL
;
28034 #endif /* not used */
28036 /* Find the positions of the first and the last glyphs in window W's
28037 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28038 (assumed to be a string), and return in HLINFO's mouse_face_*
28039 members the pixel and column/row coordinates of those glyphs. */
28042 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28043 Lisp_Object object
,
28044 ptrdiff_t startpos
, ptrdiff_t endpos
)
28046 int yb
= window_text_bottom_y (w
);
28047 struct glyph_row
*r
;
28048 struct glyph
*g
, *e
;
28052 /* Find the glyph row with at least one position in the range
28053 [STARTPOS..ENDPOS), and the first glyph in that row whose
28054 position belongs to that range. */
28055 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28056 r
->enabled_p
&& r
->y
< yb
;
28059 if (!r
->reversed_p
)
28061 g
= r
->glyphs
[TEXT_AREA
];
28062 e
= g
+ r
->used
[TEXT_AREA
];
28063 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28064 if (EQ (g
->object
, object
)
28065 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28067 hlinfo
->mouse_face_beg_row
28068 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28069 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28070 hlinfo
->mouse_face_beg_x
= gx
;
28079 e
= r
->glyphs
[TEXT_AREA
];
28080 g
= e
+ r
->used
[TEXT_AREA
];
28081 for ( ; g
> e
; --g
)
28082 if (EQ ((g
-1)->object
, object
)
28083 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28085 hlinfo
->mouse_face_beg_row
28086 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28087 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28088 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28089 gx
+= g1
->pixel_width
;
28090 hlinfo
->mouse_face_beg_x
= gx
;
28102 /* Starting with the next row, look for the first row which does NOT
28103 include any glyphs whose positions are in the range. */
28104 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28106 g
= r
->glyphs
[TEXT_AREA
];
28107 e
= g
+ r
->used
[TEXT_AREA
];
28109 for ( ; g
< e
; ++g
)
28110 if (EQ (g
->object
, object
)
28111 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28120 /* The highlighted region ends on the previous row. */
28123 /* Set the end row. */
28124 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28126 /* Compute and set the end column and the end column's horizontal
28127 pixel coordinate. */
28128 if (!r
->reversed_p
)
28130 g
= r
->glyphs
[TEXT_AREA
];
28131 e
= g
+ r
->used
[TEXT_AREA
];
28132 for ( ; e
> g
; --e
)
28133 if (EQ ((e
-1)->object
, object
)
28134 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28136 hlinfo
->mouse_face_end_col
= e
- g
;
28138 for (gx
= r
->x
; g
< e
; ++g
)
28139 gx
+= g
->pixel_width
;
28140 hlinfo
->mouse_face_end_x
= gx
;
28144 e
= r
->glyphs
[TEXT_AREA
];
28145 g
= e
+ r
->used
[TEXT_AREA
];
28146 for (gx
= r
->x
; e
< g
; ++e
)
28148 if (EQ (e
->object
, object
)
28149 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28151 gx
+= e
->pixel_width
;
28153 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28154 hlinfo
->mouse_face_end_x
= gx
;
28158 #ifdef HAVE_WINDOW_SYSTEM
28160 /* See if position X, Y is within a hot-spot of an image. */
28163 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28165 if (!CONSP (hot_spot
))
28168 if (EQ (XCAR (hot_spot
), Qrect
))
28170 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28171 Lisp_Object rect
= XCDR (hot_spot
);
28175 if (!CONSP (XCAR (rect
)))
28177 if (!CONSP (XCDR (rect
)))
28179 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28181 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28183 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28185 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28189 else if (EQ (XCAR (hot_spot
), Qcircle
))
28191 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28192 Lisp_Object circ
= XCDR (hot_spot
);
28193 Lisp_Object lr
, lx0
, ly0
;
28195 && CONSP (XCAR (circ
))
28196 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28197 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28198 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28200 double r
= XFLOATINT (lr
);
28201 double dx
= XINT (lx0
) - x
;
28202 double dy
= XINT (ly0
) - y
;
28203 return (dx
* dx
+ dy
* dy
<= r
* r
);
28206 else if (EQ (XCAR (hot_spot
), Qpoly
))
28208 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28209 if (VECTORP (XCDR (hot_spot
)))
28211 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28212 Lisp_Object
*poly
= v
->contents
;
28213 ptrdiff_t n
= v
->header
.size
;
28216 Lisp_Object lx
, ly
;
28219 /* Need an even number of coordinates, and at least 3 edges. */
28220 if (n
< 6 || n
& 1)
28223 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28224 If count is odd, we are inside polygon. Pixels on edges
28225 may or may not be included depending on actual geometry of the
28227 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28228 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28230 x0
= XINT (lx
), y0
= XINT (ly
);
28231 for (i
= 0; i
< n
; i
+= 2)
28233 int x1
= x0
, y1
= y0
;
28234 if ((lx
= poly
[i
], !INTEGERP (lx
))
28235 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28237 x0
= XINT (lx
), y0
= XINT (ly
);
28239 /* Does this segment cross the X line? */
28247 if (y
> y0
&& y
> y1
)
28249 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28259 find_hot_spot (Lisp_Object map
, int x
, int y
)
28261 while (CONSP (map
))
28263 if (CONSP (XCAR (map
))
28264 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28272 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28274 doc
: /* Lookup in image map MAP coordinates X and Y.
28275 An image map is an alist where each element has the format (AREA ID PLIST).
28276 An AREA is specified as either a rectangle, a circle, or a polygon:
28277 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28278 pixel coordinates of the upper left and bottom right corners.
28279 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28280 and the radius of the circle; r may be a float or integer.
28281 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28282 vector describes one corner in the polygon.
28283 Returns the alist element for the first matching AREA in MAP. */)
28284 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28292 return find_hot_spot (map
,
28293 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28294 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28298 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28300 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28302 /* Do not change cursor shape while dragging mouse. */
28303 if (!NILP (do_mouse_tracking
))
28306 if (!NILP (pointer
))
28308 if (EQ (pointer
, Qarrow
))
28309 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28310 else if (EQ (pointer
, Qhand
))
28311 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28312 else if (EQ (pointer
, Qtext
))
28313 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28314 else if (EQ (pointer
, intern ("hdrag")))
28315 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28316 else if (EQ (pointer
, intern ("nhdrag")))
28317 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28318 #ifdef HAVE_X_WINDOWS
28319 else if (EQ (pointer
, intern ("vdrag")))
28320 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28322 else if (EQ (pointer
, intern ("hourglass")))
28323 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28324 else if (EQ (pointer
, Qmodeline
))
28325 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28327 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28330 if (cursor
!= No_Cursor
)
28331 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28334 #endif /* HAVE_WINDOW_SYSTEM */
28336 /* Take proper action when mouse has moved to the mode or header line
28337 or marginal area AREA of window W, x-position X and y-position Y.
28338 X is relative to the start of the text display area of W, so the
28339 width of bitmap areas and scroll bars must be subtracted to get a
28340 position relative to the start of the mode line. */
28343 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28344 enum window_part area
)
28346 struct window
*w
= XWINDOW (window
);
28347 struct frame
*f
= XFRAME (w
->frame
);
28348 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28349 #ifdef HAVE_WINDOW_SYSTEM
28350 Display_Info
*dpyinfo
;
28352 Cursor cursor
= No_Cursor
;
28353 Lisp_Object pointer
= Qnil
;
28354 int dx
, dy
, width
, height
;
28356 Lisp_Object string
, object
= Qnil
;
28357 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28359 Lisp_Object mouse_face
;
28360 int original_x_pixel
= x
;
28361 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28362 struct glyph_row
*row
IF_LINT (= 0);
28364 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28369 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28370 returns them in row/column units! */
28371 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28372 &object
, &dx
, &dy
, &width
, &height
);
28374 row
= (area
== ON_MODE_LINE
28375 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28376 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28378 /* Find the glyph under the mouse pointer. */
28379 if (row
->mode_line_p
&& row
->enabled_p
)
28381 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28382 end
= glyph
+ row
->used
[TEXT_AREA
];
28384 for (x0
= original_x_pixel
;
28385 glyph
< end
&& x0
>= glyph
->pixel_width
;
28387 x0
-= glyph
->pixel_width
;
28395 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28396 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28397 returns them in row/column units! */
28398 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28399 &object
, &dx
, &dy
, &width
, &height
);
28404 #ifdef HAVE_WINDOW_SYSTEM
28405 if (IMAGEP (object
))
28407 Lisp_Object image_map
, hotspot
;
28408 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28410 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28412 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28416 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28417 If so, we could look for mouse-enter, mouse-leave
28418 properties in PLIST (and do something...). */
28419 hotspot
= XCDR (hotspot
);
28420 if (CONSP (hotspot
)
28421 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28423 pointer
= Fplist_get (plist
, Qpointer
);
28424 if (NILP (pointer
))
28426 help
= Fplist_get (plist
, Qhelp_echo
);
28429 help_echo_string
= help
;
28430 XSETWINDOW (help_echo_window
, w
);
28431 help_echo_object
= w
->contents
;
28432 help_echo_pos
= charpos
;
28436 if (NILP (pointer
))
28437 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28439 #endif /* HAVE_WINDOW_SYSTEM */
28441 if (STRINGP (string
))
28442 pos
= make_number (charpos
);
28444 /* Set the help text and mouse pointer. If the mouse is on a part
28445 of the mode line without any text (e.g. past the right edge of
28446 the mode line text), use the default help text and pointer. */
28447 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28449 /* Arrange to display the help by setting the global variables
28450 help_echo_string, help_echo_object, and help_echo_pos. */
28453 if (STRINGP (string
))
28454 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28458 help_echo_string
= help
;
28459 XSETWINDOW (help_echo_window
, w
);
28460 help_echo_object
= string
;
28461 help_echo_pos
= charpos
;
28463 else if (area
== ON_MODE_LINE
)
28465 Lisp_Object default_help
28466 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28469 if (STRINGP (default_help
))
28471 help_echo_string
= default_help
;
28472 XSETWINDOW (help_echo_window
, w
);
28473 help_echo_object
= Qnil
;
28474 help_echo_pos
= -1;
28479 #ifdef HAVE_WINDOW_SYSTEM
28480 /* Change the mouse pointer according to what is under it. */
28481 if (FRAME_WINDOW_P (f
))
28483 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28485 || NILP (Vresize_mini_windows
));
28487 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28488 if (STRINGP (string
))
28490 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28492 if (NILP (pointer
))
28493 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28495 /* Change the mouse pointer according to what is under X/Y. */
28497 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28500 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28501 if (!KEYMAPP (map
))
28502 map
= Fget_text_property (pos
, Qkeymap
, string
);
28503 if (!KEYMAPP (map
) && draggable
)
28504 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28507 else if (draggable
)
28508 /* Default mode-line pointer. */
28509 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28514 /* Change the mouse face according to what is under X/Y. */
28515 if (STRINGP (string
))
28517 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28518 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28519 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28524 struct glyph
* tmp_glyph
;
28528 int total_pixel_width
;
28529 ptrdiff_t begpos
, endpos
, ignore
;
28533 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28534 Qmouse_face
, string
, Qnil
);
28540 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28542 endpos
= SCHARS (string
);
28546 /* Calculate the glyph position GPOS of GLYPH in the
28547 displayed string, relative to the beginning of the
28548 highlighted part of the string.
28550 Note: GPOS is different from CHARPOS. CHARPOS is the
28551 position of GLYPH in the internal string object. A mode
28552 line string format has structures which are converted to
28553 a flattened string by the Emacs Lisp interpreter. The
28554 internal string is an element of those structures. The
28555 displayed string is the flattened string. */
28556 tmp_glyph
= row_start_glyph
;
28557 while (tmp_glyph
< glyph
28558 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28559 && begpos
<= tmp_glyph
->charpos
28560 && tmp_glyph
->charpos
< endpos
)))
28562 gpos
= glyph
- tmp_glyph
;
28564 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28565 the highlighted part of the displayed string to which
28566 GLYPH belongs. Note: GSEQ_LENGTH is different from
28567 SCHARS (STRING), because the latter returns the length of
28568 the internal string. */
28569 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28571 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28572 && begpos
<= tmp_glyph
->charpos
28573 && tmp_glyph
->charpos
< endpos
));
28576 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28578 /* Calculate the total pixel width of all the glyphs between
28579 the beginning of the highlighted area and GLYPH. */
28580 total_pixel_width
= 0;
28581 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28582 total_pixel_width
+= tmp_glyph
->pixel_width
;
28584 /* Pre calculation of re-rendering position. Note: X is in
28585 column units here, after the call to mode_line_string or
28586 marginal_area_string. */
28588 vpos
= (area
== ON_MODE_LINE
28589 ? (w
->current_matrix
)->nrows
- 1
28592 /* If GLYPH's position is included in the region that is
28593 already drawn in mouse face, we have nothing to do. */
28594 if ( EQ (window
, hlinfo
->mouse_face_window
)
28595 && (!row
->reversed_p
28596 ? (hlinfo
->mouse_face_beg_col
<= hpos
28597 && hpos
< hlinfo
->mouse_face_end_col
)
28598 /* In R2L rows we swap BEG and END, see below. */
28599 : (hlinfo
->mouse_face_end_col
<= hpos
28600 && hpos
< hlinfo
->mouse_face_beg_col
))
28601 && hlinfo
->mouse_face_beg_row
== vpos
)
28604 if (clear_mouse_face (hlinfo
))
28605 cursor
= No_Cursor
;
28607 if (!row
->reversed_p
)
28609 hlinfo
->mouse_face_beg_col
= hpos
;
28610 hlinfo
->mouse_face_beg_x
= original_x_pixel
28611 - (total_pixel_width
+ dx
);
28612 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28613 hlinfo
->mouse_face_end_x
= 0;
28617 /* In R2L rows, show_mouse_face expects BEG and END
28618 coordinates to be swapped. */
28619 hlinfo
->mouse_face_end_col
= hpos
;
28620 hlinfo
->mouse_face_end_x
= original_x_pixel
28621 - (total_pixel_width
+ dx
);
28622 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28623 hlinfo
->mouse_face_beg_x
= 0;
28626 hlinfo
->mouse_face_beg_row
= vpos
;
28627 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28628 hlinfo
->mouse_face_past_end
= 0;
28629 hlinfo
->mouse_face_window
= window
;
28631 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28636 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28638 if (NILP (pointer
))
28641 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28642 clear_mouse_face (hlinfo
);
28644 #ifdef HAVE_WINDOW_SYSTEM
28645 if (FRAME_WINDOW_P (f
))
28646 define_frame_cursor1 (f
, cursor
, pointer
);
28652 Take proper action when the mouse has moved to position X, Y on
28653 frame F with regards to highlighting portions of display that have
28654 mouse-face properties. Also de-highlight portions of display where
28655 the mouse was before, set the mouse pointer shape as appropriate
28656 for the mouse coordinates, and activate help echo (tooltips).
28657 X and Y can be negative or out of range. */
28660 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28663 enum window_part part
= ON_NOTHING
;
28664 Lisp_Object window
;
28666 Cursor cursor
= No_Cursor
;
28667 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28670 /* When a menu is active, don't highlight because this looks odd. */
28671 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28672 if (popup_activated ())
28676 if (!f
->glyphs_initialized_p
28677 || f
->pointer_invisible
)
28680 hlinfo
->mouse_face_mouse_x
= x
;
28681 hlinfo
->mouse_face_mouse_y
= y
;
28682 hlinfo
->mouse_face_mouse_frame
= f
;
28684 if (hlinfo
->mouse_face_defer
)
28687 /* Which window is that in? */
28688 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28690 /* If displaying active text in another window, clear that. */
28691 if (! EQ (window
, hlinfo
->mouse_face_window
)
28692 /* Also clear if we move out of text area in same window. */
28693 || (!NILP (hlinfo
->mouse_face_window
)
28696 && part
!= ON_MODE_LINE
28697 && part
!= ON_HEADER_LINE
))
28698 clear_mouse_face (hlinfo
);
28700 /* Not on a window -> return. */
28701 if (!WINDOWP (window
))
28704 /* Reset help_echo_string. It will get recomputed below. */
28705 help_echo_string
= Qnil
;
28707 /* Convert to window-relative pixel coordinates. */
28708 w
= XWINDOW (window
);
28709 frame_to_window_pixel_xy (w
, &x
, &y
);
28711 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28712 /* Handle tool-bar window differently since it doesn't display a
28714 if (EQ (window
, f
->tool_bar_window
))
28716 note_tool_bar_highlight (f
, x
, y
);
28721 /* Mouse is on the mode, header line or margin? */
28722 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28723 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28725 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28727 #ifdef HAVE_WINDOW_SYSTEM
28728 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28730 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28731 /* Show non-text cursor (Bug#16647). */
28739 #ifdef HAVE_WINDOW_SYSTEM
28740 if (part
== ON_VERTICAL_BORDER
)
28742 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28743 help_echo_string
= build_string ("drag-mouse-1: resize");
28745 else if (part
== ON_RIGHT_DIVIDER
)
28747 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28748 help_echo_string
= build_string ("drag-mouse-1: resize");
28750 else if (part
== ON_BOTTOM_DIVIDER
)
28751 if (! WINDOW_BOTTOMMOST_P (w
)
28753 || NILP (Vresize_mini_windows
))
28755 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28756 help_echo_string
= build_string ("drag-mouse-1: resize");
28759 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28760 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28761 || part
== ON_SCROLL_BAR
)
28762 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28764 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28767 /* Are we in a window whose display is up to date?
28768 And verify the buffer's text has not changed. */
28769 b
= XBUFFER (w
->contents
);
28770 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28772 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28774 struct glyph
*glyph
;
28775 Lisp_Object object
;
28776 Lisp_Object mouse_face
= Qnil
, position
;
28777 Lisp_Object
*overlay_vec
= NULL
;
28778 ptrdiff_t i
, noverlays
;
28779 struct buffer
*obuf
;
28780 ptrdiff_t obegv
, ozv
;
28783 /* Find the glyph under X/Y. */
28784 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28786 #ifdef HAVE_WINDOW_SYSTEM
28787 /* Look for :pointer property on image. */
28788 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28790 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28791 if (img
!= NULL
&& IMAGEP (img
->spec
))
28793 Lisp_Object image_map
, hotspot
;
28794 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28796 && (hotspot
= find_hot_spot (image_map
,
28797 glyph
->slice
.img
.x
+ dx
,
28798 glyph
->slice
.img
.y
+ dy
),
28800 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28804 /* Could check XCAR (hotspot) to see if we enter/leave
28806 If so, we could look for mouse-enter, mouse-leave
28807 properties in PLIST (and do something...). */
28808 hotspot
= XCDR (hotspot
);
28809 if (CONSP (hotspot
)
28810 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28812 pointer
= Fplist_get (plist
, Qpointer
);
28813 if (NILP (pointer
))
28815 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28816 if (!NILP (help_echo_string
))
28818 help_echo_window
= window
;
28819 help_echo_object
= glyph
->object
;
28820 help_echo_pos
= glyph
->charpos
;
28824 if (NILP (pointer
))
28825 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28828 #endif /* HAVE_WINDOW_SYSTEM */
28830 /* Clear mouse face if X/Y not over text. */
28832 || area
!= TEXT_AREA
28833 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
28834 /* Glyph's OBJECT is an integer for glyphs inserted by the
28835 display engine for its internal purposes, like truncation
28836 and continuation glyphs and blanks beyond the end of
28837 line's text on text terminals. If we are over such a
28838 glyph, we are not over any text. */
28839 || INTEGERP (glyph
->object
)
28840 /* R2L rows have a stretch glyph at their front, which
28841 stands for no text, whereas L2R rows have no glyphs at
28842 all beyond the end of text. Treat such stretch glyphs
28843 like we do with NULL glyphs in L2R rows. */
28844 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28845 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
28846 && glyph
->type
== STRETCH_GLYPH
28847 && glyph
->avoid_cursor_p
))
28849 if (clear_mouse_face (hlinfo
))
28850 cursor
= No_Cursor
;
28851 #ifdef HAVE_WINDOW_SYSTEM
28852 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28854 if (area
!= TEXT_AREA
)
28855 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28857 pointer
= Vvoid_text_area_pointer
;
28863 pos
= glyph
->charpos
;
28864 object
= glyph
->object
;
28865 if (!STRINGP (object
) && !BUFFERP (object
))
28868 /* If we get an out-of-range value, return now; avoid an error. */
28869 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28872 /* Make the window's buffer temporarily current for
28873 overlays_at and compute_char_face. */
28874 obuf
= current_buffer
;
28875 current_buffer
= b
;
28881 /* Is this char mouse-active or does it have help-echo? */
28882 position
= make_number (pos
);
28884 if (BUFFERP (object
))
28886 /* Put all the overlays we want in a vector in overlay_vec. */
28887 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
28888 /* Sort overlays into increasing priority order. */
28889 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
28894 if (NILP (Vmouse_highlight
))
28896 clear_mouse_face (hlinfo
);
28897 goto check_help_echo
;
28900 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
28903 cursor
= No_Cursor
;
28905 /* Check mouse-face highlighting. */
28907 /* If there exists an overlay with mouse-face overlapping
28908 the one we are currently highlighting, we have to
28909 check if we enter the overlapping overlay, and then
28910 highlight only that. */
28911 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
28912 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
28914 /* Find the highest priority overlay with a mouse-face. */
28915 Lisp_Object overlay
= Qnil
;
28916 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
28918 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
28919 if (!NILP (mouse_face
))
28920 overlay
= overlay_vec
[i
];
28923 /* If we're highlighting the same overlay as before, there's
28924 no need to do that again. */
28925 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
28926 goto check_help_echo
;
28927 hlinfo
->mouse_face_overlay
= overlay
;
28929 /* Clear the display of the old active region, if any. */
28930 if (clear_mouse_face (hlinfo
))
28931 cursor
= No_Cursor
;
28933 /* If no overlay applies, get a text property. */
28934 if (NILP (overlay
))
28935 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
28937 /* Next, compute the bounds of the mouse highlighting and
28939 if (!NILP (mouse_face
) && STRINGP (object
))
28941 /* The mouse-highlighting comes from a display string
28942 with a mouse-face. */
28946 s
= Fprevious_single_property_change
28947 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
28948 e
= Fnext_single_property_change
28949 (position
, Qmouse_face
, object
, Qnil
);
28951 s
= make_number (0);
28953 e
= make_number (SCHARS (object
));
28954 mouse_face_from_string_pos (w
, hlinfo
, object
,
28955 XINT (s
), XINT (e
));
28956 hlinfo
->mouse_face_past_end
= 0;
28957 hlinfo
->mouse_face_window
= window
;
28958 hlinfo
->mouse_face_face_id
28959 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
28960 glyph
->face_id
, 1);
28961 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28962 cursor
= No_Cursor
;
28966 /* The mouse-highlighting, if any, comes from an overlay
28967 or text property in the buffer. */
28968 Lisp_Object buffer
IF_LINT (= Qnil
);
28969 Lisp_Object disp_string
IF_LINT (= Qnil
);
28971 if (STRINGP (object
))
28973 /* If we are on a display string with no mouse-face,
28974 check if the text under it has one. */
28975 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
28976 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
28977 pos
= string_buffer_position (object
, start
);
28980 mouse_face
= get_char_property_and_overlay
28981 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
28982 buffer
= w
->contents
;
28983 disp_string
= object
;
28989 disp_string
= Qnil
;
28992 if (!NILP (mouse_face
))
28994 Lisp_Object before
, after
;
28995 Lisp_Object before_string
, after_string
;
28996 /* To correctly find the limits of mouse highlight
28997 in a bidi-reordered buffer, we must not use the
28998 optimization of limiting the search in
28999 previous-single-property-change and
29000 next-single-property-change, because
29001 rows_from_pos_range needs the real start and end
29002 positions to DTRT in this case. That's because
29003 the first row visible in a window does not
29004 necessarily display the character whose position
29005 is the smallest. */
29007 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29008 ? Fmarker_position (w
->start
)
29011 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29012 ? make_number (BUF_Z (XBUFFER (buffer
))
29013 - w
->window_end_pos
)
29016 if (NILP (overlay
))
29018 /* Handle the text property case. */
29019 before
= Fprevious_single_property_change
29020 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29021 after
= Fnext_single_property_change
29022 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29023 before_string
= after_string
= Qnil
;
29027 /* Handle the overlay case. */
29028 before
= Foverlay_start (overlay
);
29029 after
= Foverlay_end (overlay
);
29030 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29031 after_string
= Foverlay_get (overlay
, Qafter_string
);
29033 if (!STRINGP (before_string
)) before_string
= Qnil
;
29034 if (!STRINGP (after_string
)) after_string
= Qnil
;
29037 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29040 : XFASTINT (before
),
29042 ? BUF_Z (XBUFFER (buffer
))
29043 : XFASTINT (after
),
29044 before_string
, after_string
,
29046 cursor
= No_Cursor
;
29053 /* Look for a `help-echo' property. */
29054 if (NILP (help_echo_string
)) {
29055 Lisp_Object help
, overlay
;
29057 /* Check overlays first. */
29058 help
= overlay
= Qnil
;
29059 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29061 overlay
= overlay_vec
[i
];
29062 help
= Foverlay_get (overlay
, Qhelp_echo
);
29067 help_echo_string
= help
;
29068 help_echo_window
= window
;
29069 help_echo_object
= overlay
;
29070 help_echo_pos
= pos
;
29074 Lisp_Object obj
= glyph
->object
;
29075 ptrdiff_t charpos
= glyph
->charpos
;
29077 /* Try text properties. */
29080 && charpos
< SCHARS (obj
))
29082 help
= Fget_text_property (make_number (charpos
),
29086 /* If the string itself doesn't specify a help-echo,
29087 see if the buffer text ``under'' it does. */
29088 struct glyph_row
*r
29089 = MATRIX_ROW (w
->current_matrix
, vpos
);
29090 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29091 ptrdiff_t p
= string_buffer_position (obj
, start
);
29094 help
= Fget_char_property (make_number (p
),
29095 Qhelp_echo
, w
->contents
);
29104 else if (BUFFERP (obj
)
29107 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29112 help_echo_string
= help
;
29113 help_echo_window
= window
;
29114 help_echo_object
= obj
;
29115 help_echo_pos
= charpos
;
29120 #ifdef HAVE_WINDOW_SYSTEM
29121 /* Look for a `pointer' property. */
29122 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29124 /* Check overlays first. */
29125 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29126 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29128 if (NILP (pointer
))
29130 Lisp_Object obj
= glyph
->object
;
29131 ptrdiff_t charpos
= glyph
->charpos
;
29133 /* Try text properties. */
29136 && charpos
< SCHARS (obj
))
29138 pointer
= Fget_text_property (make_number (charpos
),
29140 if (NILP (pointer
))
29142 /* If the string itself doesn't specify a pointer,
29143 see if the buffer text ``under'' it does. */
29144 struct glyph_row
*r
29145 = MATRIX_ROW (w
->current_matrix
, vpos
);
29146 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29147 ptrdiff_t p
= string_buffer_position (obj
, start
);
29149 pointer
= Fget_char_property (make_number (p
),
29150 Qpointer
, w
->contents
);
29153 else if (BUFFERP (obj
)
29156 pointer
= Fget_text_property (make_number (charpos
),
29160 #endif /* HAVE_WINDOW_SYSTEM */
29164 current_buffer
= obuf
;
29169 #ifdef HAVE_WINDOW_SYSTEM
29170 if (FRAME_WINDOW_P (f
))
29171 define_frame_cursor1 (f
, cursor
, pointer
);
29173 /* This is here to prevent a compiler error, about "label at end of
29174 compound statement". */
29181 Clear any mouse-face on window W. This function is part of the
29182 redisplay interface, and is called from try_window_id and similar
29183 functions to ensure the mouse-highlight is off. */
29186 x_clear_window_mouse_face (struct window
*w
)
29188 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29189 Lisp_Object window
;
29192 XSETWINDOW (window
, w
);
29193 if (EQ (window
, hlinfo
->mouse_face_window
))
29194 clear_mouse_face (hlinfo
);
29200 Just discard the mouse face information for frame F, if any.
29201 This is used when the size of F is changed. */
29204 cancel_mouse_face (struct frame
*f
)
29206 Lisp_Object window
;
29207 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29209 window
= hlinfo
->mouse_face_window
;
29210 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29211 reset_mouse_highlight (hlinfo
);
29216 /***********************************************************************
29218 ***********************************************************************/
29220 #ifdef HAVE_WINDOW_SYSTEM
29222 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29223 which intersects rectangle R. R is in window-relative coordinates. */
29226 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29227 enum glyph_row_area area
)
29229 struct glyph
*first
= row
->glyphs
[area
];
29230 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29231 struct glyph
*last
;
29232 int first_x
, start_x
, x
;
29234 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29235 /* If row extends face to end of line write the whole line. */
29236 draw_glyphs (w
, 0, row
, area
,
29237 0, row
->used
[area
],
29238 DRAW_NORMAL_TEXT
, 0);
29241 /* Set START_X to the window-relative start position for drawing glyphs of
29242 AREA. The first glyph of the text area can be partially visible.
29243 The first glyphs of other areas cannot. */
29244 start_x
= window_box_left_offset (w
, area
);
29246 if (area
== TEXT_AREA
)
29249 /* Find the first glyph that must be redrawn. */
29251 && x
+ first
->pixel_width
< r
->x
)
29253 x
+= first
->pixel_width
;
29257 /* Find the last one. */
29261 && x
< r
->x
+ r
->width
)
29263 x
+= last
->pixel_width
;
29269 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29270 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29271 DRAW_NORMAL_TEXT
, 0);
29276 /* Redraw the parts of the glyph row ROW on window W intersecting
29277 rectangle R. R is in window-relative coordinates. Value is
29278 non-zero if mouse-face was overwritten. */
29281 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29283 eassert (row
->enabled_p
);
29285 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29286 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29287 0, row
->used
[TEXT_AREA
],
29288 DRAW_NORMAL_TEXT
, 0);
29291 if (row
->used
[LEFT_MARGIN_AREA
])
29292 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29293 if (row
->used
[TEXT_AREA
])
29294 expose_area (w
, row
, r
, TEXT_AREA
);
29295 if (row
->used
[RIGHT_MARGIN_AREA
])
29296 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29297 draw_row_fringe_bitmaps (w
, row
);
29300 return row
->mouse_face_p
;
29304 /* Redraw those parts of glyphs rows during expose event handling that
29305 overlap other rows. Redrawing of an exposed line writes over parts
29306 of lines overlapping that exposed line; this function fixes that.
29308 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29309 row in W's current matrix that is exposed and overlaps other rows.
29310 LAST_OVERLAPPING_ROW is the last such row. */
29313 expose_overlaps (struct window
*w
,
29314 struct glyph_row
*first_overlapping_row
,
29315 struct glyph_row
*last_overlapping_row
,
29318 struct glyph_row
*row
;
29320 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29321 if (row
->overlapping_p
)
29323 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29326 if (row
->used
[LEFT_MARGIN_AREA
])
29327 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29329 if (row
->used
[TEXT_AREA
])
29330 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29332 if (row
->used
[RIGHT_MARGIN_AREA
])
29333 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29339 /* Return non-zero if W's cursor intersects rectangle R. */
29342 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29344 XRectangle cr
, result
;
29345 struct glyph
*cursor_glyph
;
29346 struct glyph_row
*row
;
29348 if (w
->phys_cursor
.vpos
>= 0
29349 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29350 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29352 && row
->cursor_in_fringe_p
)
29354 /* Cursor is in the fringe. */
29355 cr
.x
= window_box_right_offset (w
,
29356 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29357 ? RIGHT_MARGIN_AREA
29360 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29361 cr
.height
= row
->height
;
29362 return x_intersect_rectangles (&cr
, r
, &result
);
29365 cursor_glyph
= get_phys_cursor_glyph (w
);
29368 /* r is relative to W's box, but w->phys_cursor.x is relative
29369 to left edge of W's TEXT area. Adjust it. */
29370 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29371 cr
.y
= w
->phys_cursor
.y
;
29372 cr
.width
= cursor_glyph
->pixel_width
;
29373 cr
.height
= w
->phys_cursor_height
;
29374 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29375 I assume the effect is the same -- and this is portable. */
29376 return x_intersect_rectangles (&cr
, r
, &result
);
29378 /* If we don't understand the format, pretend we're not in the hot-spot. */
29384 Draw a vertical window border to the right of window W if W doesn't
29385 have vertical scroll bars. */
29388 x_draw_vertical_border (struct window
*w
)
29390 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29392 /* We could do better, if we knew what type of scroll-bar the adjacent
29393 windows (on either side) have... But we don't :-(
29394 However, I think this works ok. ++KFS 2003-04-25 */
29396 /* Redraw borders between horizontally adjacent windows. Don't
29397 do it for frames with vertical scroll bars because either the
29398 right scroll bar of a window, or the left scroll bar of its
29399 neighbor will suffice as a border. */
29400 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29403 /* Note: It is necessary to redraw both the left and the right
29404 borders, for when only this single window W is being
29406 if (!WINDOW_RIGHTMOST_P (w
)
29407 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29409 int x0
, x1
, y0
, y1
;
29411 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29414 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29417 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29420 if (!WINDOW_LEFTMOST_P (w
)
29421 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29423 int x0
, x1
, y0
, y1
;
29425 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29428 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29431 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29436 /* Draw window dividers for window W. */
29439 x_draw_right_divider (struct window
*w
)
29441 struct frame
*f
= WINDOW_XFRAME (w
);
29443 if (w
->mini
|| w
->pseudo_window_p
)
29445 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29447 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29448 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29449 int y0
= WINDOW_TOP_EDGE_Y (w
);
29450 /* The bottom divider prevails. */
29451 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29453 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29458 x_draw_bottom_divider (struct window
*w
)
29460 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29462 if (w
->mini
|| w
->pseudo_window_p
)
29464 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29466 int x0
= WINDOW_LEFT_EDGE_X (w
);
29467 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29468 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29469 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29471 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29475 /* Redraw the part of window W intersection rectangle FR. Pixel
29476 coordinates in FR are frame-relative. Call this function with
29477 input blocked. Value is non-zero if the exposure overwrites
29481 expose_window (struct window
*w
, XRectangle
*fr
)
29483 struct frame
*f
= XFRAME (w
->frame
);
29485 int mouse_face_overwritten_p
= 0;
29487 /* If window is not yet fully initialized, do nothing. This can
29488 happen when toolkit scroll bars are used and a window is split.
29489 Reconfiguring the scroll bar will generate an expose for a newly
29491 if (w
->current_matrix
== NULL
)
29494 /* When we're currently updating the window, display and current
29495 matrix usually don't agree. Arrange for a thorough display
29497 if (w
->must_be_updated_p
)
29499 SET_FRAME_GARBAGED (f
);
29503 /* Frame-relative pixel rectangle of W. */
29504 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29505 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29506 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29507 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29509 if (x_intersect_rectangles (fr
, &wr
, &r
))
29511 int yb
= window_text_bottom_y (w
);
29512 struct glyph_row
*row
;
29513 int cursor_cleared_p
, phys_cursor_on_p
;
29514 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29516 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29517 r
.x
, r
.y
, r
.width
, r
.height
));
29519 /* Convert to window coordinates. */
29520 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29521 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29523 /* Turn off the cursor. */
29524 if (!w
->pseudo_window_p
29525 && phys_cursor_in_rect_p (w
, &r
))
29527 x_clear_cursor (w
);
29528 cursor_cleared_p
= 1;
29531 cursor_cleared_p
= 0;
29533 /* If the row containing the cursor extends face to end of line,
29534 then expose_area might overwrite the cursor outside the
29535 rectangle and thus notice_overwritten_cursor might clear
29536 w->phys_cursor_on_p. We remember the original value and
29537 check later if it is changed. */
29538 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29540 /* Update lines intersecting rectangle R. */
29541 first_overlapping_row
= last_overlapping_row
= NULL
;
29542 for (row
= w
->current_matrix
->rows
;
29547 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29549 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29550 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29551 || (r
.y
>= y0
&& r
.y
< y1
)
29552 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29554 /* A header line may be overlapping, but there is no need
29555 to fix overlapping areas for them. KFS 2005-02-12 */
29556 if (row
->overlapping_p
&& !row
->mode_line_p
)
29558 if (first_overlapping_row
== NULL
)
29559 first_overlapping_row
= row
;
29560 last_overlapping_row
= row
;
29564 if (expose_line (w
, row
, &r
))
29565 mouse_face_overwritten_p
= 1;
29568 else if (row
->overlapping_p
)
29570 /* We must redraw a row overlapping the exposed area. */
29572 ? y0
+ row
->phys_height
> r
.y
29573 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29575 if (first_overlapping_row
== NULL
)
29576 first_overlapping_row
= row
;
29577 last_overlapping_row
= row
;
29585 /* Display the mode line if there is one. */
29586 if (WINDOW_WANTS_MODELINE_P (w
)
29587 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29589 && row
->y
< r
.y
+ r
.height
)
29591 if (expose_line (w
, row
, &r
))
29592 mouse_face_overwritten_p
= 1;
29595 if (!w
->pseudo_window_p
)
29597 /* Fix the display of overlapping rows. */
29598 if (first_overlapping_row
)
29599 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29602 /* Draw border between windows. */
29603 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29604 x_draw_right_divider (w
);
29606 x_draw_vertical_border (w
);
29608 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29609 x_draw_bottom_divider (w
);
29611 /* Turn the cursor on again. */
29612 if (cursor_cleared_p
29613 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29614 update_window_cursor (w
, 1);
29618 return mouse_face_overwritten_p
;
29623 /* Redraw (parts) of all windows in the window tree rooted at W that
29624 intersect R. R contains frame pixel coordinates. Value is
29625 non-zero if the exposure overwrites mouse-face. */
29628 expose_window_tree (struct window
*w
, XRectangle
*r
)
29630 struct frame
*f
= XFRAME (w
->frame
);
29631 int mouse_face_overwritten_p
= 0;
29633 while (w
&& !FRAME_GARBAGED_P (f
))
29635 if (WINDOWP (w
->contents
))
29636 mouse_face_overwritten_p
29637 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29639 mouse_face_overwritten_p
|= expose_window (w
, r
);
29641 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29644 return mouse_face_overwritten_p
;
29649 Redisplay an exposed area of frame F. X and Y are the upper-left
29650 corner of the exposed rectangle. W and H are width and height of
29651 the exposed area. All are pixel values. W or H zero means redraw
29652 the entire frame. */
29655 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29658 int mouse_face_overwritten_p
= 0;
29660 TRACE ((stderr
, "expose_frame "));
29662 /* No need to redraw if frame will be redrawn soon. */
29663 if (FRAME_GARBAGED_P (f
))
29665 TRACE ((stderr
, " garbaged\n"));
29669 /* If basic faces haven't been realized yet, there is no point in
29670 trying to redraw anything. This can happen when we get an expose
29671 event while Emacs is starting, e.g. by moving another window. */
29672 if (FRAME_FACE_CACHE (f
) == NULL
29673 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29675 TRACE ((stderr
, " no faces\n"));
29679 if (w
== 0 || h
== 0)
29682 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29683 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29693 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29694 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29696 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29697 if (WINDOWP (f
->tool_bar_window
))
29698 mouse_face_overwritten_p
29699 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29702 #ifdef HAVE_X_WINDOWS
29704 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29705 if (WINDOWP (f
->menu_bar_window
))
29706 mouse_face_overwritten_p
29707 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29708 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29712 /* Some window managers support a focus-follows-mouse style with
29713 delayed raising of frames. Imagine a partially obscured frame,
29714 and moving the mouse into partially obscured mouse-face on that
29715 frame. The visible part of the mouse-face will be highlighted,
29716 then the WM raises the obscured frame. With at least one WM, KDE
29717 2.1, Emacs is not getting any event for the raising of the frame
29718 (even tried with SubstructureRedirectMask), only Expose events.
29719 These expose events will draw text normally, i.e. not
29720 highlighted. Which means we must redo the highlight here.
29721 Subsume it under ``we love X''. --gerd 2001-08-15 */
29722 /* Included in Windows version because Windows most likely does not
29723 do the right thing if any third party tool offers
29724 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29725 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29727 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29728 if (f
== hlinfo
->mouse_face_mouse_frame
)
29730 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29731 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29732 clear_mouse_face (hlinfo
);
29733 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29740 Determine the intersection of two rectangles R1 and R2. Return
29741 the intersection in *RESULT. Value is non-zero if RESULT is not
29745 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29747 XRectangle
*left
, *right
;
29748 XRectangle
*upper
, *lower
;
29749 int intersection_p
= 0;
29751 /* Rearrange so that R1 is the left-most rectangle. */
29753 left
= r1
, right
= r2
;
29755 left
= r2
, right
= r1
;
29757 /* X0 of the intersection is right.x0, if this is inside R1,
29758 otherwise there is no intersection. */
29759 if (right
->x
<= left
->x
+ left
->width
)
29761 result
->x
= right
->x
;
29763 /* The right end of the intersection is the minimum of
29764 the right ends of left and right. */
29765 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29768 /* Same game for Y. */
29770 upper
= r1
, lower
= r2
;
29772 upper
= r2
, lower
= r1
;
29774 /* The upper end of the intersection is lower.y0, if this is inside
29775 of upper. Otherwise, there is no intersection. */
29776 if (lower
->y
<= upper
->y
+ upper
->height
)
29778 result
->y
= lower
->y
;
29780 /* The lower end of the intersection is the minimum of the lower
29781 ends of upper and lower. */
29782 result
->height
= (min (lower
->y
+ lower
->height
,
29783 upper
->y
+ upper
->height
)
29785 intersection_p
= 1;
29789 return intersection_p
;
29792 #endif /* HAVE_WINDOW_SYSTEM */
29795 /***********************************************************************
29797 ***********************************************************************/
29800 syms_of_xdisp (void)
29802 Vwith_echo_area_save_vector
= Qnil
;
29803 staticpro (&Vwith_echo_area_save_vector
);
29805 Vmessage_stack
= Qnil
;
29806 staticpro (&Vmessage_stack
);
29808 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29809 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29811 message_dolog_marker1
= Fmake_marker ();
29812 staticpro (&message_dolog_marker1
);
29813 message_dolog_marker2
= Fmake_marker ();
29814 staticpro (&message_dolog_marker2
);
29815 message_dolog_marker3
= Fmake_marker ();
29816 staticpro (&message_dolog_marker3
);
29819 defsubr (&Sdump_frame_glyph_matrix
);
29820 defsubr (&Sdump_glyph_matrix
);
29821 defsubr (&Sdump_glyph_row
);
29822 defsubr (&Sdump_tool_bar_row
);
29823 defsubr (&Strace_redisplay
);
29824 defsubr (&Strace_to_stderr
);
29826 #ifdef HAVE_WINDOW_SYSTEM
29827 defsubr (&Stool_bar_height
);
29828 defsubr (&Slookup_image_map
);
29830 defsubr (&Sline_pixel_height
);
29831 defsubr (&Sformat_mode_line
);
29832 defsubr (&Sinvisible_p
);
29833 defsubr (&Scurrent_bidi_paragraph_direction
);
29834 defsubr (&Swindow_text_pixel_size
);
29835 defsubr (&Smove_point_visually
);
29837 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29838 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29839 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29840 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29841 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29842 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29843 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29844 DEFSYM (Qeval
, "eval");
29845 DEFSYM (QCdata
, ":data");
29846 DEFSYM (Qdisplay
, "display");
29847 DEFSYM (Qspace_width
, "space-width");
29848 DEFSYM (Qraise
, "raise");
29849 DEFSYM (Qslice
, "slice");
29850 DEFSYM (Qspace
, "space");
29851 DEFSYM (Qmargin
, "margin");
29852 DEFSYM (Qpointer
, "pointer");
29853 DEFSYM (Qleft_margin
, "left-margin");
29854 DEFSYM (Qright_margin
, "right-margin");
29855 DEFSYM (Qcenter
, "center");
29856 DEFSYM (Qline_height
, "line-height");
29857 DEFSYM (QCalign_to
, ":align-to");
29858 DEFSYM (QCrelative_width
, ":relative-width");
29859 DEFSYM (QCrelative_height
, ":relative-height");
29860 DEFSYM (QCeval
, ":eval");
29861 DEFSYM (QCpropertize
, ":propertize");
29862 DEFSYM (QCfile
, ":file");
29863 DEFSYM (Qfontified
, "fontified");
29864 DEFSYM (Qfontification_functions
, "fontification-functions");
29865 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29866 DEFSYM (Qescape_glyph
, "escape-glyph");
29867 DEFSYM (Qnobreak_space
, "nobreak-space");
29868 DEFSYM (Qimage
, "image");
29869 DEFSYM (Qtext
, "text");
29870 DEFSYM (Qboth
, "both");
29871 DEFSYM (Qboth_horiz
, "both-horiz");
29872 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29873 DEFSYM (QCmap
, ":map");
29874 DEFSYM (QCpointer
, ":pointer");
29875 DEFSYM (Qrect
, "rect");
29876 DEFSYM (Qcircle
, "circle");
29877 DEFSYM (Qpoly
, "poly");
29878 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29879 DEFSYM (Qgrow_only
, "grow-only");
29880 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
29881 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
29882 DEFSYM (Qposition
, "position");
29883 DEFSYM (Qbuffer_position
, "buffer-position");
29884 DEFSYM (Qobject
, "object");
29885 DEFSYM (Qbar
, "bar");
29886 DEFSYM (Qhbar
, "hbar");
29887 DEFSYM (Qbox
, "box");
29888 DEFSYM (Qhollow
, "hollow");
29889 DEFSYM (Qhand
, "hand");
29890 DEFSYM (Qarrow
, "arrow");
29891 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
29893 list_of_error
= list1 (list2 (intern_c_string ("error"),
29894 intern_c_string ("void-variable")));
29895 staticpro (&list_of_error
);
29897 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
29898 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
29899 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
29900 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
29902 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
29903 staticpro (&echo_buffer
[0]);
29904 staticpro (&echo_buffer
[1]);
29906 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
29907 staticpro (&echo_area_buffer
[0]);
29908 staticpro (&echo_area_buffer
[1]);
29910 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
29911 staticpro (&Vmessages_buffer_name
);
29913 mode_line_proptrans_alist
= Qnil
;
29914 staticpro (&mode_line_proptrans_alist
);
29915 mode_line_string_list
= Qnil
;
29916 staticpro (&mode_line_string_list
);
29917 mode_line_string_face
= Qnil
;
29918 staticpro (&mode_line_string_face
);
29919 mode_line_string_face_prop
= Qnil
;
29920 staticpro (&mode_line_string_face_prop
);
29921 Vmode_line_unwind_vector
= Qnil
;
29922 staticpro (&Vmode_line_unwind_vector
);
29924 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
29926 help_echo_string
= Qnil
;
29927 staticpro (&help_echo_string
);
29928 help_echo_object
= Qnil
;
29929 staticpro (&help_echo_object
);
29930 help_echo_window
= Qnil
;
29931 staticpro (&help_echo_window
);
29932 previous_help_echo_string
= Qnil
;
29933 staticpro (&previous_help_echo_string
);
29934 help_echo_pos
= -1;
29936 DEFSYM (Qright_to_left
, "right-to-left");
29937 DEFSYM (Qleft_to_right
, "left-to-right");
29939 #ifdef HAVE_WINDOW_SYSTEM
29940 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
29941 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
29942 For example, if a block cursor is over a tab, it will be drawn as
29943 wide as that tab on the display. */);
29944 x_stretch_cursor_p
= 0;
29947 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
29948 doc
: /* Non-nil means highlight trailing whitespace.
29949 The face used for trailing whitespace is `trailing-whitespace'. */);
29950 Vshow_trailing_whitespace
= Qnil
;
29952 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
29953 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
29954 If the value is t, Emacs highlights non-ASCII chars which have the
29955 same appearance as an ASCII space or hyphen, using the `nobreak-space'
29956 or `escape-glyph' face respectively.
29958 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
29959 U+2011 (non-breaking hyphen) are affected.
29961 Any other non-nil value means to display these characters as a escape
29962 glyph followed by an ordinary space or hyphen.
29964 A value of nil means no special handling of these characters. */);
29965 Vnobreak_char_display
= Qt
;
29967 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
29968 doc
: /* The pointer shape to show in void text areas.
29969 A value of nil means to show the text pointer. Other options are `arrow',
29970 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
29971 Vvoid_text_area_pointer
= Qarrow
;
29973 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
29974 doc
: /* Non-nil means don't actually do any redisplay.
29975 This is used for internal purposes. */);
29976 Vinhibit_redisplay
= Qnil
;
29978 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
29979 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
29980 Vglobal_mode_string
= Qnil
;
29982 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
29983 doc
: /* Marker for where to display an arrow on top of the buffer text.
29984 This must be the beginning of a line in order to work.
29985 See also `overlay-arrow-string'. */);
29986 Voverlay_arrow_position
= Qnil
;
29988 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
29989 doc
: /* String to display as an arrow in non-window frames.
29990 See also `overlay-arrow-position'. */);
29991 Voverlay_arrow_string
= build_pure_c_string ("=>");
29993 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
29994 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
29995 The symbols on this list are examined during redisplay to determine
29996 where to display overlay arrows. */);
29997 Voverlay_arrow_variable_list
29998 = list1 (intern_c_string ("overlay-arrow-position"));
30000 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30001 doc
: /* The number of lines to try scrolling a window by when point moves out.
30002 If that fails to bring point back on frame, point is centered instead.
30003 If this is zero, point is always centered after it moves off frame.
30004 If you want scrolling to always be a line at a time, you should set
30005 `scroll-conservatively' to a large value rather than set this to 1. */);
30007 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30008 doc
: /* Scroll up to this many lines, to bring point back on screen.
30009 If point moves off-screen, redisplay will scroll by up to
30010 `scroll-conservatively' lines in order to bring point just barely
30011 onto the screen again. If that cannot be done, then redisplay
30012 recenters point as usual.
30014 If the value is greater than 100, redisplay will never recenter point,
30015 but will always scroll just enough text to bring point into view, even
30016 if you move far away.
30018 A value of zero means always recenter point if it moves off screen. */);
30019 scroll_conservatively
= 0;
30021 DEFVAR_INT ("scroll-margin", scroll_margin
,
30022 doc
: /* Number of lines of margin at the top and bottom of a window.
30023 Recenter the window whenever point gets within this many lines
30024 of the top or bottom of the window. */);
30027 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30028 doc
: /* Pixels per inch value for non-window system displays.
30029 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30030 Vdisplay_pixels_per_inch
= make_float (72.0);
30033 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30036 DEFVAR_LISP ("truncate-partial-width-windows",
30037 Vtruncate_partial_width_windows
,
30038 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30039 For an integer value, truncate lines in each window narrower than the
30040 full frame width, provided the window width is less than that integer;
30041 otherwise, respect the value of `truncate-lines'.
30043 For any other non-nil value, truncate lines in all windows that do
30044 not span the full frame width.
30046 A value of nil means to respect the value of `truncate-lines'.
30048 If `word-wrap' is enabled, you might want to reduce this. */);
30049 Vtruncate_partial_width_windows
= make_number (50);
30051 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30052 doc
: /* Maximum buffer size for which line number should be displayed.
30053 If the buffer is bigger than this, the line number does not appear
30054 in the mode line. A value of nil means no limit. */);
30055 Vline_number_display_limit
= Qnil
;
30057 DEFVAR_INT ("line-number-display-limit-width",
30058 line_number_display_limit_width
,
30059 doc
: /* Maximum line width (in characters) for line number display.
30060 If the average length of the lines near point is bigger than this, then the
30061 line number may be omitted from the mode line. */);
30062 line_number_display_limit_width
= 200;
30064 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30065 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30066 highlight_nonselected_windows
= 0;
30068 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30069 doc
: /* Non-nil if more than one frame is visible on this display.
30070 Minibuffer-only frames don't count, but iconified frames do.
30071 This variable is not guaranteed to be accurate except while processing
30072 `frame-title-format' and `icon-title-format'. */);
30074 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30075 doc
: /* Template for displaying the title bar of visible frames.
30076 \(Assuming the window manager supports this feature.)
30078 This variable has the same structure as `mode-line-format', except that
30079 the %c and %l constructs are ignored. It is used only on frames for
30080 which no explicit name has been set \(see `modify-frame-parameters'). */);
30082 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30083 doc
: /* Template for displaying the title bar of an iconified frame.
30084 \(Assuming the window manager supports this feature.)
30085 This variable has the same structure as `mode-line-format' (which see),
30086 and is used only on frames for which no explicit name has been set
30087 \(see `modify-frame-parameters'). */);
30089 = Vframe_title_format
30090 = listn (CONSTYPE_PURE
, 3,
30091 intern_c_string ("multiple-frames"),
30092 build_pure_c_string ("%b"),
30093 listn (CONSTYPE_PURE
, 4,
30094 empty_unibyte_string
,
30095 intern_c_string ("invocation-name"),
30096 build_pure_c_string ("@"),
30097 intern_c_string ("system-name")));
30099 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30100 doc
: /* Maximum number of lines to keep in the message log buffer.
30101 If nil, disable message logging. If t, log messages but don't truncate
30102 the buffer when it becomes large. */);
30103 Vmessage_log_max
= make_number (1000);
30105 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30106 doc
: /* Functions called before redisplay, if window sizes have changed.
30107 The value should be a list of functions that take one argument.
30108 Just before redisplay, for each frame, if any of its windows have changed
30109 size since the last redisplay, or have been split or deleted,
30110 all the functions in the list are called, with the frame as argument. */);
30111 Vwindow_size_change_functions
= Qnil
;
30113 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30114 doc
: /* List of functions to call before redisplaying a window with scrolling.
30115 Each function is called with two arguments, the window and its new
30116 display-start position. Note that these functions are also called by
30117 `set-window-buffer'. Also note that the value of `window-end' is not
30118 valid when these functions are called.
30120 Warning: Do not use this feature to alter the way the window
30121 is scrolled. It is not designed for that, and such use probably won't
30123 Vwindow_scroll_functions
= Qnil
;
30125 DEFVAR_LISP ("window-text-change-functions",
30126 Vwindow_text_change_functions
,
30127 doc
: /* Functions to call in redisplay when text in the window might change. */);
30128 Vwindow_text_change_functions
= Qnil
;
30130 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30131 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30132 Each function is called with two arguments, the window and the end trigger value.
30133 See `set-window-redisplay-end-trigger'. */);
30134 Vredisplay_end_trigger_functions
= Qnil
;
30136 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30137 doc
: /* Non-nil means autoselect window with mouse pointer.
30138 If nil, do not autoselect windows.
30139 A positive number means delay autoselection by that many seconds: a
30140 window is autoselected only after the mouse has remained in that
30141 window for the duration of the delay.
30142 A negative number has a similar effect, but causes windows to be
30143 autoselected only after the mouse has stopped moving. \(Because of
30144 the way Emacs compares mouse events, you will occasionally wait twice
30145 that time before the window gets selected.\)
30146 Any other value means to autoselect window instantaneously when the
30147 mouse pointer enters it.
30149 Autoselection selects the minibuffer only if it is active, and never
30150 unselects the minibuffer if it is active.
30152 When customizing this variable make sure that the actual value of
30153 `focus-follows-mouse' matches the behavior of your window manager. */);
30154 Vmouse_autoselect_window
= Qnil
;
30156 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30157 doc
: /* Non-nil means automatically resize tool-bars.
30158 This dynamically changes the tool-bar's height to the minimum height
30159 that is needed to make all tool-bar items visible.
30160 If value is `grow-only', the tool-bar's height is only increased
30161 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30162 Vauto_resize_tool_bars
= Qt
;
30164 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30165 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30166 auto_raise_tool_bar_buttons_p
= 1;
30168 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30169 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30170 make_cursor_line_fully_visible_p
= 1;
30172 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30173 doc
: /* Border below tool-bar in pixels.
30174 If an integer, use it as the height of the border.
30175 If it is one of `internal-border-width' or `border-width', use the
30176 value of the corresponding frame parameter.
30177 Otherwise, no border is added below the tool-bar. */);
30178 Vtool_bar_border
= Qinternal_border_width
;
30180 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30181 doc
: /* Margin around tool-bar buttons in pixels.
30182 If an integer, use that for both horizontal and vertical margins.
30183 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30184 HORZ specifying the horizontal margin, and VERT specifying the
30185 vertical margin. */);
30186 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30188 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30189 doc
: /* Relief thickness of tool-bar buttons. */);
30190 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30192 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30193 doc
: /* Tool bar style to use.
30195 image - show images only
30196 text - show text only
30197 both - show both, text below image
30198 both-horiz - show text to the right of the image
30199 text-image-horiz - show text to the left of the image
30200 any other - use system default or image if no system default.
30202 This variable only affects the GTK+ toolkit version of Emacs. */);
30203 Vtool_bar_style
= Qnil
;
30205 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30206 doc
: /* Maximum number of characters a label can have to be shown.
30207 The tool bar style must also show labels for this to have any effect, see
30208 `tool-bar-style'. */);
30209 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30211 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30212 doc
: /* List of functions to call to fontify regions of text.
30213 Each function is called with one argument POS. Functions must
30214 fontify a region starting at POS in the current buffer, and give
30215 fontified regions the property `fontified'. */);
30216 Vfontification_functions
= Qnil
;
30217 Fmake_variable_buffer_local (Qfontification_functions
);
30219 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30220 unibyte_display_via_language_environment
,
30221 doc
: /* Non-nil means display unibyte text according to language environment.
30222 Specifically, this means that raw bytes in the range 160-255 decimal
30223 are displayed by converting them to the equivalent multibyte characters
30224 according to the current language environment. As a result, they are
30225 displayed according to the current fontset.
30227 Note that this variable affects only how these bytes are displayed,
30228 but does not change the fact they are interpreted as raw bytes. */);
30229 unibyte_display_via_language_environment
= 0;
30231 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30232 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30233 If a float, it specifies a fraction of the mini-window frame's height.
30234 If an integer, it specifies a number of lines. */);
30235 Vmax_mini_window_height
= make_float (0.25);
30237 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30238 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30239 A value of nil means don't automatically resize mini-windows.
30240 A value of t means resize them to fit the text displayed in them.
30241 A value of `grow-only', the default, means let mini-windows grow only;
30242 they return to their normal size when the minibuffer is closed, or the
30243 echo area becomes empty. */);
30244 Vresize_mini_windows
= Qgrow_only
;
30246 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30247 doc
: /* Alist specifying how to blink the cursor off.
30248 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30249 `cursor-type' frame-parameter or variable equals ON-STATE,
30250 comparing using `equal', Emacs uses OFF-STATE to specify
30251 how to blink it off. ON-STATE and OFF-STATE are values for
30252 the `cursor-type' frame parameter.
30254 If a frame's ON-STATE has no entry in this list,
30255 the frame's other specifications determine how to blink the cursor off. */);
30256 Vblink_cursor_alist
= Qnil
;
30258 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30259 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30260 If non-nil, windows are automatically scrolled horizontally to make
30261 point visible. */);
30262 automatic_hscrolling_p
= 1;
30263 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30265 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30266 doc
: /* How many columns away from the window edge point is allowed to get
30267 before automatic hscrolling will horizontally scroll the window. */);
30268 hscroll_margin
= 5;
30270 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30271 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30272 When point is less than `hscroll-margin' columns from the window
30273 edge, automatic hscrolling will scroll the window by the amount of columns
30274 determined by this variable. If its value is a positive integer, scroll that
30275 many columns. If it's a positive floating-point number, it specifies the
30276 fraction of the window's width to scroll. If it's nil or zero, point will be
30277 centered horizontally after the scroll. Any other value, including negative
30278 numbers, are treated as if the value were zero.
30280 Automatic hscrolling always moves point outside the scroll margin, so if
30281 point was more than scroll step columns inside the margin, the window will
30282 scroll more than the value given by the scroll step.
30284 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30285 and `scroll-right' overrides this variable's effect. */);
30286 Vhscroll_step
= make_number (0);
30288 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30289 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30290 Bind this around calls to `message' to let it take effect. */);
30291 message_truncate_lines
= 0;
30293 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30294 doc
: /* Normal hook run to update the menu bar definitions.
30295 Redisplay runs this hook before it redisplays the menu bar.
30296 This is used to update menus such as Buffers, whose contents depend on
30298 Vmenu_bar_update_hook
= Qnil
;
30300 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30301 doc
: /* Frame for which we are updating a menu.
30302 The enable predicate for a menu binding should check this variable. */);
30303 Vmenu_updating_frame
= Qnil
;
30305 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30306 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30307 inhibit_menubar_update
= 0;
30309 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30310 doc
: /* Prefix prepended to all continuation lines at display time.
30311 The value may be a string, an image, or a stretch-glyph; it is
30312 interpreted in the same way as the value of a `display' text property.
30314 This variable is overridden by any `wrap-prefix' text or overlay
30317 To add a prefix to non-continuation lines, use `line-prefix'. */);
30318 Vwrap_prefix
= Qnil
;
30319 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30320 Fmake_variable_buffer_local (Qwrap_prefix
);
30322 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30323 doc
: /* Prefix prepended to all non-continuation lines at display time.
30324 The value may be a string, an image, or a stretch-glyph; it is
30325 interpreted in the same way as the value of a `display' text property.
30327 This variable is overridden by any `line-prefix' text or overlay
30330 To add a prefix to continuation lines, use `wrap-prefix'. */);
30331 Vline_prefix
= Qnil
;
30332 DEFSYM (Qline_prefix
, "line-prefix");
30333 Fmake_variable_buffer_local (Qline_prefix
);
30335 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30336 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30337 inhibit_eval_during_redisplay
= 0;
30339 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30340 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30341 inhibit_free_realized_faces
= 0;
30344 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30345 doc
: /* Inhibit try_window_id display optimization. */);
30346 inhibit_try_window_id
= 0;
30348 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30349 doc
: /* Inhibit try_window_reusing display optimization. */);
30350 inhibit_try_window_reusing
= 0;
30352 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30353 doc
: /* Inhibit try_cursor_movement display optimization. */);
30354 inhibit_try_cursor_movement
= 0;
30355 #endif /* GLYPH_DEBUG */
30357 DEFVAR_INT ("overline-margin", overline_margin
,
30358 doc
: /* Space between overline and text, in pixels.
30359 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30360 margin to the character height. */);
30361 overline_margin
= 2;
30363 DEFVAR_INT ("underline-minimum-offset",
30364 underline_minimum_offset
,
30365 doc
: /* Minimum distance between baseline and underline.
30366 This can improve legibility of underlined text at small font sizes,
30367 particularly when using variable `x-use-underline-position-properties'
30368 with fonts that specify an UNDERLINE_POSITION relatively close to the
30369 baseline. The default value is 1. */);
30370 underline_minimum_offset
= 1;
30372 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30373 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30374 This feature only works when on a window system that can change
30375 cursor shapes. */);
30376 display_hourglass_p
= 1;
30378 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30379 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30380 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30382 #ifdef HAVE_WINDOW_SYSTEM
30383 hourglass_atimer
= NULL
;
30384 hourglass_shown_p
= 0;
30385 #endif /* HAVE_WINDOW_SYSTEM */
30387 DEFSYM (Qglyphless_char
, "glyphless-char");
30388 DEFSYM (Qhex_code
, "hex-code");
30389 DEFSYM (Qempty_box
, "empty-box");
30390 DEFSYM (Qthin_space
, "thin-space");
30391 DEFSYM (Qzero_width
, "zero-width");
30393 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30394 doc
: /* Function run just before redisplay.
30395 It is called with one argument, which is the set of windows that are to
30396 be redisplayed. This set can be nil (meaning, only the selected window),
30397 or t (meaning all windows). */);
30398 Vpre_redisplay_function
= intern ("ignore");
30400 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30401 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30403 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30404 doc
: /* Char-table defining glyphless characters.
30405 Each element, if non-nil, should be one of the following:
30406 an ASCII acronym string: display this string in a box
30407 `hex-code': display the hexadecimal code of a character in a box
30408 `empty-box': display as an empty box
30409 `thin-space': display as 1-pixel width space
30410 `zero-width': don't display
30411 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30412 display method for graphical terminals and text terminals respectively.
30413 GRAPHICAL and TEXT should each have one of the values listed above.
30415 The char-table has one extra slot to control the display of a character for
30416 which no font is found. This slot only takes effect on graphical terminals.
30417 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30418 `thin-space'. The default is `empty-box'.
30420 If a character has a non-nil entry in an active display table, the
30421 display table takes effect; in this case, Emacs does not consult
30422 `glyphless-char-display' at all. */);
30423 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30424 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30427 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30428 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30429 Vdebug_on_message
= Qnil
;
30431 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30433 Vredisplay__all_windows_cause
30434 = Fmake_vector (make_number (100), make_number (0));
30436 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30438 Vredisplay__mode_lines_cause
30439 = Fmake_vector (make_number (100), make_number (0));
30443 /* Initialize this module when Emacs starts. */
30448 CHARPOS (this_line_start_pos
) = 0;
30450 if (!noninteractive
)
30452 struct window
*m
= XWINDOW (minibuf_window
);
30453 Lisp_Object frame
= m
->frame
;
30454 struct frame
*f
= XFRAME (frame
);
30455 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30456 struct window
*r
= XWINDOW (root
);
30459 echo_area_window
= minibuf_window
;
30461 r
->top_line
= FRAME_TOP_MARGIN (f
);
30462 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30463 r
->total_cols
= FRAME_COLS (f
);
30464 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30465 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30466 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30468 m
->top_line
= FRAME_LINES (f
) - 1;
30469 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30470 m
->total_cols
= FRAME_COLS (f
);
30471 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30472 m
->total_lines
= 1;
30473 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30475 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30476 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30477 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30479 /* The default ellipsis glyphs `...'. */
30480 for (i
= 0; i
< 3; ++i
)
30481 default_invis_vector
[i
] = make_number ('.');
30485 /* Allocate the buffer for frame titles.
30486 Also used for `format-mode-line'. */
30488 mode_line_noprop_buf
= xmalloc (size
);
30489 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30490 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30491 mode_line_target
= MODE_LINE_DISPLAY
;
30494 help_echo_showing_p
= 0;
30497 #ifdef HAVE_WINDOW_SYSTEM
30499 /* Platform-independent portion of hourglass implementation. */
30501 /* Cancel a currently active hourglass timer, and start a new one. */
30503 start_hourglass (void)
30505 struct timespec delay
;
30507 cancel_hourglass ();
30509 if (INTEGERP (Vhourglass_delay
)
30510 && XINT (Vhourglass_delay
) > 0)
30511 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30512 TYPE_MAXIMUM (time_t)),
30514 else if (FLOATP (Vhourglass_delay
)
30515 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30516 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30518 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30522 extern void w32_note_current_window (void);
30523 w32_note_current_window ();
30525 #endif /* HAVE_NTGUI */
30527 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30528 show_hourglass
, NULL
);
30532 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30535 cancel_hourglass (void)
30537 if (hourglass_atimer
)
30539 cancel_atimer (hourglass_atimer
);
30540 hourglass_atimer
= NULL
;
30543 if (hourglass_shown_p
)
30547 #endif /* HAVE_WINDOW_SYSTEM */