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. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
328 Lisp_Object Qwindow_scroll_functions
;
329 static Lisp_Object Qwindow_text_change_functions
;
330 static Lisp_Object Qredisplay_end_trigger_functions
;
331 Lisp_Object Qinhibit_point_motion_hooks
;
332 static Lisp_Object QCeval
, QCpropertize
;
333 Lisp_Object QCfile
, QCdata
;
334 static Lisp_Object Qfontified
;
335 static Lisp_Object Qgrow_only
;
336 static Lisp_Object Qinhibit_eval_during_redisplay
;
337 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
338 static Lisp_Object Qright_to_left
, Qleft_to_right
;
341 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
343 /* Pointer shapes. */
344 static Lisp_Object Qarrow
, Qhand
;
347 /* Holds the list (error). */
348 static Lisp_Object list_of_error
;
350 static Lisp_Object Qfontification_functions
;
352 static Lisp_Object Qwrap_prefix
;
353 static Lisp_Object Qline_prefix
;
354 static Lisp_Object Qredisplay_internal
;
356 /* Non-nil means don't actually do any redisplay. */
358 Lisp_Object Qinhibit_redisplay
;
360 /* Names of text properties relevant for redisplay. */
362 Lisp_Object Qdisplay
;
364 Lisp_Object Qspace
, QCalign_to
;
365 static Lisp_Object QCrelative_width
, QCrelative_height
;
366 Lisp_Object Qleft_margin
, Qright_margin
;
367 static Lisp_Object Qspace_width
, Qraise
;
368 static Lisp_Object Qslice
;
370 static Lisp_Object Qmargin
, Qpointer
;
371 static Lisp_Object Qline_height
;
373 #ifdef HAVE_WINDOW_SYSTEM
375 /* Test if overflow newline into fringe. Called with iterator IT
376 at or past right window margin, and with IT->current_x set. */
378 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
379 (!NILP (Voverflow_newline_into_fringe) \
380 && FRAME_WINDOW_P ((IT)->f) \
381 && ((IT)->bidi_it.paragraph_dir == R2L \
382 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
383 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
384 && (IT)->current_x == (IT)->last_visible_x)
386 #else /* !HAVE_WINDOW_SYSTEM */
387 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
388 #endif /* HAVE_WINDOW_SYSTEM */
390 /* Test if the display element loaded in IT, or the underlying buffer
391 or string character, is a space or a TAB character. This is used
392 to determine where word wrapping can occur. */
394 #define IT_DISPLAYING_WHITESPACE(it) \
395 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
396 || ((STRINGP (it->string) \
397 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
398 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
400 && (it->s[IT_BYTEPOS (*it)] == ' ' \
401 || it->s[IT_BYTEPOS (*it)] == '\t')) \
402 || (IT_BYTEPOS (*it) < ZV_BYTE \
403 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
404 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
406 /* Name of the face used to highlight trailing whitespace. */
408 static Lisp_Object Qtrailing_whitespace
;
410 /* Name and number of the face used to highlight escape glyphs. */
412 static Lisp_Object Qescape_glyph
;
414 /* Name and number of the face used to highlight non-breaking spaces. */
416 static Lisp_Object Qnobreak_space
;
418 /* The symbol `image' which is the car of the lists used to represent
419 images in Lisp. Also a tool bar style. */
423 /* The image map types. */
425 static Lisp_Object QCpointer
;
426 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
428 /* Tool bar styles */
429 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
431 /* Non-zero means print newline to stdout before next mini-buffer
434 bool noninteractive_need_newline
;
436 /* Non-zero means print newline to message log before next message. */
438 static bool message_log_need_newline
;
440 /* Three markers that message_dolog uses.
441 It could allocate them itself, but that causes trouble
442 in handling memory-full errors. */
443 static Lisp_Object message_dolog_marker1
;
444 static Lisp_Object message_dolog_marker2
;
445 static Lisp_Object message_dolog_marker3
;
447 /* The buffer position of the first character appearing entirely or
448 partially on the line of the selected window which contains the
449 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
450 redisplay optimization in redisplay_internal. */
452 static struct text_pos this_line_start_pos
;
454 /* Number of characters past the end of the line above, including the
455 terminating newline. */
457 static struct text_pos this_line_end_pos
;
459 /* The vertical positions and the height of this line. */
461 static int this_line_vpos
;
462 static int this_line_y
;
463 static int this_line_pixel_height
;
465 /* X position at which this display line starts. Usually zero;
466 negative if first character is partially visible. */
468 static int this_line_start_x
;
470 /* The smallest character position seen by move_it_* functions as they
471 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
472 hscrolled lines, see display_line. */
474 static struct text_pos this_line_min_pos
;
476 /* Buffer that this_line_.* variables are referring to. */
478 static struct buffer
*this_line_buffer
;
481 /* Values of those variables at last redisplay are stored as
482 properties on `overlay-arrow-position' symbol. However, if
483 Voverlay_arrow_position is a marker, last-arrow-position is its
484 numerical position. */
486 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
488 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
489 properties on a symbol in overlay-arrow-variable-list. */
491 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
493 Lisp_Object Qmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static bool overlay_arrow_seen
;
499 /* Vector containing glyphs for an ellipsis `...'. */
501 static Lisp_Object default_invis_vector
[3];
503 /* This is the window where the echo area message was displayed. It
504 is always a mini-buffer window, but it may not be the same window
505 currently active as a mini-buffer. */
507 Lisp_Object echo_area_window
;
509 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
510 pushes the current message and the value of
511 message_enable_multibyte on the stack, the function restore_message
512 pops the stack and displays MESSAGE again. */
514 static Lisp_Object Vmessage_stack
;
516 /* Nonzero means multibyte characters were enabled when the echo area
517 message was specified. */
519 static bool message_enable_multibyte
;
521 /* Nonzero if we should redraw the mode lines on the next redisplay.
522 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
523 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
524 (the number used is then only used to track down the cause for this
527 int update_mode_lines
;
529 /* Nonzero if window sizes or contents other than selected-window have changed
530 since last redisplay that finished.
531 If it has value REDISPLAY_SOME, then only redisplay the windows where
532 the `redisplay' bit has been set. Otherwise, redisplay all windows
533 (the number used is then only used to track down the cause for this
536 int windows_or_buffers_changed
;
538 /* Nonzero after display_mode_line if %l was used and it displayed a
541 static bool line_number_displayed
;
543 /* The name of the *Messages* buffer, a string. */
545 static Lisp_Object Vmessages_buffer_name
;
547 /* Current, index 0, and last displayed echo area message. Either
548 buffers from echo_buffers, or nil to indicate no message. */
550 Lisp_Object echo_area_buffer
[2];
552 /* The buffers referenced from echo_area_buffer. */
554 static Lisp_Object echo_buffer
[2];
556 /* A vector saved used in with_area_buffer to reduce consing. */
558 static Lisp_Object Vwith_echo_area_save_vector
;
560 /* Non-zero means display_echo_area should display the last echo area
561 message again. Set by redisplay_preserve_echo_area. */
563 static bool display_last_displayed_message_p
;
565 /* Nonzero if echo area is being used by print; zero if being used by
568 static bool message_buf_print
;
570 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
572 static Lisp_Object Qinhibit_menubar_update
;
573 static Lisp_Object Qmessage_truncate_lines
;
575 /* Set to 1 in clear_message to make redisplay_internal aware
576 of an emptied echo area. */
578 static bool message_cleared_p
;
580 /* A scratch glyph row with contents used for generating truncation
581 glyphs. Also used in direct_output_for_insert. */
583 #define MAX_SCRATCH_GLYPHS 100
584 static struct glyph_row scratch_glyph_row
;
585 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
587 /* Ascent and height of the last line processed by move_it_to. */
589 static int last_height
;
591 /* Non-zero if there's a help-echo in the echo area. */
593 bool help_echo_showing_p
;
595 /* The maximum distance to look ahead for text properties. Values
596 that are too small let us call compute_char_face and similar
597 functions too often which is expensive. Values that are too large
598 let us call compute_char_face and alike too often because we
599 might not be interested in text properties that far away. */
601 #define TEXT_PROP_DISTANCE_LIMIT 100
603 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
604 iterator state and later restore it. This is needed because the
605 bidi iterator on bidi.c keeps a stacked cache of its states, which
606 is really a singleton. When we use scratch iterator objects to
607 move around the buffer, we can cause the bidi cache to be pushed or
608 popped, and therefore we need to restore the cache state when we
609 return to the original iterator. */
610 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
613 bidi_unshelve_cache (CACHE, 1); \
615 CACHE = bidi_shelve_cache (); \
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
626 /* Functions to mark elements as needing redisplay. */
627 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
630 redisplay_other_windows (void)
632 if (!windows_or_buffers_changed
)
633 windows_or_buffers_changed
= REDISPLAY_SOME
;
637 wset_redisplay (struct window
*w
)
639 /* Beware: selected_window can be nil during early stages. */
640 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
641 redisplay_other_windows ();
646 fset_redisplay (struct frame
*f
)
648 redisplay_other_windows ();
653 bset_redisplay (struct buffer
*b
)
655 int count
= buffer_window_count (b
);
658 /* ... it's visible in other window than selected, */
659 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
660 redisplay_other_windows ();
661 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
662 so that if we later set windows_or_buffers_changed, this buffer will
664 b
->text
->redisplay
= true;
669 bset_update_mode_line (struct buffer
*b
)
671 if (!update_mode_lines
)
672 update_mode_lines
= REDISPLAY_SOME
;
673 b
->text
->redisplay
= true;
678 /* Non-zero means print traces of redisplay if compiled with
679 GLYPH_DEBUG defined. */
681 bool trace_redisplay_p
;
683 #endif /* GLYPH_DEBUG */
685 #ifdef DEBUG_TRACE_MOVE
686 /* Non-zero means trace with TRACE_MOVE to stderr. */
689 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
691 #define TRACE_MOVE(x) (void) 0
694 static Lisp_Object Qauto_hscroll_mode
;
696 /* Buffer being redisplayed -- for redisplay_window_error. */
698 static struct buffer
*displayed_buffer
;
700 /* Value returned from text property handlers (see below). */
705 HANDLED_RECOMPUTE_PROPS
,
706 HANDLED_OVERLAY_STRING_CONSUMED
,
710 /* A description of text properties that redisplay is interested
715 /* The name of the property. */
718 /* A unique index for the property. */
721 /* A handler function called to set up iterator IT from the property
722 at IT's current position. Value is used to steer handle_stop. */
723 enum prop_handled (*handler
) (struct it
*it
);
726 static enum prop_handled
handle_face_prop (struct it
*);
727 static enum prop_handled
handle_invisible_prop (struct it
*);
728 static enum prop_handled
handle_display_prop (struct it
*);
729 static enum prop_handled
handle_composition_prop (struct it
*);
730 static enum prop_handled
handle_overlay_change (struct it
*);
731 static enum prop_handled
handle_fontified_prop (struct it
*);
733 /* Properties handled by iterators. */
735 static struct props it_props
[] =
737 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
738 /* Handle `face' before `display' because some sub-properties of
739 `display' need to know the face. */
740 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
741 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
742 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
743 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
747 /* Value is the position described by X. If X is a marker, value is
748 the marker_position of X. Otherwise, value is X. */
750 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
752 /* Enumeration returned by some move_it_.* functions internally. */
756 /* Not used. Undefined value. */
759 /* Move ended at the requested buffer position or ZV. */
760 MOVE_POS_MATCH_OR_ZV
,
762 /* Move ended at the requested X pixel position. */
765 /* Move within a line ended at the end of a line that must be
769 /* Move within a line ended at the end of a line that would
770 be displayed truncated. */
773 /* Move within a line ended at a line end. */
777 /* This counter is used to clear the face cache every once in a while
778 in redisplay_internal. It is incremented for each redisplay.
779 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
782 #define CLEAR_FACE_CACHE_COUNT 500
783 static int clear_face_cache_count
;
785 /* Similarly for the image cache. */
787 #ifdef HAVE_WINDOW_SYSTEM
788 #define CLEAR_IMAGE_CACHE_COUNT 101
789 static int clear_image_cache_count
;
791 /* Null glyph slice */
792 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
795 /* True while redisplay_internal is in progress. */
799 static Lisp_Object Qinhibit_free_realized_faces
;
800 static Lisp_Object Qmode_line_default_help_echo
;
802 /* If a string, XTread_socket generates an event to display that string.
803 (The display is done in read_char.) */
805 Lisp_Object help_echo_string
;
806 Lisp_Object help_echo_window
;
807 Lisp_Object help_echo_object
;
808 ptrdiff_t help_echo_pos
;
810 /* Temporary variable for XTread_socket. */
812 Lisp_Object previous_help_echo_string
;
814 /* Platform-independent portion of hourglass implementation. */
816 #ifdef HAVE_WINDOW_SYSTEM
818 /* Non-zero means an hourglass cursor is currently shown. */
819 static bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 static struct atimer
*hourglass_atimer
;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char
;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display
;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
836 /* Default number of seconds to wait before displaying an hourglass
838 #define DEFAULT_HOURGLASS_DELAY 1
840 #ifdef HAVE_WINDOW_SYSTEM
842 /* Default pixel width of `thin-space' display method. */
843 #define THIN_SPACE_WIDTH 1
845 #endif /* HAVE_WINDOW_SYSTEM */
847 /* Function prototypes. */
849 static void setup_for_ellipsis (struct it
*, int);
850 static void set_iterator_to_next (struct it
*, int);
851 static void mark_window_display_accurate_1 (struct window
*, int);
852 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
853 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
854 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
855 static int cursor_row_p (struct glyph_row
*);
856 static int redisplay_mode_lines (Lisp_Object
, bool);
857 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
859 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
861 static void handle_line_prefix (struct it
*);
863 static void pint2str (char *, int, ptrdiff_t);
864 static void pint2hrstr (char *, int, ptrdiff_t);
865 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
867 static int text_outside_line_unchanged_p (struct window
*,
868 ptrdiff_t, ptrdiff_t);
869 static void store_mode_line_noprop_char (char);
870 static int store_mode_line_noprop (const char *, int, int);
871 static void handle_stop (struct it
*);
872 static void handle_stop_backwards (struct it
*, ptrdiff_t);
873 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874 static void ensure_echo_area_buffers (void);
875 static void unwind_with_echo_area_buffer (Lisp_Object
);
876 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
877 static int with_echo_area_buffer (struct window
*, int,
878 int (*) (ptrdiff_t, Lisp_Object
),
879 ptrdiff_t, Lisp_Object
);
880 static void clear_garbaged_frames (void);
881 static int current_message_1 (ptrdiff_t, Lisp_Object
);
882 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
883 static void set_message (Lisp_Object
);
884 static int set_message_1 (ptrdiff_t, Lisp_Object
);
885 static int display_echo_area (struct window
*);
886 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
887 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
888 static void unwind_redisplay (void);
889 static int string_char_and_length (const unsigned char *, int *);
890 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
892 static int compute_window_start_on_continuation_line (struct window
*);
893 static void insert_left_trunc_glyphs (struct it
*);
894 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
896 static void extend_face_to_end_of_line (struct it
*);
897 static int append_space_for_newline (struct it
*, int);
898 static int cursor_row_fully_visible_p (struct window
*, int, int);
899 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
900 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
901 static int trailing_whitespace_p (ptrdiff_t);
902 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903 static void push_it (struct it
*, struct text_pos
*);
904 static void iterate_out_of_display_property (struct it
*);
905 static void pop_it (struct it
*);
906 static void sync_frame_with_window_matrix_rows (struct window
*);
907 static void redisplay_internal (void);
908 static int echo_area_display (int);
909 static void redisplay_windows (Lisp_Object
);
910 static void redisplay_window (Lisp_Object
, bool);
911 static Lisp_Object
redisplay_window_error (Lisp_Object
);
912 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
913 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
914 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
915 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
917 static int update_menu_bar (struct frame
*, int, int);
918 static int try_window_reusing_current_matrix (struct window
*);
919 static int try_window_id (struct window
*);
920 static int display_line (struct it
*);
921 static int display_mode_lines (struct window
*);
922 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
923 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
924 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
925 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
926 static void display_menu_bar (struct window
*);
927 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
929 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
930 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
931 static void compute_line_metrics (struct it
*);
932 static void run_redisplay_end_trigger_hook (struct it
*);
933 static int get_overlay_strings (struct it
*, ptrdiff_t);
934 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
935 static void next_overlay_string (struct it
*);
936 static void reseat (struct it
*, struct text_pos
, int);
937 static void reseat_1 (struct it
*, struct text_pos
, int);
938 static void back_to_previous_visible_line_start (struct it
*);
939 static void reseat_at_next_visible_line_start (struct it
*, int);
940 static int next_element_from_ellipsis (struct it
*);
941 static int next_element_from_display_vector (struct it
*);
942 static int next_element_from_string (struct it
*);
943 static int next_element_from_c_string (struct it
*);
944 static int next_element_from_buffer (struct it
*);
945 static int next_element_from_composition (struct it
*);
946 static int next_element_from_image (struct it
*);
947 static int next_element_from_stretch (struct it
*);
948 static void load_overlay_strings (struct it
*, ptrdiff_t);
949 static int init_from_display_pos (struct it
*, struct window
*,
950 struct display_pos
*);
951 static void reseat_to_string (struct it
*, const char *,
952 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
953 static int get_next_display_element (struct it
*);
954 static enum move_it_result
955 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
956 enum move_operation_enum
);
957 static void get_visually_first_element (struct it
*);
958 static void init_to_row_start (struct it
*, struct window
*,
960 static int init_to_row_end (struct it
*, struct window
*,
962 static void back_to_previous_line_start (struct it
*);
963 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
964 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
965 Lisp_Object
, ptrdiff_t);
966 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
967 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
968 static ptrdiff_t number_of_chars (const char *, bool);
969 static void compute_stop_pos (struct it
*);
970 static void compute_string_pos (struct text_pos
*, struct text_pos
,
972 static int face_before_or_after_it_pos (struct it
*, int);
973 static ptrdiff_t next_overlay_change (ptrdiff_t);
974 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
975 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
976 static int handle_single_display_spec (struct it
*, Lisp_Object
,
977 Lisp_Object
, Lisp_Object
,
978 struct text_pos
*, ptrdiff_t, int, int);
979 static int underlying_face_id (struct it
*);
980 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
983 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
984 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
986 #ifdef HAVE_WINDOW_SYSTEM
988 static void x_consider_frame_title (Lisp_Object
);
989 static void update_tool_bar (struct frame
*, int);
990 static int redisplay_tool_bar (struct frame
*);
991 static void x_draw_bottom_divider (struct window
*w
);
992 static void notice_overwritten_cursor (struct window
*,
995 static void append_stretch_glyph (struct it
*, Lisp_Object
,
999 #endif /* HAVE_WINDOW_SYSTEM */
1001 static void produce_special_glyphs (struct it
*, enum display_element_type
);
1002 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
1003 static bool coords_in_mouse_face_p (struct window
*, int, int);
1007 /***********************************************************************
1008 Window display dimensions
1009 ***********************************************************************/
1011 /* Return the bottom boundary y-position for text lines in window W.
1012 This is the first y position at which a line cannot start.
1013 It is relative to the top of the window.
1015 This is the height of W minus the height of a mode line, if any. */
1018 window_text_bottom_y (struct window
*w
)
1020 int height
= WINDOW_PIXEL_HEIGHT (w
);
1022 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1025 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1027 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1032 /* Return the pixel width of display area AREA of window W.
1033 ANY_AREA means return the total width of W, not including
1034 fringes to the left and right of the window. */
1037 window_box_width (struct window
*w
, enum glyph_row_area area
)
1039 int width
= w
->pixel_width
;
1041 if (!w
->pseudo_window_p
)
1043 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1044 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1046 if (area
== TEXT_AREA
)
1047 width
-= (WINDOW_MARGINS_WIDTH (w
)
1048 + WINDOW_FRINGES_WIDTH (w
));
1049 else if (area
== LEFT_MARGIN_AREA
)
1050 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1051 else if (area
== RIGHT_MARGIN_AREA
)
1052 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1055 /* With wide margins, fringes, etc. we might end up with a negative
1056 width, correct that here. */
1057 return max (0, width
);
1061 /* Return the pixel height of the display area of window W, not
1062 including mode lines of W, if any. */
1065 window_box_height (struct window
*w
)
1067 struct frame
*f
= XFRAME (w
->frame
);
1068 int height
= WINDOW_PIXEL_HEIGHT (w
);
1070 eassert (height
>= 0);
1072 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1073 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1075 /* Note: the code below that determines the mode-line/header-line
1076 height is essentially the same as that contained in the macro
1077 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1078 the appropriate glyph row has its `mode_line_p' flag set,
1079 and if it doesn't, uses estimate_mode_line_height instead. */
1081 if (WINDOW_WANTS_MODELINE_P (w
))
1083 struct glyph_row
*ml_row
1084 = (w
->current_matrix
&& w
->current_matrix
->rows
1085 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1087 if (ml_row
&& ml_row
->mode_line_p
)
1088 height
-= ml_row
->height
;
1090 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1093 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1095 struct glyph_row
*hl_row
1096 = (w
->current_matrix
&& w
->current_matrix
->rows
1097 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1099 if (hl_row
&& hl_row
->mode_line_p
)
1100 height
-= hl_row
->height
;
1102 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1105 /* With a very small font and a mode-line that's taller than
1106 default, we might end up with a negative height. */
1107 return max (0, height
);
1110 /* Return the window-relative coordinate of the left edge of display
1111 area AREA of window W. ANY_AREA means return the left edge of the
1112 whole window, to the right of the left fringe of W. */
1115 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1119 if (w
->pseudo_window_p
)
1122 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1124 if (area
== TEXT_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
));
1127 else if (area
== RIGHT_MARGIN_AREA
)
1128 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1129 + window_box_width (w
, LEFT_MARGIN_AREA
)
1130 + window_box_width (w
, TEXT_AREA
)
1131 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1133 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1134 else if (area
== LEFT_MARGIN_AREA
1135 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1136 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1138 /* Don't return more than the window's pixel width. */
1139 return min (x
, w
->pixel_width
);
1143 /* Return the window-relative coordinate of the right edge of display
1144 area AREA of window W. ANY_AREA means return the right edge of the
1145 whole window, to the left of the right fringe of W. */
1148 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1150 /* Don't return more than the window's pixel width. */
1151 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1155 /* Return the frame-relative coordinate of the left edge of display
1156 area AREA of window W. ANY_AREA means return the left edge of the
1157 whole window, to the right of the left fringe of W. */
1160 window_box_left (struct window
*w
, enum glyph_row_area area
)
1162 struct frame
*f
= XFRAME (w
->frame
);
1165 if (w
->pseudo_window_p
)
1166 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1168 x
= (WINDOW_LEFT_EDGE_X (w
)
1169 + window_box_left_offset (w
, area
));
1175 /* Return the frame-relative coordinate of the right edge of display
1176 area AREA of window W. ANY_AREA means return the right edge of the
1177 whole window, to the left of the right fringe of W. */
1180 window_box_right (struct window
*w
, enum glyph_row_area area
)
1182 return window_box_left (w
, area
) + window_box_width (w
, area
);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines, in frame-relative coordinates. ANY_AREA means the
1187 whole window, not including the left and right fringes of
1188 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1189 coordinates of the upper-left corner of the box. Return in
1190 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1193 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1194 int *box_y
, int *box_width
, int *box_height
)
1197 *box_width
= window_box_width (w
, area
);
1199 *box_height
= window_box_height (w
);
1201 *box_x
= window_box_left (w
, area
);
1204 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 #ifdef HAVE_WINDOW_SYSTEM
1212 /* Get the bounding box of the display area AREA of window W, without
1213 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1220 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1221 int *bottom_right_x
, int *bottom_right_y
)
1223 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1224 bottom_right_x
, bottom_right_y
);
1225 *bottom_right_x
+= *top_left_x
;
1226 *bottom_right_y
+= *top_left_y
;
1229 #endif /* HAVE_WINDOW_SYSTEM */
1231 /***********************************************************************
1233 ***********************************************************************/
1235 /* Return the bottom y-position of the line the iterator IT is in.
1236 This can modify IT's settings. */
1239 line_bottom_y (struct it
*it
)
1241 int line_height
= it
->max_ascent
+ it
->max_descent
;
1242 int line_top_y
= it
->current_y
;
1244 if (line_height
== 0)
1247 line_height
= last_height
;
1248 else if (IT_CHARPOS (*it
) < ZV
)
1250 move_it_by_lines (it
, 1);
1251 line_height
= (it
->max_ascent
|| it
->max_descent
1252 ? it
->max_ascent
+ it
->max_descent
1257 struct glyph_row
*row
= it
->glyph_row
;
1259 /* Use the default character height. */
1260 it
->glyph_row
= NULL
;
1261 it
->what
= IT_CHARACTER
;
1264 PRODUCE_GLYPHS (it
);
1265 line_height
= it
->ascent
+ it
->descent
;
1266 it
->glyph_row
= row
;
1270 return line_top_y
+ line_height
;
1273 DEFUN ("line-pixel-height", Fline_pixel_height
,
1274 Sline_pixel_height
, 0, 0, 0,
1275 doc
: /* Return height in pixels of text line in the selected window.
1277 Value is the height in pixels of the line at point. */)
1282 struct window
*w
= XWINDOW (selected_window
);
1283 struct buffer
*old_buffer
= NULL
;
1286 if (XBUFFER (w
->contents
) != current_buffer
)
1288 old_buffer
= current_buffer
;
1289 set_buffer_internal_1 (XBUFFER (w
->contents
));
1291 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1292 start_display (&it
, w
, pt
);
1293 it
.vpos
= it
.current_y
= 0;
1295 result
= make_number (line_bottom_y (&it
));
1297 set_buffer_internal_1 (old_buffer
);
1302 /* Return the default pixel height of text lines in window W. The
1303 value is the canonical height of the W frame's default font, plus
1304 any extra space required by the line-spacing variable or frame
1307 Implementation note: this ignores any line-spacing text properties
1308 put on the newline characters. This is because those properties
1309 only affect the _screen_ line ending in the newline (i.e., in a
1310 continued line, only the last screen line will be affected), which
1311 means only a small number of lines in a buffer can ever use this
1312 feature. Since this function is used to compute the default pixel
1313 equivalent of text lines in a window, we can safely ignore those
1314 few lines. For the same reasons, we ignore the line-height
1317 default_line_pixel_height (struct window
*w
)
1319 struct frame
*f
= WINDOW_XFRAME (w
);
1320 int height
= FRAME_LINE_HEIGHT (f
);
1322 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1324 struct buffer
*b
= XBUFFER (w
->contents
);
1325 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1328 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1331 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1332 height
+= XFASTINT (val
);
1333 else if (FLOATP (val
))
1335 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1342 height
+= f
->extra_line_spacing
;
1348 /* Subroutine of pos_visible_p below. Extracts a display string, if
1349 any, from the display spec given as its argument. */
1351 string_from_display_spec (Lisp_Object spec
)
1355 while (CONSP (spec
))
1357 if (STRINGP (XCAR (spec
)))
1362 else if (VECTORP (spec
))
1366 for (i
= 0; i
< ASIZE (spec
); i
++)
1368 if (STRINGP (AREF (spec
, i
)))
1369 return AREF (spec
, i
);
1378 /* Limit insanely large values of W->hscroll on frame F to the largest
1379 value that will still prevent first_visible_x and last_visible_x of
1380 'struct it' from overflowing an int. */
1382 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1384 ptrdiff_t window_hscroll
= w
->hscroll
;
1385 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1386 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1388 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1389 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1391 return window_hscroll
;
1394 /* Return 1 if position CHARPOS is visible in window W.
1395 CHARPOS < 0 means return info about WINDOW_END position.
1396 If visible, set *X and *Y to pixel coordinates of top left corner.
1397 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1398 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1401 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1402 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1405 void *itdata
= bidi_shelve_cache ();
1406 struct text_pos top
;
1408 struct buffer
*old_buffer
= NULL
;
1410 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1413 if (XBUFFER (w
->contents
) != current_buffer
)
1415 old_buffer
= current_buffer
;
1416 set_buffer_internal_1 (XBUFFER (w
->contents
));
1419 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1420 /* Scrolling a minibuffer window via scroll bar when the echo area
1421 shows long text sometimes resets the minibuffer contents behind
1423 if (CHARPOS (top
) > ZV
)
1424 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1426 /* Compute exact mode line heights. */
1427 if (WINDOW_WANTS_MODELINE_P (w
))
1429 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1430 BVAR (current_buffer
, mode_line_format
));
1432 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1433 w
->header_line_height
1434 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1435 BVAR (current_buffer
, header_line_format
));
1437 start_display (&it
, w
, top
);
1438 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1439 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1442 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1443 && IT_CHARPOS (it
) >= charpos
)
1444 /* When scanning backwards under bidi iteration, move_it_to
1445 stops at or _before_ CHARPOS, because it stops at or to
1446 the _right_ of the character at CHARPOS. */
1447 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1448 && IT_CHARPOS (it
) <= charpos
)))
1450 /* We have reached CHARPOS, or passed it. How the call to
1451 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1452 or covered by a display property, move_it_to stops at the end
1453 of the invisible text, to the right of CHARPOS. (ii) If
1454 CHARPOS is in a display vector, move_it_to stops on its last
1456 int top_x
= it
.current_x
;
1457 int top_y
= it
.current_y
;
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1461 void *save_it_data
= NULL
;
1463 /* Calling line_bottom_y may change it.method, it.position, etc. */
1464 SAVE_IT (save_it
, it
, save_it_data
);
1466 bottom_y
= line_bottom_y (&it
);
1467 if (top_y
< window_top_y
)
1468 visible_p
= bottom_y
> window_top_y
;
1469 else if (top_y
< it
.last_visible_y
)
1471 if (bottom_y
>= it
.last_visible_y
1472 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1473 && IT_CHARPOS (it
) < charpos
)
1475 /* When the last line of the window is scanned backwards
1476 under bidi iteration, we could be duped into thinking
1477 that we have passed CHARPOS, when in fact move_it_to
1478 simply stopped short of CHARPOS because it reached
1479 last_visible_y. To see if that's what happened, we call
1480 move_it_to again with a slightly larger vertical limit,
1481 and see if it actually moved vertically; if it did, we
1482 didn't really reach CHARPOS, which is beyond window end. */
1483 /* Why 10? because we don't know how many canonical lines
1484 will the height of the next line(s) be. So we guess. */
1485 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1487 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1488 MOVE_TO_POS
| MOVE_TO_Y
);
1489 if (it
.current_y
> top_y
)
1493 RESTORE_IT (&it
, &save_it
, save_it_data
);
1496 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1498 /* We stopped on the last glyph of a display vector.
1499 Try and recompute. Hack alert! */
1500 if (charpos
< 2 || top
.charpos
>= charpos
)
1501 top_x
= it
.glyph_row
->x
;
1504 struct it it2
, it2_prev
;
1505 /* The idea is to get to the previous buffer
1506 position, consume the character there, and use
1507 the pixel coordinates we get after that. But if
1508 the previous buffer position is also displayed
1509 from a display vector, we need to consume all of
1510 the glyphs from that display vector. */
1511 start_display (&it2
, w
, top
);
1512 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1513 /* If we didn't get to CHARPOS - 1, there's some
1514 replacing display property at that position, and
1515 we stopped after it. That is exactly the place
1516 whose coordinates we want. */
1517 if (IT_CHARPOS (it2
) != charpos
- 1)
1521 /* Iterate until we get out of the display
1522 vector that displays the character at
1525 get_next_display_element (&it2
);
1526 PRODUCE_GLYPHS (&it2
);
1528 set_iterator_to_next (&it2
, 1);
1529 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1530 && IT_CHARPOS (it2
) < charpos
);
1532 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1533 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1534 top_x
= it
.glyph_row
->x
;
1537 top_x
= it2_prev
.current_x
;
1538 top_y
= it2_prev
.current_y
;
1542 else if (IT_CHARPOS (it
) != charpos
)
1544 Lisp_Object cpos
= make_number (charpos
);
1545 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1546 Lisp_Object string
= string_from_display_spec (spec
);
1547 struct text_pos tpos
;
1548 int replacing_spec_p
;
1549 bool newline_in_string
1551 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1553 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1556 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1557 charpos
, FRAME_WINDOW_P (it
.f
)));
1558 /* The tricky code below is needed because there's a
1559 discrepancy between move_it_to and how we set cursor
1560 when PT is at the beginning of a portion of text
1561 covered by a display property or an overlay with a
1562 display property, or the display line ends in a
1563 newline from a display string. move_it_to will stop
1564 _after_ such display strings, whereas
1565 set_cursor_from_row conspires with cursor_row_p to
1566 place the cursor on the first glyph produced from the
1569 /* We have overshoot PT because it is covered by a
1570 display property that replaces the text it covers.
1571 If the string includes embedded newlines, we are also
1572 in the wrong display line. Backtrack to the correct
1573 line, where the display property begins. */
1574 if (replacing_spec_p
)
1576 Lisp_Object startpos
, endpos
;
1577 EMACS_INT start
, end
;
1581 /* Find the first and the last buffer positions
1582 covered by the display string. */
1584 Fnext_single_char_property_change (cpos
, Qdisplay
,
1587 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1589 start
= XFASTINT (startpos
);
1590 end
= XFASTINT (endpos
);
1591 /* Move to the last buffer position before the
1592 display property. */
1593 start_display (&it3
, w
, top
);
1594 if (start
> CHARPOS (top
))
1595 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1596 /* Move forward one more line if the position before
1597 the display string is a newline or if it is the
1598 rightmost character on a line that is
1599 continued or word-wrapped. */
1600 if (it3
.method
== GET_FROM_BUFFER
1602 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1603 move_it_by_lines (&it3
, 1);
1604 else if (move_it_in_display_line_to (&it3
, -1,
1608 == MOVE_LINE_CONTINUED
)
1610 move_it_by_lines (&it3
, 1);
1611 /* When we are under word-wrap, the #$@%!
1612 move_it_by_lines moves 2 lines, so we need to
1614 if (it3
.line_wrap
== WORD_WRAP
)
1615 move_it_by_lines (&it3
, -1);
1618 /* Record the vertical coordinate of the display
1619 line where we wound up. */
1620 top_y
= it3
.current_y
;
1623 /* When characters are reordered for display,
1624 the character displayed to the left of the
1625 display string could be _after_ the display
1626 property in the logical order. Use the
1627 smallest vertical position of these two. */
1628 start_display (&it3
, w
, top
);
1629 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1630 if (it3
.current_y
< top_y
)
1631 top_y
= it3
.current_y
;
1633 /* Move from the top of the window to the beginning
1634 of the display line where the display string
1636 start_display (&it3
, w
, top
);
1637 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1638 /* If it3_moved stays zero after the 'while' loop
1639 below, that means we already were at a newline
1640 before the loop (e.g., the display string begins
1641 with a newline), so we don't need to (and cannot)
1642 inspect the glyphs of it3.glyph_row, because
1643 PRODUCE_GLYPHS will not produce anything for a
1644 newline, and thus it3.glyph_row stays at its
1645 stale content it got at top of the window. */
1647 /* Finally, advance the iterator until we hit the
1648 first display element whose character position is
1649 CHARPOS, or until the first newline from the
1650 display string, which signals the end of the
1652 while (get_next_display_element (&it3
))
1654 PRODUCE_GLYPHS (&it3
);
1655 if (IT_CHARPOS (it3
) == charpos
1656 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1659 set_iterator_to_next (&it3
, 0);
1661 top_x
= it3
.current_x
- it3
.pixel_width
;
1662 /* Normally, we would exit the above loop because we
1663 found the display element whose character
1664 position is CHARPOS. For the contingency that we
1665 didn't, and stopped at the first newline from the
1666 display string, move back over the glyphs
1667 produced from the string, until we find the
1668 rightmost glyph not from the string. */
1670 && newline_in_string
1671 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1673 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1674 + it3
.glyph_row
->used
[TEXT_AREA
];
1676 while (EQ ((g
- 1)->object
, string
))
1679 top_x
-= g
->pixel_width
;
1681 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1682 + it3
.glyph_row
->used
[TEXT_AREA
]);
1688 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1689 *rtop
= max (0, window_top_y
- top_y
);
1690 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1691 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1692 - max (top_y
, window_top_y
)));
1698 /* Either we were asked to provide info about WINDOW_END, or
1699 CHARPOS is in the partially visible glyph row at end of
1702 void *it2data
= NULL
;
1704 SAVE_IT (it2
, it
, it2data
);
1705 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1706 move_it_by_lines (&it
, 1);
1707 if (charpos
< IT_CHARPOS (it
)
1708 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1711 RESTORE_IT (&it2
, &it2
, it2data
);
1712 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1714 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1715 *rtop
= max (0, -it2
.current_y
);
1716 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1717 - it
.last_visible_y
));
1718 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1720 - max (it2
.current_y
,
1721 WINDOW_HEADER_LINE_HEIGHT (w
))));
1725 bidi_unshelve_cache (it2data
, 1);
1727 bidi_unshelve_cache (itdata
, 0);
1730 set_buffer_internal_1 (old_buffer
);
1732 if (visible_p
&& w
->hscroll
> 0)
1734 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1735 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1738 /* Debugging code. */
1740 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1741 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1743 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1750 /* Return the next character from STR. Return in *LEN the length of
1751 the character. This is like STRING_CHAR_AND_LENGTH but never
1752 returns an invalid character. If we find one, we return a `?', but
1753 with the length of the invalid character. */
1756 string_char_and_length (const unsigned char *str
, int *len
)
1760 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1761 if (!CHAR_VALID_P (c
))
1762 /* We may not change the length here because other places in Emacs
1763 don't use this function, i.e. they silently accept invalid
1772 /* Given a position POS containing a valid character and byte position
1773 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1775 static struct text_pos
1776 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1778 eassert (STRINGP (string
) && nchars
>= 0);
1780 if (STRING_MULTIBYTE (string
))
1782 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1787 string_char_and_length (p
, &len
);
1790 BYTEPOS (pos
) += len
;
1794 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1800 /* Value is the text position, i.e. character and byte position,
1801 for character position CHARPOS in STRING. */
1803 static struct text_pos
1804 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1806 struct text_pos pos
;
1807 eassert (STRINGP (string
));
1808 eassert (charpos
>= 0);
1809 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1814 /* Value is a text position, i.e. character and byte position, for
1815 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1816 means recognize multibyte characters. */
1818 static struct text_pos
1819 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1821 struct text_pos pos
;
1823 eassert (s
!= NULL
);
1824 eassert (charpos
>= 0);
1830 SET_TEXT_POS (pos
, 0, 0);
1833 string_char_and_length ((const unsigned char *) s
, &len
);
1836 BYTEPOS (pos
) += len
;
1840 SET_TEXT_POS (pos
, charpos
, charpos
);
1846 /* Value is the number of characters in C string S. MULTIBYTE_P
1847 non-zero means recognize multibyte characters. */
1850 number_of_chars (const char *s
, bool multibyte_p
)
1856 ptrdiff_t rest
= strlen (s
);
1858 const unsigned char *p
= (const unsigned char *) s
;
1860 for (nchars
= 0; rest
> 0; ++nchars
)
1862 string_char_and_length (p
, &len
);
1863 rest
-= len
, p
+= len
;
1867 nchars
= strlen (s
);
1873 /* Compute byte position NEWPOS->bytepos corresponding to
1874 NEWPOS->charpos. POS is a known position in string STRING.
1875 NEWPOS->charpos must be >= POS.charpos. */
1878 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1880 eassert (STRINGP (string
));
1881 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1883 if (STRING_MULTIBYTE (string
))
1884 *newpos
= string_pos_nchars_ahead (pos
, string
,
1885 CHARPOS (*newpos
) - CHARPOS (pos
));
1887 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1891 Return an estimation of the pixel height of mode or header lines on
1892 frame F. FACE_ID specifies what line's height to estimate. */
1895 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1897 #ifdef HAVE_WINDOW_SYSTEM
1898 if (FRAME_WINDOW_P (f
))
1900 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1902 /* This function is called so early when Emacs starts that the face
1903 cache and mode line face are not yet initialized. */
1904 if (FRAME_FACE_CACHE (f
))
1906 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1910 height
= FONT_HEIGHT (face
->font
);
1911 if (face
->box_line_width
> 0)
1912 height
+= 2 * face
->box_line_width
;
1923 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1924 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1925 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1926 not force the value into range. */
1929 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1930 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1933 #ifdef HAVE_WINDOW_SYSTEM
1934 if (FRAME_WINDOW_P (f
))
1936 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1937 even for negative values. */
1939 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1941 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1943 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1944 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1947 STORE_NATIVE_RECT (*bounds
,
1948 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1949 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1950 FRAME_COLUMN_WIDTH (f
) - 1,
1951 FRAME_LINE_HEIGHT (f
) - 1);
1953 /* PXW: Should we clip pixels before converting to columns/lines? */
1958 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1959 pix_x
= FRAME_TOTAL_COLS (f
);
1963 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1964 pix_y
= FRAME_TOTAL_LINES (f
);
1974 /* Find the glyph under window-relative coordinates X/Y in window W.
1975 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1976 strings. Return in *HPOS and *VPOS the row and column number of
1977 the glyph found. Return in *AREA the glyph area containing X.
1978 Value is a pointer to the glyph found or null if X/Y is not on
1979 text, or we can't tell because W's current matrix is not up to
1982 static struct glyph
*
1983 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1984 int *dx
, int *dy
, int *area
)
1986 struct glyph
*glyph
, *end
;
1987 struct glyph_row
*row
= NULL
;
1990 /* Find row containing Y. Give up if some row is not enabled. */
1991 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1993 row
= MATRIX_ROW (w
->current_matrix
, i
);
1994 if (!row
->enabled_p
)
1996 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2003 /* Give up if Y is not in the window. */
2004 if (i
== w
->current_matrix
->nrows
)
2007 /* Get the glyph area containing X. */
2008 if (w
->pseudo_window_p
)
2015 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2017 *area
= LEFT_MARGIN_AREA
;
2018 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2020 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2023 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2027 *area
= RIGHT_MARGIN_AREA
;
2028 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2032 /* Find glyph containing X. */
2033 glyph
= row
->glyphs
[*area
];
2034 end
= glyph
+ row
->used
[*area
];
2036 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2038 x
-= glyph
->pixel_width
;
2048 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2051 *hpos
= glyph
- row
->glyphs
[*area
];
2055 /* Convert frame-relative x/y to coordinates relative to window W.
2056 Takes pseudo-windows into account. */
2059 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2061 if (w
->pseudo_window_p
)
2063 /* A pseudo-window is always full-width, and starts at the
2064 left edge of the frame, plus a frame border. */
2065 struct frame
*f
= XFRAME (w
->frame
);
2066 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2067 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2071 *x
-= WINDOW_LEFT_EDGE_X (w
);
2072 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2076 #ifdef HAVE_WINDOW_SYSTEM
2079 Return in RECTS[] at most N clipping rectangles for glyph string S.
2080 Return the number of stored rectangles. */
2083 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2090 if (s
->row
->full_width_p
)
2092 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2093 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2094 if (s
->row
->mode_line_p
)
2095 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2097 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2099 /* Unless displaying a mode or menu bar line, which are always
2100 fully visible, clip to the visible part of the row. */
2101 if (s
->w
->pseudo_window_p
)
2102 r
.height
= s
->row
->visible_height
;
2104 r
.height
= s
->height
;
2108 /* This is a text line that may be partially visible. */
2109 r
.x
= window_box_left (s
->w
, s
->area
);
2110 r
.width
= window_box_width (s
->w
, s
->area
);
2111 r
.height
= s
->row
->visible_height
;
2115 if (r
.x
< s
->clip_head
->x
)
2117 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2118 r
.width
-= s
->clip_head
->x
- r
.x
;
2121 r
.x
= s
->clip_head
->x
;
2124 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2126 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2127 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2132 /* If S draws overlapping rows, it's sufficient to use the top and
2133 bottom of the window for clipping because this glyph string
2134 intentionally draws over other lines. */
2135 if (s
->for_overlaps
)
2137 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2138 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2140 /* Alas, the above simple strategy does not work for the
2141 environments with anti-aliased text: if the same text is
2142 drawn onto the same place multiple times, it gets thicker.
2143 If the overlap we are processing is for the erased cursor, we
2144 take the intersection with the rectangle of the cursor. */
2145 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2147 XRectangle rc
, r_save
= r
;
2149 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2150 rc
.y
= s
->w
->phys_cursor
.y
;
2151 rc
.width
= s
->w
->phys_cursor_width
;
2152 rc
.height
= s
->w
->phys_cursor_height
;
2154 x_intersect_rectangles (&r_save
, &rc
, &r
);
2159 /* Don't use S->y for clipping because it doesn't take partially
2160 visible lines into account. For example, it can be negative for
2161 partially visible lines at the top of a window. */
2162 if (!s
->row
->full_width_p
2163 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2164 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2166 r
.y
= max (0, s
->row
->y
);
2169 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2171 /* If drawing the cursor, don't let glyph draw outside its
2172 advertised boundaries. Cleartype does this under some circumstances. */
2173 if (s
->hl
== DRAW_CURSOR
)
2175 struct glyph
*glyph
= s
->first_glyph
;
2180 if (r
.width
>= s
->x
- r
.x
)
2181 r
.width
-= s
->x
- r
.x
;
2182 else /* R2L hscrolled row with cursor outside text area */
2186 r
.width
= min (r
.width
, glyph
->pixel_width
);
2188 /* If r.y is below window bottom, ensure that we still see a cursor. */
2189 height
= min (glyph
->ascent
+ glyph
->descent
,
2190 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2191 max_y
= window_text_bottom_y (s
->w
) - height
;
2192 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2193 if (s
->ybase
- glyph
->ascent
> max_y
)
2200 /* Don't draw cursor glyph taller than our actual glyph. */
2201 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2202 if (height
< r
.height
)
2204 max_y
= r
.y
+ r
.height
;
2205 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2206 r
.height
= min (max_y
- r
.y
, height
);
2213 XRectangle r_save
= r
;
2215 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2219 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2220 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2222 #ifdef CONVERT_FROM_XRECT
2223 CONVERT_FROM_XRECT (r
, *rects
);
2231 /* If we are processing overlapping and allowed to return
2232 multiple clipping rectangles, we exclude the row of the glyph
2233 string from the clipping rectangle. This is to avoid drawing
2234 the same text on the environment with anti-aliasing. */
2235 #ifdef CONVERT_FROM_XRECT
2238 XRectangle
*rs
= rects
;
2240 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2242 if (s
->for_overlaps
& OVERLAPS_PRED
)
2245 if (r
.y
+ r
.height
> row_y
)
2248 rs
[i
].height
= row_y
- r
.y
;
2254 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2257 if (r
.y
< row_y
+ s
->row
->visible_height
)
2259 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2261 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2262 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2271 #ifdef CONVERT_FROM_XRECT
2272 for (i
= 0; i
< n
; i
++)
2273 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2280 Return in *NR the clipping rectangle for glyph string S. */
2283 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2285 get_glyph_string_clip_rects (s
, nr
, 1);
2290 Return the position and height of the phys cursor in window W.
2291 Set w->phys_cursor_width to width of phys cursor.
2295 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2296 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2299 int x
, y
, wd
, h
, h0
, y0
;
2301 /* Compute the width of the rectangle to draw. If on a stretch
2302 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2303 rectangle as wide as the glyph, but use a canonical character
2305 wd
= glyph
->pixel_width
- 1;
2306 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2310 x
= w
->phys_cursor
.x
;
2317 if (glyph
->type
== STRETCH_GLYPH
2318 && !x_stretch_cursor_p
)
2319 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2320 w
->phys_cursor_width
= wd
;
2322 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2324 /* If y is below window bottom, ensure that we still see a cursor. */
2325 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2327 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2328 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2330 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2333 h
= max (h
- (y0
- y
) + 1, h0
);
2338 y0
= window_text_bottom_y (w
) - h0
;
2346 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2347 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2352 * Remember which glyph the mouse is over.
2356 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2360 struct glyph_row
*r
, *gr
, *end_row
;
2361 enum window_part part
;
2362 enum glyph_row_area area
;
2363 int x
, y
, width
, height
;
2365 /* Try to determine frame pixel position and size of the glyph under
2366 frame pixel coordinates X/Y on frame F. */
2368 if (window_resize_pixelwise
)
2373 else if (!f
->glyphs_initialized_p
2374 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2377 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2378 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2382 w
= XWINDOW (window
);
2383 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2384 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2386 x
= window_relative_x_coord (w
, part
, gx
);
2387 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2389 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2390 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2392 if (w
->pseudo_window_p
)
2395 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2401 case ON_LEFT_MARGIN
:
2402 area
= LEFT_MARGIN_AREA
;
2405 case ON_RIGHT_MARGIN
:
2406 area
= RIGHT_MARGIN_AREA
;
2409 case ON_HEADER_LINE
:
2411 gr
= (part
== ON_HEADER_LINE
2412 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2413 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2416 goto text_glyph_row_found
;
2423 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2424 if (r
->y
+ r
->height
> y
)
2430 text_glyph_row_found
:
2433 struct glyph
*g
= gr
->glyphs
[area
];
2434 struct glyph
*end
= g
+ gr
->used
[area
];
2436 height
= gr
->height
;
2437 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2438 if (gx
+ g
->pixel_width
> x
)
2443 if (g
->type
== IMAGE_GLYPH
)
2445 /* Don't remember when mouse is over image, as
2446 image may have hot-spots. */
2447 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2450 width
= g
->pixel_width
;
2454 /* Use nominal char spacing at end of line. */
2456 gx
+= (x
/ width
) * width
;
2459 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2461 gx
+= window_box_left_offset (w
, area
);
2462 /* Don't expand over the modeline to make sure the vertical
2463 drag cursor is shown early enough. */
2464 height
= min (height
,
2465 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2470 /* Use nominal line height at end of window. */
2471 gx
= (x
/ width
) * width
;
2473 gy
+= (y
/ height
) * height
;
2474 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2475 /* See comment above. */
2476 height
= min (height
,
2477 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2481 case ON_LEFT_FRINGE
:
2482 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2483 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2484 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2485 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2488 case ON_RIGHT_FRINGE
:
2489 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2490 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2491 : window_box_right_offset (w
, TEXT_AREA
));
2492 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2493 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2494 && !WINDOW_RIGHTMOST_P (w
))
2495 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2496 /* Make sure the vertical border can get her own glyph to the
2497 right of the one we build here. */
2498 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2500 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2502 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2506 case ON_VERTICAL_BORDER
:
2507 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2510 case ON_VERTICAL_SCROLL_BAR
:
2511 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2513 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2514 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2515 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2517 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2521 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2522 if (r
->y
+ r
->height
> y
)
2529 height
= gr
->height
;
2532 /* Use nominal line height at end of window. */
2534 gy
+= (y
/ height
) * height
;
2538 case ON_RIGHT_DIVIDER
:
2539 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2540 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2542 /* The bottom divider prevails. */
2543 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2546 case ON_BOTTOM_DIVIDER
:
2548 width
= WINDOW_PIXEL_WIDTH (w
);
2549 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2550 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2556 /* If there is no glyph under the mouse, then we divide the screen
2557 into a grid of the smallest glyph in the frame, and use that
2560 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2561 round down even for negative values. */
2567 gx
= (gx
/ width
) * width
;
2568 gy
= (gy
/ height
) * height
;
2574 gx
+= WINDOW_LEFT_EDGE_X (w
);
2575 gy
+= WINDOW_TOP_EDGE_Y (w
);
2578 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2580 /* Visible feedback for debugging. */
2583 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2584 f
->output_data
.x
->normal_gc
,
2585 gx
, gy
, width
, height
);
2591 #endif /* HAVE_WINDOW_SYSTEM */
2594 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2597 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2598 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2600 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2603 /***********************************************************************
2604 Lisp form evaluation
2605 ***********************************************************************/
2607 /* Error handler for safe_eval and safe_call. */
2610 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2612 add_to_log ("Error during redisplay: %S signaled %S",
2613 Flist (nargs
, args
), arg
);
2617 /* Call function FUNC with the rest of NARGS - 1 arguments
2618 following. Return the result, or nil if something went
2619 wrong. Prevent redisplay during the evaluation. */
2622 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2626 if (inhibit_eval_during_redisplay
)
2631 ptrdiff_t count
= SPECPDL_INDEX ();
2634 SAFE_ALLOCA_LISP (args
, nargs
);
2637 for (i
= 1; i
< nargs
; i
++)
2638 args
[i
] = va_arg (ap
, Lisp_Object
);
2640 specbind (Qinhibit_redisplay
, Qt
);
2642 specbind (Qinhibit_quit
, Qt
);
2643 /* Use Qt to ensure debugger does not run,
2644 so there is no possibility of wanting to redisplay. */
2645 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2648 val
= unbind_to (count
, val
);
2655 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2660 va_start (ap
, func
);
2661 retval
= safe__call (false, nargs
, func
, ap
);
2666 /* Call function FN with one argument ARG.
2667 Return the result, or nil if something went wrong. */
2670 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2672 return safe_call (2, fn
, arg
);
2676 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2682 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2687 static Lisp_Object Qeval
;
2690 safe_eval (Lisp_Object sexpr
)
2692 return safe__call1 (false, Qeval
, sexpr
);
2696 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2698 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2701 /* Call function FN with two arguments ARG1 and ARG2.
2702 Return the result, or nil if something went wrong. */
2705 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2707 return safe_call (3, fn
, arg1
, arg2
);
2712 /***********************************************************************
2714 ***********************************************************************/
2718 /* Define CHECK_IT to perform sanity checks on iterators.
2719 This is for debugging. It is too slow to do unconditionally. */
2722 check_it (struct it
*it
)
2724 if (it
->method
== GET_FROM_STRING
)
2726 eassert (STRINGP (it
->string
));
2727 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2731 eassert (IT_STRING_CHARPOS (*it
) < 0);
2732 if (it
->method
== GET_FROM_BUFFER
)
2734 /* Check that character and byte positions agree. */
2735 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2740 eassert (it
->current
.dpvec_index
>= 0);
2742 eassert (it
->current
.dpvec_index
< 0);
2745 #define CHECK_IT(IT) check_it ((IT))
2749 #define CHECK_IT(IT) (void) 0
2754 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2756 /* Check that the window end of window W is what we expect it
2757 to be---the last row in the current matrix displaying text. */
2760 check_window_end (struct window
*w
)
2762 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2764 struct glyph_row
*row
;
2765 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2767 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2768 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2772 #define CHECK_WINDOW_END(W) check_window_end ((W))
2776 #define CHECK_WINDOW_END(W) (void) 0
2778 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2780 /***********************************************************************
2781 Iterator initialization
2782 ***********************************************************************/
2784 /* Initialize IT for displaying current_buffer in window W, starting
2785 at character position CHARPOS. CHARPOS < 0 means that no buffer
2786 position is specified which is useful when the iterator is assigned
2787 a position later. BYTEPOS is the byte position corresponding to
2790 If ROW is not null, calls to produce_glyphs with IT as parameter
2791 will produce glyphs in that row.
2793 BASE_FACE_ID is the id of a base face to use. It must be one of
2794 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2795 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2796 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2798 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2799 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2800 will be initialized to use the corresponding mode line glyph row of
2801 the desired matrix of W. */
2804 init_iterator (struct it
*it
, struct window
*w
,
2805 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2806 struct glyph_row
*row
, enum face_id base_face_id
)
2808 enum face_id remapped_base_face_id
= base_face_id
;
2810 /* Some precondition checks. */
2811 eassert (w
!= NULL
&& it
!= NULL
);
2812 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2815 /* If face attributes have been changed since the last redisplay,
2816 free realized faces now because they depend on face definitions
2817 that might have changed. Don't free faces while there might be
2818 desired matrices pending which reference these faces. */
2819 if (face_change_count
&& !inhibit_free_realized_faces
)
2821 face_change_count
= 0;
2822 free_all_realized_faces (Qnil
);
2825 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2826 if (! NILP (Vface_remapping_alist
))
2827 remapped_base_face_id
2828 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2830 /* Use one of the mode line rows of W's desired matrix if
2834 if (base_face_id
== MODE_LINE_FACE_ID
2835 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2836 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2837 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2838 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2842 memset (it
, 0, sizeof *it
);
2843 it
->current
.overlay_string_index
= -1;
2844 it
->current
.dpvec_index
= -1;
2845 it
->base_face_id
= remapped_base_face_id
;
2847 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2848 it
->paragraph_embedding
= L2R
;
2849 it
->bidi_it
.string
.lstring
= Qnil
;
2850 it
->bidi_it
.string
.s
= NULL
;
2851 it
->bidi_it
.string
.bufpos
= 0;
2854 /* The window in which we iterate over current_buffer: */
2855 XSETWINDOW (it
->window
, w
);
2857 it
->f
= XFRAME (w
->frame
);
2861 /* Extra space between lines (on window systems only). */
2862 if (base_face_id
== DEFAULT_FACE_ID
2863 && FRAME_WINDOW_P (it
->f
))
2865 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2866 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2867 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2868 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2869 * FRAME_LINE_HEIGHT (it
->f
));
2870 else if (it
->f
->extra_line_spacing
> 0)
2871 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2872 it
->max_extra_line_spacing
= 0;
2875 /* If realized faces have been removed, e.g. because of face
2876 attribute changes of named faces, recompute them. When running
2877 in batch mode, the face cache of the initial frame is null. If
2878 we happen to get called, make a dummy face cache. */
2879 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2880 init_frame_faces (it
->f
);
2881 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2882 recompute_basic_faces (it
->f
);
2884 /* Current value of the `slice', `space-width', and 'height' properties. */
2885 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2886 it
->space_width
= Qnil
;
2887 it
->font_height
= Qnil
;
2888 it
->override_ascent
= -1;
2890 /* Are control characters displayed as `^C'? */
2891 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2893 /* -1 means everything between a CR and the following line end
2894 is invisible. >0 means lines indented more than this value are
2896 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2898 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2900 : (!NILP (BVAR (current_buffer
, selective_display
))
2902 it
->selective_display_ellipsis_p
2903 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2905 /* Display table to use. */
2906 it
->dp
= window_display_table (w
);
2908 /* Are multibyte characters enabled in current_buffer? */
2909 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2911 /* Get the position at which the redisplay_end_trigger hook should
2912 be run, if it is to be run at all. */
2913 if (MARKERP (w
->redisplay_end_trigger
)
2914 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2915 it
->redisplay_end_trigger_charpos
2916 = marker_position (w
->redisplay_end_trigger
);
2917 else if (INTEGERP (w
->redisplay_end_trigger
))
2918 it
->redisplay_end_trigger_charpos
2919 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2922 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2924 /* Are lines in the display truncated? */
2925 if (base_face_id
!= DEFAULT_FACE_ID
2927 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2928 && ((!NILP (Vtruncate_partial_width_windows
)
2929 && !INTEGERP (Vtruncate_partial_width_windows
))
2930 || (INTEGERP (Vtruncate_partial_width_windows
)
2931 /* PXW: Shall we do something about this? */
2932 && (WINDOW_TOTAL_COLS (it
->w
)
2933 < XINT (Vtruncate_partial_width_windows
))))))
2934 it
->line_wrap
= TRUNCATE
;
2935 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2936 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2937 ? WINDOW_WRAP
: WORD_WRAP
;
2939 it
->line_wrap
= TRUNCATE
;
2941 /* Get dimensions of truncation and continuation glyphs. These are
2942 displayed as fringe bitmaps under X, but we need them for such
2943 frames when the fringes are turned off. But leave the dimensions
2944 zero for tooltip frames, as these glyphs look ugly there and also
2945 sabotage calculations of tooltip dimensions in x-show-tip. */
2946 #ifdef HAVE_WINDOW_SYSTEM
2947 if (!(FRAME_WINDOW_P (it
->f
)
2948 && FRAMEP (tip_frame
)
2949 && it
->f
== XFRAME (tip_frame
)))
2952 if (it
->line_wrap
== TRUNCATE
)
2954 /* We will need the truncation glyph. */
2955 eassert (it
->glyph_row
== NULL
);
2956 produce_special_glyphs (it
, IT_TRUNCATION
);
2957 it
->truncation_pixel_width
= it
->pixel_width
;
2961 /* We will need the continuation glyph. */
2962 eassert (it
->glyph_row
== NULL
);
2963 produce_special_glyphs (it
, IT_CONTINUATION
);
2964 it
->continuation_pixel_width
= it
->pixel_width
;
2968 /* Reset these values to zero because the produce_special_glyphs
2969 above has changed them. */
2970 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2971 it
->phys_ascent
= it
->phys_descent
= 0;
2973 /* Set this after getting the dimensions of truncation and
2974 continuation glyphs, so that we don't produce glyphs when calling
2975 produce_special_glyphs, above. */
2976 it
->glyph_row
= row
;
2977 it
->area
= TEXT_AREA
;
2979 /* Get the dimensions of the display area. The display area
2980 consists of the visible window area plus a horizontally scrolled
2981 part to the left of the window. All x-values are relative to the
2982 start of this total display area. */
2983 if (base_face_id
!= DEFAULT_FACE_ID
)
2985 /* Mode lines, menu bar in terminal frames. */
2986 it
->first_visible_x
= 0;
2987 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2992 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2993 it
->last_visible_x
= (it
->first_visible_x
2994 + window_box_width (w
, TEXT_AREA
));
2996 /* If we truncate lines, leave room for the truncation glyph(s) at
2997 the right margin. Otherwise, leave room for the continuation
2998 glyph(s). Done only if the window has no fringes. Since we
2999 don't know at this point whether there will be any R2L lines in
3000 the window, we reserve space for truncation/continuation glyphs
3001 even if only one of the fringes is absent. */
3002 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
3003 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
3005 if (it
->line_wrap
== TRUNCATE
)
3006 it
->last_visible_x
-= it
->truncation_pixel_width
;
3008 it
->last_visible_x
-= it
->continuation_pixel_width
;
3011 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3012 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3015 /* Leave room for a border glyph. */
3016 if (!FRAME_WINDOW_P (it
->f
)
3017 && !WINDOW_RIGHTMOST_P (it
->w
))
3018 it
->last_visible_x
-= 1;
3020 it
->last_visible_y
= window_text_bottom_y (w
);
3022 /* For mode lines and alike, arrange for the first glyph having a
3023 left box line if the face specifies a box. */
3024 if (base_face_id
!= DEFAULT_FACE_ID
)
3028 it
->face_id
= remapped_base_face_id
;
3030 /* If we have a boxed mode line, make the first character appear
3031 with a left box line. */
3032 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3033 if (face
&& face
->box
!= FACE_NO_BOX
)
3034 it
->start_of_box_run_p
= true;
3037 /* If a buffer position was specified, set the iterator there,
3038 getting overlays and face properties from that position. */
3039 if (charpos
>= BUF_BEG (current_buffer
))
3041 it
->stop_charpos
= charpos
;
3042 it
->end_charpos
= ZV
;
3043 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3044 IT_CHARPOS (*it
) = charpos
;
3045 IT_BYTEPOS (*it
) = bytepos
;
3047 /* We will rely on `reseat' to set this up properly, via
3048 handle_face_prop. */
3049 it
->face_id
= it
->base_face_id
;
3051 it
->start
= it
->current
;
3052 /* Do we need to reorder bidirectional text? Not if this is a
3053 unibyte buffer: by definition, none of the single-byte
3054 characters are strong R2L, so no reordering is needed. And
3055 bidi.c doesn't support unibyte buffers anyway. Also, don't
3056 reorder while we are loading loadup.el, since the tables of
3057 character properties needed for reordering are not yet
3061 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3064 /* If we are to reorder bidirectional text, init the bidi
3068 /* Note the paragraph direction that this buffer wants to
3070 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3072 it
->paragraph_embedding
= L2R
;
3073 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3075 it
->paragraph_embedding
= R2L
;
3077 it
->paragraph_embedding
= NEUTRAL_DIR
;
3078 bidi_unshelve_cache (NULL
, 0);
3079 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3083 /* Compute faces etc. */
3084 reseat (it
, it
->current
.pos
, 1);
3091 /* Initialize IT for the display of window W with window start POS. */
3094 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3096 struct glyph_row
*row
;
3097 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3099 row
= w
->desired_matrix
->rows
+ first_vpos
;
3100 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3101 it
->first_vpos
= first_vpos
;
3103 /* Don't reseat to previous visible line start if current start
3104 position is in a string or image. */
3105 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3107 int start_at_line_beg_p
;
3108 int first_y
= it
->current_y
;
3110 /* If window start is not at a line start, skip forward to POS to
3111 get the correct continuation lines width. */
3112 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3113 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3114 if (!start_at_line_beg_p
)
3118 reseat_at_previous_visible_line_start (it
);
3119 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3121 new_x
= it
->current_x
+ it
->pixel_width
;
3123 /* If lines are continued, this line may end in the middle
3124 of a multi-glyph character (e.g. a control character
3125 displayed as \003, or in the middle of an overlay
3126 string). In this case move_it_to above will not have
3127 taken us to the start of the continuation line but to the
3128 end of the continued line. */
3129 if (it
->current_x
> 0
3130 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3131 && (/* And glyph doesn't fit on the line. */
3132 new_x
> it
->last_visible_x
3133 /* Or it fits exactly and we're on a window
3135 || (new_x
== it
->last_visible_x
3136 && FRAME_WINDOW_P (it
->f
)
3137 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3138 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3139 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3141 if ((it
->current
.dpvec_index
>= 0
3142 || it
->current
.overlay_string_index
>= 0)
3143 /* If we are on a newline from a display vector or
3144 overlay string, then we are already at the end of
3145 a screen line; no need to go to the next line in
3146 that case, as this line is not really continued.
3147 (If we do go to the next line, C-e will not DTRT.) */
3150 set_iterator_to_next (it
, 1);
3151 move_it_in_display_line_to (it
, -1, -1, 0);
3154 it
->continuation_lines_width
+= it
->current_x
;
3156 /* If the character at POS is displayed via a display
3157 vector, move_it_to above stops at the final glyph of
3158 IT->dpvec. To make the caller redisplay that character
3159 again (a.k.a. start at POS), we need to reset the
3160 dpvec_index to the beginning of IT->dpvec. */
3161 else if (it
->current
.dpvec_index
>= 0)
3162 it
->current
.dpvec_index
= 0;
3164 /* We're starting a new display line, not affected by the
3165 height of the continued line, so clear the appropriate
3166 fields in the iterator structure. */
3167 it
->max_ascent
= it
->max_descent
= 0;
3168 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3170 it
->current_y
= first_y
;
3172 it
->current_x
= it
->hpos
= 0;
3178 /* Return 1 if POS is a position in ellipses displayed for invisible
3179 text. W is the window we display, for text property lookup. */
3182 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3184 Lisp_Object prop
, window
;
3186 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3188 /* If POS specifies a position in a display vector, this might
3189 be for an ellipsis displayed for invisible text. We won't
3190 get the iterator set up for delivering that ellipsis unless
3191 we make sure that it gets aware of the invisible text. */
3192 if (pos
->dpvec_index
>= 0
3193 && pos
->overlay_string_index
< 0
3194 && CHARPOS (pos
->string_pos
) < 0
3196 && (XSETWINDOW (window
, w
),
3197 prop
= Fget_char_property (make_number (charpos
),
3198 Qinvisible
, window
),
3199 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3201 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3203 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3210 /* Initialize IT for stepping through current_buffer in window W,
3211 starting at position POS that includes overlay string and display
3212 vector/ control character translation position information. Value
3213 is zero if there are overlay strings with newlines at POS. */
3216 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3218 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3219 int i
, overlay_strings_with_newlines
= 0;
3221 /* If POS specifies a position in a display vector, this might
3222 be for an ellipsis displayed for invisible text. We won't
3223 get the iterator set up for delivering that ellipsis unless
3224 we make sure that it gets aware of the invisible text. */
3225 if (in_ellipses_for_invisible_text_p (pos
, w
))
3231 /* Keep in mind: the call to reseat in init_iterator skips invisible
3232 text, so we might end up at a position different from POS. This
3233 is only a problem when POS is a row start after a newline and an
3234 overlay starts there with an after-string, and the overlay has an
3235 invisible property. Since we don't skip invisible text in
3236 display_line and elsewhere immediately after consuming the
3237 newline before the row start, such a POS will not be in a string,
3238 but the call to init_iterator below will move us to the
3240 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3242 /* This only scans the current chunk -- it should scan all chunks.
3243 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3244 to 16 in 22.1 to make this a lesser problem. */
3245 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3247 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3248 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3250 while (s
< e
&& *s
!= '\n')
3255 overlay_strings_with_newlines
= 1;
3260 /* If position is within an overlay string, set up IT to the right
3262 if (pos
->overlay_string_index
>= 0)
3266 /* If the first overlay string happens to have a `display'
3267 property for an image, the iterator will be set up for that
3268 image, and we have to undo that setup first before we can
3269 correct the overlay string index. */
3270 if (it
->method
== GET_FROM_IMAGE
)
3273 /* We already have the first chunk of overlay strings in
3274 IT->overlay_strings. Load more until the one for
3275 pos->overlay_string_index is in IT->overlay_strings. */
3276 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3278 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3279 it
->current
.overlay_string_index
= 0;
3282 load_overlay_strings (it
, 0);
3283 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3287 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3288 relative_index
= (it
->current
.overlay_string_index
3289 % OVERLAY_STRING_CHUNK_SIZE
);
3290 it
->string
= it
->overlay_strings
[relative_index
];
3291 eassert (STRINGP (it
->string
));
3292 it
->current
.string_pos
= pos
->string_pos
;
3293 it
->method
= GET_FROM_STRING
;
3294 it
->end_charpos
= SCHARS (it
->string
);
3295 /* Set up the bidi iterator for this overlay string. */
3298 it
->bidi_it
.string
.lstring
= it
->string
;
3299 it
->bidi_it
.string
.s
= NULL
;
3300 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3301 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3302 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3303 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3304 it
->bidi_it
.w
= it
->w
;
3305 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3306 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3308 /* Synchronize the state of the bidi iterator with
3309 pos->string_pos. For any string position other than
3310 zero, this will be done automagically when we resume
3311 iteration over the string and get_visually_first_element
3312 is called. But if string_pos is zero, and the string is
3313 to be reordered for display, we need to resync manually,
3314 since it could be that the iteration state recorded in
3315 pos ended at string_pos of 0 moving backwards in string. */
3316 if (CHARPOS (pos
->string_pos
) == 0)
3318 get_visually_first_element (it
);
3319 if (IT_STRING_CHARPOS (*it
) != 0)
3322 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3323 bidi_move_to_visually_next (&it
->bidi_it
);
3324 } while (it
->bidi_it
.charpos
!= 0);
3326 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3327 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3331 if (CHARPOS (pos
->string_pos
) >= 0)
3333 /* Recorded position is not in an overlay string, but in another
3334 string. This can only be a string from a `display' property.
3335 IT should already be filled with that string. */
3336 it
->current
.string_pos
= pos
->string_pos
;
3337 eassert (STRINGP (it
->string
));
3339 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3340 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3343 /* Restore position in display vector translations, control
3344 character translations or ellipses. */
3345 if (pos
->dpvec_index
>= 0)
3347 if (it
->dpvec
== NULL
)
3348 get_next_display_element (it
);
3349 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3350 it
->current
.dpvec_index
= pos
->dpvec_index
;
3354 return !overlay_strings_with_newlines
;
3358 /* Initialize IT for stepping through current_buffer in window W
3359 starting at ROW->start. */
3362 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3364 init_from_display_pos (it
, w
, &row
->start
);
3365 it
->start
= row
->start
;
3366 it
->continuation_lines_width
= row
->continuation_lines_width
;
3371 /* Initialize IT for stepping through current_buffer in window W
3372 starting in the line following ROW, i.e. starting at ROW->end.
3373 Value is zero if there are overlay strings with newlines at ROW's
3377 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3381 if (init_from_display_pos (it
, w
, &row
->end
))
3383 if (row
->continued_p
)
3384 it
->continuation_lines_width
3385 = row
->continuation_lines_width
+ row
->pixel_width
;
3396 /***********************************************************************
3398 ***********************************************************************/
3400 /* Called when IT reaches IT->stop_charpos. Handle text property and
3401 overlay changes. Set IT->stop_charpos to the next position where
3405 handle_stop (struct it
*it
)
3407 enum prop_handled handled
;
3408 int handle_overlay_change_p
;
3412 it
->current
.dpvec_index
= -1;
3413 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3414 it
->ignore_overlay_strings_at_pos_p
= 0;
3417 /* Use face of preceding text for ellipsis (if invisible) */
3418 if (it
->selective_display_ellipsis_p
)
3419 it
->saved_face_id
= it
->face_id
;
3421 /* Here's the description of the semantics of, and the logic behind,
3422 the various HANDLED_* statuses:
3424 HANDLED_NORMALLY means the handler did its job, and the loop
3425 should proceed to calling the next handler in order.
3427 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3428 change in the properties and overlays at current position, so the
3429 loop should be restarted, to re-invoke the handlers that were
3430 already called. This happens when fontification-functions were
3431 called by handle_fontified_prop, and actually fontified
3432 something. Another case where HANDLED_RECOMPUTE_PROPS is
3433 returned is when we discover overlay strings that need to be
3434 displayed right away. The loop below will continue for as long
3435 as the status is HANDLED_RECOMPUTE_PROPS.
3437 HANDLED_RETURN means return immediately to the caller, to
3438 continue iteration without calling any further handlers. This is
3439 used when we need to act on some property right away, for example
3440 when we need to display the ellipsis or a replacing display
3441 property, such as display string or image.
3443 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3444 consumed, and the handler switched to the next overlay string.
3445 This signals the loop below to refrain from looking for more
3446 overlays before all the overlay strings of the current overlay
3449 Some of the handlers called by the loop push the iterator state
3450 onto the stack (see 'push_it'), and arrange for the iteration to
3451 continue with another object, such as an image, a display string,
3452 or an overlay string. In most such cases, it->stop_charpos is
3453 set to the first character of the string, so that when the
3454 iteration resumes, this function will immediately be called
3455 again, to examine the properties at the beginning of the string.
3457 When a display or overlay string is exhausted, the iterator state
3458 is popped (see 'pop_it'), and iteration continues with the
3459 previous object. Again, in many such cases this function is
3460 called again to find the next position where properties might
3465 handled
= HANDLED_NORMALLY
;
3467 /* Call text property handlers. */
3468 for (p
= it_props
; p
->handler
; ++p
)
3470 handled
= p
->handler (it
);
3472 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3474 else if (handled
== HANDLED_RETURN
)
3476 /* We still want to show before and after strings from
3477 overlays even if the actual buffer text is replaced. */
3478 if (!handle_overlay_change_p
3480 /* Don't call get_overlay_strings_1 if we already
3481 have overlay strings loaded, because doing so
3482 will load them again and push the iterator state
3483 onto the stack one more time, which is not
3484 expected by the rest of the code that processes
3486 || (it
->current
.overlay_string_index
< 0
3487 ? !get_overlay_strings_1 (it
, 0, 0)
3491 setup_for_ellipsis (it
, 0);
3492 /* When handling a display spec, we might load an
3493 empty string. In that case, discard it here. We
3494 used to discard it in handle_single_display_spec,
3495 but that causes get_overlay_strings_1, above, to
3496 ignore overlay strings that we must check. */
3497 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3501 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3505 it
->ignore_overlay_strings_at_pos_p
= true;
3506 it
->string_from_display_prop_p
= 0;
3507 it
->from_disp_prop_p
= 0;
3508 handle_overlay_change_p
= 0;
3510 handled
= HANDLED_RECOMPUTE_PROPS
;
3513 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3514 handle_overlay_change_p
= 0;
3517 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3519 /* Don't check for overlay strings below when set to deliver
3520 characters from a display vector. */
3521 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3522 handle_overlay_change_p
= 0;
3524 /* Handle overlay changes.
3525 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3526 if it finds overlays. */
3527 if (handle_overlay_change_p
)
3528 handled
= handle_overlay_change (it
);
3533 setup_for_ellipsis (it
, 0);
3537 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3539 /* Determine where to stop next. */
3540 if (handled
== HANDLED_NORMALLY
)
3541 compute_stop_pos (it
);
3545 /* Compute IT->stop_charpos from text property and overlay change
3546 information for IT's current position. */
3549 compute_stop_pos (struct it
*it
)
3551 register INTERVAL iv
, next_iv
;
3552 Lisp_Object object
, limit
, position
;
3553 ptrdiff_t charpos
, bytepos
;
3555 if (STRINGP (it
->string
))
3557 /* Strings are usually short, so don't limit the search for
3559 it
->stop_charpos
= it
->end_charpos
;
3560 object
= it
->string
;
3562 charpos
= IT_STRING_CHARPOS (*it
);
3563 bytepos
= IT_STRING_BYTEPOS (*it
);
3569 /* If end_charpos is out of range for some reason, such as a
3570 misbehaving display function, rationalize it (Bug#5984). */
3571 if (it
->end_charpos
> ZV
)
3572 it
->end_charpos
= ZV
;
3573 it
->stop_charpos
= it
->end_charpos
;
3575 /* If next overlay change is in front of the current stop pos
3576 (which is IT->end_charpos), stop there. Note: value of
3577 next_overlay_change is point-max if no overlay change
3579 charpos
= IT_CHARPOS (*it
);
3580 bytepos
= IT_BYTEPOS (*it
);
3581 pos
= next_overlay_change (charpos
);
3582 if (pos
< it
->stop_charpos
)
3583 it
->stop_charpos
= pos
;
3585 /* Set up variables for computing the stop position from text
3586 property changes. */
3587 XSETBUFFER (object
, current_buffer
);
3588 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3591 /* Get the interval containing IT's position. Value is a null
3592 interval if there isn't such an interval. */
3593 position
= make_number (charpos
);
3594 iv
= validate_interval_range (object
, &position
, &position
, 0);
3597 Lisp_Object values_here
[LAST_PROP_IDX
];
3600 /* Get properties here. */
3601 for (p
= it_props
; p
->handler
; ++p
)
3602 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3604 /* Look for an interval following iv that has different
3606 for (next_iv
= next_interval (iv
);
3609 || XFASTINT (limit
) > next_iv
->position
));
3610 next_iv
= next_interval (next_iv
))
3612 for (p
= it_props
; p
->handler
; ++p
)
3614 Lisp_Object new_value
;
3616 new_value
= textget (next_iv
->plist
, *p
->name
);
3617 if (!EQ (values_here
[p
->idx
], new_value
))
3627 if (INTEGERP (limit
)
3628 && next_iv
->position
>= XFASTINT (limit
))
3629 /* No text property change up to limit. */
3630 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3632 /* Text properties change in next_iv. */
3633 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3637 if (it
->cmp_it
.id
< 0)
3639 ptrdiff_t stoppos
= it
->end_charpos
;
3641 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3643 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3644 stoppos
, it
->string
);
3647 eassert (STRINGP (it
->string
)
3648 || (it
->stop_charpos
>= BEGV
3649 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3653 /* Return the position of the next overlay change after POS in
3654 current_buffer. Value is point-max if no overlay change
3655 follows. This is like `next-overlay-change' but doesn't use
3659 next_overlay_change (ptrdiff_t pos
)
3661 ptrdiff_t i
, noverlays
;
3663 Lisp_Object
*overlays
;
3666 /* Get all overlays at the given position. */
3667 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3669 /* If any of these overlays ends before endpos,
3670 use its ending point instead. */
3671 for (i
= 0; i
< noverlays
; ++i
)
3676 oend
= OVERLAY_END (overlays
[i
]);
3677 oendpos
= OVERLAY_POSITION (oend
);
3678 endpos
= min (endpos
, oendpos
);
3685 /* How many characters forward to search for a display property or
3686 display string. Searching too far forward makes the bidi display
3687 sluggish, especially in small windows. */
3688 #define MAX_DISP_SCAN 250
3690 /* Return the character position of a display string at or after
3691 position specified by POSITION. If no display string exists at or
3692 after POSITION, return ZV. A display string is either an overlay
3693 with `display' property whose value is a string, or a `display'
3694 text property whose value is a string. STRING is data about the
3695 string to iterate; if STRING->lstring is nil, we are iterating a
3696 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3697 on a GUI frame. DISP_PROP is set to zero if we searched
3698 MAX_DISP_SCAN characters forward without finding any display
3699 strings, non-zero otherwise. It is set to 2 if the display string
3700 uses any kind of `(space ...)' spec that will produce a stretch of
3701 white space in the text area. */
3703 compute_display_string_pos (struct text_pos
*position
,
3704 struct bidi_string_data
*string
,
3706 int frame_window_p
, int *disp_prop
)
3708 /* OBJECT = nil means current buffer. */
3709 Lisp_Object object
, object1
;
3710 Lisp_Object pos
, spec
, limpos
;
3711 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3712 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3713 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3714 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3716 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3717 struct text_pos tpos
;
3720 if (string
&& STRINGP (string
->lstring
))
3721 object1
= object
= string
->lstring
;
3722 else if (w
&& !string_p
)
3724 XSETWINDOW (object
, w
);
3728 object1
= object
= Qnil
;
3733 /* We don't support display properties whose values are strings
3734 that have display string properties. */
3735 || string
->from_disp_str
3736 /* C strings cannot have display properties. */
3737 || (string
->s
&& !STRINGP (object
)))
3743 /* If the character at CHARPOS is where the display string begins,
3745 pos
= make_number (charpos
);
3746 if (STRINGP (object
))
3747 bufpos
= string
->bufpos
;
3751 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3753 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3756 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3764 /* Look forward for the first character with a `display' property
3765 that will replace the underlying text when displayed. */
3766 limpos
= make_number (lim
);
3768 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3769 CHARPOS (tpos
) = XFASTINT (pos
);
3770 if (CHARPOS (tpos
) >= lim
)
3775 if (STRINGP (object
))
3776 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3778 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3779 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3780 if (!STRINGP (object
))
3781 bufpos
= CHARPOS (tpos
);
3782 } while (NILP (spec
)
3783 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3784 bufpos
, frame_window_p
)));
3788 return CHARPOS (tpos
);
3791 /* Return the character position of the end of the display string that
3792 started at CHARPOS. If there's no display string at CHARPOS,
3793 return -1. A display string is either an overlay with `display'
3794 property whose value is a string or a `display' text property whose
3795 value is a string. */
3797 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3799 /* OBJECT = nil means current buffer. */
3800 Lisp_Object object
=
3801 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3802 Lisp_Object pos
= make_number (charpos
);
3804 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3806 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3809 /* It could happen that the display property or overlay was removed
3810 since we found it in compute_display_string_pos above. One way
3811 this can happen is if JIT font-lock was called (through
3812 handle_fontified_prop), and jit-lock-functions remove text
3813 properties or overlays from the portion of buffer that includes
3814 CHARPOS. Muse mode is known to do that, for example. In this
3815 case, we return -1 to the caller, to signal that no display
3816 string is actually present at CHARPOS. See bidi_fetch_char for
3817 how this is handled.
3819 An alternative would be to never look for display properties past
3820 it->stop_charpos. But neither compute_display_string_pos nor
3821 bidi_fetch_char that calls it know or care where the next
3823 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3826 /* Look forward for the first character where the `display' property
3828 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3830 return XFASTINT (pos
);
3835 /***********************************************************************
3837 ***********************************************************************/
3839 /* Handle changes in the `fontified' property of the current buffer by
3840 calling hook functions from Qfontification_functions to fontify
3843 static enum prop_handled
3844 handle_fontified_prop (struct it
*it
)
3846 Lisp_Object prop
, pos
;
3847 enum prop_handled handled
= HANDLED_NORMALLY
;
3849 if (!NILP (Vmemory_full
))
3852 /* Get the value of the `fontified' property at IT's current buffer
3853 position. (The `fontified' property doesn't have a special
3854 meaning in strings.) If the value is nil, call functions from
3855 Qfontification_functions. */
3856 if (!STRINGP (it
->string
)
3858 && !NILP (Vfontification_functions
)
3859 && !NILP (Vrun_hooks
)
3860 && (pos
= make_number (IT_CHARPOS (*it
)),
3861 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3862 /* Ignore the special cased nil value always present at EOB since
3863 no amount of fontifying will be able to change it. */
3864 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3866 ptrdiff_t count
= SPECPDL_INDEX ();
3868 struct buffer
*obuf
= current_buffer
;
3869 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3870 bool old_clip_changed
= current_buffer
->clip_changed
;
3872 val
= Vfontification_functions
;
3873 specbind (Qfontification_functions
, Qnil
);
3875 eassert (it
->end_charpos
== ZV
);
3877 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3878 safe_call1 (val
, pos
);
3881 Lisp_Object fns
, fn
;
3882 struct gcpro gcpro1
, gcpro2
;
3887 for (; CONSP (val
); val
= XCDR (val
))
3893 /* A value of t indicates this hook has a local
3894 binding; it means to run the global binding too.
3895 In a global value, t should not occur. If it
3896 does, we must ignore it to avoid an endless
3898 for (fns
= Fdefault_value (Qfontification_functions
);
3904 safe_call1 (fn
, pos
);
3908 safe_call1 (fn
, pos
);
3914 unbind_to (count
, Qnil
);
3916 /* Fontification functions routinely call `save-restriction'.
3917 Normally, this tags clip_changed, which can confuse redisplay
3918 (see discussion in Bug#6671). Since we don't perform any
3919 special handling of fontification changes in the case where
3920 `save-restriction' isn't called, there's no point doing so in
3921 this case either. So, if the buffer's restrictions are
3922 actually left unchanged, reset clip_changed. */
3923 if (obuf
== current_buffer
)
3925 if (begv
== BEGV
&& zv
== ZV
)
3926 current_buffer
->clip_changed
= old_clip_changed
;
3928 /* There isn't much we can reasonably do to protect against
3929 misbehaving fontification, but here's a fig leaf. */
3930 else if (BUFFER_LIVE_P (obuf
))
3931 set_buffer_internal_1 (obuf
);
3933 /* The fontification code may have added/removed text.
3934 It could do even a lot worse, but let's at least protect against
3935 the most obvious case where only the text past `pos' gets changed',
3936 as is/was done in grep.el where some escapes sequences are turned
3937 into face properties (bug#7876). */
3938 it
->end_charpos
= ZV
;
3940 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3941 something. This avoids an endless loop if they failed to
3942 fontify the text for which reason ever. */
3943 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3944 handled
= HANDLED_RECOMPUTE_PROPS
;
3952 /***********************************************************************
3954 ***********************************************************************/
3956 /* Set up iterator IT from face properties at its current position.
3957 Called from handle_stop. */
3959 static enum prop_handled
3960 handle_face_prop (struct it
*it
)
3963 ptrdiff_t next_stop
;
3965 if (!STRINGP (it
->string
))
3968 = face_at_buffer_position (it
->w
,
3972 + TEXT_PROP_DISTANCE_LIMIT
),
3973 0, it
->base_face_id
);
3975 /* Is this a start of a run of characters with box face?
3976 Caveat: this can be called for a freshly initialized
3977 iterator; face_id is -1 in this case. We know that the new
3978 face will not change until limit, i.e. if the new face has a
3979 box, all characters up to limit will have one. But, as
3980 usual, we don't know whether limit is really the end. */
3981 if (new_face_id
!= it
->face_id
)
3983 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3984 /* If it->face_id is -1, old_face below will be NULL, see
3985 the definition of FACE_FROM_ID. This will happen if this
3986 is the initial call that gets the face. */
3987 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3989 /* If the value of face_id of the iterator is -1, we have to
3990 look in front of IT's position and see whether there is a
3991 face there that's different from new_face_id. */
3992 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3994 int prev_face_id
= face_before_it_pos (it
);
3996 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3999 /* If the new face has a box, but the old face does not,
4000 this is the start of a run of characters with box face,
4001 i.e. this character has a shadow on the left side. */
4002 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4003 && (old_face
== NULL
|| !old_face
->box
));
4004 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4012 Lisp_Object from_overlay
4013 = (it
->current
.overlay_string_index
>= 0
4014 ? it
->string_overlays
[it
->current
.overlay_string_index
4015 % OVERLAY_STRING_CHUNK_SIZE
]
4018 /* See if we got to this string directly or indirectly from
4019 an overlay property. That includes the before-string or
4020 after-string of an overlay, strings in display properties
4021 provided by an overlay, their text properties, etc.
4023 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4024 if (! NILP (from_overlay
))
4025 for (i
= it
->sp
- 1; i
>= 0; i
--)
4027 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4029 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4030 % OVERLAY_STRING_CHUNK_SIZE
];
4031 else if (! NILP (it
->stack
[i
].from_overlay
))
4032 from_overlay
= it
->stack
[i
].from_overlay
;
4034 if (!NILP (from_overlay
))
4038 if (! NILP (from_overlay
))
4040 bufpos
= IT_CHARPOS (*it
);
4041 /* For a string from an overlay, the base face depends
4042 only on text properties and ignores overlays. */
4044 = face_for_overlay_string (it
->w
,
4048 + TEXT_PROP_DISTANCE_LIMIT
),
4056 /* For strings from a `display' property, use the face at
4057 IT's current buffer position as the base face to merge
4058 with, so that overlay strings appear in the same face as
4059 surrounding text, unless they specify their own faces.
4060 For strings from wrap-prefix and line-prefix properties,
4061 use the default face, possibly remapped via
4062 Vface_remapping_alist. */
4063 /* Note that the fact that we use the face at _buffer_
4064 position means that a 'display' property on an overlay
4065 string will not inherit the face of that overlay string,
4066 but will instead revert to the face of buffer text
4067 covered by the overlay. This is visible, e.g., when the
4068 overlay specifies a box face, but neither the buffer nor
4069 the display string do. This sounds like a design bug,
4070 but Emacs always did that since v21.1, so changing that
4071 might be a big deal. */
4072 base_face_id
= it
->string_from_prefix_prop_p
4073 ? (!NILP (Vface_remapping_alist
)
4074 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4076 : underlying_face_id (it
);
4079 new_face_id
= face_at_string_position (it
->w
,
4081 IT_STRING_CHARPOS (*it
),
4086 /* Is this a start of a run of characters with box? Caveat:
4087 this can be called for a freshly allocated iterator; face_id
4088 is -1 is this case. We know that the new face will not
4089 change until the next check pos, i.e. if the new face has a
4090 box, all characters up to that position will have a
4091 box. But, as usual, we don't know whether that position
4092 is really the end. */
4093 if (new_face_id
!= it
->face_id
)
4095 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4096 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4098 /* If new face has a box but old face hasn't, this is the
4099 start of a run of characters with box, i.e. it has a
4100 shadow on the left side. */
4101 it
->start_of_box_run_p
4102 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4103 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4107 it
->face_id
= new_face_id
;
4108 return HANDLED_NORMALLY
;
4112 /* Return the ID of the face ``underlying'' IT's current position,
4113 which is in a string. If the iterator is associated with a
4114 buffer, return the face at IT's current buffer position.
4115 Otherwise, use the iterator's base_face_id. */
4118 underlying_face_id (struct it
*it
)
4120 int face_id
= it
->base_face_id
, i
;
4122 eassert (STRINGP (it
->string
));
4124 for (i
= it
->sp
- 1; i
>= 0; --i
)
4125 if (NILP (it
->stack
[i
].string
))
4126 face_id
= it
->stack
[i
].face_id
;
4132 /* Compute the face one character before or after the current position
4133 of IT, in the visual order. BEFORE_P non-zero means get the face
4134 in front (to the left in L2R paragraphs, to the right in R2L
4135 paragraphs) of IT's screen position. Value is the ID of the face. */
4138 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4141 ptrdiff_t next_check_charpos
;
4143 void *it_copy_data
= NULL
;
4145 eassert (it
->s
== NULL
);
4147 if (STRINGP (it
->string
))
4149 ptrdiff_t bufpos
, charpos
;
4152 /* No face change past the end of the string (for the case
4153 we are padding with spaces). No face change before the
4155 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4156 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4161 /* Set charpos to the position before or after IT's current
4162 position, in the logical order, which in the non-bidi
4163 case is the same as the visual order. */
4165 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4166 else if (it
->what
== IT_COMPOSITION
)
4167 /* For composition, we must check the character after the
4169 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4171 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4177 /* With bidi iteration, the character before the current
4178 in the visual order cannot be found by simple
4179 iteration, because "reverse" reordering is not
4180 supported. Instead, we need to use the move_it_*
4181 family of functions. */
4182 /* Ignore face changes before the first visible
4183 character on this display line. */
4184 if (it
->current_x
<= it
->first_visible_x
)
4186 SAVE_IT (it_copy
, *it
, it_copy_data
);
4187 /* Implementation note: Since move_it_in_display_line
4188 works in the iterator geometry, and thinks the first
4189 character is always the leftmost, even in R2L lines,
4190 we don't need to distinguish between the R2L and L2R
4192 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4193 it_copy
.current_x
- 1, MOVE_TO_X
);
4194 charpos
= IT_STRING_CHARPOS (it_copy
);
4195 RESTORE_IT (it
, it
, it_copy_data
);
4199 /* Set charpos to the string position of the character
4200 that comes after IT's current position in the visual
4202 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4206 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4208 charpos
= it_copy
.bidi_it
.charpos
;
4211 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4213 if (it
->current
.overlay_string_index
>= 0)
4214 bufpos
= IT_CHARPOS (*it
);
4218 base_face_id
= underlying_face_id (it
);
4220 /* Get the face for ASCII, or unibyte. */
4221 face_id
= face_at_string_position (it
->w
,
4225 &next_check_charpos
,
4228 /* Correct the face for charsets different from ASCII. Do it
4229 for the multibyte case only. The face returned above is
4230 suitable for unibyte text if IT->string is unibyte. */
4231 if (STRING_MULTIBYTE (it
->string
))
4233 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4234 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4236 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4238 c
= string_char_and_length (p
, &len
);
4239 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4244 struct text_pos pos
;
4246 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4247 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4250 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4251 pos
= it
->current
.pos
;
4256 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4259 if (it
->what
== IT_COMPOSITION
)
4261 /* For composition, we must check the position after
4263 pos
.charpos
+= it
->cmp_it
.nchars
;
4264 pos
.bytepos
+= it
->len
;
4267 INC_TEXT_POS (pos
, it
->multibyte_p
);
4274 /* With bidi iteration, the character before the current
4275 in the visual order cannot be found by simple
4276 iteration, because "reverse" reordering is not
4277 supported. Instead, we need to use the move_it_*
4278 family of functions. */
4279 /* Ignore face changes before the first visible
4280 character on this display line. */
4281 if (it
->current_x
<= it
->first_visible_x
)
4283 SAVE_IT (it_copy
, *it
, it_copy_data
);
4284 /* Implementation note: Since move_it_in_display_line
4285 works in the iterator geometry, and thinks the first
4286 character is always the leftmost, even in R2L lines,
4287 we don't need to distinguish between the R2L and L2R
4289 move_it_in_display_line (&it_copy
, ZV
,
4290 it_copy
.current_x
- 1, MOVE_TO_X
);
4291 pos
= it_copy
.current
.pos
;
4292 RESTORE_IT (it
, it
, it_copy_data
);
4296 /* Set charpos to the buffer position of the character
4297 that comes after IT's current position in the visual
4299 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4303 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4306 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4309 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4311 /* Determine face for CHARSET_ASCII, or unibyte. */
4312 face_id
= face_at_buffer_position (it
->w
,
4314 &next_check_charpos
,
4317 /* Correct the face for charsets different from ASCII. Do it
4318 for the multibyte case only. The face returned above is
4319 suitable for unibyte text if current_buffer is unibyte. */
4320 if (it
->multibyte_p
)
4322 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4323 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4324 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4333 /***********************************************************************
4335 ***********************************************************************/
4337 /* Set up iterator IT from invisible properties at its current
4338 position. Called from handle_stop. */
4340 static enum prop_handled
4341 handle_invisible_prop (struct it
*it
)
4343 enum prop_handled handled
= HANDLED_NORMALLY
;
4347 if (STRINGP (it
->string
))
4349 Lisp_Object end_charpos
, limit
, charpos
;
4351 /* Get the value of the invisible text property at the
4352 current position. Value will be nil if there is no such
4354 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4355 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4356 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4358 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4360 /* Record whether we have to display an ellipsis for the
4362 int display_ellipsis_p
= (invis_p
== 2);
4363 ptrdiff_t len
, endpos
;
4365 handled
= HANDLED_RECOMPUTE_PROPS
;
4367 /* Get the position at which the next visible text can be
4368 found in IT->string, if any. */
4369 endpos
= len
= SCHARS (it
->string
);
4370 XSETINT (limit
, len
);
4373 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4375 if (INTEGERP (end_charpos
))
4377 endpos
= XFASTINT (end_charpos
);
4378 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4379 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4381 display_ellipsis_p
= true;
4384 while (invis_p
&& endpos
< len
);
4386 if (display_ellipsis_p
)
4387 it
->ellipsis_p
= true;
4391 /* Text at END_CHARPOS is visible. Move IT there. */
4392 struct text_pos old
;
4395 old
= it
->current
.string_pos
;
4396 oldpos
= CHARPOS (old
);
4399 if (it
->bidi_it
.first_elt
4400 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4401 bidi_paragraph_init (it
->paragraph_embedding
,
4403 /* Bidi-iterate out of the invisible text. */
4406 bidi_move_to_visually_next (&it
->bidi_it
);
4408 while (oldpos
<= it
->bidi_it
.charpos
4409 && it
->bidi_it
.charpos
< endpos
);
4411 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4412 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4413 if (IT_CHARPOS (*it
) >= endpos
)
4414 it
->prev_stop
= endpos
;
4418 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4419 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4424 /* The rest of the string is invisible. If this is an
4425 overlay string, proceed with the next overlay string
4426 or whatever comes and return a character from there. */
4427 if (it
->current
.overlay_string_index
>= 0
4428 && !display_ellipsis_p
)
4430 next_overlay_string (it
);
4431 /* Don't check for overlay strings when we just
4432 finished processing them. */
4433 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4437 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4438 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4445 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4446 Lisp_Object pos
, overlay
;
4448 /* First of all, is there invisible text at this position? */
4449 tem
= start_charpos
= IT_CHARPOS (*it
);
4450 pos
= make_number (tem
);
4451 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4453 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4455 /* If we are on invisible text, skip over it. */
4456 if (invis_p
&& start_charpos
< it
->end_charpos
)
4458 /* Record whether we have to display an ellipsis for the
4460 int display_ellipsis_p
= invis_p
== 2;
4462 handled
= HANDLED_RECOMPUTE_PROPS
;
4464 /* Loop skipping over invisible text. The loop is left at
4465 ZV or with IT on the first char being visible again. */
4468 /* Try to skip some invisible text. Return value is the
4469 position reached which can be equal to where we start
4470 if there is nothing invisible there. This skips both
4471 over invisible text properties and overlays with
4472 invisible property. */
4473 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4475 /* If we skipped nothing at all we weren't at invisible
4476 text in the first place. If everything to the end of
4477 the buffer was skipped, end the loop. */
4478 if (newpos
== tem
|| newpos
>= ZV
)
4482 /* We skipped some characters but not necessarily
4483 all there are. Check if we ended up on visible
4484 text. Fget_char_property returns the property of
4485 the char before the given position, i.e. if we
4486 get invis_p = 0, this means that the char at
4487 newpos is visible. */
4488 pos
= make_number (newpos
);
4489 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4490 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4493 /* If we ended up on invisible text, proceed to
4494 skip starting with next_stop. */
4498 /* If there are adjacent invisible texts, don't lose the
4499 second one's ellipsis. */
4501 display_ellipsis_p
= true;
4505 /* The position newpos is now either ZV or on visible text. */
4508 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4510 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4512 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4514 /* If the invisible text ends on a newline or on a
4515 character after a newline, we can avoid the costly,
4516 character by character, bidi iteration to NEWPOS, and
4517 instead simply reseat the iterator there. That's
4518 because all bidi reordering information is tossed at
4519 the newline. This is a big win for modes that hide
4520 complete lines, like Outline, Org, etc. */
4521 if (on_newline
|| after_newline
)
4523 struct text_pos tpos
;
4524 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4526 SET_TEXT_POS (tpos
, newpos
, bpos
);
4527 reseat_1 (it
, tpos
, 0);
4528 /* If we reseat on a newline/ZV, we need to prep the
4529 bidi iterator for advancing to the next character
4530 after the newline/EOB, keeping the current paragraph
4531 direction (so that PRODUCE_GLYPHS does TRT wrt
4532 prepending/appending glyphs to a glyph row). */
4535 it
->bidi_it
.first_elt
= 0;
4536 it
->bidi_it
.paragraph_dir
= pdir
;
4537 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4538 it
->bidi_it
.nchars
= 1;
4539 it
->bidi_it
.ch_len
= 1;
4542 else /* Must use the slow method. */
4544 /* With bidi iteration, the region of invisible text
4545 could start and/or end in the middle of a
4546 non-base embedding level. Therefore, we need to
4547 skip invisible text using the bidi iterator,
4548 starting at IT's current position, until we find
4549 ourselves outside of the invisible text.
4550 Skipping invisible text _after_ bidi iteration
4551 avoids affecting the visual order of the
4552 displayed text when invisible properties are
4553 added or removed. */
4554 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4556 /* If we were `reseat'ed to a new paragraph,
4557 determine the paragraph base direction. We
4558 need to do it now because
4559 next_element_from_buffer may not have a
4560 chance to do it, if we are going to skip any
4561 text at the beginning, which resets the
4563 bidi_paragraph_init (it
->paragraph_embedding
,
4568 bidi_move_to_visually_next (&it
->bidi_it
);
4570 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4571 && it
->bidi_it
.charpos
< newpos
);
4572 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4573 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4574 /* If we overstepped NEWPOS, record its position in
4575 the iterator, so that we skip invisible text if
4576 later the bidi iteration lands us in the
4577 invisible region again. */
4578 if (IT_CHARPOS (*it
) >= newpos
)
4579 it
->prev_stop
= newpos
;
4584 IT_CHARPOS (*it
) = newpos
;
4585 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4588 /* If there are before-strings at the start of invisible
4589 text, and the text is invisible because of a text
4590 property, arrange to show before-strings because 20.x did
4591 it that way. (If the text is invisible because of an
4592 overlay property instead of a text property, this is
4593 already handled in the overlay code.) */
4595 && get_overlay_strings (it
, it
->stop_charpos
))
4597 handled
= HANDLED_RECOMPUTE_PROPS
;
4600 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4601 /* The call to get_overlay_strings above recomputes
4602 it->stop_charpos, but it only considers changes
4603 in properties and overlays beyond iterator's
4604 current position. This causes us to miss changes
4605 that happen exactly where the invisible property
4606 ended. So we play it safe here and force the
4607 iterator to check for potential stop positions
4608 immediately after the invisible text. Note that
4609 if get_overlay_strings returns non-zero, it
4610 normally also pushed the iterator stack, so we
4611 need to update the stop position in the slot
4612 below the current one. */
4613 it
->stack
[it
->sp
- 1].stop_charpos
4614 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4617 else if (display_ellipsis_p
)
4619 /* Make sure that the glyphs of the ellipsis will get
4620 correct `charpos' values. If we would not update
4621 it->position here, the glyphs would belong to the
4622 last visible character _before_ the invisible
4623 text, which confuses `set_cursor_from_row'.
4625 We use the last invisible position instead of the
4626 first because this way the cursor is always drawn on
4627 the first "." of the ellipsis, whenever PT is inside
4628 the invisible text. Otherwise the cursor would be
4629 placed _after_ the ellipsis when the point is after the
4630 first invisible character. */
4631 if (!STRINGP (it
->object
))
4633 it
->position
.charpos
= newpos
- 1;
4634 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4636 it
->ellipsis_p
= true;
4637 /* Let the ellipsis display before
4638 considering any properties of the following char.
4639 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4640 handled
= HANDLED_RETURN
;
4649 /* Make iterator IT return `...' next.
4650 Replaces LEN characters from buffer. */
4653 setup_for_ellipsis (struct it
*it
, int len
)
4655 /* Use the display table definition for `...'. Invalid glyphs
4656 will be handled by the method returning elements from dpvec. */
4657 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4659 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4660 it
->dpvec
= v
->contents
;
4661 it
->dpend
= v
->contents
+ v
->header
.size
;
4665 /* Default `...'. */
4666 it
->dpvec
= default_invis_vector
;
4667 it
->dpend
= default_invis_vector
+ 3;
4670 it
->dpvec_char_len
= len
;
4671 it
->current
.dpvec_index
= 0;
4672 it
->dpvec_face_id
= -1;
4674 /* Remember the current face id in case glyphs specify faces.
4675 IT's face is restored in set_iterator_to_next.
4676 saved_face_id was set to preceding char's face in handle_stop. */
4677 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4678 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4680 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4681 it
->ellipsis_p
= true;
4686 /***********************************************************************
4688 ***********************************************************************/
4690 /* Set up iterator IT from `display' property at its current position.
4691 Called from handle_stop.
4692 We return HANDLED_RETURN if some part of the display property
4693 overrides the display of the buffer text itself.
4694 Otherwise we return HANDLED_NORMALLY. */
4696 static enum prop_handled
4697 handle_display_prop (struct it
*it
)
4699 Lisp_Object propval
, object
, overlay
;
4700 struct text_pos
*position
;
4702 /* Nonzero if some property replaces the display of the text itself. */
4703 int display_replaced_p
= 0;
4705 if (STRINGP (it
->string
))
4707 object
= it
->string
;
4708 position
= &it
->current
.string_pos
;
4709 bufpos
= CHARPOS (it
->current
.pos
);
4713 XSETWINDOW (object
, it
->w
);
4714 position
= &it
->current
.pos
;
4715 bufpos
= CHARPOS (*position
);
4718 /* Reset those iterator values set from display property values. */
4719 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4720 it
->space_width
= Qnil
;
4721 it
->font_height
= Qnil
;
4724 /* We don't support recursive `display' properties, i.e. string
4725 values that have a string `display' property, that have a string
4726 `display' property etc. */
4727 if (!it
->string_from_display_prop_p
)
4728 it
->area
= TEXT_AREA
;
4730 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4731 Qdisplay
, object
, &overlay
);
4733 return HANDLED_NORMALLY
;
4734 /* Now OVERLAY is the overlay that gave us this property, or nil
4735 if it was a text property. */
4737 if (!STRINGP (it
->string
))
4738 object
= it
->w
->contents
;
4740 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4742 FRAME_WINDOW_P (it
->f
));
4744 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4747 /* Subroutine of handle_display_prop. Returns non-zero if the display
4748 specification in SPEC is a replacing specification, i.e. it would
4749 replace the text covered by `display' property with something else,
4750 such as an image or a display string. If SPEC includes any kind or
4751 `(space ...) specification, the value is 2; this is used by
4752 compute_display_string_pos, which see.
4754 See handle_single_display_spec for documentation of arguments.
4755 frame_window_p is non-zero if the window being redisplayed is on a
4756 GUI frame; this argument is used only if IT is NULL, see below.
4758 IT can be NULL, if this is called by the bidi reordering code
4759 through compute_display_string_pos, which see. In that case, this
4760 function only examines SPEC, but does not otherwise "handle" it, in
4761 the sense that it doesn't set up members of IT from the display
4764 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4765 Lisp_Object overlay
, struct text_pos
*position
,
4766 ptrdiff_t bufpos
, int frame_window_p
)
4768 int replacing_p
= 0;
4772 /* Simple specifications. */
4773 && !EQ (XCAR (spec
), Qimage
)
4774 && !EQ (XCAR (spec
), Qspace
)
4775 && !EQ (XCAR (spec
), Qwhen
)
4776 && !EQ (XCAR (spec
), Qslice
)
4777 && !EQ (XCAR (spec
), Qspace_width
)
4778 && !EQ (XCAR (spec
), Qheight
)
4779 && !EQ (XCAR (spec
), Qraise
)
4780 /* Marginal area specifications. */
4781 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4782 && !EQ (XCAR (spec
), Qleft_fringe
)
4783 && !EQ (XCAR (spec
), Qright_fringe
)
4784 && !NILP (XCAR (spec
)))
4786 for (; CONSP (spec
); spec
= XCDR (spec
))
4788 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4789 overlay
, position
, bufpos
,
4790 replacing_p
, frame_window_p
)))
4793 /* If some text in a string is replaced, `position' no
4794 longer points to the position of `object'. */
4795 if (!it
|| STRINGP (object
))
4800 else if (VECTORP (spec
))
4803 for (i
= 0; i
< ASIZE (spec
); ++i
)
4804 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4805 overlay
, position
, bufpos
,
4806 replacing_p
, frame_window_p
)))
4809 /* If some text in a string is replaced, `position' no
4810 longer points to the position of `object'. */
4811 if (!it
|| STRINGP (object
))
4817 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4818 position
, bufpos
, 0,
4826 /* Value is the position of the end of the `display' property starting
4827 at START_POS in OBJECT. */
4829 static struct text_pos
4830 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4833 struct text_pos end_pos
;
4835 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4836 Qdisplay
, object
, Qnil
);
4837 CHARPOS (end_pos
) = XFASTINT (end
);
4838 if (STRINGP (object
))
4839 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4841 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4847 /* Set up IT from a single `display' property specification SPEC. OBJECT
4848 is the object in which the `display' property was found. *POSITION
4849 is the position in OBJECT at which the `display' property was found.
4850 BUFPOS is the buffer position of OBJECT (different from POSITION if
4851 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4852 previously saw a display specification which already replaced text
4853 display with something else, for example an image; we ignore such
4854 properties after the first one has been processed.
4856 OVERLAY is the overlay this `display' property came from,
4857 or nil if it was a text property.
4859 If SPEC is a `space' or `image' specification, and in some other
4860 cases too, set *POSITION to the position where the `display'
4863 If IT is NULL, only examine the property specification in SPEC, but
4864 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4865 is intended to be displayed in a window on a GUI frame.
4867 Value is non-zero if something was found which replaces the display
4868 of buffer or string text. */
4871 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4872 Lisp_Object overlay
, struct text_pos
*position
,
4873 ptrdiff_t bufpos
, int display_replaced_p
,
4877 Lisp_Object location
, value
;
4878 struct text_pos start_pos
= *position
;
4881 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4882 If the result is non-nil, use VALUE instead of SPEC. */
4884 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4893 if (!NILP (form
) && !EQ (form
, Qt
))
4895 ptrdiff_t count
= SPECPDL_INDEX ();
4896 struct gcpro gcpro1
;
4898 /* Bind `object' to the object having the `display' property, a
4899 buffer or string. Bind `position' to the position in the
4900 object where the property was found, and `buffer-position'
4901 to the current position in the buffer. */
4904 XSETBUFFER (object
, current_buffer
);
4905 specbind (Qobject
, object
);
4906 specbind (Qposition
, make_number (CHARPOS (*position
)));
4907 specbind (Qbuffer_position
, make_number (bufpos
));
4909 form
= safe_eval (form
);
4911 unbind_to (count
, Qnil
);
4917 /* Handle `(height HEIGHT)' specifications. */
4919 && EQ (XCAR (spec
), Qheight
)
4920 && CONSP (XCDR (spec
)))
4924 if (!FRAME_WINDOW_P (it
->f
))
4927 it
->font_height
= XCAR (XCDR (spec
));
4928 if (!NILP (it
->font_height
))
4930 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4931 int new_height
= -1;
4933 if (CONSP (it
->font_height
)
4934 && (EQ (XCAR (it
->font_height
), Qplus
)
4935 || EQ (XCAR (it
->font_height
), Qminus
))
4936 && CONSP (XCDR (it
->font_height
))
4937 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4939 /* `(+ N)' or `(- N)' where N is an integer. */
4940 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4941 if (EQ (XCAR (it
->font_height
), Qplus
))
4943 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4945 else if (FUNCTIONP (it
->font_height
))
4947 /* Call function with current height as argument.
4948 Value is the new height. */
4950 height
= safe_call1 (it
->font_height
,
4951 face
->lface
[LFACE_HEIGHT_INDEX
]);
4952 if (NUMBERP (height
))
4953 new_height
= XFLOATINT (height
);
4955 else if (NUMBERP (it
->font_height
))
4957 /* Value is a multiple of the canonical char height. */
4960 f
= FACE_FROM_ID (it
->f
,
4961 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4962 new_height
= (XFLOATINT (it
->font_height
)
4963 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4967 /* Evaluate IT->font_height with `height' bound to the
4968 current specified height to get the new height. */
4969 ptrdiff_t count
= SPECPDL_INDEX ();
4971 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4972 value
= safe_eval (it
->font_height
);
4973 unbind_to (count
, Qnil
);
4975 if (NUMBERP (value
))
4976 new_height
= XFLOATINT (value
);
4980 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4987 /* Handle `(space-width WIDTH)'. */
4989 && EQ (XCAR (spec
), Qspace_width
)
4990 && CONSP (XCDR (spec
)))
4994 if (!FRAME_WINDOW_P (it
->f
))
4997 value
= XCAR (XCDR (spec
));
4998 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4999 it
->space_width
= value
;
5005 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5007 && EQ (XCAR (spec
), Qslice
))
5013 if (!FRAME_WINDOW_P (it
->f
))
5016 if (tem
= XCDR (spec
), CONSP (tem
))
5018 it
->slice
.x
= XCAR (tem
);
5019 if (tem
= XCDR (tem
), CONSP (tem
))
5021 it
->slice
.y
= XCAR (tem
);
5022 if (tem
= XCDR (tem
), CONSP (tem
))
5024 it
->slice
.width
= XCAR (tem
);
5025 if (tem
= XCDR (tem
), CONSP (tem
))
5026 it
->slice
.height
= XCAR (tem
);
5035 /* Handle `(raise FACTOR)'. */
5037 && EQ (XCAR (spec
), Qraise
)
5038 && CONSP (XCDR (spec
)))
5042 if (!FRAME_WINDOW_P (it
->f
))
5045 #ifdef HAVE_WINDOW_SYSTEM
5046 value
= XCAR (XCDR (spec
));
5047 if (NUMBERP (value
))
5049 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5050 it
->voffset
= - (XFLOATINT (value
)
5051 * (FONT_HEIGHT (face
->font
)));
5053 #endif /* HAVE_WINDOW_SYSTEM */
5059 /* Don't handle the other kinds of display specifications
5060 inside a string that we got from a `display' property. */
5061 if (it
&& it
->string_from_display_prop_p
)
5064 /* Characters having this form of property are not displayed, so
5065 we have to find the end of the property. */
5068 start_pos
= *position
;
5069 *position
= display_prop_end (it
, object
, start_pos
);
5073 /* Stop the scan at that end position--we assume that all
5074 text properties change there. */
5076 it
->stop_charpos
= position
->charpos
;
5078 /* Handle `(left-fringe BITMAP [FACE])'
5079 and `(right-fringe BITMAP [FACE])'. */
5081 && (EQ (XCAR (spec
), Qleft_fringe
)
5082 || EQ (XCAR (spec
), Qright_fringe
))
5083 && CONSP (XCDR (spec
)))
5089 if (!FRAME_WINDOW_P (it
->f
))
5090 /* If we return here, POSITION has been advanced
5091 across the text with this property. */
5093 /* Synchronize the bidi iterator with POSITION. This is
5094 needed because we are not going to push the iterator
5095 on behalf of this display property, so there will be
5096 no pop_it call to do this synchronization for us. */
5099 it
->position
= *position
;
5100 iterate_out_of_display_property (it
);
5101 *position
= it
->position
;
5106 else if (!frame_window_p
)
5109 #ifdef HAVE_WINDOW_SYSTEM
5110 value
= XCAR (XCDR (spec
));
5111 if (!SYMBOLP (value
)
5112 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5113 /* If we return here, POSITION has been advanced
5114 across the text with this property. */
5116 if (it
&& it
->bidi_p
)
5118 it
->position
= *position
;
5119 iterate_out_of_display_property (it
);
5120 *position
= it
->position
;
5127 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5129 if (CONSP (XCDR (XCDR (spec
))))
5131 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5132 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5138 /* Save current settings of IT so that we can restore them
5139 when we are finished with the glyph property value. */
5140 push_it (it
, position
);
5142 it
->area
= TEXT_AREA
;
5143 it
->what
= IT_IMAGE
;
5144 it
->image_id
= -1; /* no image */
5145 it
->position
= start_pos
;
5146 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5147 it
->method
= GET_FROM_IMAGE
;
5148 it
->from_overlay
= Qnil
;
5149 it
->face_id
= face_id
;
5150 it
->from_disp_prop_p
= true;
5152 /* Say that we haven't consumed the characters with
5153 `display' property yet. The call to pop_it in
5154 set_iterator_to_next will clean this up. */
5155 *position
= start_pos
;
5157 if (EQ (XCAR (spec
), Qleft_fringe
))
5159 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5160 it
->left_user_fringe_face_id
= face_id
;
5164 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5165 it
->right_user_fringe_face_id
= face_id
;
5168 #endif /* HAVE_WINDOW_SYSTEM */
5172 /* Prepare to handle `((margin left-margin) ...)',
5173 `((margin right-margin) ...)' and `((margin nil) ...)'
5174 prefixes for display specifications. */
5175 location
= Qunbound
;
5176 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5180 value
= XCDR (spec
);
5182 value
= XCAR (value
);
5185 if (EQ (XCAR (tem
), Qmargin
)
5186 && (tem
= XCDR (tem
),
5187 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5189 || EQ (tem
, Qleft_margin
)
5190 || EQ (tem
, Qright_margin
))))
5194 if (EQ (location
, Qunbound
))
5200 /* After this point, VALUE is the property after any
5201 margin prefix has been stripped. It must be a string,
5202 an image specification, or `(space ...)'.
5204 LOCATION specifies where to display: `left-margin',
5205 `right-margin' or nil. */
5207 valid_p
= (STRINGP (value
)
5208 #ifdef HAVE_WINDOW_SYSTEM
5209 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5210 && valid_image_p (value
))
5211 #endif /* not HAVE_WINDOW_SYSTEM */
5212 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5214 if (valid_p
&& !display_replaced_p
)
5220 /* Callers need to know whether the display spec is any kind
5221 of `(space ...)' spec that is about to affect text-area
5223 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5228 /* Save current settings of IT so that we can restore them
5229 when we are finished with the glyph property value. */
5230 push_it (it
, position
);
5231 it
->from_overlay
= overlay
;
5232 it
->from_disp_prop_p
= true;
5234 if (NILP (location
))
5235 it
->area
= TEXT_AREA
;
5236 else if (EQ (location
, Qleft_margin
))
5237 it
->area
= LEFT_MARGIN_AREA
;
5239 it
->area
= RIGHT_MARGIN_AREA
;
5241 if (STRINGP (value
))
5244 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5245 it
->current
.overlay_string_index
= -1;
5246 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5247 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5248 it
->method
= GET_FROM_STRING
;
5249 it
->stop_charpos
= 0;
5251 it
->base_level_stop
= 0;
5252 it
->string_from_display_prop_p
= true;
5253 /* Say that we haven't consumed the characters with
5254 `display' property yet. The call to pop_it in
5255 set_iterator_to_next will clean this up. */
5256 if (BUFFERP (object
))
5257 *position
= start_pos
;
5259 /* Force paragraph direction to be that of the parent
5260 object. If the parent object's paragraph direction is
5261 not yet determined, default to L2R. */
5262 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5263 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5265 it
->paragraph_embedding
= L2R
;
5267 /* Set up the bidi iterator for this display string. */
5270 it
->bidi_it
.string
.lstring
= it
->string
;
5271 it
->bidi_it
.string
.s
= NULL
;
5272 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5273 it
->bidi_it
.string
.bufpos
= bufpos
;
5274 it
->bidi_it
.string
.from_disp_str
= 1;
5275 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5276 it
->bidi_it
.w
= it
->w
;
5277 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5280 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5282 it
->method
= GET_FROM_STRETCH
;
5284 *position
= it
->position
= start_pos
;
5285 retval
= 1 + (it
->area
== TEXT_AREA
);
5287 #ifdef HAVE_WINDOW_SYSTEM
5290 it
->what
= IT_IMAGE
;
5291 it
->image_id
= lookup_image (it
->f
, value
);
5292 it
->position
= start_pos
;
5293 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5294 it
->method
= GET_FROM_IMAGE
;
5296 /* Say that we haven't consumed the characters with
5297 `display' property yet. The call to pop_it in
5298 set_iterator_to_next will clean this up. */
5299 *position
= start_pos
;
5301 #endif /* HAVE_WINDOW_SYSTEM */
5306 /* Invalid property or property not supported. Restore
5307 POSITION to what it was before. */
5308 *position
= start_pos
;
5312 /* Check if PROP is a display property value whose text should be
5313 treated as intangible. OVERLAY is the overlay from which PROP
5314 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5315 specify the buffer position covered by PROP. */
5318 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5319 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5321 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5322 struct text_pos position
;
5324 SET_TEXT_POS (position
, charpos
, bytepos
);
5325 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5326 &position
, charpos
, frame_window_p
);
5330 /* Return 1 if PROP is a display sub-property value containing STRING.
5332 Implementation note: this and the following function are really
5333 special cases of handle_display_spec and
5334 handle_single_display_spec, and should ideally use the same code.
5335 Until they do, these two pairs must be consistent and must be
5336 modified in sync. */
5339 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5341 if (EQ (string
, prop
))
5344 /* Skip over `when FORM'. */
5345 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5350 /* Actually, the condition following `when' should be eval'ed,
5351 like handle_single_display_spec does, and we should return
5352 zero if it evaluates to nil. However, this function is
5353 called only when the buffer was already displayed and some
5354 glyph in the glyph matrix was found to come from a display
5355 string. Therefore, the condition was already evaluated, and
5356 the result was non-nil, otherwise the display string wouldn't
5357 have been displayed and we would have never been called for
5358 this property. Thus, we can skip the evaluation and assume
5359 its result is non-nil. */
5364 /* Skip over `margin LOCATION'. */
5365 if (EQ (XCAR (prop
), Qmargin
))
5376 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5380 /* Return 1 if STRING appears in the `display' property PROP. */
5383 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5386 && !EQ (XCAR (prop
), Qwhen
)
5387 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5389 /* A list of sub-properties. */
5390 while (CONSP (prop
))
5392 if (single_display_spec_string_p (XCAR (prop
), string
))
5397 else if (VECTORP (prop
))
5399 /* A vector of sub-properties. */
5401 for (i
= 0; i
< ASIZE (prop
); ++i
)
5402 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5406 return single_display_spec_string_p (prop
, string
);
5411 /* Look for STRING in overlays and text properties in the current
5412 buffer, between character positions FROM and TO (excluding TO).
5413 BACK_P non-zero means look back (in this case, TO is supposed to be
5415 Value is the first character position where STRING was found, or
5416 zero if it wasn't found before hitting TO.
5418 This function may only use code that doesn't eval because it is
5419 called asynchronously from note_mouse_highlight. */
5422 string_buffer_position_lim (Lisp_Object string
,
5423 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5425 Lisp_Object limit
, prop
, pos
;
5428 pos
= make_number (max (from
, BEGV
));
5430 if (!back_p
) /* looking forward */
5432 limit
= make_number (min (to
, ZV
));
5433 while (!found
&& !EQ (pos
, limit
))
5435 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5436 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5439 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5443 else /* looking back */
5445 limit
= make_number (max (to
, BEGV
));
5446 while (!found
&& !EQ (pos
, limit
))
5448 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5449 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5452 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5457 return found
? XINT (pos
) : 0;
5460 /* Determine which buffer position in current buffer STRING comes from.
5461 AROUND_CHARPOS is an approximate position where it could come from.
5462 Value is the buffer position or 0 if it couldn't be determined.
5464 This function is necessary because we don't record buffer positions
5465 in glyphs generated from strings (to keep struct glyph small).
5466 This function may only use code that doesn't eval because it is
5467 called asynchronously from note_mouse_highlight. */
5470 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5472 const int MAX_DISTANCE
= 1000;
5473 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5474 around_charpos
+ MAX_DISTANCE
,
5478 found
= string_buffer_position_lim (string
, around_charpos
,
5479 around_charpos
- MAX_DISTANCE
, 1);
5485 /***********************************************************************
5486 `composition' property
5487 ***********************************************************************/
5489 /* Set up iterator IT from `composition' property at its current
5490 position. Called from handle_stop. */
5492 static enum prop_handled
5493 handle_composition_prop (struct it
*it
)
5495 Lisp_Object prop
, string
;
5496 ptrdiff_t pos
, pos_byte
, start
, end
;
5498 if (STRINGP (it
->string
))
5502 pos
= IT_STRING_CHARPOS (*it
);
5503 pos_byte
= IT_STRING_BYTEPOS (*it
);
5504 string
= it
->string
;
5505 s
= SDATA (string
) + pos_byte
;
5506 it
->c
= STRING_CHAR (s
);
5510 pos
= IT_CHARPOS (*it
);
5511 pos_byte
= IT_BYTEPOS (*it
);
5513 it
->c
= FETCH_CHAR (pos_byte
);
5516 /* If there's a valid composition and point is not inside of the
5517 composition (in the case that the composition is from the current
5518 buffer), draw a glyph composed from the composition components. */
5519 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5520 && composition_valid_p (start
, end
, prop
)
5521 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5524 /* As we can't handle this situation (perhaps font-lock added
5525 a new composition), we just return here hoping that next
5526 redisplay will detect this composition much earlier. */
5527 return HANDLED_NORMALLY
;
5530 if (STRINGP (it
->string
))
5531 pos_byte
= string_char_to_byte (it
->string
, start
);
5533 pos_byte
= CHAR_TO_BYTE (start
);
5535 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5538 if (it
->cmp_it
.id
>= 0)
5541 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5542 it
->cmp_it
.nglyphs
= -1;
5546 return HANDLED_NORMALLY
;
5551 /***********************************************************************
5553 ***********************************************************************/
5555 /* The following structure is used to record overlay strings for
5556 later sorting in load_overlay_strings. */
5558 struct overlay_entry
5560 Lisp_Object overlay
;
5567 /* Set up iterator IT from overlay strings at its current position.
5568 Called from handle_stop. */
5570 static enum prop_handled
5571 handle_overlay_change (struct it
*it
)
5573 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5574 return HANDLED_RECOMPUTE_PROPS
;
5576 return HANDLED_NORMALLY
;
5580 /* Set up the next overlay string for delivery by IT, if there is an
5581 overlay string to deliver. Called by set_iterator_to_next when the
5582 end of the current overlay string is reached. If there are more
5583 overlay strings to display, IT->string and
5584 IT->current.overlay_string_index are set appropriately here.
5585 Otherwise IT->string is set to nil. */
5588 next_overlay_string (struct it
*it
)
5590 ++it
->current
.overlay_string_index
;
5591 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5593 /* No more overlay strings. Restore IT's settings to what
5594 they were before overlay strings were processed, and
5595 continue to deliver from current_buffer. */
5597 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5600 || (NILP (it
->string
)
5601 && it
->method
== GET_FROM_BUFFER
5602 && it
->stop_charpos
>= BEGV
5603 && it
->stop_charpos
<= it
->end_charpos
));
5604 it
->current
.overlay_string_index
= -1;
5605 it
->n_overlay_strings
= 0;
5606 it
->overlay_strings_charpos
= -1;
5607 /* If there's an empty display string on the stack, pop the
5608 stack, to resync the bidi iterator with IT's position. Such
5609 empty strings are pushed onto the stack in
5610 get_overlay_strings_1. */
5611 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5614 /* If we're at the end of the buffer, record that we have
5615 processed the overlay strings there already, so that
5616 next_element_from_buffer doesn't try it again. */
5617 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5618 it
->overlay_strings_at_end_processed_p
= true;
5622 /* There are more overlay strings to process. If
5623 IT->current.overlay_string_index has advanced to a position
5624 where we must load IT->overlay_strings with more strings, do
5625 it. We must load at the IT->overlay_strings_charpos where
5626 IT->n_overlay_strings was originally computed; when invisible
5627 text is present, this might not be IT_CHARPOS (Bug#7016). */
5628 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5630 if (it
->current
.overlay_string_index
&& i
== 0)
5631 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5633 /* Initialize IT to deliver display elements from the overlay
5635 it
->string
= it
->overlay_strings
[i
];
5636 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5637 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5638 it
->method
= GET_FROM_STRING
;
5639 it
->stop_charpos
= 0;
5640 it
->end_charpos
= SCHARS (it
->string
);
5641 if (it
->cmp_it
.stop_pos
>= 0)
5642 it
->cmp_it
.stop_pos
= 0;
5644 it
->base_level_stop
= 0;
5646 /* Set up the bidi iterator for this overlay string. */
5649 it
->bidi_it
.string
.lstring
= it
->string
;
5650 it
->bidi_it
.string
.s
= NULL
;
5651 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5652 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5653 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5654 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5655 it
->bidi_it
.w
= it
->w
;
5656 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5664 /* Compare two overlay_entry structures E1 and E2. Used as a
5665 comparison function for qsort in load_overlay_strings. Overlay
5666 strings for the same position are sorted so that
5668 1. All after-strings come in front of before-strings, except
5669 when they come from the same overlay.
5671 2. Within after-strings, strings are sorted so that overlay strings
5672 from overlays with higher priorities come first.
5674 2. Within before-strings, strings are sorted so that overlay
5675 strings from overlays with higher priorities come last.
5677 Value is analogous to strcmp. */
5681 compare_overlay_entries (const void *e1
, const void *e2
)
5683 struct overlay_entry
const *entry1
= e1
;
5684 struct overlay_entry
const *entry2
= e2
;
5687 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5689 /* Let after-strings appear in front of before-strings if
5690 they come from different overlays. */
5691 if (EQ (entry1
->overlay
, entry2
->overlay
))
5692 result
= entry1
->after_string_p
? 1 : -1;
5694 result
= entry1
->after_string_p
? -1 : 1;
5696 else if (entry1
->priority
!= entry2
->priority
)
5698 if (entry1
->after_string_p
)
5699 /* After-strings sorted in order of decreasing priority. */
5700 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5702 /* Before-strings sorted in order of increasing priority. */
5703 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5712 /* Load the vector IT->overlay_strings with overlay strings from IT's
5713 current buffer position, or from CHARPOS if that is > 0. Set
5714 IT->n_overlays to the total number of overlay strings found.
5716 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5717 a time. On entry into load_overlay_strings,
5718 IT->current.overlay_string_index gives the number of overlay
5719 strings that have already been loaded by previous calls to this
5722 IT->add_overlay_start contains an additional overlay start
5723 position to consider for taking overlay strings from, if non-zero.
5724 This position comes into play when the overlay has an `invisible'
5725 property, and both before and after-strings. When we've skipped to
5726 the end of the overlay, because of its `invisible' property, we
5727 nevertheless want its before-string to appear.
5728 IT->add_overlay_start will contain the overlay start position
5731 Overlay strings are sorted so that after-string strings come in
5732 front of before-string strings. Within before and after-strings,
5733 strings are sorted by overlay priority. See also function
5734 compare_overlay_entries. */
5737 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5739 Lisp_Object overlay
, window
, str
, invisible
;
5740 struct Lisp_Overlay
*ov
;
5741 ptrdiff_t start
, end
;
5742 ptrdiff_t n
= 0, i
, j
;
5744 struct overlay_entry entriesbuf
[20];
5745 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5746 struct overlay_entry
*entries
= entriesbuf
;
5750 charpos
= IT_CHARPOS (*it
);
5752 /* Append the overlay string STRING of overlay OVERLAY to vector
5753 `entries' which has size `size' and currently contains `n'
5754 elements. AFTER_P non-zero means STRING is an after-string of
5756 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5759 Lisp_Object priority; \
5763 struct overlay_entry *old = entries; \
5764 SAFE_NALLOCA (entries, 2, size); \
5765 memcpy (entries, old, size * sizeof *entries); \
5769 entries[n].string = (STRING); \
5770 entries[n].overlay = (OVERLAY); \
5771 priority = Foverlay_get ((OVERLAY), Qpriority); \
5772 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5773 entries[n].after_string_p = (AFTER_P); \
5778 /* Process overlay before the overlay center. */
5779 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5781 XSETMISC (overlay
, ov
);
5782 eassert (OVERLAYP (overlay
));
5783 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5784 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5789 /* Skip this overlay if it doesn't start or end at IT's current
5791 if (end
!= charpos
&& start
!= charpos
)
5794 /* Skip this overlay if it doesn't apply to IT->w. */
5795 window
= Foverlay_get (overlay
, Qwindow
);
5796 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5799 /* If the text ``under'' the overlay is invisible, both before-
5800 and after-strings from this overlay are visible; start and
5801 end position are indistinguishable. */
5802 invisible
= Foverlay_get (overlay
, Qinvisible
);
5803 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5805 /* If overlay has a non-empty before-string, record it. */
5806 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5807 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5809 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5811 /* If overlay has a non-empty after-string, record it. */
5812 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5813 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5815 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5818 /* Process overlays after the overlay center. */
5819 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5821 XSETMISC (overlay
, ov
);
5822 eassert (OVERLAYP (overlay
));
5823 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5824 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5826 if (start
> charpos
)
5829 /* Skip this overlay if it doesn't start or end at IT's current
5831 if (end
!= charpos
&& start
!= charpos
)
5834 /* Skip this overlay if it doesn't apply to IT->w. */
5835 window
= Foverlay_get (overlay
, Qwindow
);
5836 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5839 /* If the text ``under'' the overlay is invisible, it has a zero
5840 dimension, and both before- and after-strings apply. */
5841 invisible
= Foverlay_get (overlay
, Qinvisible
);
5842 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5844 /* If overlay has a non-empty before-string, record it. */
5845 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5846 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5848 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5850 /* If overlay has a non-empty after-string, record it. */
5851 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5852 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5854 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5857 #undef RECORD_OVERLAY_STRING
5861 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5863 /* Record number of overlay strings, and where we computed it. */
5864 it
->n_overlay_strings
= n
;
5865 it
->overlay_strings_charpos
= charpos
;
5867 /* IT->current.overlay_string_index is the number of overlay strings
5868 that have already been consumed by IT. Copy some of the
5869 remaining overlay strings to IT->overlay_strings. */
5871 j
= it
->current
.overlay_string_index
;
5872 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5874 it
->overlay_strings
[i
] = entries
[j
].string
;
5875 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5883 /* Get the first chunk of overlay strings at IT's current buffer
5884 position, or at CHARPOS if that is > 0. Value is non-zero if at
5885 least one overlay string was found. */
5888 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5890 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5891 process. This fills IT->overlay_strings with strings, and sets
5892 IT->n_overlay_strings to the total number of strings to process.
5893 IT->pos.overlay_string_index has to be set temporarily to zero
5894 because load_overlay_strings needs this; it must be set to -1
5895 when no overlay strings are found because a zero value would
5896 indicate a position in the first overlay string. */
5897 it
->current
.overlay_string_index
= 0;
5898 load_overlay_strings (it
, charpos
);
5900 /* If we found overlay strings, set up IT to deliver display
5901 elements from the first one. Otherwise set up IT to deliver
5902 from current_buffer. */
5903 if (it
->n_overlay_strings
)
5905 /* Make sure we know settings in current_buffer, so that we can
5906 restore meaningful values when we're done with the overlay
5909 compute_stop_pos (it
);
5910 eassert (it
->face_id
>= 0);
5912 /* Save IT's settings. They are restored after all overlay
5913 strings have been processed. */
5914 eassert (!compute_stop_p
|| it
->sp
== 0);
5916 /* When called from handle_stop, there might be an empty display
5917 string loaded. In that case, don't bother saving it. But
5918 don't use this optimization with the bidi iterator, since we
5919 need the corresponding pop_it call to resync the bidi
5920 iterator's position with IT's position, after we are done
5921 with the overlay strings. (The corresponding call to pop_it
5922 in case of an empty display string is in
5923 next_overlay_string.) */
5925 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5928 /* Set up IT to deliver display elements from the first overlay
5930 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5931 it
->string
= it
->overlay_strings
[0];
5932 it
->from_overlay
= Qnil
;
5933 it
->stop_charpos
= 0;
5934 eassert (STRINGP (it
->string
));
5935 it
->end_charpos
= SCHARS (it
->string
);
5937 it
->base_level_stop
= 0;
5938 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5939 it
->method
= GET_FROM_STRING
;
5940 it
->from_disp_prop_p
= 0;
5942 /* Force paragraph direction to be that of the parent
5944 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5945 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5947 it
->paragraph_embedding
= L2R
;
5949 /* Set up the bidi iterator for this overlay string. */
5952 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5954 it
->bidi_it
.string
.lstring
= it
->string
;
5955 it
->bidi_it
.string
.s
= NULL
;
5956 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5957 it
->bidi_it
.string
.bufpos
= pos
;
5958 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5959 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5960 it
->bidi_it
.w
= it
->w
;
5961 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5966 it
->current
.overlay_string_index
= -1;
5971 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5974 it
->method
= GET_FROM_BUFFER
;
5976 (void) get_overlay_strings_1 (it
, charpos
, 1);
5980 /* Value is non-zero if we found at least one overlay string. */
5981 return STRINGP (it
->string
);
5986 /***********************************************************************
5987 Saving and restoring state
5988 ***********************************************************************/
5990 /* Save current settings of IT on IT->stack. Called, for example,
5991 before setting up IT for an overlay string, to be able to restore
5992 IT's settings to what they were after the overlay string has been
5993 processed. If POSITION is non-NULL, it is the position to save on
5994 the stack instead of IT->position. */
5997 push_it (struct it
*it
, struct text_pos
*position
)
5999 struct iterator_stack_entry
*p
;
6001 eassert (it
->sp
< IT_STACK_SIZE
);
6002 p
= it
->stack
+ it
->sp
;
6004 p
->stop_charpos
= it
->stop_charpos
;
6005 p
->prev_stop
= it
->prev_stop
;
6006 p
->base_level_stop
= it
->base_level_stop
;
6007 p
->cmp_it
= it
->cmp_it
;
6008 eassert (it
->face_id
>= 0);
6009 p
->face_id
= it
->face_id
;
6010 p
->string
= it
->string
;
6011 p
->method
= it
->method
;
6012 p
->from_overlay
= it
->from_overlay
;
6015 case GET_FROM_IMAGE
:
6016 p
->u
.image
.object
= it
->object
;
6017 p
->u
.image
.image_id
= it
->image_id
;
6018 p
->u
.image
.slice
= it
->slice
;
6020 case GET_FROM_STRETCH
:
6021 p
->u
.stretch
.object
= it
->object
;
6024 p
->position
= position
? *position
: it
->position
;
6025 p
->current
= it
->current
;
6026 p
->end_charpos
= it
->end_charpos
;
6027 p
->string_nchars
= it
->string_nchars
;
6029 p
->multibyte_p
= it
->multibyte_p
;
6030 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6031 p
->space_width
= it
->space_width
;
6032 p
->font_height
= it
->font_height
;
6033 p
->voffset
= it
->voffset
;
6034 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6035 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6036 p
->display_ellipsis_p
= 0;
6037 p
->line_wrap
= it
->line_wrap
;
6038 p
->bidi_p
= it
->bidi_p
;
6039 p
->paragraph_embedding
= it
->paragraph_embedding
;
6040 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6043 /* Save the state of the bidi iterator as well. */
6045 bidi_push_it (&it
->bidi_it
);
6049 iterate_out_of_display_property (struct it
*it
)
6051 int buffer_p
= !STRINGP (it
->string
);
6052 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6053 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6055 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6057 /* Maybe initialize paragraph direction. If we are at the beginning
6058 of a new paragraph, next_element_from_buffer may not have a
6059 chance to do that. */
6060 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6061 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6062 /* prev_stop can be zero, so check against BEGV as well. */
6063 while (it
->bidi_it
.charpos
>= bob
6064 && it
->prev_stop
<= it
->bidi_it
.charpos
6065 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6066 && it
->bidi_it
.charpos
< eob
)
6067 bidi_move_to_visually_next (&it
->bidi_it
);
6068 /* Record the stop_pos we just crossed, for when we cross it
6070 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6071 it
->prev_stop
= CHARPOS (it
->position
);
6072 /* If we ended up not where pop_it put us, resync IT's
6073 positional members with the bidi iterator. */
6074 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6075 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6077 it
->current
.pos
= it
->position
;
6079 it
->current
.string_pos
= it
->position
;
6082 /* Restore IT's settings from IT->stack. Called, for example, when no
6083 more overlay strings must be processed, and we return to delivering
6084 display elements from a buffer, or when the end of a string from a
6085 `display' property is reached and we return to delivering display
6086 elements from an overlay string, or from a buffer. */
6089 pop_it (struct it
*it
)
6091 struct iterator_stack_entry
*p
;
6092 int from_display_prop
= it
->from_disp_prop_p
;
6094 eassert (it
->sp
> 0);
6096 p
= it
->stack
+ it
->sp
;
6097 it
->stop_charpos
= p
->stop_charpos
;
6098 it
->prev_stop
= p
->prev_stop
;
6099 it
->base_level_stop
= p
->base_level_stop
;
6100 it
->cmp_it
= p
->cmp_it
;
6101 it
->face_id
= p
->face_id
;
6102 it
->current
= p
->current
;
6103 it
->position
= p
->position
;
6104 it
->string
= p
->string
;
6105 it
->from_overlay
= p
->from_overlay
;
6106 if (NILP (it
->string
))
6107 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6108 it
->method
= p
->method
;
6111 case GET_FROM_IMAGE
:
6112 it
->image_id
= p
->u
.image
.image_id
;
6113 it
->object
= p
->u
.image
.object
;
6114 it
->slice
= p
->u
.image
.slice
;
6116 case GET_FROM_STRETCH
:
6117 it
->object
= p
->u
.stretch
.object
;
6119 case GET_FROM_BUFFER
:
6120 it
->object
= it
->w
->contents
;
6122 case GET_FROM_STRING
:
6124 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6126 /* Restore the face_box_p flag, since it could have been
6127 overwritten by the face of the object that we just finished
6130 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6131 it
->object
= it
->string
;
6134 case GET_FROM_DISPLAY_VECTOR
:
6136 it
->method
= GET_FROM_C_STRING
;
6137 else if (STRINGP (it
->string
))
6138 it
->method
= GET_FROM_STRING
;
6141 it
->method
= GET_FROM_BUFFER
;
6142 it
->object
= it
->w
->contents
;
6145 it
->end_charpos
= p
->end_charpos
;
6146 it
->string_nchars
= p
->string_nchars
;
6148 it
->multibyte_p
= p
->multibyte_p
;
6149 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6150 it
->space_width
= p
->space_width
;
6151 it
->font_height
= p
->font_height
;
6152 it
->voffset
= p
->voffset
;
6153 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6154 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6155 it
->line_wrap
= p
->line_wrap
;
6156 it
->bidi_p
= p
->bidi_p
;
6157 it
->paragraph_embedding
= p
->paragraph_embedding
;
6158 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6161 bidi_pop_it (&it
->bidi_it
);
6162 /* Bidi-iterate until we get out of the portion of text, if any,
6163 covered by a `display' text property or by an overlay with
6164 `display' property. (We cannot just jump there, because the
6165 internal coherency of the bidi iterator state can not be
6166 preserved across such jumps.) We also must determine the
6167 paragraph base direction if the overlay we just processed is
6168 at the beginning of a new paragraph. */
6169 if (from_display_prop
6170 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6171 iterate_out_of_display_property (it
);
6173 eassert ((BUFFERP (it
->object
)
6174 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6175 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6176 || (STRINGP (it
->object
)
6177 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6178 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6179 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6185 /***********************************************************************
6187 ***********************************************************************/
6189 /* Set IT's current position to the previous line start. */
6192 back_to_previous_line_start (struct it
*it
)
6194 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6197 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6201 /* Move IT to the next line start.
6203 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6204 we skipped over part of the text (as opposed to moving the iterator
6205 continuously over the text). Otherwise, don't change the value
6208 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6209 iterator on the newline, if it was found.
6211 Newlines may come from buffer text, overlay strings, or strings
6212 displayed via the `display' property. That's the reason we can't
6213 simply use find_newline_no_quit.
6215 Note that this function may not skip over invisible text that is so
6216 because of text properties and immediately follows a newline. If
6217 it would, function reseat_at_next_visible_line_start, when called
6218 from set_iterator_to_next, would effectively make invisible
6219 characters following a newline part of the wrong glyph row, which
6220 leads to wrong cursor motion. */
6223 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6224 struct bidi_it
*bidi_it_prev
)
6226 ptrdiff_t old_selective
;
6227 int newline_found_p
, n
;
6228 const int MAX_NEWLINE_DISTANCE
= 500;
6230 /* If already on a newline, just consume it to avoid unintended
6231 skipping over invisible text below. */
6232 if (it
->what
== IT_CHARACTER
6234 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6236 if (it
->bidi_p
&& bidi_it_prev
)
6237 *bidi_it_prev
= it
->bidi_it
;
6238 set_iterator_to_next (it
, 0);
6243 /* Don't handle selective display in the following. It's (a)
6244 unnecessary because it's done by the caller, and (b) leads to an
6245 infinite recursion because next_element_from_ellipsis indirectly
6246 calls this function. */
6247 old_selective
= it
->selective
;
6250 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6251 from buffer text. */
6252 for (n
= newline_found_p
= 0;
6253 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6254 n
+= STRINGP (it
->string
) ? 0 : 1)
6256 if (!get_next_display_element (it
))
6258 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6259 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6260 *bidi_it_prev
= it
->bidi_it
;
6261 set_iterator_to_next (it
, 0);
6264 /* If we didn't find a newline near enough, see if we can use a
6266 if (!newline_found_p
)
6268 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6269 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6273 eassert (!STRINGP (it
->string
));
6275 /* If there isn't any `display' property in sight, and no
6276 overlays, we can just use the position of the newline in
6278 if (it
->stop_charpos
>= limit
6279 || ((pos
= Fnext_single_property_change (make_number (start
),
6281 make_number (limit
)),
6283 && next_overlay_change (start
) == ZV
))
6287 IT_CHARPOS (*it
) = limit
;
6288 IT_BYTEPOS (*it
) = bytepos
;
6292 struct bidi_it bprev
;
6294 /* Help bidi.c avoid expensive searches for display
6295 properties and overlays, by telling it that there are
6296 none up to `limit'. */
6297 if (it
->bidi_it
.disp_pos
< limit
)
6299 it
->bidi_it
.disp_pos
= limit
;
6300 it
->bidi_it
.disp_prop
= 0;
6303 bprev
= it
->bidi_it
;
6304 bidi_move_to_visually_next (&it
->bidi_it
);
6305 } while (it
->bidi_it
.charpos
!= limit
);
6306 IT_CHARPOS (*it
) = limit
;
6307 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6309 *bidi_it_prev
= bprev
;
6311 *skipped_p
= newline_found_p
= true;
6315 while (get_next_display_element (it
)
6316 && !newline_found_p
)
6318 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6319 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6320 *bidi_it_prev
= it
->bidi_it
;
6321 set_iterator_to_next (it
, 0);
6326 it
->selective
= old_selective
;
6327 return newline_found_p
;
6331 /* Set IT's current position to the previous visible line start. Skip
6332 invisible text that is so either due to text properties or due to
6333 selective display. Caution: this does not change IT->current_x and
6337 back_to_previous_visible_line_start (struct it
*it
)
6339 while (IT_CHARPOS (*it
) > BEGV
)
6341 back_to_previous_line_start (it
);
6343 if (IT_CHARPOS (*it
) <= BEGV
)
6346 /* If selective > 0, then lines indented more than its value are
6348 if (it
->selective
> 0
6349 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6353 /* Check the newline before point for invisibility. */
6356 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6357 Qinvisible
, it
->window
);
6358 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6362 if (IT_CHARPOS (*it
) <= BEGV
)
6367 void *it2data
= NULL
;
6370 Lisp_Object val
, overlay
;
6372 SAVE_IT (it2
, *it
, it2data
);
6374 /* If newline is part of a composition, continue from start of composition */
6375 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6376 && beg
< IT_CHARPOS (*it
))
6379 /* If newline is replaced by a display property, find start of overlay
6380 or interval and continue search from that point. */
6381 pos
= --IT_CHARPOS (it2
);
6384 bidi_unshelve_cache (NULL
, 0);
6385 it2
.string_from_display_prop_p
= 0;
6386 it2
.from_disp_prop_p
= 0;
6387 if (handle_display_prop (&it2
) == HANDLED_RETURN
6388 && !NILP (val
= get_char_property_and_overlay
6389 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6390 && (OVERLAYP (overlay
)
6391 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6392 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6394 RESTORE_IT (it
, it
, it2data
);
6398 /* Newline is not replaced by anything -- so we are done. */
6399 RESTORE_IT (it
, it
, it2data
);
6405 IT_CHARPOS (*it
) = beg
;
6406 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6410 it
->continuation_lines_width
= 0;
6412 eassert (IT_CHARPOS (*it
) >= BEGV
);
6413 eassert (IT_CHARPOS (*it
) == BEGV
6414 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6419 /* Reseat iterator IT at the previous visible line start. Skip
6420 invisible text that is so either due to text properties or due to
6421 selective display. At the end, update IT's overlay information,
6422 face information etc. */
6425 reseat_at_previous_visible_line_start (struct it
*it
)
6427 back_to_previous_visible_line_start (it
);
6428 reseat (it
, it
->current
.pos
, 1);
6433 /* Reseat iterator IT on the next visible line start in the current
6434 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6435 preceding the line start. Skip over invisible text that is so
6436 because of selective display. Compute faces, overlays etc at the
6437 new position. Note that this function does not skip over text that
6438 is invisible because of text properties. */
6441 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6443 int newline_found_p
, skipped_p
= 0;
6444 struct bidi_it bidi_it_prev
;
6446 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6448 /* Skip over lines that are invisible because they are indented
6449 more than the value of IT->selective. */
6450 if (it
->selective
> 0)
6451 while (IT_CHARPOS (*it
) < ZV
6452 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6455 eassert (IT_BYTEPOS (*it
) == BEGV
6456 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6458 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6461 /* Position on the newline if that's what's requested. */
6462 if (on_newline_p
&& newline_found_p
)
6464 if (STRINGP (it
->string
))
6466 if (IT_STRING_CHARPOS (*it
) > 0)
6470 --IT_STRING_CHARPOS (*it
);
6471 --IT_STRING_BYTEPOS (*it
);
6475 /* We need to restore the bidi iterator to the state
6476 it had on the newline, and resync the IT's
6477 position with that. */
6478 it
->bidi_it
= bidi_it_prev
;
6479 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6480 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6484 else if (IT_CHARPOS (*it
) > BEGV
)
6493 /* We need to restore the bidi iterator to the state it
6494 had on the newline and resync IT with that. */
6495 it
->bidi_it
= bidi_it_prev
;
6496 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6497 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6499 reseat (it
, it
->current
.pos
, 0);
6503 reseat (it
, it
->current
.pos
, 0);
6510 /***********************************************************************
6511 Changing an iterator's position
6512 ***********************************************************************/
6514 /* Change IT's current position to POS in current_buffer. If FORCE_P
6515 is non-zero, always check for text properties at the new position.
6516 Otherwise, text properties are only looked up if POS >=
6517 IT->check_charpos of a property. */
6520 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6522 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6524 reseat_1 (it
, pos
, 0);
6526 /* Determine where to check text properties. Avoid doing it
6527 where possible because text property lookup is very expensive. */
6529 || CHARPOS (pos
) > it
->stop_charpos
6530 || CHARPOS (pos
) < original_pos
)
6534 /* For bidi iteration, we need to prime prev_stop and
6535 base_level_stop with our best estimations. */
6536 /* Implementation note: Of course, POS is not necessarily a
6537 stop position, so assigning prev_pos to it is a lie; we
6538 should have called compute_stop_backwards. However, if
6539 the current buffer does not include any R2L characters,
6540 that call would be a waste of cycles, because the
6541 iterator will never move back, and thus never cross this
6542 "fake" stop position. So we delay that backward search
6543 until the time we really need it, in next_element_from_buffer. */
6544 if (CHARPOS (pos
) != it
->prev_stop
)
6545 it
->prev_stop
= CHARPOS (pos
);
6546 if (CHARPOS (pos
) < it
->base_level_stop
)
6547 it
->base_level_stop
= 0; /* meaning it's unknown */
6553 it
->prev_stop
= it
->base_level_stop
= 0;
6562 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6563 IT->stop_pos to POS, also. */
6566 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6568 /* Don't call this function when scanning a C string. */
6569 eassert (it
->s
== NULL
);
6571 /* POS must be a reasonable value. */
6572 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6574 it
->current
.pos
= it
->position
= pos
;
6575 it
->end_charpos
= ZV
;
6577 it
->current
.dpvec_index
= -1;
6578 it
->current
.overlay_string_index
= -1;
6579 IT_STRING_CHARPOS (*it
) = -1;
6580 IT_STRING_BYTEPOS (*it
) = -1;
6582 it
->method
= GET_FROM_BUFFER
;
6583 it
->object
= it
->w
->contents
;
6584 it
->area
= TEXT_AREA
;
6585 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6587 it
->string_from_display_prop_p
= 0;
6588 it
->string_from_prefix_prop_p
= 0;
6590 it
->from_disp_prop_p
= 0;
6591 it
->face_before_selective_p
= 0;
6594 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6596 bidi_unshelve_cache (NULL
, 0);
6597 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6598 it
->bidi_it
.string
.s
= NULL
;
6599 it
->bidi_it
.string
.lstring
= Qnil
;
6600 it
->bidi_it
.string
.bufpos
= 0;
6601 it
->bidi_it
.string
.from_disp_str
= 0;
6602 it
->bidi_it
.string
.unibyte
= 0;
6603 it
->bidi_it
.w
= it
->w
;
6608 it
->stop_charpos
= CHARPOS (pos
);
6609 it
->base_level_stop
= CHARPOS (pos
);
6611 /* This make the information stored in it->cmp_it invalidate. */
6616 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6617 If S is non-null, it is a C string to iterate over. Otherwise,
6618 STRING gives a Lisp string to iterate over.
6620 If PRECISION > 0, don't return more then PRECISION number of
6621 characters from the string.
6623 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6624 characters have been returned. FIELD_WIDTH < 0 means an infinite
6627 MULTIBYTE = 0 means disable processing of multibyte characters,
6628 MULTIBYTE > 0 means enable it,
6629 MULTIBYTE < 0 means use IT->multibyte_p.
6631 IT must be initialized via a prior call to init_iterator before
6632 calling this function. */
6635 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6636 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6639 /* No text property checks performed by default, but see below. */
6640 it
->stop_charpos
= -1;
6642 /* Set iterator position and end position. */
6643 memset (&it
->current
, 0, sizeof it
->current
);
6644 it
->current
.overlay_string_index
= -1;
6645 it
->current
.dpvec_index
= -1;
6646 eassert (charpos
>= 0);
6648 /* If STRING is specified, use its multibyteness, otherwise use the
6649 setting of MULTIBYTE, if specified. */
6651 it
->multibyte_p
= multibyte
> 0;
6653 /* Bidirectional reordering of strings is controlled by the default
6654 value of bidi-display-reordering. Don't try to reorder while
6655 loading loadup.el, as the necessary character property tables are
6656 not yet available. */
6659 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6663 eassert (STRINGP (string
));
6664 it
->string
= string
;
6666 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6667 it
->method
= GET_FROM_STRING
;
6668 it
->current
.string_pos
= string_pos (charpos
, string
);
6672 it
->bidi_it
.string
.lstring
= string
;
6673 it
->bidi_it
.string
.s
= NULL
;
6674 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6675 it
->bidi_it
.string
.bufpos
= 0;
6676 it
->bidi_it
.string
.from_disp_str
= 0;
6677 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6678 it
->bidi_it
.w
= it
->w
;
6679 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6680 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6685 it
->s
= (const unsigned char *) s
;
6688 /* Note that we use IT->current.pos, not it->current.string_pos,
6689 for displaying C strings. */
6690 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6691 if (it
->multibyte_p
)
6693 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6694 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6698 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6699 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6704 it
->bidi_it
.string
.lstring
= Qnil
;
6705 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6706 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6707 it
->bidi_it
.string
.bufpos
= 0;
6708 it
->bidi_it
.string
.from_disp_str
= 0;
6709 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6710 it
->bidi_it
.w
= it
->w
;
6711 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6714 it
->method
= GET_FROM_C_STRING
;
6717 /* PRECISION > 0 means don't return more than PRECISION characters
6719 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6721 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6723 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6726 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6727 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6728 FIELD_WIDTH < 0 means infinite field width. This is useful for
6729 padding with `-' at the end of a mode line. */
6730 if (field_width
< 0)
6731 field_width
= INFINITY
;
6732 /* Implementation note: We deliberately don't enlarge
6733 it->bidi_it.string.schars here to fit it->end_charpos, because
6734 the bidi iterator cannot produce characters out of thin air. */
6735 if (field_width
> it
->end_charpos
- charpos
)
6736 it
->end_charpos
= charpos
+ field_width
;
6738 /* Use the standard display table for displaying strings. */
6739 if (DISP_TABLE_P (Vstandard_display_table
))
6740 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6742 it
->stop_charpos
= charpos
;
6743 it
->prev_stop
= charpos
;
6744 it
->base_level_stop
= 0;
6747 it
->bidi_it
.first_elt
= 1;
6748 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6749 it
->bidi_it
.disp_pos
= -1;
6751 if (s
== NULL
&& it
->multibyte_p
)
6753 ptrdiff_t endpos
= SCHARS (it
->string
);
6754 if (endpos
> it
->end_charpos
)
6755 endpos
= it
->end_charpos
;
6756 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6764 /***********************************************************************
6766 ***********************************************************************/
6768 /* Map enum it_method value to corresponding next_element_from_* function. */
6770 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6772 next_element_from_buffer
,
6773 next_element_from_display_vector
,
6774 next_element_from_string
,
6775 next_element_from_c_string
,
6776 next_element_from_image
,
6777 next_element_from_stretch
6780 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6783 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6784 (possibly with the following characters). */
6786 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6787 ((IT)->cmp_it.id >= 0 \
6788 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6789 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6790 END_CHARPOS, (IT)->w, \
6791 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6795 /* Lookup the char-table Vglyphless_char_display for character C (-1
6796 if we want information for no-font case), and return the display
6797 method symbol. By side-effect, update it->what and
6798 it->glyphless_method. This function is called from
6799 get_next_display_element for each character element, and from
6800 x_produce_glyphs when no suitable font was found. */
6803 lookup_glyphless_char_display (int c
, struct it
*it
)
6805 Lisp_Object glyphless_method
= Qnil
;
6807 if (CHAR_TABLE_P (Vglyphless_char_display
)
6808 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6812 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6813 if (CONSP (glyphless_method
))
6814 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6815 ? XCAR (glyphless_method
)
6816 : XCDR (glyphless_method
);
6819 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6823 if (NILP (glyphless_method
))
6826 /* The default is to display the character by a proper font. */
6828 /* The default for the no-font case is to display an empty box. */
6829 glyphless_method
= Qempty_box
;
6831 if (EQ (glyphless_method
, Qzero_width
))
6834 return glyphless_method
;
6835 /* This method can't be used for the no-font case. */
6836 glyphless_method
= Qempty_box
;
6838 if (EQ (glyphless_method
, Qthin_space
))
6839 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6840 else if (EQ (glyphless_method
, Qempty_box
))
6841 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6842 else if (EQ (glyphless_method
, Qhex_code
))
6843 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6844 else if (STRINGP (glyphless_method
))
6845 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6848 /* Invalid value. We use the default method. */
6849 glyphless_method
= Qnil
;
6852 it
->what
= IT_GLYPHLESS
;
6853 return glyphless_method
;
6856 /* Merge escape glyph face and cache the result. */
6858 static struct frame
*last_escape_glyph_frame
= NULL
;
6859 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6860 static int last_escape_glyph_merged_face_id
= 0;
6863 merge_escape_glyph_face (struct it
*it
)
6867 if (it
->f
== last_escape_glyph_frame
6868 && it
->face_id
== last_escape_glyph_face_id
)
6869 face_id
= last_escape_glyph_merged_face_id
;
6872 /* Merge the `escape-glyph' face into the current face. */
6873 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6874 last_escape_glyph_frame
= it
->f
;
6875 last_escape_glyph_face_id
= it
->face_id
;
6876 last_escape_glyph_merged_face_id
= face_id
;
6881 /* Likewise for glyphless glyph face. */
6883 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6884 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6885 static int last_glyphless_glyph_merged_face_id
= 0;
6888 merge_glyphless_glyph_face (struct it
*it
)
6892 if (it
->f
== last_glyphless_glyph_frame
6893 && it
->face_id
== last_glyphless_glyph_face_id
)
6894 face_id
= last_glyphless_glyph_merged_face_id
;
6897 /* Merge the `glyphless-char' face into the current face. */
6898 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6899 last_glyphless_glyph_frame
= it
->f
;
6900 last_glyphless_glyph_face_id
= it
->face_id
;
6901 last_glyphless_glyph_merged_face_id
= face_id
;
6906 /* Load IT's display element fields with information about the next
6907 display element from the current position of IT. Value is zero if
6908 end of buffer (or C string) is reached. */
6911 get_next_display_element (struct it
*it
)
6913 /* Non-zero means that we found a display element. Zero means that
6914 we hit the end of what we iterate over. Performance note: the
6915 function pointer `method' used here turns out to be faster than
6916 using a sequence of if-statements. */
6920 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6922 if (it
->what
== IT_CHARACTER
)
6924 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6925 and only if (a) the resolved directionality of that character
6927 /* FIXME: Do we need an exception for characters from display
6929 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6930 it
->c
= bidi_mirror_char (it
->c
);
6931 /* Map via display table or translate control characters.
6932 IT->c, IT->len etc. have been set to the next character by
6933 the function call above. If we have a display table, and it
6934 contains an entry for IT->c, translate it. Don't do this if
6935 IT->c itself comes from a display table, otherwise we could
6936 end up in an infinite recursion. (An alternative could be to
6937 count the recursion depth of this function and signal an
6938 error when a certain maximum depth is reached.) Is it worth
6940 if (success_p
&& it
->dpvec
== NULL
)
6943 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6944 int nonascii_space_p
= 0;
6945 int nonascii_hyphen_p
= 0;
6946 int c
= it
->c
; /* This is the character to display. */
6948 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6950 eassert (SINGLE_BYTE_CHAR_P (c
));
6951 if (unibyte_display_via_language_environment
)
6953 c
= DECODE_CHAR (unibyte
, c
);
6955 c
= BYTE8_TO_CHAR (it
->c
);
6958 c
= BYTE8_TO_CHAR (it
->c
);
6962 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6965 struct Lisp_Vector
*v
= XVECTOR (dv
);
6967 /* Return the first character from the display table
6968 entry, if not empty. If empty, don't display the
6969 current character. */
6972 it
->dpvec_char_len
= it
->len
;
6973 it
->dpvec
= v
->contents
;
6974 it
->dpend
= v
->contents
+ v
->header
.size
;
6975 it
->current
.dpvec_index
= 0;
6976 it
->dpvec_face_id
= -1;
6977 it
->saved_face_id
= it
->face_id
;
6978 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6983 set_iterator_to_next (it
, 0);
6988 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6990 if (it
->what
== IT_GLYPHLESS
)
6992 /* Don't display this character. */
6993 set_iterator_to_next (it
, 0);
6997 /* If `nobreak-char-display' is non-nil, we display
6998 non-ASCII spaces and hyphens specially. */
6999 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7002 nonascii_space_p
= true;
7003 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7004 nonascii_hyphen_p
= true;
7007 /* Translate control characters into `\003' or `^C' form.
7008 Control characters coming from a display table entry are
7009 currently not translated because we use IT->dpvec to hold
7010 the translation. This could easily be changed but I
7011 don't believe that it is worth doing.
7013 The characters handled by `nobreak-char-display' must be
7016 Non-printable characters and raw-byte characters are also
7017 translated to octal form. */
7018 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7019 ? (it
->area
!= TEXT_AREA
7020 /* In mode line, treat \n, \t like other crl chars. */
7023 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7024 || (c
!= '\n' && c
!= '\t'))
7026 || nonascii_hyphen_p
7028 || ! CHAR_PRINTABLE_P (c
))))
7030 /* C is a control character, non-ASCII space/hyphen,
7031 raw-byte, or a non-printable character which must be
7032 displayed either as '\003' or as `^C' where the '\\'
7033 and '^' can be defined in the display table. Fill
7034 IT->ctl_chars with glyphs for what we have to
7035 display. Then, set IT->dpvec to these glyphs. */
7042 /* Handle control characters with ^. */
7044 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7048 g
= '^'; /* default glyph for Control */
7049 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7051 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7053 g
= GLYPH_CODE_CHAR (gc
);
7054 lface_id
= GLYPH_CODE_FACE (gc
);
7058 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7059 : merge_escape_glyph_face (it
));
7061 XSETINT (it
->ctl_chars
[0], g
);
7062 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7064 goto display_control
;
7067 /* Handle non-ascii space in the mode where it only gets
7070 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7072 /* Merge `nobreak-space' into the current face. */
7073 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7075 XSETINT (it
->ctl_chars
[0], ' ');
7077 goto display_control
;
7080 /* Handle sequences that start with the "escape glyph". */
7082 /* the default escape glyph is \. */
7083 escape_glyph
= '\\';
7086 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7088 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7089 lface_id
= GLYPH_CODE_FACE (gc
);
7093 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7094 : merge_escape_glyph_face (it
));
7096 /* Draw non-ASCII hyphen with just highlighting: */
7098 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7100 XSETINT (it
->ctl_chars
[0], '-');
7102 goto display_control
;
7105 /* Draw non-ASCII space/hyphen with escape glyph: */
7107 if (nonascii_space_p
|| nonascii_hyphen_p
)
7109 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7110 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7112 goto display_control
;
7119 if (CHAR_BYTE8_P (c
))
7120 /* Display \200 instead of \17777600. */
7121 c
= CHAR_TO_BYTE8 (c
);
7122 len
= sprintf (str
, "%03o", c
);
7124 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7125 for (i
= 0; i
< len
; i
++)
7126 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7131 /* Set up IT->dpvec and return first character from it. */
7132 it
->dpvec_char_len
= it
->len
;
7133 it
->dpvec
= it
->ctl_chars
;
7134 it
->dpend
= it
->dpvec
+ ctl_len
;
7135 it
->current
.dpvec_index
= 0;
7136 it
->dpvec_face_id
= face_id
;
7137 it
->saved_face_id
= it
->face_id
;
7138 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7142 it
->char_to_display
= c
;
7146 it
->char_to_display
= it
->c
;
7150 #ifdef HAVE_WINDOW_SYSTEM
7151 /* Adjust face id for a multibyte character. There are no multibyte
7152 character in unibyte text. */
7153 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7156 && FRAME_WINDOW_P (it
->f
))
7158 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7160 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7162 /* Automatic composition with glyph-string. */
7163 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7165 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7169 ptrdiff_t pos
= (it
->s
? -1
7170 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7171 : IT_CHARPOS (*it
));
7174 if (it
->what
== IT_CHARACTER
)
7175 c
= it
->char_to_display
;
7178 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7182 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7183 /* TAB in a composition means display glyphs with
7184 padding space on the left or right. */
7185 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7188 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7191 #endif /* HAVE_WINDOW_SYSTEM */
7194 /* Is this character the last one of a run of characters with
7195 box? If yes, set IT->end_of_box_run_p to 1. */
7199 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7201 int face_id
= underlying_face_id (it
);
7202 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7206 if (face
->box
== FACE_NO_BOX
)
7208 /* If the box comes from face properties in a
7209 display string, check faces in that string. */
7210 int string_face_id
= face_after_it_pos (it
);
7211 it
->end_of_box_run_p
7212 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7215 /* Otherwise, the box comes from the underlying face.
7216 If this is the last string character displayed, check
7217 the next buffer location. */
7218 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7219 /* n_overlay_strings is unreliable unless
7220 overlay_string_index is non-negative. */
7221 && ((it
->current
.overlay_string_index
>= 0
7222 && (it
->current
.overlay_string_index
7223 == it
->n_overlay_strings
- 1))
7224 /* A string from display property. */
7225 || it
->from_disp_prop_p
))
7229 struct text_pos pos
= it
->current
.pos
;
7231 /* For a string from a display property, the next
7232 buffer position is stored in the 'position'
7233 member of the iteration stack slot below the
7234 current one, see handle_single_display_spec. By
7235 contrast, it->current.pos was is not yet updated
7236 to point to that buffer position; that will
7237 happen in pop_it, after we finish displaying the
7238 current string. Note that we already checked
7239 above that it->sp is positive, so subtracting one
7241 if (it
->from_disp_prop_p
)
7242 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7244 INC_TEXT_POS (pos
, it
->multibyte_p
);
7246 if (CHARPOS (pos
) >= ZV
)
7247 it
->end_of_box_run_p
= true;
7250 next_face_id
= face_at_buffer_position
7251 (it
->w
, CHARPOS (pos
), &ignore
,
7252 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7253 it
->end_of_box_run_p
7254 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7260 /* next_element_from_display_vector sets this flag according to
7261 faces of the display vector glyphs, see there. */
7262 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7264 int face_id
= face_after_it_pos (it
);
7265 it
->end_of_box_run_p
7266 = (face_id
!= it
->face_id
7267 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7270 /* If we reached the end of the object we've been iterating (e.g., a
7271 display string or an overlay string), and there's something on
7272 IT->stack, proceed with what's on the stack. It doesn't make
7273 sense to return zero if there's unprocessed stuff on the stack,
7274 because otherwise that stuff will never be displayed. */
7275 if (!success_p
&& it
->sp
> 0)
7277 set_iterator_to_next (it
, 0);
7278 success_p
= get_next_display_element (it
);
7281 /* Value is 0 if end of buffer or string reached. */
7286 /* Move IT to the next display element.
7288 RESEAT_P non-zero means if called on a newline in buffer text,
7289 skip to the next visible line start.
7291 Functions get_next_display_element and set_iterator_to_next are
7292 separate because I find this arrangement easier to handle than a
7293 get_next_display_element function that also increments IT's
7294 position. The way it is we can first look at an iterator's current
7295 display element, decide whether it fits on a line, and if it does,
7296 increment the iterator position. The other way around we probably
7297 would either need a flag indicating whether the iterator has to be
7298 incremented the next time, or we would have to implement a
7299 decrement position function which would not be easy to write. */
7302 set_iterator_to_next (struct it
*it
, int reseat_p
)
7304 /* Reset flags indicating start and end of a sequence of characters
7305 with box. Reset them at the start of this function because
7306 moving the iterator to a new position might set them. */
7307 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7311 case GET_FROM_BUFFER
:
7312 /* The current display element of IT is a character from
7313 current_buffer. Advance in the buffer, and maybe skip over
7314 invisible lines that are so because of selective display. */
7315 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7316 reseat_at_next_visible_line_start (it
, 0);
7317 else if (it
->cmp_it
.id
>= 0)
7319 /* We are currently getting glyphs from a composition. */
7324 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7325 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7326 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7328 it
->cmp_it
.from
= it
->cmp_it
.to
;
7333 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7335 it
->end_charpos
, Qnil
);
7338 else if (! it
->cmp_it
.reversed_p
)
7340 /* Composition created while scanning forward. */
7341 /* Update IT's char/byte positions to point to the first
7342 character of the next grapheme cluster, or to the
7343 character visually after the current composition. */
7344 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7345 bidi_move_to_visually_next (&it
->bidi_it
);
7346 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7347 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7349 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7351 /* Proceed to the next grapheme cluster. */
7352 it
->cmp_it
.from
= it
->cmp_it
.to
;
7356 /* No more grapheme clusters in this composition.
7357 Find the next stop position. */
7358 ptrdiff_t stop
= it
->end_charpos
;
7359 if (it
->bidi_it
.scan_dir
< 0)
7360 /* Now we are scanning backward and don't know
7363 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7364 IT_BYTEPOS (*it
), stop
, Qnil
);
7369 /* Composition created while scanning backward. */
7370 /* Update IT's char/byte positions to point to the last
7371 character of the previous grapheme cluster, or the
7372 character visually after the current composition. */
7373 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7374 bidi_move_to_visually_next (&it
->bidi_it
);
7375 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7376 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7377 if (it
->cmp_it
.from
> 0)
7379 /* Proceed to the previous grapheme cluster. */
7380 it
->cmp_it
.to
= it
->cmp_it
.from
;
7384 /* No more grapheme clusters in this composition.
7385 Find the next stop position. */
7386 ptrdiff_t stop
= it
->end_charpos
;
7387 if (it
->bidi_it
.scan_dir
< 0)
7388 /* Now we are scanning backward and don't know
7391 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7392 IT_BYTEPOS (*it
), stop
, Qnil
);
7398 eassert (it
->len
!= 0);
7402 IT_BYTEPOS (*it
) += it
->len
;
7403 IT_CHARPOS (*it
) += 1;
7407 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7408 /* If this is a new paragraph, determine its base
7409 direction (a.k.a. its base embedding level). */
7410 if (it
->bidi_it
.new_paragraph
)
7411 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7412 bidi_move_to_visually_next (&it
->bidi_it
);
7413 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7414 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7415 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7417 /* As the scan direction was changed, we must
7418 re-compute the stop position for composition. */
7419 ptrdiff_t stop
= it
->end_charpos
;
7420 if (it
->bidi_it
.scan_dir
< 0)
7422 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7423 IT_BYTEPOS (*it
), stop
, Qnil
);
7426 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7430 case GET_FROM_C_STRING
:
7431 /* Current display element of IT is from a C string. */
7433 /* If the string position is beyond string's end, it means
7434 next_element_from_c_string is padding the string with
7435 blanks, in which case we bypass the bidi iterator,
7436 because it cannot deal with such virtual characters. */
7437 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7439 IT_BYTEPOS (*it
) += it
->len
;
7440 IT_CHARPOS (*it
) += 1;
7444 bidi_move_to_visually_next (&it
->bidi_it
);
7445 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7446 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7450 case GET_FROM_DISPLAY_VECTOR
:
7451 /* Current display element of IT is from a display table entry.
7452 Advance in the display table definition. Reset it to null if
7453 end reached, and continue with characters from buffers/
7455 ++it
->current
.dpvec_index
;
7457 /* Restore face of the iterator to what they were before the
7458 display vector entry (these entries may contain faces). */
7459 it
->face_id
= it
->saved_face_id
;
7461 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7463 int recheck_faces
= it
->ellipsis_p
;
7466 it
->method
= GET_FROM_C_STRING
;
7467 else if (STRINGP (it
->string
))
7468 it
->method
= GET_FROM_STRING
;
7471 it
->method
= GET_FROM_BUFFER
;
7472 it
->object
= it
->w
->contents
;
7476 it
->current
.dpvec_index
= -1;
7478 /* Skip over characters which were displayed via IT->dpvec. */
7479 if (it
->dpvec_char_len
< 0)
7480 reseat_at_next_visible_line_start (it
, 1);
7481 else if (it
->dpvec_char_len
> 0)
7483 if (it
->method
== GET_FROM_STRING
7484 && it
->current
.overlay_string_index
>= 0
7485 && it
->n_overlay_strings
> 0)
7486 it
->ignore_overlay_strings_at_pos_p
= true;
7487 it
->len
= it
->dpvec_char_len
;
7488 set_iterator_to_next (it
, reseat_p
);
7491 /* Maybe recheck faces after display vector. */
7493 it
->stop_charpos
= IT_CHARPOS (*it
);
7497 case GET_FROM_STRING
:
7498 /* Current display element is a character from a Lisp string. */
7499 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7500 /* Don't advance past string end. These conditions are true
7501 when set_iterator_to_next is called at the end of
7502 get_next_display_element, in which case the Lisp string is
7503 already exhausted, and all we want is pop the iterator
7505 if (it
->current
.overlay_string_index
>= 0)
7507 /* This is an overlay string, so there's no padding with
7508 spaces, and the number of characters in the string is
7509 where the string ends. */
7510 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7511 goto consider_string_end
;
7515 /* Not an overlay string. There could be padding, so test
7516 against it->end_charpos. */
7517 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7518 goto consider_string_end
;
7520 if (it
->cmp_it
.id
>= 0)
7526 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7527 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7528 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7529 it
->cmp_it
.from
= it
->cmp_it
.to
;
7533 composition_compute_stop_pos (&it
->cmp_it
,
7534 IT_STRING_CHARPOS (*it
),
7535 IT_STRING_BYTEPOS (*it
),
7536 it
->end_charpos
, it
->string
);
7539 else if (! it
->cmp_it
.reversed_p
)
7541 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7542 bidi_move_to_visually_next (&it
->bidi_it
);
7543 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7544 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7546 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7547 it
->cmp_it
.from
= it
->cmp_it
.to
;
7550 ptrdiff_t stop
= it
->end_charpos
;
7551 if (it
->bidi_it
.scan_dir
< 0)
7553 composition_compute_stop_pos (&it
->cmp_it
,
7554 IT_STRING_CHARPOS (*it
),
7555 IT_STRING_BYTEPOS (*it
), stop
,
7561 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7562 bidi_move_to_visually_next (&it
->bidi_it
);
7563 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7564 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7565 if (it
->cmp_it
.from
> 0)
7566 it
->cmp_it
.to
= it
->cmp_it
.from
;
7569 ptrdiff_t stop
= it
->end_charpos
;
7570 if (it
->bidi_it
.scan_dir
< 0)
7572 composition_compute_stop_pos (&it
->cmp_it
,
7573 IT_STRING_CHARPOS (*it
),
7574 IT_STRING_BYTEPOS (*it
), stop
,
7582 /* If the string position is beyond string's end, it
7583 means next_element_from_string is padding the string
7584 with blanks, in which case we bypass the bidi
7585 iterator, because it cannot deal with such virtual
7587 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7589 IT_STRING_BYTEPOS (*it
) += it
->len
;
7590 IT_STRING_CHARPOS (*it
) += 1;
7594 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7596 bidi_move_to_visually_next (&it
->bidi_it
);
7597 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7598 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7599 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7601 ptrdiff_t stop
= it
->end_charpos
;
7603 if (it
->bidi_it
.scan_dir
< 0)
7605 composition_compute_stop_pos (&it
->cmp_it
,
7606 IT_STRING_CHARPOS (*it
),
7607 IT_STRING_BYTEPOS (*it
), stop
,
7613 consider_string_end
:
7615 if (it
->current
.overlay_string_index
>= 0)
7617 /* IT->string is an overlay string. Advance to the
7618 next, if there is one. */
7619 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7622 next_overlay_string (it
);
7624 setup_for_ellipsis (it
, 0);
7629 /* IT->string is not an overlay string. If we reached
7630 its end, and there is something on IT->stack, proceed
7631 with what is on the stack. This can be either another
7632 string, this time an overlay string, or a buffer. */
7633 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7637 if (it
->method
== GET_FROM_STRING
)
7638 goto consider_string_end
;
7643 case GET_FROM_IMAGE
:
7644 case GET_FROM_STRETCH
:
7645 /* The position etc with which we have to proceed are on
7646 the stack. The position may be at the end of a string,
7647 if the `display' property takes up the whole string. */
7648 eassert (it
->sp
> 0);
7650 if (it
->method
== GET_FROM_STRING
)
7651 goto consider_string_end
;
7655 /* There are no other methods defined, so this should be a bug. */
7659 eassert (it
->method
!= GET_FROM_STRING
7660 || (STRINGP (it
->string
)
7661 && IT_STRING_CHARPOS (*it
) >= 0));
7664 /* Load IT's display element fields with information about the next
7665 display element which comes from a display table entry or from the
7666 result of translating a control character to one of the forms `^C'
7669 IT->dpvec holds the glyphs to return as characters.
7670 IT->saved_face_id holds the face id before the display vector--it
7671 is restored into IT->face_id in set_iterator_to_next. */
7674 next_element_from_display_vector (struct it
*it
)
7677 int prev_face_id
= it
->face_id
;
7681 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7683 it
->face_id
= it
->saved_face_id
;
7685 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7686 That seemed totally bogus - so I changed it... */
7687 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7689 if (GLYPH_CODE_P (gc
))
7691 struct face
*this_face
, *prev_face
, *next_face
;
7693 it
->c
= GLYPH_CODE_CHAR (gc
);
7694 it
->len
= CHAR_BYTES (it
->c
);
7696 /* The entry may contain a face id to use. Such a face id is
7697 the id of a Lisp face, not a realized face. A face id of
7698 zero means no face is specified. */
7699 if (it
->dpvec_face_id
>= 0)
7700 it
->face_id
= it
->dpvec_face_id
;
7703 int lface_id
= GLYPH_CODE_FACE (gc
);
7705 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7709 /* Glyphs in the display vector could have the box face, so we
7710 need to set the related flags in the iterator, as
7712 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7713 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7715 /* Is this character the first character of a box-face run? */
7716 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7718 || prev_face
->box
== FACE_NO_BOX
));
7720 /* For the last character of the box-face run, we need to look
7721 either at the next glyph from the display vector, or at the
7722 face we saw before the display vector. */
7723 next_face_id
= it
->saved_face_id
;
7724 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7726 if (it
->dpvec_face_id
>= 0)
7727 next_face_id
= it
->dpvec_face_id
;
7731 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7734 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7738 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7739 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7741 || next_face
->box
== FACE_NO_BOX
));
7742 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7745 /* Display table entry is invalid. Return a space. */
7746 it
->c
= ' ', it
->len
= 1;
7748 /* Don't change position and object of the iterator here. They are
7749 still the values of the character that had this display table
7750 entry or was translated, and that's what we want. */
7751 it
->what
= IT_CHARACTER
;
7755 /* Get the first element of string/buffer in the visual order, after
7756 being reseated to a new position in a string or a buffer. */
7758 get_visually_first_element (struct it
*it
)
7760 int string_p
= STRINGP (it
->string
) || it
->s
;
7761 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7762 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7764 if (STRINGP (it
->string
))
7766 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7767 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7771 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7772 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7775 if (it
->bidi_it
.charpos
== eob
)
7777 /* Nothing to do, but reset the FIRST_ELT flag, like
7778 bidi_paragraph_init does, because we are not going to
7780 it
->bidi_it
.first_elt
= 0;
7782 else if (it
->bidi_it
.charpos
== bob
7784 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7785 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7787 /* If we are at the beginning of a line/string, we can produce
7788 the next element right away. */
7789 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7790 bidi_move_to_visually_next (&it
->bidi_it
);
7794 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7796 /* We need to prime the bidi iterator starting at the line's or
7797 string's beginning, before we will be able to produce the
7800 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7802 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7803 IT_BYTEPOS (*it
), -1,
7804 &it
->bidi_it
.bytepos
);
7805 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7808 /* Now return to buffer/string position where we were asked
7809 to get the next display element, and produce that. */
7810 bidi_move_to_visually_next (&it
->bidi_it
);
7812 while (it
->bidi_it
.bytepos
!= orig_bytepos
7813 && it
->bidi_it
.charpos
< eob
);
7816 /* Adjust IT's position information to where we ended up. */
7817 if (STRINGP (it
->string
))
7819 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7820 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7824 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7825 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7828 if (STRINGP (it
->string
) || !it
->s
)
7830 ptrdiff_t stop
, charpos
, bytepos
;
7832 if (STRINGP (it
->string
))
7835 stop
= SCHARS (it
->string
);
7836 if (stop
> it
->end_charpos
)
7837 stop
= it
->end_charpos
;
7838 charpos
= IT_STRING_CHARPOS (*it
);
7839 bytepos
= IT_STRING_BYTEPOS (*it
);
7843 stop
= it
->end_charpos
;
7844 charpos
= IT_CHARPOS (*it
);
7845 bytepos
= IT_BYTEPOS (*it
);
7847 if (it
->bidi_it
.scan_dir
< 0)
7849 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7854 /* Load IT with the next display element from Lisp string IT->string.
7855 IT->current.string_pos is the current position within the string.
7856 If IT->current.overlay_string_index >= 0, the Lisp string is an
7860 next_element_from_string (struct it
*it
)
7862 struct text_pos position
;
7864 eassert (STRINGP (it
->string
));
7865 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7866 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7867 position
= it
->current
.string_pos
;
7869 /* With bidi reordering, the character to display might not be the
7870 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7871 that we were reseat()ed to a new string, whose paragraph
7872 direction is not known. */
7873 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7875 get_visually_first_element (it
);
7876 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7879 /* Time to check for invisible text? */
7880 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7882 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7885 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7886 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7888 /* With bidi non-linear iteration, we could find
7889 ourselves far beyond the last computed stop_charpos,
7890 with several other stop positions in between that we
7891 missed. Scan them all now, in buffer's logical
7892 order, until we find and handle the last stop_charpos
7893 that precedes our current position. */
7894 handle_stop_backwards (it
, it
->stop_charpos
);
7895 return GET_NEXT_DISPLAY_ELEMENT (it
);
7901 /* Take note of the stop position we just moved
7902 across, for when we will move back across it. */
7903 it
->prev_stop
= it
->stop_charpos
;
7904 /* If we are at base paragraph embedding level, take
7905 note of the last stop position seen at this
7907 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7908 it
->base_level_stop
= it
->stop_charpos
;
7912 /* Since a handler may have changed IT->method, we must
7914 return GET_NEXT_DISPLAY_ELEMENT (it
);
7918 /* If we are before prev_stop, we may have overstepped
7919 on our way backwards a stop_pos, and if so, we need
7920 to handle that stop_pos. */
7921 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7922 /* We can sometimes back up for reasons that have nothing
7923 to do with bidi reordering. E.g., compositions. The
7924 code below is only needed when we are above the base
7925 embedding level, so test for that explicitly. */
7926 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7928 /* If we lost track of base_level_stop, we have no better
7929 place for handle_stop_backwards to start from than string
7930 beginning. This happens, e.g., when we were reseated to
7931 the previous screenful of text by vertical-motion. */
7932 if (it
->base_level_stop
<= 0
7933 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7934 it
->base_level_stop
= 0;
7935 handle_stop_backwards (it
, it
->base_level_stop
);
7936 return GET_NEXT_DISPLAY_ELEMENT (it
);
7940 if (it
->current
.overlay_string_index
>= 0)
7942 /* Get the next character from an overlay string. In overlay
7943 strings, there is no field width or padding with spaces to
7945 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7950 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7951 IT_STRING_BYTEPOS (*it
),
7952 it
->bidi_it
.scan_dir
< 0
7954 : SCHARS (it
->string
))
7955 && next_element_from_composition (it
))
7959 else if (STRING_MULTIBYTE (it
->string
))
7961 const unsigned char *s
= (SDATA (it
->string
)
7962 + IT_STRING_BYTEPOS (*it
));
7963 it
->c
= string_char_and_length (s
, &it
->len
);
7967 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7973 /* Get the next character from a Lisp string that is not an
7974 overlay string. Such strings come from the mode line, for
7975 example. We may have to pad with spaces, or truncate the
7976 string. See also next_element_from_c_string. */
7977 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7982 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7984 /* Pad with spaces. */
7985 it
->c
= ' ', it
->len
= 1;
7986 CHARPOS (position
) = BYTEPOS (position
) = -1;
7988 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7989 IT_STRING_BYTEPOS (*it
),
7990 it
->bidi_it
.scan_dir
< 0
7992 : it
->string_nchars
)
7993 && next_element_from_composition (it
))
7997 else if (STRING_MULTIBYTE (it
->string
))
7999 const unsigned char *s
= (SDATA (it
->string
)
8000 + IT_STRING_BYTEPOS (*it
));
8001 it
->c
= string_char_and_length (s
, &it
->len
);
8005 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8010 /* Record what we have and where it came from. */
8011 it
->what
= IT_CHARACTER
;
8012 it
->object
= it
->string
;
8013 it
->position
= position
;
8018 /* Load IT with next display element from C string IT->s.
8019 IT->string_nchars is the maximum number of characters to return
8020 from the string. IT->end_charpos may be greater than
8021 IT->string_nchars when this function is called, in which case we
8022 may have to return padding spaces. Value is zero if end of string
8023 reached, including padding spaces. */
8026 next_element_from_c_string (struct it
*it
)
8028 bool success_p
= true;
8031 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8032 it
->what
= IT_CHARACTER
;
8033 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8036 /* With bidi reordering, the character to display might not be the
8037 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8038 we were reseated to a new string, whose paragraph direction is
8040 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8041 get_visually_first_element (it
);
8043 /* IT's position can be greater than IT->string_nchars in case a
8044 field width or precision has been specified when the iterator was
8046 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8048 /* End of the game. */
8052 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8054 /* Pad with spaces. */
8055 it
->c
= ' ', it
->len
= 1;
8056 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8058 else if (it
->multibyte_p
)
8059 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8061 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8067 /* Set up IT to return characters from an ellipsis, if appropriate.
8068 The definition of the ellipsis glyphs may come from a display table
8069 entry. This function fills IT with the first glyph from the
8070 ellipsis if an ellipsis is to be displayed. */
8073 next_element_from_ellipsis (struct it
*it
)
8075 if (it
->selective_display_ellipsis_p
)
8076 setup_for_ellipsis (it
, it
->len
);
8079 /* The face at the current position may be different from the
8080 face we find after the invisible text. Remember what it
8081 was in IT->saved_face_id, and signal that it's there by
8082 setting face_before_selective_p. */
8083 it
->saved_face_id
= it
->face_id
;
8084 it
->method
= GET_FROM_BUFFER
;
8085 it
->object
= it
->w
->contents
;
8086 reseat_at_next_visible_line_start (it
, 1);
8087 it
->face_before_selective_p
= true;
8090 return GET_NEXT_DISPLAY_ELEMENT (it
);
8094 /* Deliver an image display element. The iterator IT is already
8095 filled with image information (done in handle_display_prop). Value
8100 next_element_from_image (struct it
*it
)
8102 it
->what
= IT_IMAGE
;
8103 it
->ignore_overlay_strings_at_pos_p
= 0;
8108 /* Fill iterator IT with next display element from a stretch glyph
8109 property. IT->object is the value of the text property. Value is
8113 next_element_from_stretch (struct it
*it
)
8115 it
->what
= IT_STRETCH
;
8119 /* Scan backwards from IT's current position until we find a stop
8120 position, or until BEGV. This is called when we find ourself
8121 before both the last known prev_stop and base_level_stop while
8122 reordering bidirectional text. */
8125 compute_stop_pos_backwards (struct it
*it
)
8127 const int SCAN_BACK_LIMIT
= 1000;
8128 struct text_pos pos
;
8129 struct display_pos save_current
= it
->current
;
8130 struct text_pos save_position
= it
->position
;
8131 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8132 ptrdiff_t where_we_are
= charpos
;
8133 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8134 ptrdiff_t save_end_pos
= it
->end_charpos
;
8136 eassert (NILP (it
->string
) && !it
->s
);
8137 eassert (it
->bidi_p
);
8141 it
->end_charpos
= min (charpos
+ 1, ZV
);
8142 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8143 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8144 reseat_1 (it
, pos
, 0);
8145 compute_stop_pos (it
);
8146 /* We must advance forward, right? */
8147 if (it
->stop_charpos
<= charpos
)
8150 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8152 if (it
->stop_charpos
<= where_we_are
)
8153 it
->prev_stop
= it
->stop_charpos
;
8155 it
->prev_stop
= BEGV
;
8157 it
->current
= save_current
;
8158 it
->position
= save_position
;
8159 it
->stop_charpos
= save_stop_pos
;
8160 it
->end_charpos
= save_end_pos
;
8163 /* Scan forward from CHARPOS in the current buffer/string, until we
8164 find a stop position > current IT's position. Then handle the stop
8165 position before that. This is called when we bump into a stop
8166 position while reordering bidirectional text. CHARPOS should be
8167 the last previously processed stop_pos (or BEGV/0, if none were
8168 processed yet) whose position is less that IT's current
8172 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8174 int bufp
= !STRINGP (it
->string
);
8175 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8176 struct display_pos save_current
= it
->current
;
8177 struct text_pos save_position
= it
->position
;
8178 struct text_pos pos1
;
8179 ptrdiff_t next_stop
;
8181 /* Scan in strict logical order. */
8182 eassert (it
->bidi_p
);
8186 it
->prev_stop
= charpos
;
8189 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8190 reseat_1 (it
, pos1
, 0);
8193 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8194 compute_stop_pos (it
);
8195 /* We must advance forward, right? */
8196 if (it
->stop_charpos
<= it
->prev_stop
)
8198 charpos
= it
->stop_charpos
;
8200 while (charpos
<= where_we_are
);
8203 it
->current
= save_current
;
8204 it
->position
= save_position
;
8205 next_stop
= it
->stop_charpos
;
8206 it
->stop_charpos
= it
->prev_stop
;
8208 it
->stop_charpos
= next_stop
;
8211 /* Load IT with the next display element from current_buffer. Value
8212 is zero if end of buffer reached. IT->stop_charpos is the next
8213 position at which to stop and check for text properties or buffer
8217 next_element_from_buffer (struct it
*it
)
8219 bool success_p
= true;
8221 eassert (IT_CHARPOS (*it
) >= BEGV
);
8222 eassert (NILP (it
->string
) && !it
->s
);
8223 eassert (!it
->bidi_p
8224 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8225 && it
->bidi_it
.string
.s
== NULL
));
8227 /* With bidi reordering, the character to display might not be the
8228 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8229 we were reseat()ed to a new buffer position, which is potentially
8230 a different paragraph. */
8231 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8233 get_visually_first_element (it
);
8234 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8237 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8239 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8241 int overlay_strings_follow_p
;
8243 /* End of the game, except when overlay strings follow that
8244 haven't been returned yet. */
8245 if (it
->overlay_strings_at_end_processed_p
)
8246 overlay_strings_follow_p
= 0;
8249 it
->overlay_strings_at_end_processed_p
= true;
8250 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8253 if (overlay_strings_follow_p
)
8254 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8258 it
->position
= it
->current
.pos
;
8262 else if (!(!it
->bidi_p
8263 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8264 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8266 /* With bidi non-linear iteration, we could find ourselves
8267 far beyond the last computed stop_charpos, with several
8268 other stop positions in between that we missed. Scan
8269 them all now, in buffer's logical order, until we find
8270 and handle the last stop_charpos that precedes our
8271 current position. */
8272 handle_stop_backwards (it
, it
->stop_charpos
);
8273 return GET_NEXT_DISPLAY_ELEMENT (it
);
8279 /* Take note of the stop position we just moved across,
8280 for when we will move back across it. */
8281 it
->prev_stop
= it
->stop_charpos
;
8282 /* If we are at base paragraph embedding level, take
8283 note of the last stop position seen at this
8285 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8286 it
->base_level_stop
= it
->stop_charpos
;
8289 return GET_NEXT_DISPLAY_ELEMENT (it
);
8293 /* If we are before prev_stop, we may have overstepped on
8294 our way backwards a stop_pos, and if so, we need to
8295 handle that stop_pos. */
8296 && IT_CHARPOS (*it
) < it
->prev_stop
8297 /* We can sometimes back up for reasons that have nothing
8298 to do with bidi reordering. E.g., compositions. The
8299 code below is only needed when we are above the base
8300 embedding level, so test for that explicitly. */
8301 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8303 if (it
->base_level_stop
<= 0
8304 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8306 /* If we lost track of base_level_stop, we need to find
8307 prev_stop by looking backwards. This happens, e.g., when
8308 we were reseated to the previous screenful of text by
8310 it
->base_level_stop
= BEGV
;
8311 compute_stop_pos_backwards (it
);
8312 handle_stop_backwards (it
, it
->prev_stop
);
8315 handle_stop_backwards (it
, it
->base_level_stop
);
8316 return GET_NEXT_DISPLAY_ELEMENT (it
);
8320 /* No face changes, overlays etc. in sight, so just return a
8321 character from current_buffer. */
8325 /* Maybe run the redisplay end trigger hook. Performance note:
8326 This doesn't seem to cost measurable time. */
8327 if (it
->redisplay_end_trigger_charpos
8329 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8330 run_redisplay_end_trigger_hook (it
);
8332 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8333 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8335 && next_element_from_composition (it
))
8340 /* Get the next character, maybe multibyte. */
8341 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8342 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8343 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8345 it
->c
= *p
, it
->len
= 1;
8347 /* Record what we have and where it came from. */
8348 it
->what
= IT_CHARACTER
;
8349 it
->object
= it
->w
->contents
;
8350 it
->position
= it
->current
.pos
;
8352 /* Normally we return the character found above, except when we
8353 really want to return an ellipsis for selective display. */
8358 /* A value of selective > 0 means hide lines indented more
8359 than that number of columns. */
8360 if (it
->selective
> 0
8361 && IT_CHARPOS (*it
) + 1 < ZV
8362 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8363 IT_BYTEPOS (*it
) + 1,
8366 success_p
= next_element_from_ellipsis (it
);
8367 it
->dpvec_char_len
= -1;
8370 else if (it
->c
== '\r' && it
->selective
== -1)
8372 /* A value of selective == -1 means that everything from the
8373 CR to the end of the line is invisible, with maybe an
8374 ellipsis displayed for it. */
8375 success_p
= next_element_from_ellipsis (it
);
8376 it
->dpvec_char_len
= -1;
8381 /* Value is zero if end of buffer reached. */
8382 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8387 /* Run the redisplay end trigger hook for IT. */
8390 run_redisplay_end_trigger_hook (struct it
*it
)
8392 Lisp_Object args
[3];
8394 /* IT->glyph_row should be non-null, i.e. we should be actually
8395 displaying something, or otherwise we should not run the hook. */
8396 eassert (it
->glyph_row
);
8398 /* Set up hook arguments. */
8399 args
[0] = Qredisplay_end_trigger_functions
;
8400 args
[1] = it
->window
;
8401 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8402 it
->redisplay_end_trigger_charpos
= 0;
8404 /* Since we are *trying* to run these functions, don't try to run
8405 them again, even if they get an error. */
8406 wset_redisplay_end_trigger (it
->w
, Qnil
);
8407 Frun_hook_with_args (3, args
);
8409 /* Notice if it changed the face of the character we are on. */
8410 handle_face_prop (it
);
8414 /* Deliver a composition display element. Unlike the other
8415 next_element_from_XXX, this function is not registered in the array
8416 get_next_element[]. It is called from next_element_from_buffer and
8417 next_element_from_string when necessary. */
8420 next_element_from_composition (struct it
*it
)
8422 it
->what
= IT_COMPOSITION
;
8423 it
->len
= it
->cmp_it
.nbytes
;
8424 if (STRINGP (it
->string
))
8428 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8429 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8432 it
->position
= it
->current
.string_pos
;
8433 it
->object
= it
->string
;
8434 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8435 IT_STRING_BYTEPOS (*it
), it
->string
);
8441 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8442 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8445 if (it
->bidi_it
.new_paragraph
)
8446 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8447 /* Resync the bidi iterator with IT's new position.
8448 FIXME: this doesn't support bidirectional text. */
8449 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8450 bidi_move_to_visually_next (&it
->bidi_it
);
8454 it
->position
= it
->current
.pos
;
8455 it
->object
= it
->w
->contents
;
8456 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8457 IT_BYTEPOS (*it
), Qnil
);
8464 /***********************************************************************
8465 Moving an iterator without producing glyphs
8466 ***********************************************************************/
8468 /* Check if iterator is at a position corresponding to a valid buffer
8469 position after some move_it_ call. */
8471 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8472 ((it)->method == GET_FROM_STRING \
8473 ? IT_STRING_CHARPOS (*it) == 0 \
8477 /* Move iterator IT to a specified buffer or X position within one
8478 line on the display without producing glyphs.
8480 OP should be a bit mask including some or all of these bits:
8481 MOVE_TO_X: Stop upon reaching x-position TO_X.
8482 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8483 Regardless of OP's value, stop upon reaching the end of the display line.
8485 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8486 This means, in particular, that TO_X includes window's horizontal
8489 The return value has several possible values that
8490 say what condition caused the scan to stop:
8492 MOVE_POS_MATCH_OR_ZV
8493 - when TO_POS or ZV was reached.
8496 -when TO_X was reached before TO_POS or ZV were reached.
8499 - when we reached the end of the display area and the line must
8503 - when we reached the end of the display area and the line is
8507 - when we stopped at a line end, i.e. a newline or a CR and selective
8510 static enum move_it_result
8511 move_it_in_display_line_to (struct it
*it
,
8512 ptrdiff_t to_charpos
, int to_x
,
8513 enum move_operation_enum op
)
8515 enum move_it_result result
= MOVE_UNDEFINED
;
8516 struct glyph_row
*saved_glyph_row
;
8517 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8518 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8519 void *ppos_data
= NULL
;
8521 enum it_method prev_method
= it
->method
;
8522 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8523 int saw_smaller_pos
= prev_pos
< to_charpos
;
8525 /* Don't produce glyphs in produce_glyphs. */
8526 saved_glyph_row
= it
->glyph_row
;
8527 it
->glyph_row
= NULL
;
8529 /* Use wrap_it to save a copy of IT wherever a word wrap could
8530 occur. Use atpos_it to save a copy of IT at the desired buffer
8531 position, if found, so that we can scan ahead and check if the
8532 word later overshoots the window edge. Use atx_it similarly, for
8538 /* Use ppos_it under bidi reordering to save a copy of IT for the
8539 initial position. We restore that position in IT when we have
8540 scanned the entire display line without finding a match for
8541 TO_CHARPOS and all the character positions are greater than
8542 TO_CHARPOS. We then restart the scan from the initial position,
8543 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8544 the closest to TO_CHARPOS. */
8547 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8549 SAVE_IT (ppos_it
, *it
, ppos_data
);
8550 closest_pos
= IT_CHARPOS (*it
);
8556 #define BUFFER_POS_REACHED_P() \
8557 ((op & MOVE_TO_POS) != 0 \
8558 && BUFFERP (it->object) \
8559 && (IT_CHARPOS (*it) == to_charpos \
8561 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8562 && IT_CHARPOS (*it) > to_charpos) \
8563 || (it->what == IT_COMPOSITION \
8564 && ((IT_CHARPOS (*it) > to_charpos \
8565 && to_charpos >= it->cmp_it.charpos) \
8566 || (IT_CHARPOS (*it) < to_charpos \
8567 && to_charpos <= it->cmp_it.charpos)))) \
8568 && (it->method == GET_FROM_BUFFER \
8569 || (it->method == GET_FROM_DISPLAY_VECTOR \
8570 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8572 /* If there's a line-/wrap-prefix, handle it. */
8573 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8574 && it
->current_y
< it
->last_visible_y
)
8575 handle_line_prefix (it
);
8577 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8578 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8582 int x
, i
, ascent
= 0, descent
= 0;
8584 /* Utility macro to reset an iterator with x, ascent, and descent. */
8585 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8586 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8587 (IT)->max_descent = descent)
8589 /* Stop if we move beyond TO_CHARPOS (after an image or a
8590 display string or stretch glyph). */
8591 if ((op
& MOVE_TO_POS
) != 0
8592 && BUFFERP (it
->object
)
8593 && it
->method
== GET_FROM_BUFFER
8595 /* When the iterator is at base embedding level, we
8596 are guaranteed that characters are delivered for
8597 display in strictly increasing order of their
8598 buffer positions. */
8599 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8600 && IT_CHARPOS (*it
) > to_charpos
)
8602 && (prev_method
== GET_FROM_IMAGE
8603 || prev_method
== GET_FROM_STRETCH
8604 || prev_method
== GET_FROM_STRING
)
8605 /* Passed TO_CHARPOS from left to right. */
8606 && ((prev_pos
< to_charpos
8607 && IT_CHARPOS (*it
) > to_charpos
)
8608 /* Passed TO_CHARPOS from right to left. */
8609 || (prev_pos
> to_charpos
8610 && IT_CHARPOS (*it
) < to_charpos
)))))
8612 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8614 result
= MOVE_POS_MATCH_OR_ZV
;
8617 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8618 /* If wrap_it is valid, the current position might be in a
8619 word that is wrapped. So, save the iterator in
8620 atpos_it and continue to see if wrapping happens. */
8621 SAVE_IT (atpos_it
, *it
, atpos_data
);
8624 /* Stop when ZV reached.
8625 We used to stop here when TO_CHARPOS reached as well, but that is
8626 too soon if this glyph does not fit on this line. So we handle it
8627 explicitly below. */
8628 if (!get_next_display_element (it
))
8630 result
= MOVE_POS_MATCH_OR_ZV
;
8634 if (it
->line_wrap
== TRUNCATE
)
8636 if (BUFFER_POS_REACHED_P ())
8638 result
= MOVE_POS_MATCH_OR_ZV
;
8644 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8646 if (IT_DISPLAYING_WHITESPACE (it
))
8650 /* We have reached a glyph that follows one or more
8651 whitespace characters. If the position is
8652 already found, we are done. */
8653 if (atpos_it
.sp
>= 0)
8655 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8656 result
= MOVE_POS_MATCH_OR_ZV
;
8661 RESTORE_IT (it
, &atx_it
, atx_data
);
8662 result
= MOVE_X_REACHED
;
8665 /* Otherwise, we can wrap here. */
8666 SAVE_IT (wrap_it
, *it
, wrap_data
);
8672 /* Remember the line height for the current line, in case
8673 the next element doesn't fit on the line. */
8674 ascent
= it
->max_ascent
;
8675 descent
= it
->max_descent
;
8677 /* The call to produce_glyphs will get the metrics of the
8678 display element IT is loaded with. Record the x-position
8679 before this display element, in case it doesn't fit on the
8683 PRODUCE_GLYPHS (it
);
8685 if (it
->area
!= TEXT_AREA
)
8687 prev_method
= it
->method
;
8688 if (it
->method
== GET_FROM_BUFFER
)
8689 prev_pos
= IT_CHARPOS (*it
);
8690 set_iterator_to_next (it
, 1);
8691 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8692 SET_TEXT_POS (this_line_min_pos
,
8693 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8695 && (op
& MOVE_TO_POS
)
8696 && IT_CHARPOS (*it
) > to_charpos
8697 && IT_CHARPOS (*it
) < closest_pos
)
8698 closest_pos
= IT_CHARPOS (*it
);
8702 /* The number of glyphs we get back in IT->nglyphs will normally
8703 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8704 character on a terminal frame, or (iii) a line end. For the
8705 second case, IT->nglyphs - 1 padding glyphs will be present.
8706 (On X frames, there is only one glyph produced for a
8707 composite character.)
8709 The behavior implemented below means, for continuation lines,
8710 that as many spaces of a TAB as fit on the current line are
8711 displayed there. For terminal frames, as many glyphs of a
8712 multi-glyph character are displayed in the current line, too.
8713 This is what the old redisplay code did, and we keep it that
8714 way. Under X, the whole shape of a complex character must
8715 fit on the line or it will be completely displayed in the
8718 Note that both for tabs and padding glyphs, all glyphs have
8722 /* More than one glyph or glyph doesn't fit on line. All
8723 glyphs have the same width. */
8724 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8726 int x_before_this_char
= x
;
8727 int hpos_before_this_char
= it
->hpos
;
8729 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8731 new_x
= x
+ single_glyph_width
;
8733 /* We want to leave anything reaching TO_X to the caller. */
8734 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8736 if (BUFFER_POS_REACHED_P ())
8738 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8739 goto buffer_pos_reached
;
8740 if (atpos_it
.sp
< 0)
8742 SAVE_IT (atpos_it
, *it
, atpos_data
);
8743 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8748 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8751 result
= MOVE_X_REACHED
;
8756 SAVE_IT (atx_it
, *it
, atx_data
);
8757 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8762 if (/* Lines are continued. */
8763 it
->line_wrap
!= TRUNCATE
8764 && (/* And glyph doesn't fit on the line. */
8765 new_x
> it
->last_visible_x
8766 /* Or it fits exactly and we're on a window
8768 || (new_x
== it
->last_visible_x
8769 && FRAME_WINDOW_P (it
->f
)
8770 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8771 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8772 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8774 if (/* IT->hpos == 0 means the very first glyph
8775 doesn't fit on the line, e.g. a wide image. */
8777 || (new_x
== it
->last_visible_x
8778 && FRAME_WINDOW_P (it
->f
)
8779 /* When word-wrap is ON and we have a valid
8780 wrap point, we don't allow the last glyph
8781 to "just barely fit" on the line. */
8782 && (it
->line_wrap
!= WORD_WRAP
8783 || wrap_it
.sp
< 0)))
8786 it
->current_x
= new_x
;
8788 /* The character's last glyph just barely fits
8790 if (i
== it
->nglyphs
- 1)
8792 /* If this is the destination position,
8793 return a position *before* it in this row,
8794 now that we know it fits in this row. */
8795 if (BUFFER_POS_REACHED_P ())
8797 if (it
->line_wrap
!= WORD_WRAP
8800 it
->hpos
= hpos_before_this_char
;
8801 it
->current_x
= x_before_this_char
;
8802 result
= MOVE_POS_MATCH_OR_ZV
;
8805 if (it
->line_wrap
== WORD_WRAP
8808 SAVE_IT (atpos_it
, *it
, atpos_data
);
8809 atpos_it
.current_x
= x_before_this_char
;
8810 atpos_it
.hpos
= hpos_before_this_char
;
8814 prev_method
= it
->method
;
8815 if (it
->method
== GET_FROM_BUFFER
)
8816 prev_pos
= IT_CHARPOS (*it
);
8817 set_iterator_to_next (it
, 1);
8818 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8819 SET_TEXT_POS (this_line_min_pos
,
8820 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8821 /* On graphical terminals, newlines may
8822 "overflow" into the fringe if
8823 overflow-newline-into-fringe is non-nil.
8824 On text terminals, and on graphical
8825 terminals with no right margin, newlines
8826 may overflow into the last glyph on the
8828 if (!FRAME_WINDOW_P (it
->f
)
8830 && it
->bidi_it
.paragraph_dir
== R2L
)
8831 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8832 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8833 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8835 if (!get_next_display_element (it
))
8837 result
= MOVE_POS_MATCH_OR_ZV
;
8840 if (BUFFER_POS_REACHED_P ())
8842 if (ITERATOR_AT_END_OF_LINE_P (it
))
8843 result
= MOVE_POS_MATCH_OR_ZV
;
8845 result
= MOVE_LINE_CONTINUED
;
8848 if (ITERATOR_AT_END_OF_LINE_P (it
)
8849 && (it
->line_wrap
!= WORD_WRAP
8852 result
= MOVE_NEWLINE_OR_CR
;
8859 IT_RESET_X_ASCENT_DESCENT (it
);
8861 if (wrap_it
.sp
>= 0)
8863 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8868 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8870 result
= MOVE_LINE_CONTINUED
;
8874 if (BUFFER_POS_REACHED_P ())
8876 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8877 goto buffer_pos_reached
;
8878 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8880 SAVE_IT (atpos_it
, *it
, atpos_data
);
8881 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8885 if (new_x
> it
->first_visible_x
)
8887 /* Glyph is visible. Increment number of glyphs that
8888 would be displayed. */
8893 if (result
!= MOVE_UNDEFINED
)
8896 else if (BUFFER_POS_REACHED_P ())
8899 IT_RESET_X_ASCENT_DESCENT (it
);
8900 result
= MOVE_POS_MATCH_OR_ZV
;
8903 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8905 /* Stop when TO_X specified and reached. This check is
8906 necessary here because of lines consisting of a line end,
8907 only. The line end will not produce any glyphs and we
8908 would never get MOVE_X_REACHED. */
8909 eassert (it
->nglyphs
== 0);
8910 result
= MOVE_X_REACHED
;
8914 /* Is this a line end? If yes, we're done. */
8915 if (ITERATOR_AT_END_OF_LINE_P (it
))
8917 /* If we are past TO_CHARPOS, but never saw any character
8918 positions smaller than TO_CHARPOS, return
8919 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8921 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8923 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8925 if (closest_pos
< ZV
)
8927 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8928 /* Don't recurse if closest_pos is equal to
8929 to_charpos, since we have just tried that. */
8930 if (closest_pos
!= to_charpos
)
8931 move_it_in_display_line_to (it
, closest_pos
, -1,
8933 result
= MOVE_POS_MATCH_OR_ZV
;
8936 goto buffer_pos_reached
;
8938 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8939 && IT_CHARPOS (*it
) > to_charpos
)
8940 goto buffer_pos_reached
;
8942 result
= MOVE_NEWLINE_OR_CR
;
8945 result
= MOVE_NEWLINE_OR_CR
;
8949 prev_method
= it
->method
;
8950 if (it
->method
== GET_FROM_BUFFER
)
8951 prev_pos
= IT_CHARPOS (*it
);
8952 /* The current display element has been consumed. Advance
8954 set_iterator_to_next (it
, 1);
8955 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8956 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8957 if (IT_CHARPOS (*it
) < to_charpos
)
8958 saw_smaller_pos
= 1;
8960 && (op
& MOVE_TO_POS
)
8961 && IT_CHARPOS (*it
) >= to_charpos
8962 && IT_CHARPOS (*it
) < closest_pos
)
8963 closest_pos
= IT_CHARPOS (*it
);
8965 /* Stop if lines are truncated and IT's current x-position is
8966 past the right edge of the window now. */
8967 if (it
->line_wrap
== TRUNCATE
8968 && it
->current_x
>= it
->last_visible_x
)
8970 if (!FRAME_WINDOW_P (it
->f
)
8971 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8972 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8973 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8974 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8978 if ((at_eob_p
= !get_next_display_element (it
))
8979 || BUFFER_POS_REACHED_P ()
8980 /* If we are past TO_CHARPOS, but never saw any
8981 character positions smaller than TO_CHARPOS,
8982 return MOVE_POS_MATCH_OR_ZV, like the
8983 unidirectional display did. */
8984 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8986 && IT_CHARPOS (*it
) > to_charpos
))
8989 && !BUFFER_POS_REACHED_P ()
8990 && !at_eob_p
&& closest_pos
< ZV
)
8992 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8993 if (closest_pos
!= to_charpos
)
8994 move_it_in_display_line_to (it
, closest_pos
, -1,
8997 result
= MOVE_POS_MATCH_OR_ZV
;
9000 if (ITERATOR_AT_END_OF_LINE_P (it
))
9002 result
= MOVE_NEWLINE_OR_CR
;
9006 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9008 && IT_CHARPOS (*it
) > to_charpos
)
9010 if (closest_pos
< ZV
)
9012 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9013 if (closest_pos
!= to_charpos
)
9014 move_it_in_display_line_to (it
, closest_pos
, -1,
9017 result
= MOVE_POS_MATCH_OR_ZV
;
9020 result
= MOVE_LINE_TRUNCATED
;
9023 #undef IT_RESET_X_ASCENT_DESCENT
9026 #undef BUFFER_POS_REACHED_P
9028 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9029 restore the saved iterator. */
9030 if (atpos_it
.sp
>= 0)
9031 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9032 else if (atx_it
.sp
>= 0)
9033 RESTORE_IT (it
, &atx_it
, atx_data
);
9038 bidi_unshelve_cache (atpos_data
, 1);
9040 bidi_unshelve_cache (atx_data
, 1);
9042 bidi_unshelve_cache (wrap_data
, 1);
9044 bidi_unshelve_cache (ppos_data
, 1);
9046 /* Restore the iterator settings altered at the beginning of this
9048 it
->glyph_row
= saved_glyph_row
;
9052 /* For external use. */
9054 move_it_in_display_line (struct it
*it
,
9055 ptrdiff_t to_charpos
, int to_x
,
9056 enum move_operation_enum op
)
9058 if (it
->line_wrap
== WORD_WRAP
9059 && (op
& MOVE_TO_X
))
9062 void *save_data
= NULL
;
9065 SAVE_IT (save_it
, *it
, save_data
);
9066 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9067 /* When word-wrap is on, TO_X may lie past the end
9068 of a wrapped line. Then it->current is the
9069 character on the next line, so backtrack to the
9070 space before the wrap point. */
9071 if (skip
== MOVE_LINE_CONTINUED
)
9073 int prev_x
= max (it
->current_x
- 1, 0);
9074 RESTORE_IT (it
, &save_it
, save_data
);
9075 move_it_in_display_line_to
9076 (it
, -1, prev_x
, MOVE_TO_X
);
9079 bidi_unshelve_cache (save_data
, 1);
9082 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9086 /* Move IT forward until it satisfies one or more of the criteria in
9087 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9089 OP is a bit-mask that specifies where to stop, and in particular,
9090 which of those four position arguments makes a difference. See the
9091 description of enum move_operation_enum.
9093 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9094 screen line, this function will set IT to the next position that is
9095 displayed to the right of TO_CHARPOS on the screen.
9097 Return the maximum pixel length of any line scanned but never more
9098 than it.last_visible_x. */
9101 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9103 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9104 int line_height
, line_start_x
= 0, reached
= 0;
9105 int max_current_x
= 0;
9106 void *backup_data
= NULL
;
9110 if (op
& MOVE_TO_VPOS
)
9112 /* If no TO_CHARPOS and no TO_X specified, stop at the
9113 start of the line TO_VPOS. */
9114 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9116 if (it
->vpos
== to_vpos
)
9122 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9126 /* TO_VPOS >= 0 means stop at TO_X in the line at
9127 TO_VPOS, or at TO_POS, whichever comes first. */
9128 if (it
->vpos
== to_vpos
)
9134 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9136 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9141 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9143 /* We have reached TO_X but not in the line we want. */
9144 skip
= move_it_in_display_line_to (it
, to_charpos
,
9146 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9154 else if (op
& MOVE_TO_Y
)
9156 struct it it_backup
;
9158 if (it
->line_wrap
== WORD_WRAP
)
9159 SAVE_IT (it_backup
, *it
, backup_data
);
9161 /* TO_Y specified means stop at TO_X in the line containing
9162 TO_Y---or at TO_CHARPOS if this is reached first. The
9163 problem is that we can't really tell whether the line
9164 contains TO_Y before we have completely scanned it, and
9165 this may skip past TO_X. What we do is to first scan to
9168 If TO_X is not specified, use a TO_X of zero. The reason
9169 is to make the outcome of this function more predictable.
9170 If we didn't use TO_X == 0, we would stop at the end of
9171 the line which is probably not what a caller would expect
9173 skip
= move_it_in_display_line_to
9174 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9175 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9177 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9178 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9180 else if (skip
== MOVE_X_REACHED
)
9182 /* If TO_X was reached, we want to know whether TO_Y is
9183 in the line. We know this is the case if the already
9184 scanned glyphs make the line tall enough. Otherwise,
9185 we must check by scanning the rest of the line. */
9186 line_height
= it
->max_ascent
+ it
->max_descent
;
9187 if (to_y
>= it
->current_y
9188 && to_y
< it
->current_y
+ line_height
)
9193 SAVE_IT (it_backup
, *it
, backup_data
);
9194 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9195 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9197 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9198 line_height
= it
->max_ascent
+ it
->max_descent
;
9199 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9201 if (to_y
>= it
->current_y
9202 && to_y
< it
->current_y
+ line_height
)
9204 /* If TO_Y is in this line and TO_X was reached
9205 above, we scanned too far. We have to restore
9206 IT's settings to the ones before skipping. But
9207 keep the more accurate values of max_ascent and
9208 max_descent we've found while skipping the rest
9209 of the line, for the sake of callers, such as
9210 pos_visible_p, that need to know the line
9212 int max_ascent
= it
->max_ascent
;
9213 int max_descent
= it
->max_descent
;
9215 RESTORE_IT (it
, &it_backup
, backup_data
);
9216 it
->max_ascent
= max_ascent
;
9217 it
->max_descent
= max_descent
;
9223 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9229 /* Check whether TO_Y is in this line. */
9230 line_height
= it
->max_ascent
+ it
->max_descent
;
9231 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9233 if (to_y
>= it
->current_y
9234 && to_y
< it
->current_y
+ line_height
)
9236 if (to_y
> it
->current_y
)
9237 max_current_x
= max (it
->current_x
, max_current_x
);
9239 /* When word-wrap is on, TO_X may lie past the end
9240 of a wrapped line. Then it->current is the
9241 character on the next line, so backtrack to the
9242 space before the wrap point. */
9243 if (skip
== MOVE_LINE_CONTINUED
9244 && it
->line_wrap
== WORD_WRAP
)
9246 int prev_x
= max (it
->current_x
- 1, 0);
9247 RESTORE_IT (it
, &it_backup
, backup_data
);
9248 skip
= move_it_in_display_line_to
9249 (it
, -1, prev_x
, MOVE_TO_X
);
9258 max_current_x
= max (it
->current_x
, max_current_x
);
9262 else if (BUFFERP (it
->object
)
9263 && (it
->method
== GET_FROM_BUFFER
9264 || it
->method
== GET_FROM_STRETCH
)
9265 && IT_CHARPOS (*it
) >= to_charpos
9266 /* Under bidi iteration, a call to set_iterator_to_next
9267 can scan far beyond to_charpos if the initial
9268 portion of the next line needs to be reordered. In
9269 that case, give move_it_in_display_line_to another
9272 && it
->bidi_it
.scan_dir
== -1))
9273 skip
= MOVE_POS_MATCH_OR_ZV
;
9275 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9279 case MOVE_POS_MATCH_OR_ZV
:
9280 max_current_x
= max (it
->current_x
, max_current_x
);
9284 case MOVE_NEWLINE_OR_CR
:
9285 max_current_x
= max (it
->current_x
, max_current_x
);
9286 set_iterator_to_next (it
, 1);
9287 it
->continuation_lines_width
= 0;
9290 case MOVE_LINE_TRUNCATED
:
9291 max_current_x
= it
->last_visible_x
;
9292 it
->continuation_lines_width
= 0;
9293 reseat_at_next_visible_line_start (it
, 0);
9294 if ((op
& MOVE_TO_POS
) != 0
9295 && IT_CHARPOS (*it
) > to_charpos
)
9302 case MOVE_LINE_CONTINUED
:
9303 max_current_x
= it
->last_visible_x
;
9304 /* For continued lines ending in a tab, some of the glyphs
9305 associated with the tab are displayed on the current
9306 line. Since it->current_x does not include these glyphs,
9307 we use it->last_visible_x instead. */
9310 it
->continuation_lines_width
+= it
->last_visible_x
;
9311 /* When moving by vpos, ensure that the iterator really
9312 advances to the next line (bug#847, bug#969). Fixme:
9313 do we need to do this in other circumstances? */
9314 if (it
->current_x
!= it
->last_visible_x
9315 && (op
& MOVE_TO_VPOS
)
9316 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9318 line_start_x
= it
->current_x
+ it
->pixel_width
9319 - it
->last_visible_x
;
9320 if (FRAME_WINDOW_P (it
->f
))
9322 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9323 struct font
*face_font
= face
->font
;
9325 /* When display_line produces a continued line
9326 that ends in a TAB, it skips a tab stop that
9327 is closer than the font's space character
9328 width (see x_produce_glyphs where it produces
9329 the stretch glyph which represents a TAB).
9330 We need to reproduce the same logic here. */
9331 eassert (face_font
);
9334 if (line_start_x
< face_font
->space_width
)
9336 += it
->tab_width
* face_font
->space_width
;
9339 set_iterator_to_next (it
, 0);
9343 it
->continuation_lines_width
+= it
->current_x
;
9350 /* Reset/increment for the next run. */
9351 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9352 it
->current_x
= line_start_x
;
9355 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9357 last_height
= it
->max_ascent
+ it
->max_descent
;
9358 it
->max_ascent
= it
->max_descent
= 0;
9363 /* On text terminals, we may stop at the end of a line in the middle
9364 of a multi-character glyph. If the glyph itself is continued,
9365 i.e. it is actually displayed on the next line, don't treat this
9366 stopping point as valid; move to the next line instead (unless
9367 that brings us offscreen). */
9368 if (!FRAME_WINDOW_P (it
->f
)
9370 && IT_CHARPOS (*it
) == to_charpos
9371 && it
->what
== IT_CHARACTER
9373 && it
->line_wrap
== WINDOW_WRAP
9374 && it
->current_x
== it
->last_visible_x
- 1
9377 && it
->vpos
< it
->w
->window_end_vpos
)
9379 it
->continuation_lines_width
+= it
->current_x
;
9380 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9381 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9383 last_height
= it
->max_ascent
+ it
->max_descent
;
9387 bidi_unshelve_cache (backup_data
, 1);
9389 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9391 return max_current_x
;
9395 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9397 If DY > 0, move IT backward at least that many pixels. DY = 0
9398 means move IT backward to the preceding line start or BEGV. This
9399 function may move over more than DY pixels if IT->current_y - DY
9400 ends up in the middle of a line; in this case IT->current_y will be
9401 set to the top of the line moved to. */
9404 move_it_vertically_backward (struct it
*it
, int dy
)
9408 void *it2data
= NULL
, *it3data
= NULL
;
9409 ptrdiff_t start_pos
;
9411 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9412 ptrdiff_t pos_limit
;
9417 start_pos
= IT_CHARPOS (*it
);
9419 /* Estimate how many newlines we must move back. */
9420 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9421 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9424 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9426 /* Set the iterator's position that many lines back. But don't go
9427 back more than NLINES full screen lines -- this wins a day with
9428 buffers which have very long lines. */
9429 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9430 back_to_previous_visible_line_start (it
);
9432 /* Reseat the iterator here. When moving backward, we don't want
9433 reseat to skip forward over invisible text, set up the iterator
9434 to deliver from overlay strings at the new position etc. So,
9435 use reseat_1 here. */
9436 reseat_1 (it
, it
->current
.pos
, 1);
9438 /* We are now surely at a line start. */
9439 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9440 reordering is in effect. */
9441 it
->continuation_lines_width
= 0;
9443 /* Move forward and see what y-distance we moved. First move to the
9444 start of the next line so that we get its height. We need this
9445 height to be able to tell whether we reached the specified
9447 SAVE_IT (it2
, *it
, it2data
);
9448 it2
.max_ascent
= it2
.max_descent
= 0;
9451 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9452 MOVE_TO_POS
| MOVE_TO_VPOS
);
9454 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9455 /* If we are in a display string which starts at START_POS,
9456 and that display string includes a newline, and we are
9457 right after that newline (i.e. at the beginning of a
9458 display line), exit the loop, because otherwise we will
9459 infloop, since move_it_to will see that it is already at
9460 START_POS and will not move. */
9461 || (it2
.method
== GET_FROM_STRING
9462 && IT_CHARPOS (it2
) == start_pos
9463 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9464 eassert (IT_CHARPOS (*it
) >= BEGV
);
9465 SAVE_IT (it3
, it2
, it3data
);
9467 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9468 eassert (IT_CHARPOS (*it
) >= BEGV
);
9469 /* H is the actual vertical distance from the position in *IT
9470 and the starting position. */
9471 h
= it2
.current_y
- it
->current_y
;
9472 /* NLINES is the distance in number of lines. */
9473 nlines
= it2
.vpos
- it
->vpos
;
9475 /* Correct IT's y and vpos position
9476 so that they are relative to the starting point. */
9482 /* DY == 0 means move to the start of the screen line. The
9483 value of nlines is > 0 if continuation lines were involved,
9484 or if the original IT position was at start of a line. */
9485 RESTORE_IT (it
, it
, it2data
);
9487 move_it_by_lines (it
, nlines
);
9488 /* The above code moves us to some position NLINES down,
9489 usually to its first glyph (leftmost in an L2R line), but
9490 that's not necessarily the start of the line, under bidi
9491 reordering. We want to get to the character position
9492 that is immediately after the newline of the previous
9495 && !it
->continuation_lines_width
9496 && !STRINGP (it
->string
)
9497 && IT_CHARPOS (*it
) > BEGV
9498 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9500 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9503 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9504 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9506 bidi_unshelve_cache (it3data
, 1);
9510 /* The y-position we try to reach, relative to *IT.
9511 Note that H has been subtracted in front of the if-statement. */
9512 int target_y
= it
->current_y
+ h
- dy
;
9513 int y0
= it3
.current_y
;
9517 RESTORE_IT (&it3
, &it3
, it3data
);
9518 y1
= line_bottom_y (&it3
);
9519 line_height
= y1
- y0
;
9520 RESTORE_IT (it
, it
, it2data
);
9521 /* If we did not reach target_y, try to move further backward if
9522 we can. If we moved too far backward, try to move forward. */
9523 if (target_y
< it
->current_y
9524 /* This is heuristic. In a window that's 3 lines high, with
9525 a line height of 13 pixels each, recentering with point
9526 on the bottom line will try to move -39/2 = 19 pixels
9527 backward. Try to avoid moving into the first line. */
9528 && (it
->current_y
- target_y
9529 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9530 && IT_CHARPOS (*it
) > BEGV
)
9532 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9533 target_y
- it
->current_y
));
9534 dy
= it
->current_y
- target_y
;
9535 goto move_further_back
;
9537 else if (target_y
>= it
->current_y
+ line_height
9538 && IT_CHARPOS (*it
) < ZV
)
9540 /* Should move forward by at least one line, maybe more.
9542 Note: Calling move_it_by_lines can be expensive on
9543 terminal frames, where compute_motion is used (via
9544 vmotion) to do the job, when there are very long lines
9545 and truncate-lines is nil. That's the reason for
9546 treating terminal frames specially here. */
9548 if (!FRAME_WINDOW_P (it
->f
))
9549 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9554 move_it_by_lines (it
, 1);
9556 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9563 /* Move IT by a specified amount of pixel lines DY. DY negative means
9564 move backwards. DY = 0 means move to start of screen line. At the
9565 end, IT will be on the start of a screen line. */
9568 move_it_vertically (struct it
*it
, int dy
)
9571 move_it_vertically_backward (it
, -dy
);
9574 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9575 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9576 MOVE_TO_POS
| MOVE_TO_Y
);
9577 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9579 /* If buffer ends in ZV without a newline, move to the start of
9580 the line to satisfy the post-condition. */
9581 if (IT_CHARPOS (*it
) == ZV
9583 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9584 move_it_by_lines (it
, 0);
9589 /* Move iterator IT past the end of the text line it is in. */
9592 move_it_past_eol (struct it
*it
)
9594 enum move_it_result rc
;
9596 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9597 if (rc
== MOVE_NEWLINE_OR_CR
)
9598 set_iterator_to_next (it
, 0);
9602 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9603 negative means move up. DVPOS == 0 means move to the start of the
9606 Optimization idea: If we would know that IT->f doesn't use
9607 a face with proportional font, we could be faster for
9608 truncate-lines nil. */
9611 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9614 /* The commented-out optimization uses vmotion on terminals. This
9615 gives bad results, because elements like it->what, on which
9616 callers such as pos_visible_p rely, aren't updated. */
9617 /* struct position pos;
9618 if (!FRAME_WINDOW_P (it->f))
9620 struct text_pos textpos;
9622 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9623 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9624 reseat (it, textpos, 1);
9625 it->vpos += pos.vpos;
9626 it->current_y += pos.vpos;
9632 /* DVPOS == 0 means move to the start of the screen line. */
9633 move_it_vertically_backward (it
, 0);
9634 /* Let next call to line_bottom_y calculate real line height. */
9639 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9640 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9642 /* Only move to the next buffer position if we ended up in a
9643 string from display property, not in an overlay string
9644 (before-string or after-string). That is because the
9645 latter don't conceal the underlying buffer position, so
9646 we can ask to move the iterator to the exact position we
9647 are interested in. Note that, even if we are already at
9648 IT_CHARPOS (*it), the call below is not a no-op, as it
9649 will detect that we are at the end of the string, pop the
9650 iterator, and compute it->current_x and it->hpos
9652 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9653 -1, -1, -1, MOVE_TO_POS
);
9659 void *it2data
= NULL
;
9660 ptrdiff_t start_charpos
, i
;
9662 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9663 bool hit_pos_limit
= false;
9664 ptrdiff_t pos_limit
;
9666 /* Start at the beginning of the screen line containing IT's
9667 position. This may actually move vertically backwards,
9668 in case of overlays, so adjust dvpos accordingly. */
9670 move_it_vertically_backward (it
, 0);
9673 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9674 screen lines, and reseat the iterator there. */
9675 start_charpos
= IT_CHARPOS (*it
);
9676 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9679 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9681 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9682 back_to_previous_visible_line_start (it
);
9683 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9684 hit_pos_limit
= true;
9685 reseat (it
, it
->current
.pos
, 1);
9687 /* Move further back if we end up in a string or an image. */
9688 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9690 /* First try to move to start of display line. */
9692 move_it_vertically_backward (it
, 0);
9694 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9696 /* If start of line is still in string or image,
9697 move further back. */
9698 back_to_previous_visible_line_start (it
);
9699 reseat (it
, it
->current
.pos
, 1);
9703 it
->current_x
= it
->hpos
= 0;
9705 /* Above call may have moved too far if continuation lines
9706 are involved. Scan forward and see if it did. */
9707 SAVE_IT (it2
, *it
, it2data
);
9708 it2
.vpos
= it2
.current_y
= 0;
9709 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9710 it
->vpos
-= it2
.vpos
;
9711 it
->current_y
-= it2
.current_y
;
9712 it
->current_x
= it
->hpos
= 0;
9714 /* If we moved too far back, move IT some lines forward. */
9715 if (it2
.vpos
> -dvpos
)
9717 int delta
= it2
.vpos
+ dvpos
;
9719 RESTORE_IT (&it2
, &it2
, it2data
);
9720 SAVE_IT (it2
, *it
, it2data
);
9721 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9722 /* Move back again if we got too far ahead. */
9723 if (IT_CHARPOS (*it
) >= start_charpos
)
9724 RESTORE_IT (it
, &it2
, it2data
);
9726 bidi_unshelve_cache (it2data
, 1);
9728 else if (hit_pos_limit
&& pos_limit
> BEGV
9729 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9731 /* If we hit the limit, but still didn't make it far enough
9732 back, that means there's a display string with a newline
9733 covering a large chunk of text, and that caused
9734 back_to_previous_visible_line_start try to go too far.
9735 Punish those who commit such atrocities by going back
9736 until we've reached DVPOS, after lifting the limit, which
9737 could make it slow for very long lines. "If it hurts,
9740 RESTORE_IT (it
, it
, it2data
);
9741 for (i
= -dvpos
; i
> 0; --i
)
9743 back_to_previous_visible_line_start (it
);
9748 RESTORE_IT (it
, it
, it2data
);
9752 /* Return true if IT points into the middle of a display vector. */
9755 in_display_vector_p (struct it
*it
)
9757 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9758 && it
->current
.dpvec_index
> 0
9759 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9762 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9763 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9764 WINDOW must be a live window and defaults to the selected one. The
9765 return value is a cons of the maximum pixel-width of any text line and
9766 the maximum pixel-height of all text lines.
9768 The optional argument FROM, if non-nil, specifies the first text
9769 position and defaults to the minimum accessible position of the buffer.
9770 If FROM is t, use the minimum accessible position that is not a newline
9771 character. TO, if non-nil, specifies the last text position and
9772 defaults to the maximum accessible position of the buffer. If TO is t,
9773 use the maximum accessible position that is not a newline character.
9775 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9776 width that can be returned. X-LIMIT nil or omitted, means to use the
9777 pixel-width of WINDOW's body; use this if you do not intend to change
9778 the width of WINDOW. Use the maximum width WINDOW may assume if you
9779 intend to change WINDOW's width. In any case, text whose x-coordinate
9780 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9781 can take some time, it's always a good idea to make this argument as
9782 small as possible; in particular, if the buffer contains long lines that
9783 shall be truncated anyway.
9785 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9786 height that can be returned. Text lines whose y-coordinate is beyond
9787 Y-LIMIT are ignored. Since calculating the text height of a large
9788 buffer can take some time, it makes sense to specify this argument if
9789 the size of the buffer is unknown.
9791 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9792 include the height of the mode- or header-line of WINDOW in the return
9793 value. If it is either the symbol `mode-line' or `header-line', include
9794 only the height of that line, if present, in the return value. If t,
9795 include the height of both, if present, in the return value. */)
9796 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9797 Lisp_Object mode_and_header_line
)
9799 struct window
*w
= decode_live_window (window
);
9803 struct buffer
*old_buffer
= NULL
;
9804 ptrdiff_t start
, end
, pos
;
9805 struct text_pos startp
;
9806 void *itdata
= NULL
;
9807 int c
, max_y
= -1, x
= 0, y
= 0;
9813 if (b
!= current_buffer
)
9815 old_buffer
= current_buffer
;
9816 set_buffer_internal (b
);
9821 else if (EQ (from
, Qt
))
9824 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9825 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9827 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9832 CHECK_NUMBER_COERCE_MARKER (from
);
9833 start
= min (max (XINT (from
), BEGV
), ZV
);
9838 else if (EQ (to
, Qt
))
9841 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9842 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9844 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9849 CHECK_NUMBER_COERCE_MARKER (to
);
9850 end
= max (start
, min (XINT (to
), ZV
));
9853 if (!NILP (y_limit
))
9855 CHECK_NUMBER (y_limit
);
9856 max_y
= min (XINT (y_limit
), INT_MAX
);
9859 itdata
= bidi_shelve_cache ();
9860 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9861 start_display (&it
, w
, startp
);
9864 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9867 CHECK_NUMBER (x_limit
);
9868 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9869 /* Actually, we never want move_it_to stop at to_x. But to make
9870 sure that move_it_in_display_line_to always moves far enough,
9871 we set it to INT_MAX and specify MOVE_TO_X. */
9872 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9873 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9876 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9878 if (!EQ (mode_and_header_line
, Qheader_line
)
9879 && !EQ (mode_and_header_line
, Qt
))
9880 /* Do not count the header-line which was counted automatically by
9882 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9884 if (EQ (mode_and_header_line
, Qmode_line
)
9885 || EQ (mode_and_header_line
, Qt
))
9886 /* Do count the mode-line which is not included automatically by
9888 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9890 bidi_unshelve_cache (itdata
, 0);
9893 set_buffer_internal (old_buffer
);
9895 return Fcons (make_number (x
), make_number (y
));
9898 /***********************************************************************
9900 ***********************************************************************/
9903 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9907 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9909 Lisp_Object args
[3];
9910 Lisp_Object msg
, fmt
;
9913 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9917 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9919 args
[0] = fmt
= build_string (format
);
9922 msg
= Fformat (3, args
);
9924 len
= SBYTES (msg
) + 1;
9925 buffer
= SAFE_ALLOCA (len
);
9926 memcpy (buffer
, SDATA (msg
), len
);
9928 message_dolog (buffer
, len
- 1, 1, 0);
9935 /* Output a newline in the *Messages* buffer if "needs" one. */
9938 message_log_maybe_newline (void)
9940 if (message_log_need_newline
)
9941 message_dolog ("", 0, 1, 0);
9945 /* Add a string M of length NBYTES to the message log, optionally
9946 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9947 true, means interpret the contents of M as multibyte. This
9948 function calls low-level routines in order to bypass text property
9949 hooks, etc. which might not be safe to run.
9951 This may GC (insert may run before/after change hooks),
9952 so the buffer M must NOT point to a Lisp string. */
9955 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9957 const unsigned char *msg
= (const unsigned char *) m
;
9959 if (!NILP (Vmemory_full
))
9962 if (!NILP (Vmessage_log_max
))
9964 struct buffer
*oldbuf
;
9965 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9966 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9967 ptrdiff_t point_at_end
= 0;
9968 ptrdiff_t zv_at_end
= 0;
9969 Lisp_Object old_deactivate_mark
;
9970 struct gcpro gcpro1
;
9972 old_deactivate_mark
= Vdeactivate_mark
;
9973 oldbuf
= current_buffer
;
9975 /* Ensure the Messages buffer exists, and switch to it.
9976 If we created it, set the major-mode. */
9979 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9981 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9984 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9985 call0 (intern ("messages-buffer-mode"));
9988 bset_undo_list (current_buffer
, Qt
);
9989 bset_cache_long_scans (current_buffer
, Qnil
);
9991 oldpoint
= message_dolog_marker1
;
9992 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9993 oldbegv
= message_dolog_marker2
;
9994 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9995 oldzv
= message_dolog_marker3
;
9996 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9997 GCPRO1 (old_deactivate_mark
);
10005 BEGV_BYTE
= BEG_BYTE
;
10008 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10010 /* Insert the string--maybe converting multibyte to single byte
10011 or vice versa, so that all the text fits the buffer. */
10013 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10019 /* Convert a multibyte string to single-byte
10020 for the *Message* buffer. */
10021 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10023 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10024 work
[0] = CHAR_TO_BYTE8 (c
);
10025 insert_1_both (work
, 1, 1, 1, 0, 0);
10028 else if (! multibyte
10029 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10033 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10034 /* Convert a single-byte string to multibyte
10035 for the *Message* buffer. */
10036 for (i
= 0; i
< nbytes
; i
++)
10039 MAKE_CHAR_MULTIBYTE (c
);
10040 char_bytes
= CHAR_STRING (c
, str
);
10041 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10045 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10049 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10052 insert_1_both ("\n", 1, 1, 1, 0, 0);
10054 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10056 this_bol_byte
= PT_BYTE
;
10058 /* See if this line duplicates the previous one.
10059 If so, combine duplicates. */
10060 if (this_bol
> BEG
)
10062 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10064 prev_bol_byte
= PT_BYTE
;
10066 dups
= message_log_check_duplicate (prev_bol_byte
,
10070 del_range_both (prev_bol
, prev_bol_byte
,
10071 this_bol
, this_bol_byte
, 0);
10074 char dupstr
[sizeof " [ times]"
10075 + INT_STRLEN_BOUND (printmax_t
)];
10077 /* If you change this format, don't forget to also
10078 change message_log_check_duplicate. */
10079 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10080 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10081 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10086 /* If we have more than the desired maximum number of lines
10087 in the *Messages* buffer now, delete the oldest ones.
10088 This is safe because we don't have undo in this buffer. */
10090 if (NATNUMP (Vmessage_log_max
))
10092 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10093 -XFASTINT (Vmessage_log_max
) - 1, 0);
10094 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10097 BEGV
= marker_position (oldbegv
);
10098 BEGV_BYTE
= marker_byte_position (oldbegv
);
10107 ZV
= marker_position (oldzv
);
10108 ZV_BYTE
= marker_byte_position (oldzv
);
10112 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10114 /* We can't do Fgoto_char (oldpoint) because it will run some
10116 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10117 marker_byte_position (oldpoint
));
10120 unchain_marker (XMARKER (oldpoint
));
10121 unchain_marker (XMARKER (oldbegv
));
10122 unchain_marker (XMARKER (oldzv
));
10124 /* We called insert_1_both above with its 5th argument (PREPARE)
10125 zero, which prevents insert_1_both from calling
10126 prepare_to_modify_buffer, which in turns prevents us from
10127 incrementing windows_or_buffers_changed even if *Messages* is
10128 shown in some window. So we must manually set
10129 windows_or_buffers_changed here to make up for that. */
10130 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10131 bset_redisplay (current_buffer
);
10133 set_buffer_internal (oldbuf
);
10135 message_log_need_newline
= !nlflag
;
10136 Vdeactivate_mark
= old_deactivate_mark
;
10141 /* We are at the end of the buffer after just having inserted a newline.
10142 (Note: We depend on the fact we won't be crossing the gap.)
10143 Check to see if the most recent message looks a lot like the previous one.
10144 Return 0 if different, 1 if the new one should just replace it, or a
10145 value N > 1 if we should also append " [N times]". */
10148 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10151 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10153 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10154 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10156 for (i
= 0; i
< len
; i
++)
10158 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10160 if (p1
[i
] != p2
[i
])
10166 if (*p1
++ == ' ' && *p1
++ == '[')
10169 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10170 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10177 /* Display an echo area message M with a specified length of NBYTES
10178 bytes. The string may include null characters. If M is not a
10179 string, clear out any existing message, and let the mini-buffer
10182 This function cancels echoing. */
10185 message3 (Lisp_Object m
)
10187 struct gcpro gcpro1
;
10190 clear_message (true, true);
10193 /* First flush out any partial line written with print. */
10194 message_log_maybe_newline ();
10197 ptrdiff_t nbytes
= SBYTES (m
);
10198 bool multibyte
= STRING_MULTIBYTE (m
);
10201 SAFE_ALLOCA_STRING (buffer
, m
);
10202 message_dolog (buffer
, nbytes
, 1, multibyte
);
10205 message3_nolog (m
);
10211 /* The non-logging version of message3.
10212 This does not cancel echoing, because it is used for echoing.
10213 Perhaps we need to make a separate function for echoing
10214 and make this cancel echoing. */
10217 message3_nolog (Lisp_Object m
)
10219 struct frame
*sf
= SELECTED_FRAME ();
10221 if (FRAME_INITIAL_P (sf
))
10223 if (noninteractive_need_newline
)
10224 putc ('\n', stderr
);
10225 noninteractive_need_newline
= 0;
10228 Lisp_Object s
= ENCODE_SYSTEM (m
);
10230 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10232 if (cursor_in_echo_area
== 0)
10233 fprintf (stderr
, "\n");
10236 /* Error messages get reported properly by cmd_error, so this must be just an
10237 informative message; if the frame hasn't really been initialized yet, just
10239 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10241 /* Get the frame containing the mini-buffer
10242 that the selected frame is using. */
10243 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10244 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10245 struct frame
*f
= XFRAME (frame
);
10247 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10248 Fmake_frame_visible (frame
);
10250 if (STRINGP (m
) && SCHARS (m
) > 0)
10253 if (minibuffer_auto_raise
)
10254 Fraise_frame (frame
);
10255 /* Assume we are not echoing.
10256 (If we are, echo_now will override this.) */
10257 echo_message_buffer
= Qnil
;
10260 clear_message (true, true);
10262 do_pending_window_change (0);
10263 echo_area_display (1);
10264 do_pending_window_change (0);
10265 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10266 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10271 /* Display a null-terminated echo area message M. If M is 0, clear
10272 out any existing message, and let the mini-buffer text show through.
10274 The buffer M must continue to exist until after the echo area gets
10275 cleared or some other message gets displayed there. Do not pass
10276 text that is stored in a Lisp string. Do not pass text in a buffer
10277 that was alloca'd. */
10280 message1 (const char *m
)
10282 message3 (m
? build_unibyte_string (m
) : Qnil
);
10286 /* The non-logging counterpart of message1. */
10289 message1_nolog (const char *m
)
10291 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10294 /* Display a message M which contains a single %s
10295 which gets replaced with STRING. */
10298 message_with_string (const char *m
, Lisp_Object string
, int log
)
10300 CHECK_STRING (string
);
10302 if (noninteractive
)
10306 /* ENCODE_SYSTEM below can GC and/or relocate the
10307 Lisp data, so make sure we don't use it here. */
10308 eassert (relocatable_string_data_p (m
) != 1);
10310 if (noninteractive_need_newline
)
10311 putc ('\n', stderr
);
10312 noninteractive_need_newline
= 0;
10313 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10314 if (!cursor_in_echo_area
)
10315 fprintf (stderr
, "\n");
10319 else if (INTERACTIVE
)
10321 /* The frame whose minibuffer we're going to display the message on.
10322 It may be larger than the selected frame, so we need
10323 to use its buffer, not the selected frame's buffer. */
10324 Lisp_Object mini_window
;
10325 struct frame
*f
, *sf
= SELECTED_FRAME ();
10327 /* Get the frame containing the minibuffer
10328 that the selected frame is using. */
10329 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10330 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10332 /* Error messages get reported properly by cmd_error, so this must be
10333 just an informative message; if the frame hasn't really been
10334 initialized yet, just toss it. */
10335 if (f
->glyphs_initialized_p
)
10337 Lisp_Object args
[2], msg
;
10338 struct gcpro gcpro1
, gcpro2
;
10340 args
[0] = build_string (m
);
10341 args
[1] = msg
= string
;
10342 GCPRO2 (args
[0], msg
);
10345 msg
= Fformat (2, args
);
10350 message3_nolog (msg
);
10354 /* Print should start at the beginning of the message
10355 buffer next time. */
10356 message_buf_print
= 0;
10362 /* Dump an informative message to the minibuf. If M is 0, clear out
10363 any existing message, and let the mini-buffer text show through. */
10366 vmessage (const char *m
, va_list ap
)
10368 if (noninteractive
)
10372 if (noninteractive_need_newline
)
10373 putc ('\n', stderr
);
10374 noninteractive_need_newline
= 0;
10375 vfprintf (stderr
, m
, ap
);
10376 if (cursor_in_echo_area
== 0)
10377 fprintf (stderr
, "\n");
10381 else if (INTERACTIVE
)
10383 /* The frame whose mini-buffer we're going to display the message
10384 on. It may be larger than the selected frame, so we need to
10385 use its buffer, not the selected frame's buffer. */
10386 Lisp_Object mini_window
;
10387 struct frame
*f
, *sf
= SELECTED_FRAME ();
10389 /* Get the frame containing the mini-buffer
10390 that the selected frame is using. */
10391 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10392 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10394 /* Error messages get reported properly by cmd_error, so this must be
10395 just an informative message; if the frame hasn't really been
10396 initialized yet, just toss it. */
10397 if (f
->glyphs_initialized_p
)
10402 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10404 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10406 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10408 message3 (make_string (message_buf
, len
));
10414 /* Print should start at the beginning of the message
10415 buffer next time. */
10416 message_buf_print
= 0;
10422 message (const char *m
, ...)
10432 /* The non-logging version of message. */
10435 message_nolog (const char *m
, ...)
10437 Lisp_Object old_log_max
;
10440 old_log_max
= Vmessage_log_max
;
10441 Vmessage_log_max
= Qnil
;
10443 Vmessage_log_max
= old_log_max
;
10449 /* Display the current message in the current mini-buffer. This is
10450 only called from error handlers in process.c, and is not time
10454 update_echo_area (void)
10456 if (!NILP (echo_area_buffer
[0]))
10458 Lisp_Object string
;
10459 string
= Fcurrent_message ();
10465 /* Make sure echo area buffers in `echo_buffers' are live.
10466 If they aren't, make new ones. */
10469 ensure_echo_area_buffers (void)
10473 for (i
= 0; i
< 2; ++i
)
10474 if (!BUFFERP (echo_buffer
[i
])
10475 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10478 Lisp_Object old_buffer
;
10481 old_buffer
= echo_buffer
[i
];
10482 echo_buffer
[i
] = Fget_buffer_create
10483 (make_formatted_string (name
, " *Echo Area %d*", i
));
10484 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10485 /* to force word wrap in echo area -
10486 it was decided to postpone this*/
10487 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10489 for (j
= 0; j
< 2; ++j
)
10490 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10491 echo_area_buffer
[j
] = echo_buffer
[i
];
10496 /* Call FN with args A1..A2 with either the current or last displayed
10497 echo_area_buffer as current buffer.
10499 WHICH zero means use the current message buffer
10500 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10501 from echo_buffer[] and clear it.
10503 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10504 suitable buffer from echo_buffer[] and clear it.
10506 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10507 that the current message becomes the last displayed one, make
10508 choose a suitable buffer for echo_area_buffer[0], and clear it.
10510 Value is what FN returns. */
10513 with_echo_area_buffer (struct window
*w
, int which
,
10514 int (*fn
) (ptrdiff_t, Lisp_Object
),
10515 ptrdiff_t a1
, Lisp_Object a2
)
10517 Lisp_Object buffer
;
10518 int this_one
, the_other
, clear_buffer_p
, rc
;
10519 ptrdiff_t count
= SPECPDL_INDEX ();
10521 /* If buffers aren't live, make new ones. */
10522 ensure_echo_area_buffers ();
10524 clear_buffer_p
= 0;
10527 this_one
= 0, the_other
= 1;
10528 else if (which
> 0)
10529 this_one
= 1, the_other
= 0;
10532 this_one
= 0, the_other
= 1;
10533 clear_buffer_p
= true;
10535 /* We need a fresh one in case the current echo buffer equals
10536 the one containing the last displayed echo area message. */
10537 if (!NILP (echo_area_buffer
[this_one
])
10538 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10539 echo_area_buffer
[this_one
] = Qnil
;
10542 /* Choose a suitable buffer from echo_buffer[] is we don't
10544 if (NILP (echo_area_buffer
[this_one
]))
10546 echo_area_buffer
[this_one
]
10547 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10548 ? echo_buffer
[the_other
]
10549 : echo_buffer
[this_one
]);
10550 clear_buffer_p
= true;
10553 buffer
= echo_area_buffer
[this_one
];
10555 /* Don't get confused by reusing the buffer used for echoing
10556 for a different purpose. */
10557 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10560 record_unwind_protect (unwind_with_echo_area_buffer
,
10561 with_echo_area_buffer_unwind_data (w
));
10563 /* Make the echo area buffer current. Note that for display
10564 purposes, it is not necessary that the displayed window's buffer
10565 == current_buffer, except for text property lookup. So, let's
10566 only set that buffer temporarily here without doing a full
10567 Fset_window_buffer. We must also change w->pointm, though,
10568 because otherwise an assertions in unshow_buffer fails, and Emacs
10570 set_buffer_internal_1 (XBUFFER (buffer
));
10573 wset_buffer (w
, buffer
);
10574 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10575 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10578 bset_undo_list (current_buffer
, Qt
);
10579 bset_read_only (current_buffer
, Qnil
);
10580 specbind (Qinhibit_read_only
, Qt
);
10581 specbind (Qinhibit_modification_hooks
, Qt
);
10583 if (clear_buffer_p
&& Z
> BEG
)
10584 del_range (BEG
, Z
);
10586 eassert (BEGV
>= BEG
);
10587 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10591 eassert (BEGV
>= BEG
);
10592 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10594 unbind_to (count
, Qnil
);
10599 /* Save state that should be preserved around the call to the function
10600 FN called in with_echo_area_buffer. */
10603 with_echo_area_buffer_unwind_data (struct window
*w
)
10606 Lisp_Object vector
, tmp
;
10608 /* Reduce consing by keeping one vector in
10609 Vwith_echo_area_save_vector. */
10610 vector
= Vwith_echo_area_save_vector
;
10611 Vwith_echo_area_save_vector
= Qnil
;
10614 vector
= Fmake_vector (make_number (11), Qnil
);
10616 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10617 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10618 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10622 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10623 ASET (vector
, i
, w
->contents
); ++i
;
10624 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10625 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10626 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10627 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10628 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10629 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10634 for (; i
< end
; ++i
)
10635 ASET (vector
, i
, Qnil
);
10638 eassert (i
== ASIZE (vector
));
10643 /* Restore global state from VECTOR which was created by
10644 with_echo_area_buffer_unwind_data. */
10647 unwind_with_echo_area_buffer (Lisp_Object vector
)
10649 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10650 Vdeactivate_mark
= AREF (vector
, 1);
10651 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10653 if (WINDOWP (AREF (vector
, 3)))
10656 Lisp_Object buffer
;
10658 w
= XWINDOW (AREF (vector
, 3));
10659 buffer
= AREF (vector
, 4);
10661 wset_buffer (w
, buffer
);
10662 set_marker_both (w
->pointm
, buffer
,
10663 XFASTINT (AREF (vector
, 5)),
10664 XFASTINT (AREF (vector
, 6)));
10665 set_marker_both (w
->old_pointm
, buffer
,
10666 XFASTINT (AREF (vector
, 7)),
10667 XFASTINT (AREF (vector
, 8)));
10668 set_marker_both (w
->start
, buffer
,
10669 XFASTINT (AREF (vector
, 9)),
10670 XFASTINT (AREF (vector
, 10)));
10673 Vwith_echo_area_save_vector
= vector
;
10677 /* Set up the echo area for use by print functions. MULTIBYTE_P
10678 non-zero means we will print multibyte. */
10681 setup_echo_area_for_printing (int multibyte_p
)
10683 /* If we can't find an echo area any more, exit. */
10684 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10685 Fkill_emacs (Qnil
);
10687 ensure_echo_area_buffers ();
10689 if (!message_buf_print
)
10691 /* A message has been output since the last time we printed.
10692 Choose a fresh echo area buffer. */
10693 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10694 echo_area_buffer
[0] = echo_buffer
[1];
10696 echo_area_buffer
[0] = echo_buffer
[0];
10698 /* Switch to that buffer and clear it. */
10699 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10700 bset_truncate_lines (current_buffer
, Qnil
);
10704 ptrdiff_t count
= SPECPDL_INDEX ();
10705 specbind (Qinhibit_read_only
, Qt
);
10706 /* Note that undo recording is always disabled. */
10707 del_range (BEG
, Z
);
10708 unbind_to (count
, Qnil
);
10710 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10712 /* Set up the buffer for the multibyteness we need. */
10714 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10715 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10717 /* Raise the frame containing the echo area. */
10718 if (minibuffer_auto_raise
)
10720 struct frame
*sf
= SELECTED_FRAME ();
10721 Lisp_Object mini_window
;
10722 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10723 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10726 message_log_maybe_newline ();
10727 message_buf_print
= 1;
10731 if (NILP (echo_area_buffer
[0]))
10733 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10734 echo_area_buffer
[0] = echo_buffer
[1];
10736 echo_area_buffer
[0] = echo_buffer
[0];
10739 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10741 /* Someone switched buffers between print requests. */
10742 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10743 bset_truncate_lines (current_buffer
, Qnil
);
10749 /* Display an echo area message in window W. Value is non-zero if W's
10750 height is changed. If display_last_displayed_message_p is
10751 non-zero, display the message that was last displayed, otherwise
10752 display the current message. */
10755 display_echo_area (struct window
*w
)
10757 int i
, no_message_p
, window_height_changed_p
;
10759 /* Temporarily disable garbage collections while displaying the echo
10760 area. This is done because a GC can print a message itself.
10761 That message would modify the echo area buffer's contents while a
10762 redisplay of the buffer is going on, and seriously confuse
10764 ptrdiff_t count
= inhibit_garbage_collection ();
10766 /* If there is no message, we must call display_echo_area_1
10767 nevertheless because it resizes the window. But we will have to
10768 reset the echo_area_buffer in question to nil at the end because
10769 with_echo_area_buffer will sets it to an empty buffer. */
10770 i
= display_last_displayed_message_p
? 1 : 0;
10771 no_message_p
= NILP (echo_area_buffer
[i
]);
10773 window_height_changed_p
10774 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10775 display_echo_area_1
,
10776 (intptr_t) w
, Qnil
);
10779 echo_area_buffer
[i
] = Qnil
;
10781 unbind_to (count
, Qnil
);
10782 return window_height_changed_p
;
10786 /* Helper for display_echo_area. Display the current buffer which
10787 contains the current echo area message in window W, a mini-window,
10788 a pointer to which is passed in A1. A2..A4 are currently not used.
10789 Change the height of W so that all of the message is displayed.
10790 Value is non-zero if height of W was changed. */
10793 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10796 struct window
*w
= (struct window
*) i1
;
10797 Lisp_Object window
;
10798 struct text_pos start
;
10799 int window_height_changed_p
= 0;
10801 /* Do this before displaying, so that we have a large enough glyph
10802 matrix for the display. If we can't get enough space for the
10803 whole text, display the last N lines. That works by setting w->start. */
10804 window_height_changed_p
= resize_mini_window (w
, 0);
10806 /* Use the starting position chosen by resize_mini_window. */
10807 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10810 clear_glyph_matrix (w
->desired_matrix
);
10811 XSETWINDOW (window
, w
);
10812 try_window (window
, start
, 0);
10814 return window_height_changed_p
;
10818 /* Resize the echo area window to exactly the size needed for the
10819 currently displayed message, if there is one. If a mini-buffer
10820 is active, don't shrink it. */
10823 resize_echo_area_exactly (void)
10825 if (BUFFERP (echo_area_buffer
[0])
10826 && WINDOWP (echo_area_window
))
10828 struct window
*w
= XWINDOW (echo_area_window
);
10829 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10830 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10831 (intptr_t) w
, resize_exactly
);
10834 windows_or_buffers_changed
= 42;
10835 update_mode_lines
= 30;
10836 redisplay_internal ();
10842 /* Callback function for with_echo_area_buffer, when used from
10843 resize_echo_area_exactly. A1 contains a pointer to the window to
10844 resize, EXACTLY non-nil means resize the mini-window exactly to the
10845 size of the text displayed. A3 and A4 are not used. Value is what
10846 resize_mini_window returns. */
10849 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10852 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10856 /* Resize mini-window W to fit the size of its contents. EXACT_P
10857 means size the window exactly to the size needed. Otherwise, it's
10858 only enlarged until W's buffer is empty.
10860 Set W->start to the right place to begin display. If the whole
10861 contents fit, start at the beginning. Otherwise, start so as
10862 to make the end of the contents appear. This is particularly
10863 important for y-or-n-p, but seems desirable generally.
10865 Value is non-zero if the window height has been changed. */
10868 resize_mini_window (struct window
*w
, int exact_p
)
10870 struct frame
*f
= XFRAME (w
->frame
);
10871 int window_height_changed_p
= 0;
10873 eassert (MINI_WINDOW_P (w
));
10875 /* By default, start display at the beginning. */
10876 set_marker_both (w
->start
, w
->contents
,
10877 BUF_BEGV (XBUFFER (w
->contents
)),
10878 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10880 /* Don't resize windows while redisplaying a window; it would
10881 confuse redisplay functions when the size of the window they are
10882 displaying changes from under them. Such a resizing can happen,
10883 for instance, when which-func prints a long message while
10884 we are running fontification-functions. We're running these
10885 functions with safe_call which binds inhibit-redisplay to t. */
10886 if (!NILP (Vinhibit_redisplay
))
10889 /* Nil means don't try to resize. */
10890 if (NILP (Vresize_mini_windows
)
10891 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10894 if (!FRAME_MINIBUF_ONLY_P (f
))
10897 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10898 + WINDOW_PIXEL_HEIGHT (w
));
10899 int unit
= FRAME_LINE_HEIGHT (f
);
10900 int height
, max_height
;
10901 struct text_pos start
;
10902 struct buffer
*old_current_buffer
= NULL
;
10904 if (current_buffer
!= XBUFFER (w
->contents
))
10906 old_current_buffer
= current_buffer
;
10907 set_buffer_internal (XBUFFER (w
->contents
));
10910 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10912 /* Compute the max. number of lines specified by the user. */
10913 if (FLOATP (Vmax_mini_window_height
))
10914 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10915 else if (INTEGERP (Vmax_mini_window_height
))
10916 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10918 max_height
= total_height
/ 4;
10920 /* Correct that max. height if it's bogus. */
10921 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10923 /* Find out the height of the text in the window. */
10924 if (it
.line_wrap
== TRUNCATE
)
10929 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10930 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10931 height
= it
.current_y
+ last_height
;
10933 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10934 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10937 /* Compute a suitable window start. */
10938 if (height
> max_height
)
10940 height
= (max_height
/ unit
) * unit
;
10941 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10942 move_it_vertically_backward (&it
, height
- unit
);
10943 start
= it
.current
.pos
;
10946 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10947 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10949 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10951 /* Let it grow only, until we display an empty message, in which
10952 case the window shrinks again. */
10953 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10955 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10957 FRAME_WINDOWS_FROZEN (f
) = 1;
10958 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10959 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10961 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10962 && (exact_p
|| BEGV
== ZV
))
10964 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10966 FRAME_WINDOWS_FROZEN (f
) = 0;
10967 shrink_mini_window (w
, 1);
10968 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10973 /* Always resize to exact size needed. */
10974 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10976 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10978 FRAME_WINDOWS_FROZEN (f
) = 1;
10979 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10980 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10982 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10984 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10986 FRAME_WINDOWS_FROZEN (f
) = 0;
10987 shrink_mini_window (w
, 1);
10991 FRAME_WINDOWS_FROZEN (f
) = 1;
10992 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10995 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10999 if (old_current_buffer
)
11000 set_buffer_internal (old_current_buffer
);
11003 return window_height_changed_p
;
11007 /* Value is the current message, a string, or nil if there is no
11008 current message. */
11011 current_message (void)
11015 if (!BUFFERP (echo_area_buffer
[0]))
11019 with_echo_area_buffer (0, 0, current_message_1
,
11020 (intptr_t) &msg
, Qnil
);
11022 echo_area_buffer
[0] = Qnil
;
11030 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11033 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11036 *msg
= make_buffer_string (BEG
, Z
, 1);
11043 /* Push the current message on Vmessage_stack for later restoration
11044 by restore_message. Value is non-zero if the current message isn't
11045 empty. This is a relatively infrequent operation, so it's not
11046 worth optimizing. */
11049 push_message (void)
11051 Lisp_Object msg
= current_message ();
11052 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11053 return STRINGP (msg
);
11057 /* Restore message display from the top of Vmessage_stack. */
11060 restore_message (void)
11062 eassert (CONSP (Vmessage_stack
));
11063 message3_nolog (XCAR (Vmessage_stack
));
11067 /* Handler for unwind-protect calling pop_message. */
11070 pop_message_unwind (void)
11072 /* Pop the top-most entry off Vmessage_stack. */
11073 eassert (CONSP (Vmessage_stack
));
11074 Vmessage_stack
= XCDR (Vmessage_stack
);
11078 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11079 exits. If the stack is not empty, we have a missing pop_message
11083 check_message_stack (void)
11085 if (!NILP (Vmessage_stack
))
11090 /* Truncate to NCHARS what will be displayed in the echo area the next
11091 time we display it---but don't redisplay it now. */
11094 truncate_echo_area (ptrdiff_t nchars
)
11097 echo_area_buffer
[0] = Qnil
;
11098 else if (!noninteractive
11100 && !NILP (echo_area_buffer
[0]))
11102 struct frame
*sf
= SELECTED_FRAME ();
11103 /* Error messages get reported properly by cmd_error, so this must be
11104 just an informative message; if the frame hasn't really been
11105 initialized yet, just toss it. */
11106 if (sf
->glyphs_initialized_p
)
11107 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11112 /* Helper function for truncate_echo_area. Truncate the current
11113 message to at most NCHARS characters. */
11116 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11118 if (BEG
+ nchars
< Z
)
11119 del_range (BEG
+ nchars
, Z
);
11121 echo_area_buffer
[0] = Qnil
;
11125 /* Set the current message to STRING. */
11128 set_message (Lisp_Object string
)
11130 eassert (STRINGP (string
));
11132 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11134 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11135 message_buf_print
= 0;
11136 help_echo_showing_p
= 0;
11138 if (STRINGP (Vdebug_on_message
)
11139 && STRINGP (string
)
11140 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11141 call_debugger (list2 (Qerror
, string
));
11145 /* Helper function for set_message. First argument is ignored and second
11146 argument has the same meaning as for set_message.
11147 This function is called with the echo area buffer being current. */
11150 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11152 eassert (STRINGP (string
));
11154 /* Change multibyteness of the echo buffer appropriately. */
11155 if (message_enable_multibyte
11156 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11157 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11159 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11160 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11161 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11163 /* Insert new message at BEG. */
11164 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11166 /* This function takes care of single/multibyte conversion.
11167 We just have to ensure that the echo area buffer has the right
11168 setting of enable_multibyte_characters. */
11169 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11175 /* Clear messages. CURRENT_P non-zero means clear the current
11176 message. LAST_DISPLAYED_P non-zero means clear the message
11180 clear_message (bool current_p
, bool last_displayed_p
)
11184 echo_area_buffer
[0] = Qnil
;
11185 message_cleared_p
= true;
11188 if (last_displayed_p
)
11189 echo_area_buffer
[1] = Qnil
;
11191 message_buf_print
= 0;
11194 /* Clear garbaged frames.
11196 This function is used where the old redisplay called
11197 redraw_garbaged_frames which in turn called redraw_frame which in
11198 turn called clear_frame. The call to clear_frame was a source of
11199 flickering. I believe a clear_frame is not necessary. It should
11200 suffice in the new redisplay to invalidate all current matrices,
11201 and ensure a complete redisplay of all windows. */
11204 clear_garbaged_frames (void)
11206 if (frame_garbaged
)
11208 Lisp_Object tail
, frame
;
11210 FOR_EACH_FRAME (tail
, frame
)
11212 struct frame
*f
= XFRAME (frame
);
11214 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11219 clear_current_matrices (f
);
11220 fset_redisplay (f
);
11221 f
->garbaged
= false;
11222 f
->resized_p
= false;
11226 frame_garbaged
= false;
11231 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11232 is non-zero update selected_frame. Value is non-zero if the
11233 mini-windows height has been changed. */
11236 echo_area_display (int update_frame_p
)
11238 Lisp_Object mini_window
;
11241 int window_height_changed_p
= 0;
11242 struct frame
*sf
= SELECTED_FRAME ();
11244 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11245 w
= XWINDOW (mini_window
);
11246 f
= XFRAME (WINDOW_FRAME (w
));
11248 /* Don't display if frame is invisible or not yet initialized. */
11249 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11252 #ifdef HAVE_WINDOW_SYSTEM
11253 /* When Emacs starts, selected_frame may be the initial terminal
11254 frame. If we let this through, a message would be displayed on
11256 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11258 #endif /* HAVE_WINDOW_SYSTEM */
11260 /* Redraw garbaged frames. */
11261 clear_garbaged_frames ();
11263 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11265 echo_area_window
= mini_window
;
11266 window_height_changed_p
= display_echo_area (w
);
11267 w
->must_be_updated_p
= true;
11269 /* Update the display, unless called from redisplay_internal.
11270 Also don't update the screen during redisplay itself. The
11271 update will happen at the end of redisplay, and an update
11272 here could cause confusion. */
11273 if (update_frame_p
&& !redisplaying_p
)
11277 /* If the display update has been interrupted by pending
11278 input, update mode lines in the frame. Due to the
11279 pending input, it might have been that redisplay hasn't
11280 been called, so that mode lines above the echo area are
11281 garbaged. This looks odd, so we prevent it here. */
11282 if (!display_completed
)
11283 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11285 if (window_height_changed_p
11286 /* Don't do this if Emacs is shutting down. Redisplay
11287 needs to run hooks. */
11288 && !NILP (Vrun_hooks
))
11290 /* Must update other windows. Likewise as in other
11291 cases, don't let this update be interrupted by
11293 ptrdiff_t count
= SPECPDL_INDEX ();
11294 specbind (Qredisplay_dont_pause
, Qt
);
11295 windows_or_buffers_changed
= 44;
11296 redisplay_internal ();
11297 unbind_to (count
, Qnil
);
11299 else if (FRAME_WINDOW_P (f
) && n
== 0)
11301 /* Window configuration is the same as before.
11302 Can do with a display update of the echo area,
11303 unless we displayed some mode lines. */
11304 update_single_window (w
, 1);
11308 update_frame (f
, 1, 1);
11310 /* If cursor is in the echo area, make sure that the next
11311 redisplay displays the minibuffer, so that the cursor will
11312 be replaced with what the minibuffer wants. */
11313 if (cursor_in_echo_area
)
11314 wset_redisplay (XWINDOW (mini_window
));
11317 else if (!EQ (mini_window
, selected_window
))
11318 wset_redisplay (XWINDOW (mini_window
));
11320 /* Last displayed message is now the current message. */
11321 echo_area_buffer
[1] = echo_area_buffer
[0];
11322 /* Inform read_char that we're not echoing. */
11323 echo_message_buffer
= Qnil
;
11325 /* Prevent redisplay optimization in redisplay_internal by resetting
11326 this_line_start_pos. This is done because the mini-buffer now
11327 displays the message instead of its buffer text. */
11328 if (EQ (mini_window
, selected_window
))
11329 CHARPOS (this_line_start_pos
) = 0;
11331 return window_height_changed_p
;
11334 /* Nonzero if W's buffer was changed but not saved. */
11337 window_buffer_changed (struct window
*w
)
11339 struct buffer
*b
= XBUFFER (w
->contents
);
11341 eassert (BUFFER_LIVE_P (b
));
11343 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11346 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11349 mode_line_update_needed (struct window
*w
)
11351 return (w
->column_number_displayed
!= -1
11352 && !(PT
== w
->last_point
&& !window_outdated (w
))
11353 && (w
->column_number_displayed
!= current_column ()));
11356 /* Nonzero if window start of W is frozen and may not be changed during
11360 window_frozen_p (struct window
*w
)
11362 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11364 Lisp_Object window
;
11366 XSETWINDOW (window
, w
);
11367 if (MINI_WINDOW_P (w
))
11369 else if (EQ (window
, selected_window
))
11371 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11372 && EQ (window
, Vminibuf_scroll_window
))
11373 /* This special window can't be frozen too. */
11381 /***********************************************************************
11382 Mode Lines and Frame Titles
11383 ***********************************************************************/
11385 /* A buffer for constructing non-propertized mode-line strings and
11386 frame titles in it; allocated from the heap in init_xdisp and
11387 resized as needed in store_mode_line_noprop_char. */
11389 static char *mode_line_noprop_buf
;
11391 /* The buffer's end, and a current output position in it. */
11393 static char *mode_line_noprop_buf_end
;
11394 static char *mode_line_noprop_ptr
;
11396 #define MODE_LINE_NOPROP_LEN(start) \
11397 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11400 MODE_LINE_DISPLAY
= 0,
11404 } mode_line_target
;
11406 /* Alist that caches the results of :propertize.
11407 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11408 static Lisp_Object mode_line_proptrans_alist
;
11410 /* List of strings making up the mode-line. */
11411 static Lisp_Object mode_line_string_list
;
11413 /* Base face property when building propertized mode line string. */
11414 static Lisp_Object mode_line_string_face
;
11415 static Lisp_Object mode_line_string_face_prop
;
11418 /* Unwind data for mode line strings */
11420 static Lisp_Object Vmode_line_unwind_vector
;
11423 format_mode_line_unwind_data (struct frame
*target_frame
,
11424 struct buffer
*obuf
,
11426 int save_proptrans
)
11428 Lisp_Object vector
, tmp
;
11430 /* Reduce consing by keeping one vector in
11431 Vwith_echo_area_save_vector. */
11432 vector
= Vmode_line_unwind_vector
;
11433 Vmode_line_unwind_vector
= Qnil
;
11436 vector
= Fmake_vector (make_number (10), Qnil
);
11438 ASET (vector
, 0, make_number (mode_line_target
));
11439 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11440 ASET (vector
, 2, mode_line_string_list
);
11441 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11442 ASET (vector
, 4, mode_line_string_face
);
11443 ASET (vector
, 5, mode_line_string_face_prop
);
11446 XSETBUFFER (tmp
, obuf
);
11449 ASET (vector
, 6, tmp
);
11450 ASET (vector
, 7, owin
);
11453 /* Similarly to `with-selected-window', if the operation selects
11454 a window on another frame, we must restore that frame's
11455 selected window, and (for a tty) the top-frame. */
11456 ASET (vector
, 8, target_frame
->selected_window
);
11457 if (FRAME_TERMCAP_P (target_frame
))
11458 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11465 unwind_format_mode_line (Lisp_Object vector
)
11467 Lisp_Object old_window
= AREF (vector
, 7);
11468 Lisp_Object target_frame_window
= AREF (vector
, 8);
11469 Lisp_Object old_top_frame
= AREF (vector
, 9);
11471 mode_line_target
= XINT (AREF (vector
, 0));
11472 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11473 mode_line_string_list
= AREF (vector
, 2);
11474 if (! EQ (AREF (vector
, 3), Qt
))
11475 mode_line_proptrans_alist
= AREF (vector
, 3);
11476 mode_line_string_face
= AREF (vector
, 4);
11477 mode_line_string_face_prop
= AREF (vector
, 5);
11479 /* Select window before buffer, since it may change the buffer. */
11480 if (!NILP (old_window
))
11482 /* If the operation that we are unwinding had selected a window
11483 on a different frame, reset its frame-selected-window. For a
11484 text terminal, reset its top-frame if necessary. */
11485 if (!NILP (target_frame_window
))
11488 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11490 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11491 Fselect_window (target_frame_window
, Qt
);
11493 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11494 Fselect_frame (old_top_frame
, Qt
);
11497 Fselect_window (old_window
, Qt
);
11500 if (!NILP (AREF (vector
, 6)))
11502 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11503 ASET (vector
, 6, Qnil
);
11506 Vmode_line_unwind_vector
= vector
;
11510 /* Store a single character C for the frame title in mode_line_noprop_buf.
11511 Re-allocate mode_line_noprop_buf if necessary. */
11514 store_mode_line_noprop_char (char c
)
11516 /* If output position has reached the end of the allocated buffer,
11517 increase the buffer's size. */
11518 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11520 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11521 ptrdiff_t size
= len
;
11522 mode_line_noprop_buf
=
11523 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11524 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11525 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11528 *mode_line_noprop_ptr
++ = c
;
11532 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11533 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11534 characters that yield more columns than PRECISION; PRECISION <= 0
11535 means copy the whole string. Pad with spaces until FIELD_WIDTH
11536 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11537 pad. Called from display_mode_element when it is used to build a
11541 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11543 const unsigned char *str
= (const unsigned char *) string
;
11545 ptrdiff_t dummy
, nbytes
;
11547 /* Copy at most PRECISION chars from STR. */
11548 nbytes
= strlen (string
);
11549 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11551 store_mode_line_noprop_char (*str
++);
11553 /* Fill up with spaces until FIELD_WIDTH reached. */
11554 while (field_width
> 0
11555 && n
< field_width
)
11557 store_mode_line_noprop_char (' ');
11564 /***********************************************************************
11566 ***********************************************************************/
11568 #ifdef HAVE_WINDOW_SYSTEM
11570 /* Set the title of FRAME, if it has changed. The title format is
11571 Vicon_title_format if FRAME is iconified, otherwise it is
11572 frame_title_format. */
11575 x_consider_frame_title (Lisp_Object frame
)
11577 struct frame
*f
= XFRAME (frame
);
11579 if (FRAME_WINDOW_P (f
)
11580 || FRAME_MINIBUF_ONLY_P (f
)
11581 || f
->explicit_name
)
11583 /* Do we have more than one visible frame on this X display? */
11584 Lisp_Object tail
, other_frame
, fmt
;
11585 ptrdiff_t title_start
;
11589 ptrdiff_t count
= SPECPDL_INDEX ();
11591 FOR_EACH_FRAME (tail
, other_frame
)
11593 struct frame
*tf
= XFRAME (other_frame
);
11596 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11597 && !FRAME_MINIBUF_ONLY_P (tf
)
11598 && !EQ (other_frame
, tip_frame
)
11599 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11603 /* Set global variable indicating that multiple frames exist. */
11604 multiple_frames
= CONSP (tail
);
11606 /* Switch to the buffer of selected window of the frame. Set up
11607 mode_line_target so that display_mode_element will output into
11608 mode_line_noprop_buf; then display the title. */
11609 record_unwind_protect (unwind_format_mode_line
,
11610 format_mode_line_unwind_data
11611 (f
, current_buffer
, selected_window
, 0));
11613 Fselect_window (f
->selected_window
, Qt
);
11614 set_buffer_internal_1
11615 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11616 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11618 mode_line_target
= MODE_LINE_TITLE
;
11619 title_start
= MODE_LINE_NOPROP_LEN (0);
11620 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11621 NULL
, DEFAULT_FACE_ID
);
11622 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11623 len
= MODE_LINE_NOPROP_LEN (title_start
);
11624 title
= mode_line_noprop_buf
+ title_start
;
11625 unbind_to (count
, Qnil
);
11627 /* Set the title only if it's changed. This avoids consing in
11628 the common case where it hasn't. (If it turns out that we've
11629 already wasted too much time by walking through the list with
11630 display_mode_element, then we might need to optimize at a
11631 higher level than this.) */
11632 if (! STRINGP (f
->name
)
11633 || SBYTES (f
->name
) != len
11634 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11635 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11639 #endif /* not HAVE_WINDOW_SYSTEM */
11642 /***********************************************************************
11644 ***********************************************************************/
11646 /* Non-zero if we will not redisplay all visible windows. */
11647 #define REDISPLAY_SOME_P() \
11648 ((windows_or_buffers_changed == 0 \
11649 || windows_or_buffers_changed == REDISPLAY_SOME) \
11650 && (update_mode_lines == 0 \
11651 || update_mode_lines == REDISPLAY_SOME))
11653 /* Prepare for redisplay by updating menu-bar item lists when
11654 appropriate. This can call eval. */
11657 prepare_menu_bars (void)
11659 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11660 bool some_windows
= REDISPLAY_SOME_P ();
11661 struct gcpro gcpro1
, gcpro2
;
11662 Lisp_Object tooltip_frame
;
11664 #ifdef HAVE_WINDOW_SYSTEM
11665 tooltip_frame
= tip_frame
;
11667 tooltip_frame
= Qnil
;
11670 if (FUNCTIONP (Vpre_redisplay_function
))
11672 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11673 if (all_windows
&& some_windows
)
11675 Lisp_Object ws
= window_list ();
11676 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11678 Lisp_Object
this = XCAR (ws
);
11679 struct window
*w
= XWINDOW (this);
11681 || XFRAME (w
->frame
)->redisplay
11682 || XBUFFER (w
->contents
)->text
->redisplay
)
11684 windows
= Fcons (this, windows
);
11688 safe__call1 (true, Vpre_redisplay_function
, windows
);
11691 /* Update all frame titles based on their buffer names, etc. We do
11692 this before the menu bars so that the buffer-menu will show the
11693 up-to-date frame titles. */
11694 #ifdef HAVE_WINDOW_SYSTEM
11697 Lisp_Object tail
, frame
;
11699 FOR_EACH_FRAME (tail
, frame
)
11701 struct frame
*f
= XFRAME (frame
);
11702 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11706 && !XBUFFER (w
->contents
)->text
->redisplay
)
11709 if (!EQ (frame
, tooltip_frame
)
11710 && (FRAME_ICONIFIED_P (f
)
11711 || FRAME_VISIBLE_P (f
) == 1
11712 /* Exclude TTY frames that are obscured because they
11713 are not the top frame on their console. This is
11714 because x_consider_frame_title actually switches
11715 to the frame, which for TTY frames means it is
11716 marked as garbaged, and will be completely
11717 redrawn on the next redisplay cycle. This causes
11718 TTY frames to be completely redrawn, when there
11719 are more than one of them, even though nothing
11720 should be changed on display. */
11721 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11722 x_consider_frame_title (frame
);
11725 #endif /* HAVE_WINDOW_SYSTEM */
11727 /* Update the menu bar item lists, if appropriate. This has to be
11728 done before any actual redisplay or generation of display lines. */
11732 Lisp_Object tail
, frame
;
11733 ptrdiff_t count
= SPECPDL_INDEX ();
11734 /* 1 means that update_menu_bar has run its hooks
11735 so any further calls to update_menu_bar shouldn't do so again. */
11736 int menu_bar_hooks_run
= 0;
11738 record_unwind_save_match_data ();
11740 FOR_EACH_FRAME (tail
, frame
)
11742 struct frame
*f
= XFRAME (frame
);
11743 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11745 /* Ignore tooltip frame. */
11746 if (EQ (frame
, tooltip_frame
))
11752 && !XBUFFER (w
->contents
)->text
->redisplay
)
11755 /* If a window on this frame changed size, report that to
11756 the user and clear the size-change flag. */
11757 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11759 Lisp_Object functions
;
11761 /* Clear flag first in case we get an error below. */
11762 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11763 functions
= Vwindow_size_change_functions
;
11764 GCPRO2 (tail
, functions
);
11766 while (CONSP (functions
))
11768 if (!EQ (XCAR (functions
), Qt
))
11769 call1 (XCAR (functions
), frame
);
11770 functions
= XCDR (functions
);
11776 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11777 #ifdef HAVE_WINDOW_SYSTEM
11778 update_tool_bar (f
, 0);
11781 if (windows_or_buffers_changed
11784 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11789 unbind_to (count
, Qnil
);
11793 struct frame
*sf
= SELECTED_FRAME ();
11794 update_menu_bar (sf
, 1, 0);
11795 #ifdef HAVE_WINDOW_SYSTEM
11796 update_tool_bar (sf
, 1);
11802 /* Update the menu bar item list for frame F. This has to be done
11803 before we start to fill in any display lines, because it can call
11806 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11808 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11809 already ran the menu bar hooks for this redisplay, so there
11810 is no need to run them again. The return value is the
11811 updated value of this flag, to pass to the next call. */
11814 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11816 Lisp_Object window
;
11817 register struct window
*w
;
11819 /* If called recursively during a menu update, do nothing. This can
11820 happen when, for instance, an activate-menubar-hook causes a
11822 if (inhibit_menubar_update
)
11825 window
= FRAME_SELECTED_WINDOW (f
);
11826 w
= XWINDOW (window
);
11828 if (FRAME_WINDOW_P (f
)
11830 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11831 || defined (HAVE_NS) || defined (USE_GTK)
11832 FRAME_EXTERNAL_MENU_BAR (f
)
11834 FRAME_MENU_BAR_LINES (f
) > 0
11836 : FRAME_MENU_BAR_LINES (f
) > 0)
11838 /* If the user has switched buffers or windows, we need to
11839 recompute to reflect the new bindings. But we'll
11840 recompute when update_mode_lines is set too; that means
11841 that people can use force-mode-line-update to request
11842 that the menu bar be recomputed. The adverse effect on
11843 the rest of the redisplay algorithm is about the same as
11844 windows_or_buffers_changed anyway. */
11845 if (windows_or_buffers_changed
11846 /* This used to test w->update_mode_line, but we believe
11847 there is no need to recompute the menu in that case. */
11848 || update_mode_lines
11849 || window_buffer_changed (w
))
11851 struct buffer
*prev
= current_buffer
;
11852 ptrdiff_t count
= SPECPDL_INDEX ();
11854 specbind (Qinhibit_menubar_update
, Qt
);
11856 set_buffer_internal_1 (XBUFFER (w
->contents
));
11857 if (save_match_data
)
11858 record_unwind_save_match_data ();
11859 if (NILP (Voverriding_local_map_menu_flag
))
11861 specbind (Qoverriding_terminal_local_map
, Qnil
);
11862 specbind (Qoverriding_local_map
, Qnil
);
11867 /* Run the Lucid hook. */
11868 safe_run_hooks (Qactivate_menubar_hook
);
11870 /* If it has changed current-menubar from previous value,
11871 really recompute the menu-bar from the value. */
11872 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11873 call0 (Qrecompute_lucid_menubar
);
11875 safe_run_hooks (Qmenu_bar_update_hook
);
11880 XSETFRAME (Vmenu_updating_frame
, f
);
11881 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11883 /* Redisplay the menu bar in case we changed it. */
11884 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11885 || defined (HAVE_NS) || defined (USE_GTK)
11886 if (FRAME_WINDOW_P (f
))
11888 #if defined (HAVE_NS)
11889 /* All frames on Mac OS share the same menubar. So only
11890 the selected frame should be allowed to set it. */
11891 if (f
== SELECTED_FRAME ())
11893 set_frame_menubar (f
, 0, 0);
11896 /* On a terminal screen, the menu bar is an ordinary screen
11897 line, and this makes it get updated. */
11898 w
->update_mode_line
= 1;
11899 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11900 /* In the non-toolkit version, the menu bar is an ordinary screen
11901 line, and this makes it get updated. */
11902 w
->update_mode_line
= 1;
11903 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11905 unbind_to (count
, Qnil
);
11906 set_buffer_internal_1 (prev
);
11913 /***********************************************************************
11915 ***********************************************************************/
11917 #ifdef HAVE_WINDOW_SYSTEM
11919 /* Select `frame' temporarily without running all the code in
11921 FIXME: Maybe do_switch_frame should be trimmed down similarly
11922 when `norecord' is set. */
11924 fast_set_selected_frame (Lisp_Object frame
)
11926 if (!EQ (selected_frame
, frame
))
11928 selected_frame
= frame
;
11929 selected_window
= XFRAME (frame
)->selected_window
;
11933 /* Update the tool-bar item list for frame F. This has to be done
11934 before we start to fill in any display lines. Called from
11935 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11936 and restore it here. */
11939 update_tool_bar (struct frame
*f
, int save_match_data
)
11941 #if defined (USE_GTK) || defined (HAVE_NS)
11942 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11944 int do_update
= (WINDOWP (f
->tool_bar_window
)
11945 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11950 Lisp_Object window
;
11953 window
= FRAME_SELECTED_WINDOW (f
);
11954 w
= XWINDOW (window
);
11956 /* If the user has switched buffers or windows, we need to
11957 recompute to reflect the new bindings. But we'll
11958 recompute when update_mode_lines is set too; that means
11959 that people can use force-mode-line-update to request
11960 that the menu bar be recomputed. The adverse effect on
11961 the rest of the redisplay algorithm is about the same as
11962 windows_or_buffers_changed anyway. */
11963 if (windows_or_buffers_changed
11964 || w
->update_mode_line
11965 || update_mode_lines
11966 || window_buffer_changed (w
))
11968 struct buffer
*prev
= current_buffer
;
11969 ptrdiff_t count
= SPECPDL_INDEX ();
11970 Lisp_Object frame
, new_tool_bar
;
11971 int new_n_tool_bar
;
11972 struct gcpro gcpro1
;
11974 /* Set current_buffer to the buffer of the selected
11975 window of the frame, so that we get the right local
11977 set_buffer_internal_1 (XBUFFER (w
->contents
));
11979 /* Save match data, if we must. */
11980 if (save_match_data
)
11981 record_unwind_save_match_data ();
11983 /* Make sure that we don't accidentally use bogus keymaps. */
11984 if (NILP (Voverriding_local_map_menu_flag
))
11986 specbind (Qoverriding_terminal_local_map
, Qnil
);
11987 specbind (Qoverriding_local_map
, Qnil
);
11990 GCPRO1 (new_tool_bar
);
11992 /* We must temporarily set the selected frame to this frame
11993 before calling tool_bar_items, because the calculation of
11994 the tool-bar keymap uses the selected frame (see
11995 `tool-bar-make-keymap' in tool-bar.el). */
11996 eassert (EQ (selected_window
,
11997 /* Since we only explicitly preserve selected_frame,
11998 check that selected_window would be redundant. */
11999 XFRAME (selected_frame
)->selected_window
));
12000 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12001 XSETFRAME (frame
, f
);
12002 fast_set_selected_frame (frame
);
12004 /* Build desired tool-bar items from keymaps. */
12006 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12009 /* Redisplay the tool-bar if we changed it. */
12010 if (new_n_tool_bar
!= f
->n_tool_bar_items
12011 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12013 /* Redisplay that happens asynchronously due to an expose event
12014 may access f->tool_bar_items. Make sure we update both
12015 variables within BLOCK_INPUT so no such event interrupts. */
12017 fset_tool_bar_items (f
, new_tool_bar
);
12018 f
->n_tool_bar_items
= new_n_tool_bar
;
12019 w
->update_mode_line
= 1;
12025 unbind_to (count
, Qnil
);
12026 set_buffer_internal_1 (prev
);
12031 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12033 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12034 F's desired tool-bar contents. F->tool_bar_items must have
12035 been set up previously by calling prepare_menu_bars. */
12038 build_desired_tool_bar_string (struct frame
*f
)
12040 int i
, size
, size_needed
;
12041 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12042 Lisp_Object image
, plist
, props
;
12044 image
= plist
= props
= Qnil
;
12045 GCPRO3 (image
, plist
, props
);
12047 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12048 Otherwise, make a new string. */
12050 /* The size of the string we might be able to reuse. */
12051 size
= (STRINGP (f
->desired_tool_bar_string
)
12052 ? SCHARS (f
->desired_tool_bar_string
)
12055 /* We need one space in the string for each image. */
12056 size_needed
= f
->n_tool_bar_items
;
12058 /* Reuse f->desired_tool_bar_string, if possible. */
12059 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12060 fset_desired_tool_bar_string
12061 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12064 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12065 Fremove_text_properties (make_number (0), make_number (size
),
12066 props
, f
->desired_tool_bar_string
);
12069 /* Put a `display' property on the string for the images to display,
12070 put a `menu_item' property on tool-bar items with a value that
12071 is the index of the item in F's tool-bar item vector. */
12072 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12074 #define PROP(IDX) \
12075 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12077 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12078 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12079 int hmargin
, vmargin
, relief
, idx
, end
;
12081 /* If image is a vector, choose the image according to the
12083 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12084 if (VECTORP (image
))
12088 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12089 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12092 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12093 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12095 eassert (ASIZE (image
) >= idx
);
12096 image
= AREF (image
, idx
);
12101 /* Ignore invalid image specifications. */
12102 if (!valid_image_p (image
))
12105 /* Display the tool-bar button pressed, or depressed. */
12106 plist
= Fcopy_sequence (XCDR (image
));
12108 /* Compute margin and relief to draw. */
12109 relief
= (tool_bar_button_relief
>= 0
12110 ? tool_bar_button_relief
12111 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12112 hmargin
= vmargin
= relief
;
12114 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12115 INT_MAX
- max (hmargin
, vmargin
)))
12117 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12118 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12120 else if (CONSP (Vtool_bar_button_margin
))
12122 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12123 INT_MAX
- hmargin
))
12124 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12126 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12127 INT_MAX
- vmargin
))
12128 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12131 if (auto_raise_tool_bar_buttons_p
)
12133 /* Add a `:relief' property to the image spec if the item is
12137 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12144 /* If image is selected, display it pressed, i.e. with a
12145 negative relief. If it's not selected, display it with a
12147 plist
= Fplist_put (plist
, QCrelief
,
12149 ? make_number (-relief
)
12150 : make_number (relief
)));
12155 /* Put a margin around the image. */
12156 if (hmargin
|| vmargin
)
12158 if (hmargin
== vmargin
)
12159 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12161 plist
= Fplist_put (plist
, QCmargin
,
12162 Fcons (make_number (hmargin
),
12163 make_number (vmargin
)));
12166 /* If button is not enabled, and we don't have special images
12167 for the disabled state, make the image appear disabled by
12168 applying an appropriate algorithm to it. */
12169 if (!enabled_p
&& idx
< 0)
12170 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12172 /* Put a `display' text property on the string for the image to
12173 display. Put a `menu-item' property on the string that gives
12174 the start of this item's properties in the tool-bar items
12176 image
= Fcons (Qimage
, plist
);
12177 props
= list4 (Qdisplay
, image
,
12178 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12180 /* Let the last image hide all remaining spaces in the tool bar
12181 string. The string can be longer than needed when we reuse a
12182 previous string. */
12183 if (i
+ 1 == f
->n_tool_bar_items
)
12184 end
= SCHARS (f
->desired_tool_bar_string
);
12187 Fadd_text_properties (make_number (i
), make_number (end
),
12188 props
, f
->desired_tool_bar_string
);
12196 /* Display one line of the tool-bar of frame IT->f.
12198 HEIGHT specifies the desired height of the tool-bar line.
12199 If the actual height of the glyph row is less than HEIGHT, the
12200 row's height is increased to HEIGHT, and the icons are centered
12201 vertically in the new height.
12203 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12204 count a final empty row in case the tool-bar width exactly matches
12209 display_tool_bar_line (struct it
*it
, int height
)
12211 struct glyph_row
*row
= it
->glyph_row
;
12212 int max_x
= it
->last_visible_x
;
12213 struct glyph
*last
;
12215 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12216 clear_glyph_row (row
);
12217 row
->enabled_p
= true;
12218 row
->y
= it
->current_y
;
12220 /* Note that this isn't made use of if the face hasn't a box,
12221 so there's no need to check the face here. */
12222 it
->start_of_box_run_p
= 1;
12224 while (it
->current_x
< max_x
)
12226 int x
, n_glyphs_before
, i
, nglyphs
;
12227 struct it it_before
;
12229 /* Get the next display element. */
12230 if (!get_next_display_element (it
))
12232 /* Don't count empty row if we are counting needed tool-bar lines. */
12233 if (height
< 0 && !it
->hpos
)
12238 /* Produce glyphs. */
12239 n_glyphs_before
= row
->used
[TEXT_AREA
];
12242 PRODUCE_GLYPHS (it
);
12244 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12246 x
= it_before
.current_x
;
12247 while (i
< nglyphs
)
12249 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12251 if (x
+ glyph
->pixel_width
> max_x
)
12253 /* Glyph doesn't fit on line. Backtrack. */
12254 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12256 /* If this is the only glyph on this line, it will never fit on the
12257 tool-bar, so skip it. But ensure there is at least one glyph,
12258 so we don't accidentally disable the tool-bar. */
12259 if (n_glyphs_before
== 0
12260 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12266 x
+= glyph
->pixel_width
;
12270 /* Stop at line end. */
12271 if (ITERATOR_AT_END_OF_LINE_P (it
))
12274 set_iterator_to_next (it
, 1);
12279 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12281 /* Use default face for the border below the tool bar.
12283 FIXME: When auto-resize-tool-bars is grow-only, there is
12284 no additional border below the possibly empty tool-bar lines.
12285 So to make the extra empty lines look "normal", we have to
12286 use the tool-bar face for the border too. */
12287 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12288 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12289 it
->face_id
= DEFAULT_FACE_ID
;
12291 extend_face_to_end_of_line (it
);
12292 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12293 last
->right_box_line_p
= 1;
12294 if (last
== row
->glyphs
[TEXT_AREA
])
12295 last
->left_box_line_p
= 1;
12297 /* Make line the desired height and center it vertically. */
12298 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12300 /* Don't add more than one line height. */
12301 height
%= FRAME_LINE_HEIGHT (it
->f
);
12302 it
->max_ascent
+= height
/ 2;
12303 it
->max_descent
+= (height
+ 1) / 2;
12306 compute_line_metrics (it
);
12308 /* If line is empty, make it occupy the rest of the tool-bar. */
12309 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12311 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12312 row
->visible_height
= row
->height
;
12313 row
->ascent
= row
->phys_ascent
= 0;
12314 row
->extra_line_spacing
= 0;
12317 row
->full_width_p
= 1;
12318 row
->continued_p
= 0;
12319 row
->truncated_on_left_p
= 0;
12320 row
->truncated_on_right_p
= 0;
12322 it
->current_x
= it
->hpos
= 0;
12323 it
->current_y
+= row
->height
;
12329 /* Value is the number of pixels needed to make all tool-bar items of
12330 frame F visible. The actual number of glyph rows needed is
12331 returned in *N_ROWS if non-NULL. */
12333 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12335 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12337 /* tool_bar_height is called from redisplay_tool_bar after building
12338 the desired matrix, so use (unused) mode-line row as temporary row to
12339 avoid destroying the first tool-bar row. */
12340 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12342 /* Initialize an iterator for iteration over
12343 F->desired_tool_bar_string in the tool-bar window of frame F. */
12344 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12345 temp_row
->reversed_p
= false;
12346 it
.first_visible_x
= 0;
12347 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12348 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12349 it
.paragraph_embedding
= L2R
;
12351 while (!ITERATOR_AT_END_P (&it
))
12353 clear_glyph_row (temp_row
);
12354 it
.glyph_row
= temp_row
;
12355 display_tool_bar_line (&it
, -1);
12357 clear_glyph_row (temp_row
);
12359 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12361 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12364 return it
.current_y
;
12366 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12369 #endif /* !USE_GTK && !HAVE_NS */
12371 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12373 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12374 If FRAME is nil or omitted, use the selected frame. Optional argument
12375 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12376 (Lisp_Object frame
, Lisp_Object pixelwise
)
12380 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12381 struct frame
*f
= decode_any_frame (frame
);
12383 if (WINDOWP (f
->tool_bar_window
)
12384 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12386 update_tool_bar (f
, 1);
12387 if (f
->n_tool_bar_items
)
12389 build_desired_tool_bar_string (f
);
12390 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12395 return make_number (height
);
12399 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12400 height should be changed. */
12402 redisplay_tool_bar (struct frame
*f
)
12404 #if defined (USE_GTK) || defined (HAVE_NS)
12406 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12407 update_frame_tool_bar (f
);
12410 #else /* !USE_GTK && !HAVE_NS */
12414 struct glyph_row
*row
;
12416 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12417 do anything. This means you must start with tool-bar-lines
12418 non-zero to get the auto-sizing effect. Or in other words, you
12419 can turn off tool-bars by specifying tool-bar-lines zero. */
12420 if (!WINDOWP (f
->tool_bar_window
)
12421 || (w
= XWINDOW (f
->tool_bar_window
),
12422 WINDOW_TOTAL_LINES (w
) == 0))
12425 /* Set up an iterator for the tool-bar window. */
12426 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12427 it
.first_visible_x
= 0;
12428 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12429 row
= it
.glyph_row
;
12430 row
->reversed_p
= false;
12432 /* Build a string that represents the contents of the tool-bar. */
12433 build_desired_tool_bar_string (f
);
12434 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12435 /* FIXME: This should be controlled by a user option. But it
12436 doesn't make sense to have an R2L tool bar if the menu bar cannot
12437 be drawn also R2L, and making the menu bar R2L is tricky due
12438 toolkit-specific code that implements it. If an R2L tool bar is
12439 ever supported, display_tool_bar_line should also be augmented to
12440 call unproduce_glyphs like display_line and display_string
12442 it
.paragraph_embedding
= L2R
;
12444 if (f
->n_tool_bar_rows
== 0)
12446 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12448 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12450 x_change_tool_bar_height (f
, new_height
);
12451 /* Always do that now. */
12452 clear_glyph_matrix (w
->desired_matrix
);
12453 f
->fonts_changed
= 1;
12458 /* Display as many lines as needed to display all tool-bar items. */
12460 if (f
->n_tool_bar_rows
> 0)
12462 int border
, rows
, height
, extra
;
12464 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12465 border
= XINT (Vtool_bar_border
);
12466 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12467 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12468 else if (EQ (Vtool_bar_border
, Qborder_width
))
12469 border
= f
->border_width
;
12475 rows
= f
->n_tool_bar_rows
;
12476 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12477 extra
= it
.last_visible_y
- border
- height
* rows
;
12479 while (it
.current_y
< it
.last_visible_y
)
12482 if (extra
> 0 && rows
-- > 0)
12484 h
= (extra
+ rows
- 1) / rows
;
12487 display_tool_bar_line (&it
, height
+ h
);
12492 while (it
.current_y
< it
.last_visible_y
)
12493 display_tool_bar_line (&it
, 0);
12496 /* It doesn't make much sense to try scrolling in the tool-bar
12497 window, so don't do it. */
12498 w
->desired_matrix
->no_scrolling_p
= 1;
12499 w
->must_be_updated_p
= 1;
12501 if (!NILP (Vauto_resize_tool_bars
))
12503 int change_height_p
= 0;
12505 /* If we couldn't display everything, change the tool-bar's
12506 height if there is room for more. */
12507 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12508 change_height_p
= 1;
12510 /* We subtract 1 because display_tool_bar_line advances the
12511 glyph_row pointer before returning to its caller. We want to
12512 examine the last glyph row produced by
12513 display_tool_bar_line. */
12514 row
= it
.glyph_row
- 1;
12516 /* If there are blank lines at the end, except for a partially
12517 visible blank line at the end that is smaller than
12518 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12519 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12520 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12521 change_height_p
= 1;
12523 /* If row displays tool-bar items, but is partially visible,
12524 change the tool-bar's height. */
12525 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12526 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12527 change_height_p
= 1;
12529 /* Resize windows as needed by changing the `tool-bar-lines'
12530 frame parameter. */
12531 if (change_height_p
)
12534 int new_height
= tool_bar_height (f
, &nrows
, 1);
12536 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12537 && !f
->minimize_tool_bar_window_p
)
12538 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12539 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12540 f
->minimize_tool_bar_window_p
= 0;
12542 if (change_height_p
)
12544 x_change_tool_bar_height (f
, new_height
);
12545 clear_glyph_matrix (w
->desired_matrix
);
12546 f
->n_tool_bar_rows
= nrows
;
12547 f
->fonts_changed
= 1;
12554 f
->minimize_tool_bar_window_p
= 0;
12557 #endif /* USE_GTK || HAVE_NS */
12560 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12562 /* Get information about the tool-bar item which is displayed in GLYPH
12563 on frame F. Return in *PROP_IDX the index where tool-bar item
12564 properties start in F->tool_bar_items. Value is zero if
12565 GLYPH doesn't display a tool-bar item. */
12568 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12574 /* This function can be called asynchronously, which means we must
12575 exclude any possibility that Fget_text_property signals an
12577 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12578 charpos
= max (0, charpos
);
12580 /* Get the text property `menu-item' at pos. The value of that
12581 property is the start index of this item's properties in
12582 F->tool_bar_items. */
12583 prop
= Fget_text_property (make_number (charpos
),
12584 Qmenu_item
, f
->current_tool_bar_string
);
12585 if (INTEGERP (prop
))
12587 *prop_idx
= XINT (prop
);
12597 /* Get information about the tool-bar item at position X/Y on frame F.
12598 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12599 the current matrix of the tool-bar window of F, or NULL if not
12600 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12601 item in F->tool_bar_items. Value is
12603 -1 if X/Y is not on a tool-bar item
12604 0 if X/Y is on the same item that was highlighted before.
12608 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12609 int *hpos
, int *vpos
, int *prop_idx
)
12611 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12612 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12615 /* Find the glyph under X/Y. */
12616 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12617 if (*glyph
== NULL
)
12620 /* Get the start of this tool-bar item's properties in
12621 f->tool_bar_items. */
12622 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12625 /* Is mouse on the highlighted item? */
12626 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12627 && *vpos
>= hlinfo
->mouse_face_beg_row
12628 && *vpos
<= hlinfo
->mouse_face_end_row
12629 && (*vpos
> hlinfo
->mouse_face_beg_row
12630 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12631 && (*vpos
< hlinfo
->mouse_face_end_row
12632 || *hpos
< hlinfo
->mouse_face_end_col
12633 || hlinfo
->mouse_face_past_end
))
12641 Handle mouse button event on the tool-bar of frame F, at
12642 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12643 0 for button release. MODIFIERS is event modifiers for button
12647 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12650 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12651 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12652 int hpos
, vpos
, prop_idx
;
12653 struct glyph
*glyph
;
12654 Lisp_Object enabled_p
;
12657 /* If not on the highlighted tool-bar item, and mouse-highlight is
12658 non-nil, return. This is so we generate the tool-bar button
12659 click only when the mouse button is released on the same item as
12660 where it was pressed. However, when mouse-highlight is disabled,
12661 generate the click when the button is released regardless of the
12662 highlight, since tool-bar items are not highlighted in that
12664 frame_to_window_pixel_xy (w
, &x
, &y
);
12665 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12667 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12670 /* When mouse-highlight is off, generate the click for the item
12671 where the button was pressed, disregarding where it was
12673 if (NILP (Vmouse_highlight
) && !down_p
)
12674 prop_idx
= f
->last_tool_bar_item
;
12676 /* If item is disabled, do nothing. */
12677 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12678 if (NILP (enabled_p
))
12683 /* Show item in pressed state. */
12684 if (!NILP (Vmouse_highlight
))
12685 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12686 f
->last_tool_bar_item
= prop_idx
;
12690 Lisp_Object key
, frame
;
12691 struct input_event event
;
12692 EVENT_INIT (event
);
12694 /* Show item in released state. */
12695 if (!NILP (Vmouse_highlight
))
12696 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12698 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12700 XSETFRAME (frame
, f
);
12701 event
.kind
= TOOL_BAR_EVENT
;
12702 event
.frame_or_window
= frame
;
12704 kbd_buffer_store_event (&event
);
12706 event
.kind
= TOOL_BAR_EVENT
;
12707 event
.frame_or_window
= frame
;
12709 event
.modifiers
= modifiers
;
12710 kbd_buffer_store_event (&event
);
12711 f
->last_tool_bar_item
= -1;
12716 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12717 tool-bar window-relative coordinates X/Y. Called from
12718 note_mouse_highlight. */
12721 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12723 Lisp_Object window
= f
->tool_bar_window
;
12724 struct window
*w
= XWINDOW (window
);
12725 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12726 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12728 struct glyph
*glyph
;
12729 struct glyph_row
*row
;
12731 Lisp_Object enabled_p
;
12733 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12734 int mouse_down_p
, rc
;
12736 /* Function note_mouse_highlight is called with negative X/Y
12737 values when mouse moves outside of the frame. */
12738 if (x
<= 0 || y
<= 0)
12740 clear_mouse_face (hlinfo
);
12744 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12747 /* Not on tool-bar item. */
12748 clear_mouse_face (hlinfo
);
12752 /* On same tool-bar item as before. */
12753 goto set_help_echo
;
12755 clear_mouse_face (hlinfo
);
12757 /* Mouse is down, but on different tool-bar item? */
12758 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12759 && f
== dpyinfo
->last_mouse_frame
);
12761 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12764 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12766 /* If tool-bar item is not enabled, don't highlight it. */
12767 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12768 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12770 /* Compute the x-position of the glyph. In front and past the
12771 image is a space. We include this in the highlighted area. */
12772 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12773 for (i
= x
= 0; i
< hpos
; ++i
)
12774 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12776 /* Record this as the current active region. */
12777 hlinfo
->mouse_face_beg_col
= hpos
;
12778 hlinfo
->mouse_face_beg_row
= vpos
;
12779 hlinfo
->mouse_face_beg_x
= x
;
12780 hlinfo
->mouse_face_past_end
= 0;
12782 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12783 hlinfo
->mouse_face_end_row
= vpos
;
12784 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12785 hlinfo
->mouse_face_window
= window
;
12786 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12788 /* Display it as active. */
12789 show_mouse_face (hlinfo
, draw
);
12794 /* Set help_echo_string to a help string to display for this tool-bar item.
12795 XTread_socket does the rest. */
12796 help_echo_object
= help_echo_window
= Qnil
;
12797 help_echo_pos
= -1;
12798 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12799 if (NILP (help_echo_string
))
12800 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12803 #endif /* !USE_GTK && !HAVE_NS */
12805 #endif /* HAVE_WINDOW_SYSTEM */
12809 /************************************************************************
12810 Horizontal scrolling
12811 ************************************************************************/
12813 static int hscroll_window_tree (Lisp_Object
);
12814 static int hscroll_windows (Lisp_Object
);
12816 /* For all leaf windows in the window tree rooted at WINDOW, set their
12817 hscroll value so that PT is (i) visible in the window, and (ii) so
12818 that it is not within a certain margin at the window's left and
12819 right border. Value is non-zero if any window's hscroll has been
12823 hscroll_window_tree (Lisp_Object window
)
12825 int hscrolled_p
= 0;
12826 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12827 int hscroll_step_abs
= 0;
12828 double hscroll_step_rel
= 0;
12830 if (hscroll_relative_p
)
12832 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12833 if (hscroll_step_rel
< 0)
12835 hscroll_relative_p
= 0;
12836 hscroll_step_abs
= 0;
12839 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12841 hscroll_step_abs
= XINT (Vhscroll_step
);
12842 if (hscroll_step_abs
< 0)
12843 hscroll_step_abs
= 0;
12846 hscroll_step_abs
= 0;
12848 while (WINDOWP (window
))
12850 struct window
*w
= XWINDOW (window
);
12852 if (WINDOWP (w
->contents
))
12853 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12854 else if (w
->cursor
.vpos
>= 0)
12857 int text_area_width
;
12858 struct glyph_row
*cursor_row
;
12859 struct glyph_row
*bottom_row
;
12862 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12863 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12864 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12866 cursor_row
= bottom_row
- 1;
12868 if (!cursor_row
->enabled_p
)
12870 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12871 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12872 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12874 cursor_row
= bottom_row
- 1;
12876 row_r2l_p
= cursor_row
->reversed_p
;
12878 text_area_width
= window_box_width (w
, TEXT_AREA
);
12880 /* Scroll when cursor is inside this scroll margin. */
12881 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12883 /* If the position of this window's point has explicitly
12884 changed, no more suspend auto hscrolling. */
12885 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12886 w
->suspend_auto_hscroll
= 0;
12888 /* Remember window point. */
12889 Fset_marker (w
->old_pointm
,
12890 ((w
== XWINDOW (selected_window
))
12891 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12892 : Fmarker_position (w
->pointm
)),
12895 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12896 && w
->suspend_auto_hscroll
== 0
12897 /* In some pathological cases, like restoring a window
12898 configuration into a frame that is much smaller than
12899 the one from which the configuration was saved, we
12900 get glyph rows whose start and end have zero buffer
12901 positions, which we cannot handle below. Just skip
12903 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12904 /* For left-to-right rows, hscroll when cursor is either
12905 (i) inside the right hscroll margin, or (ii) if it is
12906 inside the left margin and the window is already
12909 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12910 || (cursor_row
->enabled_p
12911 && cursor_row
->truncated_on_right_p
12912 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12913 /* For right-to-left rows, the logic is similar,
12914 except that rules for scrolling to left and right
12915 are reversed. E.g., if cursor.x <= h_margin, we
12916 need to hscroll "to the right" unconditionally,
12917 and that will scroll the screen to the left so as
12918 to reveal the next portion of the row. */
12920 && ((cursor_row
->enabled_p
12921 /* FIXME: It is confusing to set the
12922 truncated_on_right_p flag when R2L rows
12923 are actually truncated on the left. */
12924 && cursor_row
->truncated_on_right_p
12925 && w
->cursor
.x
<= h_margin
)
12927 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12931 struct buffer
*saved_current_buffer
;
12935 /* Find point in a display of infinite width. */
12936 saved_current_buffer
= current_buffer
;
12937 current_buffer
= XBUFFER (w
->contents
);
12939 if (w
== XWINDOW (selected_window
))
12942 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12944 /* Move iterator to pt starting at cursor_row->start in
12945 a line with infinite width. */
12946 init_to_row_start (&it
, w
, cursor_row
);
12947 it
.last_visible_x
= INFINITY
;
12948 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12949 current_buffer
= saved_current_buffer
;
12951 /* Position cursor in window. */
12952 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12953 hscroll
= max (0, (it
.current_x
12954 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12955 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12956 : (text_area_width
/ 2))))
12957 / FRAME_COLUMN_WIDTH (it
.f
);
12958 else if ((!row_r2l_p
12959 && w
->cursor
.x
>= text_area_width
- h_margin
)
12960 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12962 if (hscroll_relative_p
)
12963 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12966 wanted_x
= text_area_width
12967 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12970 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12974 if (hscroll_relative_p
)
12975 wanted_x
= text_area_width
* hscroll_step_rel
12978 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12981 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12983 hscroll
= max (hscroll
, w
->min_hscroll
);
12985 /* Don't prevent redisplay optimizations if hscroll
12986 hasn't changed, as it will unnecessarily slow down
12988 if (w
->hscroll
!= hscroll
)
12990 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12991 w
->hscroll
= hscroll
;
13000 /* Value is non-zero if hscroll of any leaf window has been changed. */
13001 return hscrolled_p
;
13005 /* Set hscroll so that cursor is visible and not inside horizontal
13006 scroll margins for all windows in the tree rooted at WINDOW. See
13007 also hscroll_window_tree above. Value is non-zero if any window's
13008 hscroll has been changed. If it has, desired matrices on the frame
13009 of WINDOW are cleared. */
13012 hscroll_windows (Lisp_Object window
)
13014 int hscrolled_p
= hscroll_window_tree (window
);
13016 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13017 return hscrolled_p
;
13022 /************************************************************************
13024 ************************************************************************/
13026 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13027 to a non-zero value. This is sometimes handy to have in a debugger
13032 /* First and last unchanged row for try_window_id. */
13034 static int debug_first_unchanged_at_end_vpos
;
13035 static int debug_last_unchanged_at_beg_vpos
;
13037 /* Delta vpos and y. */
13039 static int debug_dvpos
, debug_dy
;
13041 /* Delta in characters and bytes for try_window_id. */
13043 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13045 /* Values of window_end_pos and window_end_vpos at the end of
13048 static ptrdiff_t debug_end_vpos
;
13050 /* Append a string to W->desired_matrix->method. FMT is a printf
13051 format string. If trace_redisplay_p is true also printf the
13052 resulting string to stderr. */
13054 static void debug_method_add (struct window
*, char const *, ...)
13055 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13058 debug_method_add (struct window
*w
, char const *fmt
, ...)
13061 char *method
= w
->desired_matrix
->method
;
13062 int len
= strlen (method
);
13063 int size
= sizeof w
->desired_matrix
->method
;
13064 int remaining
= size
- len
- 1;
13067 if (len
&& remaining
)
13070 --remaining
, ++len
;
13073 va_start (ap
, fmt
);
13074 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13077 if (trace_redisplay_p
)
13078 fprintf (stderr
, "%p (%s): %s\n",
13080 ((BUFFERP (w
->contents
)
13081 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13082 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13087 #endif /* GLYPH_DEBUG */
13090 /* Value is non-zero if all changes in window W, which displays
13091 current_buffer, are in the text between START and END. START is a
13092 buffer position, END is given as a distance from Z. Used in
13093 redisplay_internal for display optimization. */
13096 text_outside_line_unchanged_p (struct window
*w
,
13097 ptrdiff_t start
, ptrdiff_t end
)
13099 int unchanged_p
= 1;
13101 /* If text or overlays have changed, see where. */
13102 if (window_outdated (w
))
13104 /* Gap in the line? */
13105 if (GPT
< start
|| Z
- GPT
< end
)
13108 /* Changes start in front of the line, or end after it? */
13110 && (BEG_UNCHANGED
< start
- 1
13111 || END_UNCHANGED
< end
))
13114 /* If selective display, can't optimize if changes start at the
13115 beginning of the line. */
13117 && INTEGERP (BVAR (current_buffer
, selective_display
))
13118 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13119 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13122 /* If there are overlays at the start or end of the line, these
13123 may have overlay strings with newlines in them. A change at
13124 START, for instance, may actually concern the display of such
13125 overlay strings as well, and they are displayed on different
13126 lines. So, quickly rule out this case. (For the future, it
13127 might be desirable to implement something more telling than
13128 just BEG/END_UNCHANGED.) */
13131 if (BEG
+ BEG_UNCHANGED
== start
13132 && overlay_touches_p (start
))
13134 if (END_UNCHANGED
== end
13135 && overlay_touches_p (Z
- end
))
13139 /* Under bidi reordering, adding or deleting a character in the
13140 beginning of a paragraph, before the first strong directional
13141 character, can change the base direction of the paragraph (unless
13142 the buffer specifies a fixed paragraph direction), which will
13143 require to redisplay the whole paragraph. It might be worthwhile
13144 to find the paragraph limits and widen the range of redisplayed
13145 lines to that, but for now just give up this optimization. */
13146 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13147 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13151 return unchanged_p
;
13155 /* Do a frame update, taking possible shortcuts into account. This is
13156 the main external entry point for redisplay.
13158 If the last redisplay displayed an echo area message and that message
13159 is no longer requested, we clear the echo area or bring back the
13160 mini-buffer if that is in use. */
13165 redisplay_internal ();
13170 overlay_arrow_string_or_property (Lisp_Object var
)
13174 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13177 return Voverlay_arrow_string
;
13180 /* Return 1 if there are any overlay-arrows in current_buffer. */
13182 overlay_arrow_in_current_buffer_p (void)
13186 for (vlist
= Voverlay_arrow_variable_list
;
13188 vlist
= XCDR (vlist
))
13190 Lisp_Object var
= XCAR (vlist
);
13193 if (!SYMBOLP (var
))
13195 val
= find_symbol_value (var
);
13197 && current_buffer
== XMARKER (val
)->buffer
)
13204 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13208 overlay_arrows_changed_p (void)
13212 for (vlist
= Voverlay_arrow_variable_list
;
13214 vlist
= XCDR (vlist
))
13216 Lisp_Object var
= XCAR (vlist
);
13217 Lisp_Object val
, pstr
;
13219 if (!SYMBOLP (var
))
13221 val
= find_symbol_value (var
);
13222 if (!MARKERP (val
))
13224 if (! EQ (COERCE_MARKER (val
),
13225 Fget (var
, Qlast_arrow_position
))
13226 || ! (pstr
= overlay_arrow_string_or_property (var
),
13227 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13233 /* Mark overlay arrows to be updated on next redisplay. */
13236 update_overlay_arrows (int up_to_date
)
13240 for (vlist
= Voverlay_arrow_variable_list
;
13242 vlist
= XCDR (vlist
))
13244 Lisp_Object var
= XCAR (vlist
);
13246 if (!SYMBOLP (var
))
13249 if (up_to_date
> 0)
13251 Lisp_Object val
= find_symbol_value (var
);
13252 Fput (var
, Qlast_arrow_position
,
13253 COERCE_MARKER (val
));
13254 Fput (var
, Qlast_arrow_string
,
13255 overlay_arrow_string_or_property (var
));
13257 else if (up_to_date
< 0
13258 || !NILP (Fget (var
, Qlast_arrow_position
)))
13260 Fput (var
, Qlast_arrow_position
, Qt
);
13261 Fput (var
, Qlast_arrow_string
, Qt
);
13267 /* Return overlay arrow string to display at row.
13268 Return integer (bitmap number) for arrow bitmap in left fringe.
13269 Return nil if no overlay arrow. */
13272 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13276 for (vlist
= Voverlay_arrow_variable_list
;
13278 vlist
= XCDR (vlist
))
13280 Lisp_Object var
= XCAR (vlist
);
13283 if (!SYMBOLP (var
))
13286 val
= find_symbol_value (var
);
13289 && current_buffer
== XMARKER (val
)->buffer
13290 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13292 if (FRAME_WINDOW_P (it
->f
)
13293 /* FIXME: if ROW->reversed_p is set, this should test
13294 the right fringe, not the left one. */
13295 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13297 #ifdef HAVE_WINDOW_SYSTEM
13298 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13301 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13302 return make_number (fringe_bitmap
);
13305 return make_number (-1); /* Use default arrow bitmap. */
13307 return overlay_arrow_string_or_property (var
);
13314 /* Return 1 if point moved out of or into a composition. Otherwise
13315 return 0. PREV_BUF and PREV_PT are the last point buffer and
13316 position. BUF and PT are the current point buffer and position. */
13319 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13320 struct buffer
*buf
, ptrdiff_t pt
)
13322 ptrdiff_t start
, end
;
13324 Lisp_Object buffer
;
13326 XSETBUFFER (buffer
, buf
);
13327 /* Check a composition at the last point if point moved within the
13329 if (prev_buf
== buf
)
13332 /* Point didn't move. */
13335 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13336 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13337 && composition_valid_p (start
, end
, prop
)
13338 && start
< prev_pt
&& end
> prev_pt
)
13339 /* The last point was within the composition. Return 1 iff
13340 point moved out of the composition. */
13341 return (pt
<= start
|| pt
>= end
);
13344 /* Check a composition at the current point. */
13345 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13346 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13347 && composition_valid_p (start
, end
, prop
)
13348 && start
< pt
&& end
> pt
);
13351 /* Reconsider the clip changes of buffer which is displayed in W. */
13354 reconsider_clip_changes (struct window
*w
)
13356 struct buffer
*b
= XBUFFER (w
->contents
);
13358 if (b
->clip_changed
13359 && w
->window_end_valid
13360 && w
->current_matrix
->buffer
== b
13361 && w
->current_matrix
->zv
== BUF_ZV (b
)
13362 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13363 b
->clip_changed
= 0;
13365 /* If display wasn't paused, and W is not a tool bar window, see if
13366 point has been moved into or out of a composition. In that case,
13367 we set b->clip_changed to 1 to force updating the screen. If
13368 b->clip_changed has already been set to 1, we can skip this
13370 if (!b
->clip_changed
&& w
->window_end_valid
)
13372 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13373 ? PT
: marker_position (w
->pointm
));
13375 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13376 && check_point_in_composition (w
->current_matrix
->buffer
,
13377 w
->last_point
, b
, pt
))
13378 b
->clip_changed
= 1;
13383 propagate_buffer_redisplay (void)
13384 { /* Resetting b->text->redisplay is problematic!
13385 We can't just reset it in the case that some window that displays
13386 it has not been redisplayed; and such a window can stay
13387 unredisplayed for a long time if it's currently invisible.
13388 But we do want to reset it at the end of redisplay otherwise
13389 its displayed windows will keep being redisplayed over and over
13391 So we copy all b->text->redisplay flags up to their windows here,
13392 such that mark_window_display_accurate can safely reset
13393 b->text->redisplay. */
13394 Lisp_Object ws
= window_list ();
13395 for (; CONSP (ws
); ws
= XCDR (ws
))
13397 struct window
*thisw
= XWINDOW (XCAR (ws
));
13398 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13399 if (thisb
->text
->redisplay
)
13400 thisw
->redisplay
= true;
13404 #define STOP_POLLING \
13405 do { if (! polling_stopped_here) stop_polling (); \
13406 polling_stopped_here = 1; } while (0)
13408 #define RESUME_POLLING \
13409 do { if (polling_stopped_here) start_polling (); \
13410 polling_stopped_here = 0; } while (0)
13413 /* Perhaps in the future avoid recentering windows if it
13414 is not necessary; currently that causes some problems. */
13417 redisplay_internal (void)
13419 struct window
*w
= XWINDOW (selected_window
);
13423 bool must_finish
= 0, match_p
;
13424 struct text_pos tlbufpos
, tlendpos
;
13425 int number_of_visible_frames
;
13428 int polling_stopped_here
= 0;
13429 Lisp_Object tail
, frame
;
13431 /* True means redisplay has to consider all windows on all
13432 frames. False, only selected_window is considered. */
13433 bool consider_all_windows_p
;
13435 /* True means redisplay has to redisplay the miniwindow. */
13436 bool update_miniwindow_p
= false;
13438 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13440 /* No redisplay if running in batch mode or frame is not yet fully
13441 initialized, or redisplay is explicitly turned off by setting
13442 Vinhibit_redisplay. */
13443 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13444 || !NILP (Vinhibit_redisplay
))
13447 /* Don't examine these until after testing Vinhibit_redisplay.
13448 When Emacs is shutting down, perhaps because its connection to
13449 X has dropped, we should not look at them at all. */
13450 fr
= XFRAME (w
->frame
);
13451 sf
= SELECTED_FRAME ();
13453 if (!fr
->glyphs_initialized_p
)
13456 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13457 if (popup_activated ())
13461 /* I don't think this happens but let's be paranoid. */
13462 if (redisplaying_p
)
13465 /* Record a function that clears redisplaying_p
13466 when we leave this function. */
13467 count
= SPECPDL_INDEX ();
13468 record_unwind_protect_void (unwind_redisplay
);
13469 redisplaying_p
= 1;
13470 specbind (Qinhibit_free_realized_faces
, Qnil
);
13472 /* Record this function, so it appears on the profiler's backtraces. */
13473 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13475 FOR_EACH_FRAME (tail
, frame
)
13476 XFRAME (frame
)->already_hscrolled_p
= 0;
13479 /* Remember the currently selected window. */
13483 last_escape_glyph_frame
= NULL
;
13484 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13485 last_glyphless_glyph_frame
= NULL
;
13486 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13488 /* If face_change_count is non-zero, init_iterator will free all
13489 realized faces, which includes the faces referenced from current
13490 matrices. So, we can't reuse current matrices in this case. */
13491 if (face_change_count
)
13492 windows_or_buffers_changed
= 47;
13494 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13495 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13497 /* Since frames on a single ASCII terminal share the same
13498 display area, displaying a different frame means redisplay
13499 the whole thing. */
13500 SET_FRAME_GARBAGED (sf
);
13502 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13504 FRAME_TTY (sf
)->previous_frame
= sf
;
13507 /* Set the visible flags for all frames. Do this before checking for
13508 resized or garbaged frames; they want to know if their frames are
13509 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13510 number_of_visible_frames
= 0;
13512 FOR_EACH_FRAME (tail
, frame
)
13514 struct frame
*f
= XFRAME (frame
);
13516 if (FRAME_VISIBLE_P (f
))
13518 ++number_of_visible_frames
;
13519 /* Adjust matrices for visible frames only. */
13520 if (f
->fonts_changed
)
13522 adjust_frame_glyphs (f
);
13523 f
->fonts_changed
= 0;
13525 /* If cursor type has been changed on the frame
13526 other than selected, consider all frames. */
13527 if (f
!= sf
&& f
->cursor_type_changed
)
13528 update_mode_lines
= 31;
13530 clear_desired_matrices (f
);
13533 /* Notice any pending interrupt request to change frame size. */
13534 do_pending_window_change (1);
13536 /* do_pending_window_change could change the selected_window due to
13537 frame resizing which makes the selected window too small. */
13538 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13541 /* Clear frames marked as garbaged. */
13542 clear_garbaged_frames ();
13544 /* Build menubar and tool-bar items. */
13545 if (NILP (Vmemory_full
))
13546 prepare_menu_bars ();
13548 reconsider_clip_changes (w
);
13550 /* In most cases selected window displays current buffer. */
13551 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13554 /* Detect case that we need to write or remove a star in the mode line. */
13555 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13556 w
->update_mode_line
= 1;
13558 if (mode_line_update_needed (w
))
13559 w
->update_mode_line
= 1;
13562 /* Normally the message* functions will have already displayed and
13563 updated the echo area, but the frame may have been trashed, or
13564 the update may have been preempted, so display the echo area
13565 again here. Checking message_cleared_p captures the case that
13566 the echo area should be cleared. */
13567 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13568 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13569 || (message_cleared_p
13570 && minibuf_level
== 0
13571 /* If the mini-window is currently selected, this means the
13572 echo-area doesn't show through. */
13573 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13575 int window_height_changed_p
= echo_area_display (0);
13577 if (message_cleared_p
)
13578 update_miniwindow_p
= true;
13582 /* If we don't display the current message, don't clear the
13583 message_cleared_p flag, because, if we did, we wouldn't clear
13584 the echo area in the next redisplay which doesn't preserve
13586 if (!display_last_displayed_message_p
)
13587 message_cleared_p
= 0;
13589 if (window_height_changed_p
)
13591 windows_or_buffers_changed
= 50;
13593 /* If window configuration was changed, frames may have been
13594 marked garbaged. Clear them or we will experience
13595 surprises wrt scrolling. */
13596 clear_garbaged_frames ();
13599 else if (EQ (selected_window
, minibuf_window
)
13600 && (current_buffer
->clip_changed
|| window_outdated (w
))
13601 && resize_mini_window (w
, 0))
13603 /* Resized active mini-window to fit the size of what it is
13604 showing if its contents might have changed. */
13607 /* If window configuration was changed, frames may have been
13608 marked garbaged. Clear them or we will experience
13609 surprises wrt scrolling. */
13610 clear_garbaged_frames ();
13613 if (windows_or_buffers_changed
&& !update_mode_lines
)
13614 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13615 only the windows's contents needs to be refreshed, or whether the
13616 mode-lines also need a refresh. */
13617 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13618 ? REDISPLAY_SOME
: 32);
13620 /* If specs for an arrow have changed, do thorough redisplay
13621 to ensure we remove any arrow that should no longer exist. */
13622 if (overlay_arrows_changed_p ())
13623 /* Apparently, this is the only case where we update other windows,
13624 without updating other mode-lines. */
13625 windows_or_buffers_changed
= 49;
13627 consider_all_windows_p
= (update_mode_lines
13628 || windows_or_buffers_changed
);
13630 #define AINC(a,i) \
13631 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13632 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13634 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13635 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13637 /* Optimize the case that only the line containing the cursor in the
13638 selected window has changed. Variables starting with this_ are
13639 set in display_line and record information about the line
13640 containing the cursor. */
13641 tlbufpos
= this_line_start_pos
;
13642 tlendpos
= this_line_end_pos
;
13643 if (!consider_all_windows_p
13644 && CHARPOS (tlbufpos
) > 0
13645 && !w
->update_mode_line
13646 && !current_buffer
->clip_changed
13647 && !current_buffer
->prevent_redisplay_optimizations_p
13648 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13649 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13650 && !XFRAME (w
->frame
)->cursor_type_changed
13651 /* Make sure recorded data applies to current buffer, etc. */
13652 && this_line_buffer
== current_buffer
13655 && !w
->optional_new_start
13656 /* Point must be on the line that we have info recorded about. */
13657 && PT
>= CHARPOS (tlbufpos
)
13658 && PT
<= Z
- CHARPOS (tlendpos
)
13659 /* All text outside that line, including its final newline,
13660 must be unchanged. */
13661 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13662 CHARPOS (tlendpos
)))
13664 if (CHARPOS (tlbufpos
) > BEGV
13665 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13666 && (CHARPOS (tlbufpos
) == ZV
13667 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13668 /* Former continuation line has disappeared by becoming empty. */
13670 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13672 /* We have to handle the case of continuation around a
13673 wide-column character (see the comment in indent.c around
13676 For instance, in the following case:
13678 -------- Insert --------
13679 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13680 J_I_ ==> J_I_ `^^' are cursors.
13684 As we have to redraw the line above, we cannot use this
13688 int line_height_before
= this_line_pixel_height
;
13690 /* Note that start_display will handle the case that the
13691 line starting at tlbufpos is a continuation line. */
13692 start_display (&it
, w
, tlbufpos
);
13694 /* Implementation note: It this still necessary? */
13695 if (it
.current_x
!= this_line_start_x
)
13698 TRACE ((stderr
, "trying display optimization 1\n"));
13699 w
->cursor
.vpos
= -1;
13700 overlay_arrow_seen
= 0;
13701 it
.vpos
= this_line_vpos
;
13702 it
.current_y
= this_line_y
;
13703 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13704 display_line (&it
);
13706 /* If line contains point, is not continued,
13707 and ends at same distance from eob as before, we win. */
13708 if (w
->cursor
.vpos
>= 0
13709 /* Line is not continued, otherwise this_line_start_pos
13710 would have been set to 0 in display_line. */
13711 && CHARPOS (this_line_start_pos
)
13712 /* Line ends as before. */
13713 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13714 /* Line has same height as before. Otherwise other lines
13715 would have to be shifted up or down. */
13716 && this_line_pixel_height
== line_height_before
)
13718 /* If this is not the window's last line, we must adjust
13719 the charstarts of the lines below. */
13720 if (it
.current_y
< it
.last_visible_y
)
13722 struct glyph_row
*row
13723 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13724 ptrdiff_t delta
, delta_bytes
;
13726 /* We used to distinguish between two cases here,
13727 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13728 when the line ends in a newline or the end of the
13729 buffer's accessible portion. But both cases did
13730 the same, so they were collapsed. */
13732 - CHARPOS (tlendpos
)
13733 - MATRIX_ROW_START_CHARPOS (row
));
13734 delta_bytes
= (Z_BYTE
13735 - BYTEPOS (tlendpos
)
13736 - MATRIX_ROW_START_BYTEPOS (row
));
13738 increment_matrix_positions (w
->current_matrix
,
13739 this_line_vpos
+ 1,
13740 w
->current_matrix
->nrows
,
13741 delta
, delta_bytes
);
13744 /* If this row displays text now but previously didn't,
13745 or vice versa, w->window_end_vpos may have to be
13747 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13749 if (w
->window_end_vpos
< this_line_vpos
)
13750 w
->window_end_vpos
= this_line_vpos
;
13752 else if (w
->window_end_vpos
== this_line_vpos
13753 && this_line_vpos
> 0)
13754 w
->window_end_vpos
= this_line_vpos
- 1;
13755 w
->window_end_valid
= 0;
13757 /* Update hint: No need to try to scroll in update_window. */
13758 w
->desired_matrix
->no_scrolling_p
= 1;
13761 *w
->desired_matrix
->method
= 0;
13762 debug_method_add (w
, "optimization 1");
13764 #ifdef HAVE_WINDOW_SYSTEM
13765 update_window_fringes (w
, 0);
13772 else if (/* Cursor position hasn't changed. */
13773 PT
== w
->last_point
13774 /* Make sure the cursor was last displayed
13775 in this window. Otherwise we have to reposition it. */
13777 /* PXW: Must be converted to pixels, probably. */
13778 && 0 <= w
->cursor
.vpos
13779 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13783 do_pending_window_change (1);
13784 /* If selected_window changed, redisplay again. */
13785 if (WINDOWP (selected_window
)
13786 && (w
= XWINDOW (selected_window
)) != sw
)
13789 /* We used to always goto end_of_redisplay here, but this
13790 isn't enough if we have a blinking cursor. */
13791 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13792 goto end_of_redisplay
;
13796 /* If highlighting the region, or if the cursor is in the echo area,
13797 then we can't just move the cursor. */
13798 else if (NILP (Vshow_trailing_whitespace
)
13799 && !cursor_in_echo_area
)
13802 struct glyph_row
*row
;
13804 /* Skip from tlbufpos to PT and see where it is. Note that
13805 PT may be in invisible text. If so, we will end at the
13806 next visible position. */
13807 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13808 NULL
, DEFAULT_FACE_ID
);
13809 it
.current_x
= this_line_start_x
;
13810 it
.current_y
= this_line_y
;
13811 it
.vpos
= this_line_vpos
;
13813 /* The call to move_it_to stops in front of PT, but
13814 moves over before-strings. */
13815 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13817 if (it
.vpos
== this_line_vpos
13818 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13821 eassert (this_line_vpos
== it
.vpos
);
13822 eassert (this_line_y
== it
.current_y
);
13823 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13825 *w
->desired_matrix
->method
= 0;
13826 debug_method_add (w
, "optimization 3");
13835 /* Text changed drastically or point moved off of line. */
13836 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13839 CHARPOS (this_line_start_pos
) = 0;
13840 ++clear_face_cache_count
;
13841 #ifdef HAVE_WINDOW_SYSTEM
13842 ++clear_image_cache_count
;
13845 /* Build desired matrices, and update the display. If
13846 consider_all_windows_p is non-zero, do it for all windows on all
13847 frames. Otherwise do it for selected_window, only. */
13849 if (consider_all_windows_p
)
13851 FOR_EACH_FRAME (tail
, frame
)
13852 XFRAME (frame
)->updated_p
= 0;
13854 propagate_buffer_redisplay ();
13856 FOR_EACH_FRAME (tail
, frame
)
13858 struct frame
*f
= XFRAME (frame
);
13860 /* We don't have to do anything for unselected terminal
13862 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13863 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13868 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13871 /* Only GC scrollbars when we redisplay the whole frame. */
13872 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13873 /* Mark all the scroll bars to be removed; we'll redeem
13874 the ones we want when we redisplay their windows. */
13875 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13876 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13878 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13879 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13880 /* Remember that the invisible frames need to be redisplayed next
13881 time they're visible. */
13882 else if (!REDISPLAY_SOME_P ())
13883 f
->redisplay
= true;
13885 /* The X error handler may have deleted that frame. */
13886 if (!FRAME_LIVE_P (f
))
13889 /* Any scroll bars which redisplay_windows should have
13890 nuked should now go away. */
13891 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13892 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13894 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13896 /* If fonts changed on visible frame, display again. */
13897 if (f
->fonts_changed
)
13899 adjust_frame_glyphs (f
);
13900 f
->fonts_changed
= 0;
13904 /* See if we have to hscroll. */
13905 if (!f
->already_hscrolled_p
)
13907 f
->already_hscrolled_p
= 1;
13908 if (hscroll_windows (f
->root_window
))
13912 /* Prevent various kinds of signals during display
13913 update. stdio is not robust about handling
13914 signals, which can cause an apparent I/O error. */
13915 if (interrupt_input
)
13916 unrequest_sigio ();
13919 pending
|= update_frame (f
, 0, 0);
13920 f
->cursor_type_changed
= 0;
13926 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13930 /* Do the mark_window_display_accurate after all windows have
13931 been redisplayed because this call resets flags in buffers
13932 which are needed for proper redisplay. */
13933 FOR_EACH_FRAME (tail
, frame
)
13935 struct frame
*f
= XFRAME (frame
);
13938 f
->redisplay
= false;
13939 mark_window_display_accurate (f
->root_window
, 1);
13940 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13941 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13946 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13948 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13949 struct frame
*mini_frame
;
13951 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13952 /* Use list_of_error, not Qerror, so that
13953 we catch only errors and don't run the debugger. */
13954 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13956 redisplay_window_error
);
13957 if (update_miniwindow_p
)
13958 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13960 redisplay_window_error
);
13962 /* Compare desired and current matrices, perform output. */
13965 /* If fonts changed, display again. */
13966 if (sf
->fonts_changed
)
13969 /* Prevent various kinds of signals during display update.
13970 stdio is not robust about handling signals,
13971 which can cause an apparent I/O error. */
13972 if (interrupt_input
)
13973 unrequest_sigio ();
13976 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13978 if (hscroll_windows (selected_window
))
13981 XWINDOW (selected_window
)->must_be_updated_p
= true;
13982 pending
= update_frame (sf
, 0, 0);
13983 sf
->cursor_type_changed
= 0;
13986 /* We may have called echo_area_display at the top of this
13987 function. If the echo area is on another frame, that may
13988 have put text on a frame other than the selected one, so the
13989 above call to update_frame would not have caught it. Catch
13991 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13992 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13994 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13996 XWINDOW (mini_window
)->must_be_updated_p
= true;
13997 pending
|= update_frame (mini_frame
, 0, 0);
13998 mini_frame
->cursor_type_changed
= 0;
13999 if (!pending
&& hscroll_windows (mini_window
))
14004 /* If display was paused because of pending input, make sure we do a
14005 thorough update the next time. */
14008 /* Prevent the optimization at the beginning of
14009 redisplay_internal that tries a single-line update of the
14010 line containing the cursor in the selected window. */
14011 CHARPOS (this_line_start_pos
) = 0;
14013 /* Let the overlay arrow be updated the next time. */
14014 update_overlay_arrows (0);
14016 /* If we pause after scrolling, some rows in the current
14017 matrices of some windows are not valid. */
14018 if (!WINDOW_FULL_WIDTH_P (w
)
14019 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14020 update_mode_lines
= 36;
14024 if (!consider_all_windows_p
)
14026 /* This has already been done above if
14027 consider_all_windows_p is set. */
14028 if (XBUFFER (w
->contents
)->text
->redisplay
14029 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14030 /* This can happen if b->text->redisplay was set during
14032 propagate_buffer_redisplay ();
14033 mark_window_display_accurate_1 (w
, 1);
14035 /* Say overlay arrows are up to date. */
14036 update_overlay_arrows (1);
14038 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14039 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14042 update_mode_lines
= 0;
14043 windows_or_buffers_changed
= 0;
14046 /* Start SIGIO interrupts coming again. Having them off during the
14047 code above makes it less likely one will discard output, but not
14048 impossible, since there might be stuff in the system buffer here.
14049 But it is much hairier to try to do anything about that. */
14050 if (interrupt_input
)
14054 /* If a frame has become visible which was not before, redisplay
14055 again, so that we display it. Expose events for such a frame
14056 (which it gets when becoming visible) don't call the parts of
14057 redisplay constructing glyphs, so simply exposing a frame won't
14058 display anything in this case. So, we have to display these
14059 frames here explicitly. */
14064 FOR_EACH_FRAME (tail
, frame
)
14066 if (XFRAME (frame
)->visible
)
14070 if (new_count
!= number_of_visible_frames
)
14071 windows_or_buffers_changed
= 52;
14074 /* Change frame size now if a change is pending. */
14075 do_pending_window_change (1);
14077 /* If we just did a pending size change, or have additional
14078 visible frames, or selected_window changed, redisplay again. */
14079 if ((windows_or_buffers_changed
&& !pending
)
14080 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14083 /* Clear the face and image caches.
14085 We used to do this only if consider_all_windows_p. But the cache
14086 needs to be cleared if a timer creates images in the current
14087 buffer (e.g. the test case in Bug#6230). */
14089 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14091 clear_face_cache (0);
14092 clear_face_cache_count
= 0;
14095 #ifdef HAVE_WINDOW_SYSTEM
14096 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14098 clear_image_caches (Qnil
);
14099 clear_image_cache_count
= 0;
14101 #endif /* HAVE_WINDOW_SYSTEM */
14104 if (interrupt_input
&& interrupts_deferred
)
14107 unbind_to (count
, Qnil
);
14112 /* Redisplay, but leave alone any recent echo area message unless
14113 another message has been requested in its place.
14115 This is useful in situations where you need to redisplay but no
14116 user action has occurred, making it inappropriate for the message
14117 area to be cleared. See tracking_off and
14118 wait_reading_process_output for examples of these situations.
14120 FROM_WHERE is an integer saying from where this function was
14121 called. This is useful for debugging. */
14124 redisplay_preserve_echo_area (int from_where
)
14126 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14128 if (!NILP (echo_area_buffer
[1]))
14130 /* We have a previously displayed message, but no current
14131 message. Redisplay the previous message. */
14132 display_last_displayed_message_p
= 1;
14133 redisplay_internal ();
14134 display_last_displayed_message_p
= 0;
14137 redisplay_internal ();
14139 flush_frame (SELECTED_FRAME ());
14143 /* Function registered with record_unwind_protect in redisplay_internal. */
14146 unwind_redisplay (void)
14148 redisplaying_p
= 0;
14152 /* Mark the display of leaf window W as accurate or inaccurate.
14153 If ACCURATE_P is non-zero mark display of W as accurate. If
14154 ACCURATE_P is zero, arrange for W to be redisplayed the next
14155 time redisplay_internal is called. */
14158 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14160 struct buffer
*b
= XBUFFER (w
->contents
);
14162 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14163 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14164 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14168 b
->clip_changed
= false;
14169 b
->prevent_redisplay_optimizations_p
= false;
14170 eassert (buffer_window_count (b
) > 0);
14171 /* Resetting b->text->redisplay is problematic!
14172 In order to make it safer to do it here, redisplay_internal must
14173 have copied all b->text->redisplay to their respective windows. */
14174 b
->text
->redisplay
= false;
14176 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14177 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14178 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14179 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14181 w
->current_matrix
->buffer
= b
;
14182 w
->current_matrix
->begv
= BUF_BEGV (b
);
14183 w
->current_matrix
->zv
= BUF_ZV (b
);
14185 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14186 w
->last_cursor_off_p
= w
->cursor_off_p
;
14188 if (w
== XWINDOW (selected_window
))
14189 w
->last_point
= BUF_PT (b
);
14191 w
->last_point
= marker_position (w
->pointm
);
14193 w
->window_end_valid
= true;
14194 w
->update_mode_line
= false;
14197 w
->redisplay
= !accurate_p
;
14201 /* Mark the display of windows in the window tree rooted at WINDOW as
14202 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14203 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14204 be redisplayed the next time redisplay_internal is called. */
14207 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14211 for (; !NILP (window
); window
= w
->next
)
14213 w
= XWINDOW (window
);
14214 if (WINDOWP (w
->contents
))
14215 mark_window_display_accurate (w
->contents
, accurate_p
);
14217 mark_window_display_accurate_1 (w
, accurate_p
);
14221 update_overlay_arrows (1);
14223 /* Force a thorough redisplay the next time by setting
14224 last_arrow_position and last_arrow_string to t, which is
14225 unequal to any useful value of Voverlay_arrow_... */
14226 update_overlay_arrows (-1);
14230 /* Return value in display table DP (Lisp_Char_Table *) for character
14231 C. Since a display table doesn't have any parent, we don't have to
14232 follow parent. Do not call this function directly but use the
14233 macro DISP_CHAR_VECTOR. */
14236 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14240 if (ASCII_CHAR_P (c
))
14243 if (SUB_CHAR_TABLE_P (val
))
14244 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14250 XSETCHAR_TABLE (table
, dp
);
14251 val
= char_table_ref (table
, c
);
14260 /***********************************************************************
14262 ***********************************************************************/
14264 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14267 redisplay_windows (Lisp_Object window
)
14269 while (!NILP (window
))
14271 struct window
*w
= XWINDOW (window
);
14273 if (WINDOWP (w
->contents
))
14274 redisplay_windows (w
->contents
);
14275 else if (BUFFERP (w
->contents
))
14277 displayed_buffer
= XBUFFER (w
->contents
);
14278 /* Use list_of_error, not Qerror, so that
14279 we catch only errors and don't run the debugger. */
14280 internal_condition_case_1 (redisplay_window_0
, window
,
14282 redisplay_window_error
);
14290 redisplay_window_error (Lisp_Object ignore
)
14292 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14297 redisplay_window_0 (Lisp_Object window
)
14299 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14300 redisplay_window (window
, false);
14305 redisplay_window_1 (Lisp_Object window
)
14307 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14308 redisplay_window (window
, true);
14313 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14314 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14315 which positions recorded in ROW differ from current buffer
14318 Return 0 if cursor is not on this row, 1 otherwise. */
14321 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14322 struct glyph_matrix
*matrix
,
14323 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14326 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14327 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14328 struct glyph
*cursor
= NULL
;
14329 /* The last known character position in row. */
14330 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14332 ptrdiff_t pt_old
= PT
- delta
;
14333 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14334 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14335 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14336 /* A glyph beyond the edge of TEXT_AREA which we should never
14338 struct glyph
*glyphs_end
= end
;
14339 /* Non-zero means we've found a match for cursor position, but that
14340 glyph has the avoid_cursor_p flag set. */
14341 int match_with_avoid_cursor
= 0;
14342 /* Non-zero means we've seen at least one glyph that came from a
14344 int string_seen
= 0;
14345 /* Largest and smallest buffer positions seen so far during scan of
14347 ptrdiff_t bpos_max
= pos_before
;
14348 ptrdiff_t bpos_min
= pos_after
;
14349 /* Last buffer position covered by an overlay string with an integer
14350 `cursor' property. */
14351 ptrdiff_t bpos_covered
= 0;
14352 /* Non-zero means the display string on which to display the cursor
14353 comes from a text property, not from an overlay. */
14354 int string_from_text_prop
= 0;
14356 /* Don't even try doing anything if called for a mode-line or
14357 header-line row, since the rest of the code isn't prepared to
14358 deal with such calamities. */
14359 eassert (!row
->mode_line_p
);
14360 if (row
->mode_line_p
)
14363 /* Skip over glyphs not having an object at the start and the end of
14364 the row. These are special glyphs like truncation marks on
14365 terminal frames. */
14366 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14368 if (!row
->reversed_p
)
14371 && INTEGERP (glyph
->object
)
14372 && glyph
->charpos
< 0)
14374 x
+= glyph
->pixel_width
;
14378 && INTEGERP ((end
- 1)->object
)
14379 /* CHARPOS is zero for blanks and stretch glyphs
14380 inserted by extend_face_to_end_of_line. */
14381 && (end
- 1)->charpos
<= 0)
14383 glyph_before
= glyph
- 1;
14390 /* If the glyph row is reversed, we need to process it from back
14391 to front, so swap the edge pointers. */
14392 glyphs_end
= end
= glyph
- 1;
14393 glyph
+= row
->used
[TEXT_AREA
] - 1;
14395 while (glyph
> end
+ 1
14396 && INTEGERP (glyph
->object
)
14397 && glyph
->charpos
< 0)
14400 x
-= glyph
->pixel_width
;
14402 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14404 /* By default, in reversed rows we put the cursor on the
14405 rightmost (first in the reading order) glyph. */
14406 for (g
= end
+ 1; g
< glyph
; g
++)
14407 x
+= g
->pixel_width
;
14409 && INTEGERP ((end
+ 1)->object
)
14410 && (end
+ 1)->charpos
<= 0)
14412 glyph_before
= glyph
+ 1;
14416 else if (row
->reversed_p
)
14418 /* In R2L rows that don't display text, put the cursor on the
14419 rightmost glyph. Case in point: an empty last line that is
14420 part of an R2L paragraph. */
14422 /* Avoid placing the cursor on the last glyph of the row, where
14423 on terminal frames we hold the vertical border between
14424 adjacent windows. */
14425 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14426 && !WINDOW_RIGHTMOST_P (w
)
14427 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14429 x
= -1; /* will be computed below, at label compute_x */
14432 /* Step 1: Try to find the glyph whose character position
14433 corresponds to point. If that's not possible, find 2 glyphs
14434 whose character positions are the closest to point, one before
14435 point, the other after it. */
14436 if (!row
->reversed_p
)
14437 while (/* not marched to end of glyph row */
14439 /* glyph was not inserted by redisplay for internal purposes */
14440 && !INTEGERP (glyph
->object
))
14442 if (BUFFERP (glyph
->object
))
14444 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14446 if (glyph
->charpos
> bpos_max
)
14447 bpos_max
= glyph
->charpos
;
14448 if (glyph
->charpos
< bpos_min
)
14449 bpos_min
= glyph
->charpos
;
14450 if (!glyph
->avoid_cursor_p
)
14452 /* If we hit point, we've found the glyph on which to
14453 display the cursor. */
14456 match_with_avoid_cursor
= 0;
14459 /* See if we've found a better approximation to
14460 POS_BEFORE or to POS_AFTER. */
14461 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14463 pos_before
= glyph
->charpos
;
14464 glyph_before
= glyph
;
14466 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14468 pos_after
= glyph
->charpos
;
14469 glyph_after
= glyph
;
14472 else if (dpos
== 0)
14473 match_with_avoid_cursor
= 1;
14475 else if (STRINGP (glyph
->object
))
14477 Lisp_Object chprop
;
14478 ptrdiff_t glyph_pos
= glyph
->charpos
;
14480 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14482 if (!NILP (chprop
))
14484 /* If the string came from a `display' text property,
14485 look up the buffer position of that property and
14486 use that position to update bpos_max, as if we
14487 actually saw such a position in one of the row's
14488 glyphs. This helps with supporting integer values
14489 of `cursor' property on the display string in
14490 situations where most or all of the row's buffer
14491 text is completely covered by display properties,
14492 so that no glyph with valid buffer positions is
14493 ever seen in the row. */
14494 ptrdiff_t prop_pos
=
14495 string_buffer_position_lim (glyph
->object
, pos_before
,
14498 if (prop_pos
>= pos_before
)
14499 bpos_max
= prop_pos
;
14501 if (INTEGERP (chprop
))
14503 bpos_covered
= bpos_max
+ XINT (chprop
);
14504 /* If the `cursor' property covers buffer positions up
14505 to and including point, we should display cursor on
14506 this glyph. Note that, if a `cursor' property on one
14507 of the string's characters has an integer value, we
14508 will break out of the loop below _before_ we get to
14509 the position match above. IOW, integer values of
14510 the `cursor' property override the "exact match for
14511 point" strategy of positioning the cursor. */
14512 /* Implementation note: bpos_max == pt_old when, e.g.,
14513 we are in an empty line, where bpos_max is set to
14514 MATRIX_ROW_START_CHARPOS, see above. */
14515 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14524 x
+= glyph
->pixel_width
;
14527 else if (glyph
> end
) /* row is reversed */
14528 while (!INTEGERP (glyph
->object
))
14530 if (BUFFERP (glyph
->object
))
14532 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14534 if (glyph
->charpos
> bpos_max
)
14535 bpos_max
= glyph
->charpos
;
14536 if (glyph
->charpos
< bpos_min
)
14537 bpos_min
= glyph
->charpos
;
14538 if (!glyph
->avoid_cursor_p
)
14542 match_with_avoid_cursor
= 0;
14545 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14547 pos_before
= glyph
->charpos
;
14548 glyph_before
= glyph
;
14550 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14552 pos_after
= glyph
->charpos
;
14553 glyph_after
= glyph
;
14556 else if (dpos
== 0)
14557 match_with_avoid_cursor
= 1;
14559 else if (STRINGP (glyph
->object
))
14561 Lisp_Object chprop
;
14562 ptrdiff_t glyph_pos
= glyph
->charpos
;
14564 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14566 if (!NILP (chprop
))
14568 ptrdiff_t prop_pos
=
14569 string_buffer_position_lim (glyph
->object
, pos_before
,
14572 if (prop_pos
>= pos_before
)
14573 bpos_max
= prop_pos
;
14575 if (INTEGERP (chprop
))
14577 bpos_covered
= bpos_max
+ XINT (chprop
);
14578 /* If the `cursor' property covers buffer positions up
14579 to and including point, we should display cursor on
14581 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14590 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14592 x
--; /* can't use any pixel_width */
14595 x
-= glyph
->pixel_width
;
14598 /* Step 2: If we didn't find an exact match for point, we need to
14599 look for a proper place to put the cursor among glyphs between
14600 GLYPH_BEFORE and GLYPH_AFTER. */
14601 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14602 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14603 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14605 /* An empty line has a single glyph whose OBJECT is zero and
14606 whose CHARPOS is the position of a newline on that line.
14607 Note that on a TTY, there are more glyphs after that, which
14608 were produced by extend_face_to_end_of_line, but their
14609 CHARPOS is zero or negative. */
14611 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14612 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14613 /* On a TTY, continued and truncated rows also have a glyph at
14614 their end whose OBJECT is zero and whose CHARPOS is
14615 positive (the continuation and truncation glyphs), but such
14616 rows are obviously not "empty". */
14617 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14619 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14621 ptrdiff_t ellipsis_pos
;
14623 /* Scan back over the ellipsis glyphs. */
14624 if (!row
->reversed_p
)
14626 ellipsis_pos
= (glyph
- 1)->charpos
;
14627 while (glyph
> row
->glyphs
[TEXT_AREA
]
14628 && (glyph
- 1)->charpos
== ellipsis_pos
)
14629 glyph
--, x
-= glyph
->pixel_width
;
14630 /* That loop always goes one position too far, including
14631 the glyph before the ellipsis. So scan forward over
14633 x
+= glyph
->pixel_width
;
14636 else /* row is reversed */
14638 ellipsis_pos
= (glyph
+ 1)->charpos
;
14639 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14640 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14641 glyph
++, x
+= glyph
->pixel_width
;
14642 x
-= glyph
->pixel_width
;
14646 else if (match_with_avoid_cursor
)
14648 cursor
= glyph_after
;
14651 else if (string_seen
)
14653 int incr
= row
->reversed_p
? -1 : +1;
14655 /* Need to find the glyph that came out of a string which is
14656 present at point. That glyph is somewhere between
14657 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14658 positioned between POS_BEFORE and POS_AFTER in the
14660 struct glyph
*start
, *stop
;
14661 ptrdiff_t pos
= pos_before
;
14665 /* If the row ends in a newline from a display string,
14666 reordering could have moved the glyphs belonging to the
14667 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14668 in this case we extend the search to the last glyph in
14669 the row that was not inserted by redisplay. */
14670 if (row
->ends_in_newline_from_string_p
)
14673 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14676 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14677 correspond to POS_BEFORE and POS_AFTER, respectively. We
14678 need START and STOP in the order that corresponds to the
14679 row's direction as given by its reversed_p flag. If the
14680 directionality of characters between POS_BEFORE and
14681 POS_AFTER is the opposite of the row's base direction,
14682 these characters will have been reordered for display,
14683 and we need to reverse START and STOP. */
14684 if (!row
->reversed_p
)
14686 start
= min (glyph_before
, glyph_after
);
14687 stop
= max (glyph_before
, glyph_after
);
14691 start
= max (glyph_before
, glyph_after
);
14692 stop
= min (glyph_before
, glyph_after
);
14694 for (glyph
= start
+ incr
;
14695 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14698 /* Any glyphs that come from the buffer are here because
14699 of bidi reordering. Skip them, and only pay
14700 attention to glyphs that came from some string. */
14701 if (STRINGP (glyph
->object
))
14705 /* If the display property covers the newline, we
14706 need to search for it one position farther. */
14707 ptrdiff_t lim
= pos_after
14708 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14710 string_from_text_prop
= 0;
14711 str
= glyph
->object
;
14712 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14713 if (tem
== 0 /* from overlay */
14716 /* If the string from which this glyph came is
14717 found in the buffer at point, or at position
14718 that is closer to point than pos_after, then
14719 we've found the glyph we've been looking for.
14720 If it comes from an overlay (tem == 0), and
14721 it has the `cursor' property on one of its
14722 glyphs, record that glyph as a candidate for
14723 displaying the cursor. (As in the
14724 unidirectional version, we will display the
14725 cursor on the last candidate we find.) */
14728 || (tem
- pt_old
> 0 && tem
< pos_after
))
14730 /* The glyphs from this string could have
14731 been reordered. Find the one with the
14732 smallest string position. Or there could
14733 be a character in the string with the
14734 `cursor' property, which means display
14735 cursor on that character's glyph. */
14736 ptrdiff_t strpos
= glyph
->charpos
;
14741 string_from_text_prop
= 1;
14744 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14745 && EQ (glyph
->object
, str
);
14749 ptrdiff_t gpos
= glyph
->charpos
;
14751 cprop
= Fget_char_property (make_number (gpos
),
14759 if (tem
&& glyph
->charpos
< strpos
)
14761 strpos
= glyph
->charpos
;
14767 || (tem
- pt_old
> 0 && tem
< pos_after
))
14771 pos
= tem
+ 1; /* don't find previous instances */
14773 /* This string is not what we want; skip all of the
14774 glyphs that came from it. */
14775 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14776 && EQ (glyph
->object
, str
))
14783 /* If we reached the end of the line, and END was from a string,
14784 the cursor is not on this line. */
14786 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14787 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14788 && STRINGP (end
->object
)
14789 && row
->continued_p
)
14792 /* A truncated row may not include PT among its character positions.
14793 Setting the cursor inside the scroll margin will trigger
14794 recalculation of hscroll in hscroll_window_tree. But if a
14795 display string covers point, defer to the string-handling
14796 code below to figure this out. */
14797 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14799 cursor
= glyph_before
;
14802 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14803 /* Zero-width characters produce no glyphs. */
14805 && (row
->reversed_p
14806 ? glyph_after
> glyphs_end
14807 : glyph_after
< glyphs_end
)))
14809 cursor
= glyph_after
;
14815 if (cursor
!= NULL
)
14817 else if (glyph
== glyphs_end
14818 && pos_before
== pos_after
14819 && STRINGP ((row
->reversed_p
14820 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14821 : row
->glyphs
[TEXT_AREA
])->object
))
14823 /* If all the glyphs of this row came from strings, put the
14824 cursor on the first glyph of the row. This avoids having the
14825 cursor outside of the text area in this very rare and hard
14829 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14830 : row
->glyphs
[TEXT_AREA
];
14836 /* Need to compute x that corresponds to GLYPH. */
14837 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14839 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14841 x
+= g
->pixel_width
;
14845 /* ROW could be part of a continued line, which, under bidi
14846 reordering, might have other rows whose start and end charpos
14847 occlude point. Only set w->cursor if we found a better
14848 approximation to the cursor position than we have from previously
14849 examined candidate rows belonging to the same continued line. */
14850 if (/* We already have a candidate row. */
14851 w
->cursor
.vpos
>= 0
14852 /* That candidate is not the row we are processing. */
14853 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14854 /* Make sure cursor.vpos specifies a row whose start and end
14855 charpos occlude point, and it is valid candidate for being a
14856 cursor-row. This is because some callers of this function
14857 leave cursor.vpos at the row where the cursor was displayed
14858 during the last redisplay cycle. */
14859 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14860 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14861 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14864 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14866 /* Don't consider glyphs that are outside TEXT_AREA. */
14867 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14869 /* Keep the candidate whose buffer position is the closest to
14870 point or has the `cursor' property. */
14871 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14872 w
->cursor
.hpos
>= 0
14873 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14874 && ((BUFFERP (g1
->object
)
14875 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14876 || (BUFFERP (glyph
->object
)
14877 && eabs (g1
->charpos
- pt_old
)
14878 < eabs (glyph
->charpos
- pt_old
))))
14879 /* Previous candidate is a glyph from a string that has
14880 a non-nil `cursor' property. */
14881 || (STRINGP (g1
->object
)
14882 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14883 Qcursor
, g1
->object
))
14884 /* Previous candidate is from the same display
14885 string as this one, and the display string
14886 came from a text property. */
14887 || (EQ (g1
->object
, glyph
->object
)
14888 && string_from_text_prop
)
14889 /* this candidate is from newline and its
14890 position is not an exact match */
14891 || (INTEGERP (glyph
->object
)
14892 && glyph
->charpos
!= pt_old
)))))
14894 /* If this candidate gives an exact match, use that. */
14895 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14896 /* If this candidate is a glyph created for the
14897 terminating newline of a line, and point is on that
14898 newline, it wins because it's an exact match. */
14899 || (!row
->continued_p
14900 && INTEGERP (glyph
->object
)
14901 && glyph
->charpos
== 0
14902 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14903 /* Otherwise, keep the candidate that comes from a row
14904 spanning less buffer positions. This may win when one or
14905 both candidate positions are on glyphs that came from
14906 display strings, for which we cannot compare buffer
14908 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14909 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14910 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14913 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14915 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14916 w
->cursor
.y
= row
->y
+ dy
;
14918 if (w
== XWINDOW (selected_window
))
14920 if (!row
->continued_p
14921 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14924 this_line_buffer
= XBUFFER (w
->contents
);
14926 CHARPOS (this_line_start_pos
)
14927 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14928 BYTEPOS (this_line_start_pos
)
14929 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14931 CHARPOS (this_line_end_pos
)
14932 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14933 BYTEPOS (this_line_end_pos
)
14934 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14936 this_line_y
= w
->cursor
.y
;
14937 this_line_pixel_height
= row
->height
;
14938 this_line_vpos
= w
->cursor
.vpos
;
14939 this_line_start_x
= row
->x
;
14942 CHARPOS (this_line_start_pos
) = 0;
14949 /* Run window scroll functions, if any, for WINDOW with new window
14950 start STARTP. Sets the window start of WINDOW to that position.
14952 We assume that the window's buffer is really current. */
14954 static struct text_pos
14955 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14957 struct window
*w
= XWINDOW (window
);
14958 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14960 eassert (current_buffer
== XBUFFER (w
->contents
));
14962 if (!NILP (Vwindow_scroll_functions
))
14964 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14965 make_number (CHARPOS (startp
)));
14966 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14967 /* In case the hook functions switch buffers. */
14968 set_buffer_internal (XBUFFER (w
->contents
));
14975 /* Make sure the line containing the cursor is fully visible.
14976 A value of 1 means there is nothing to be done.
14977 (Either the line is fully visible, or it cannot be made so,
14978 or we cannot tell.)
14980 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14981 is higher than window.
14983 A value of 0 means the caller should do scrolling
14984 as if point had gone off the screen. */
14987 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14989 struct glyph_matrix
*matrix
;
14990 struct glyph_row
*row
;
14993 if (!make_cursor_line_fully_visible_p
)
14996 /* It's not always possible to find the cursor, e.g, when a window
14997 is full of overlay strings. Don't do anything in that case. */
14998 if (w
->cursor
.vpos
< 0)
15001 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15002 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15004 /* If the cursor row is not partially visible, there's nothing to do. */
15005 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15008 /* If the row the cursor is in is taller than the window's height,
15009 it's not clear what to do, so do nothing. */
15010 window_height
= window_box_height (w
);
15011 if (row
->height
>= window_height
)
15013 if (!force_p
|| MINI_WINDOW_P (w
)
15014 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15021 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15022 non-zero means only WINDOW is redisplayed in redisplay_internal.
15023 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15024 in redisplay_window to bring a partially visible line into view in
15025 the case that only the cursor has moved.
15027 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15028 last screen line's vertical height extends past the end of the screen.
15032 1 if scrolling succeeded
15034 0 if scrolling didn't find point.
15036 -1 if new fonts have been loaded so that we must interrupt
15037 redisplay, adjust glyph matrices, and try again. */
15043 SCROLLING_NEED_LARGER_MATRICES
15046 /* If scroll-conservatively is more than this, never recenter.
15048 If you change this, don't forget to update the doc string of
15049 `scroll-conservatively' and the Emacs manual. */
15050 #define SCROLL_LIMIT 100
15053 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15054 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15055 int temp_scroll_step
, int last_line_misfit
)
15057 struct window
*w
= XWINDOW (window
);
15058 struct frame
*f
= XFRAME (w
->frame
);
15059 struct text_pos pos
, startp
;
15061 int this_scroll_margin
, scroll_max
, rc
, height
;
15062 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15063 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15064 Lisp_Object aggressive
;
15065 /* We will never try scrolling more than this number of lines. */
15066 int scroll_limit
= SCROLL_LIMIT
;
15067 int frame_line_height
= default_line_pixel_height (w
);
15068 int window_total_lines
15069 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15072 debug_method_add (w
, "try_scrolling");
15075 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15077 /* Compute scroll margin height in pixels. We scroll when point is
15078 within this distance from the top or bottom of the window. */
15079 if (scroll_margin
> 0)
15080 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15081 * frame_line_height
;
15083 this_scroll_margin
= 0;
15085 /* Force arg_scroll_conservatively to have a reasonable value, to
15086 avoid scrolling too far away with slow move_it_* functions. Note
15087 that the user can supply scroll-conservatively equal to
15088 `most-positive-fixnum', which can be larger than INT_MAX. */
15089 if (arg_scroll_conservatively
> scroll_limit
)
15091 arg_scroll_conservatively
= scroll_limit
+ 1;
15092 scroll_max
= scroll_limit
* frame_line_height
;
15094 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15095 /* Compute how much we should try to scroll maximally to bring
15096 point into view. */
15097 scroll_max
= (max (scroll_step
,
15098 max (arg_scroll_conservatively
, temp_scroll_step
))
15099 * frame_line_height
);
15100 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15101 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15102 /* We're trying to scroll because of aggressive scrolling but no
15103 scroll_step is set. Choose an arbitrary one. */
15104 scroll_max
= 10 * frame_line_height
;
15110 /* Decide whether to scroll down. */
15111 if (PT
> CHARPOS (startp
))
15113 int scroll_margin_y
;
15115 /* Compute the pixel ypos of the scroll margin, then move IT to
15116 either that ypos or PT, whichever comes first. */
15117 start_display (&it
, w
, startp
);
15118 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15119 - frame_line_height
* extra_scroll_margin_lines
;
15120 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15121 (MOVE_TO_POS
| MOVE_TO_Y
));
15123 if (PT
> CHARPOS (it
.current
.pos
))
15125 int y0
= line_bottom_y (&it
);
15126 /* Compute how many pixels below window bottom to stop searching
15127 for PT. This avoids costly search for PT that is far away if
15128 the user limited scrolling by a small number of lines, but
15129 always finds PT if scroll_conservatively is set to a large
15130 number, such as most-positive-fixnum. */
15131 int slack
= max (scroll_max
, 10 * frame_line_height
);
15132 int y_to_move
= it
.last_visible_y
+ slack
;
15134 /* Compute the distance from the scroll margin to PT or to
15135 the scroll limit, whichever comes first. This should
15136 include the height of the cursor line, to make that line
15138 move_it_to (&it
, PT
, -1, y_to_move
,
15139 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15140 dy
= line_bottom_y (&it
) - y0
;
15142 if (dy
> scroll_max
)
15143 return SCROLLING_FAILED
;
15152 /* Point is in or below the bottom scroll margin, so move the
15153 window start down. If scrolling conservatively, move it just
15154 enough down to make point visible. If scroll_step is set,
15155 move it down by scroll_step. */
15156 if (arg_scroll_conservatively
)
15158 = min (max (dy
, frame_line_height
),
15159 frame_line_height
* arg_scroll_conservatively
);
15160 else if (scroll_step
|| temp_scroll_step
)
15161 amount_to_scroll
= scroll_max
;
15164 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15165 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15166 if (NUMBERP (aggressive
))
15168 double float_amount
= XFLOATINT (aggressive
) * height
;
15169 int aggressive_scroll
= float_amount
;
15170 if (aggressive_scroll
== 0 && float_amount
> 0)
15171 aggressive_scroll
= 1;
15172 /* Don't let point enter the scroll margin near top of
15173 the window. This could happen if the value of
15174 scroll_up_aggressively is too large and there are
15175 non-zero margins, because scroll_up_aggressively
15176 means put point that fraction of window height
15177 _from_the_bottom_margin_. */
15178 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15179 aggressive_scroll
= height
- 2*this_scroll_margin
;
15180 amount_to_scroll
= dy
+ aggressive_scroll
;
15184 if (amount_to_scroll
<= 0)
15185 return SCROLLING_FAILED
;
15187 start_display (&it
, w
, startp
);
15188 if (arg_scroll_conservatively
<= scroll_limit
)
15189 move_it_vertically (&it
, amount_to_scroll
);
15192 /* Extra precision for users who set scroll-conservatively
15193 to a large number: make sure the amount we scroll
15194 the window start is never less than amount_to_scroll,
15195 which was computed as distance from window bottom to
15196 point. This matters when lines at window top and lines
15197 below window bottom have different height. */
15199 void *it1data
= NULL
;
15200 /* We use a temporary it1 because line_bottom_y can modify
15201 its argument, if it moves one line down; see there. */
15204 SAVE_IT (it1
, it
, it1data
);
15205 start_y
= line_bottom_y (&it1
);
15207 RESTORE_IT (&it
, &it
, it1data
);
15208 move_it_by_lines (&it
, 1);
15209 SAVE_IT (it1
, it
, it1data
);
15210 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15213 /* If STARTP is unchanged, move it down another screen line. */
15214 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15215 move_it_by_lines (&it
, 1);
15216 startp
= it
.current
.pos
;
15220 struct text_pos scroll_margin_pos
= startp
;
15223 /* See if point is inside the scroll margin at the top of the
15225 if (this_scroll_margin
)
15229 start_display (&it
, w
, startp
);
15230 y_start
= it
.current_y
;
15231 move_it_vertically (&it
, this_scroll_margin
);
15232 scroll_margin_pos
= it
.current
.pos
;
15233 /* If we didn't move enough before hitting ZV, request
15234 additional amount of scroll, to move point out of the
15236 if (IT_CHARPOS (it
) == ZV
15237 && it
.current_y
- y_start
< this_scroll_margin
)
15238 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15241 if (PT
< CHARPOS (scroll_margin_pos
))
15243 /* Point is in the scroll margin at the top of the window or
15244 above what is displayed in the window. */
15247 /* Compute the vertical distance from PT to the scroll
15248 margin position. Move as far as scroll_max allows, or
15249 one screenful, or 10 screen lines, whichever is largest.
15250 Give up if distance is greater than scroll_max or if we
15251 didn't reach the scroll margin position. */
15252 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15253 start_display (&it
, w
, pos
);
15255 y_to_move
= max (it
.last_visible_y
,
15256 max (scroll_max
, 10 * frame_line_height
));
15257 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15259 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15260 dy
= it
.current_y
- y0
;
15261 if (dy
> scroll_max
15262 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15263 return SCROLLING_FAILED
;
15265 /* Additional scroll for when ZV was too close to point. */
15268 /* Compute new window start. */
15269 start_display (&it
, w
, startp
);
15271 if (arg_scroll_conservatively
)
15272 amount_to_scroll
= max (dy
, frame_line_height
*
15273 max (scroll_step
, temp_scroll_step
));
15274 else if (scroll_step
|| temp_scroll_step
)
15275 amount_to_scroll
= scroll_max
;
15278 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15279 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15280 if (NUMBERP (aggressive
))
15282 double float_amount
= XFLOATINT (aggressive
) * height
;
15283 int aggressive_scroll
= float_amount
;
15284 if (aggressive_scroll
== 0 && float_amount
> 0)
15285 aggressive_scroll
= 1;
15286 /* Don't let point enter the scroll margin near
15287 bottom of the window, if the value of
15288 scroll_down_aggressively happens to be too
15290 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15291 aggressive_scroll
= height
- 2*this_scroll_margin
;
15292 amount_to_scroll
= dy
+ aggressive_scroll
;
15296 if (amount_to_scroll
<= 0)
15297 return SCROLLING_FAILED
;
15299 move_it_vertically_backward (&it
, amount_to_scroll
);
15300 startp
= it
.current
.pos
;
15304 /* Run window scroll functions. */
15305 startp
= run_window_scroll_functions (window
, startp
);
15307 /* Display the window. Give up if new fonts are loaded, or if point
15309 if (!try_window (window
, startp
, 0))
15310 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15311 else if (w
->cursor
.vpos
< 0)
15313 clear_glyph_matrix (w
->desired_matrix
);
15314 rc
= SCROLLING_FAILED
;
15318 /* Maybe forget recorded base line for line number display. */
15319 if (!just_this_one_p
15320 || current_buffer
->clip_changed
15321 || BEG_UNCHANGED
< CHARPOS (startp
))
15322 w
->base_line_number
= 0;
15324 /* If cursor ends up on a partially visible line,
15325 treat that as being off the bottom of the screen. */
15326 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15327 /* It's possible that the cursor is on the first line of the
15328 buffer, which is partially obscured due to a vscroll
15329 (Bug#7537). In that case, avoid looping forever. */
15330 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15332 clear_glyph_matrix (w
->desired_matrix
);
15333 ++extra_scroll_margin_lines
;
15336 rc
= SCROLLING_SUCCESS
;
15343 /* Compute a suitable window start for window W if display of W starts
15344 on a continuation line. Value is non-zero if a new window start
15347 The new window start will be computed, based on W's width, starting
15348 from the start of the continued line. It is the start of the
15349 screen line with the minimum distance from the old start W->start. */
15352 compute_window_start_on_continuation_line (struct window
*w
)
15354 struct text_pos pos
, start_pos
;
15355 int window_start_changed_p
= 0;
15357 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15359 /* If window start is on a continuation line... Window start may be
15360 < BEGV in case there's invisible text at the start of the
15361 buffer (M-x rmail, for example). */
15362 if (CHARPOS (start_pos
) > BEGV
15363 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15366 struct glyph_row
*row
;
15368 /* Handle the case that the window start is out of range. */
15369 if (CHARPOS (start_pos
) < BEGV
)
15370 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15371 else if (CHARPOS (start_pos
) > ZV
)
15372 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15374 /* Find the start of the continued line. This should be fast
15375 because find_newline is fast (newline cache). */
15376 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15377 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15378 row
, DEFAULT_FACE_ID
);
15379 reseat_at_previous_visible_line_start (&it
);
15381 /* If the line start is "too far" away from the window start,
15382 say it takes too much time to compute a new window start. */
15383 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15384 /* PXW: Do we need upper bounds here? */
15385 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15387 int min_distance
, distance
;
15389 /* Move forward by display lines to find the new window
15390 start. If window width was enlarged, the new start can
15391 be expected to be > the old start. If window width was
15392 decreased, the new window start will be < the old start.
15393 So, we're looking for the display line start with the
15394 minimum distance from the old window start. */
15395 pos
= it
.current
.pos
;
15396 min_distance
= INFINITY
;
15397 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15398 distance
< min_distance
)
15400 min_distance
= distance
;
15401 pos
= it
.current
.pos
;
15402 if (it
.line_wrap
== WORD_WRAP
)
15404 /* Under WORD_WRAP, move_it_by_lines is likely to
15405 overshoot and stop not at the first, but the
15406 second character from the left margin. So in
15407 that case, we need a more tight control on the X
15408 coordinate of the iterator than move_it_by_lines
15409 promises in its contract. The method is to first
15410 go to the last (rightmost) visible character of a
15411 line, then move to the leftmost character on the
15412 next line in a separate call. */
15413 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15414 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15415 move_it_to (&it
, ZV
, 0,
15416 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15417 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15420 move_it_by_lines (&it
, 1);
15423 /* Set the window start there. */
15424 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15425 window_start_changed_p
= 1;
15429 return window_start_changed_p
;
15433 /* Try cursor movement in case text has not changed in window WINDOW,
15434 with window start STARTP. Value is
15436 CURSOR_MOVEMENT_SUCCESS if successful
15438 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15440 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15441 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15442 we want to scroll as if scroll-step were set to 1. See the code.
15444 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15445 which case we have to abort this redisplay, and adjust matrices
15450 CURSOR_MOVEMENT_SUCCESS
,
15451 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15452 CURSOR_MOVEMENT_MUST_SCROLL
,
15453 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15457 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15459 struct window
*w
= XWINDOW (window
);
15460 struct frame
*f
= XFRAME (w
->frame
);
15461 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15464 if (inhibit_try_cursor_movement
)
15468 /* Previously, there was a check for Lisp integer in the
15469 if-statement below. Now, this field is converted to
15470 ptrdiff_t, thus zero means invalid position in a buffer. */
15471 eassert (w
->last_point
> 0);
15472 /* Likewise there was a check whether window_end_vpos is nil or larger
15473 than the window. Now window_end_vpos is int and so never nil, but
15474 let's leave eassert to check whether it fits in the window. */
15475 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15477 /* Handle case where text has not changed, only point, and it has
15478 not moved off the frame. */
15479 if (/* Point may be in this window. */
15480 PT
>= CHARPOS (startp
)
15481 /* Selective display hasn't changed. */
15482 && !current_buffer
->clip_changed
15483 /* Function force-mode-line-update is used to force a thorough
15484 redisplay. It sets either windows_or_buffers_changed or
15485 update_mode_lines. So don't take a shortcut here for these
15487 && !update_mode_lines
15488 && !windows_or_buffers_changed
15489 && !f
->cursor_type_changed
15490 && NILP (Vshow_trailing_whitespace
)
15491 /* This code is not used for mini-buffer for the sake of the case
15492 of redisplaying to replace an echo area message; since in
15493 that case the mini-buffer contents per se are usually
15494 unchanged. This code is of no real use in the mini-buffer
15495 since the handling of this_line_start_pos, etc., in redisplay
15496 handles the same cases. */
15497 && !EQ (window
, minibuf_window
)
15498 && (FRAME_WINDOW_P (f
)
15499 || !overlay_arrow_in_current_buffer_p ()))
15501 int this_scroll_margin
, top_scroll_margin
;
15502 struct glyph_row
*row
= NULL
;
15503 int frame_line_height
= default_line_pixel_height (w
);
15504 int window_total_lines
15505 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15508 debug_method_add (w
, "cursor movement");
15511 /* Scroll if point within this distance from the top or bottom
15512 of the window. This is a pixel value. */
15513 if (scroll_margin
> 0)
15515 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15516 this_scroll_margin
*= frame_line_height
;
15519 this_scroll_margin
= 0;
15521 top_scroll_margin
= this_scroll_margin
;
15522 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15523 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15525 /* Start with the row the cursor was displayed during the last
15526 not paused redisplay. Give up if that row is not valid. */
15527 if (w
->last_cursor_vpos
< 0
15528 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15529 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15532 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15533 if (row
->mode_line_p
)
15535 if (!row
->enabled_p
)
15536 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15539 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15541 int scroll_p
= 0, must_scroll
= 0;
15542 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15544 if (PT
> w
->last_point
)
15546 /* Point has moved forward. */
15547 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15548 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15550 eassert (row
->enabled_p
);
15554 /* If the end position of a row equals the start
15555 position of the next row, and PT is at that position,
15556 we would rather display cursor in the next line. */
15557 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15558 && MATRIX_ROW_END_CHARPOS (row
) == PT
15559 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15560 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15561 && !cursor_row_p (row
))
15564 /* If within the scroll margin, scroll. Note that
15565 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15566 the next line would be drawn, and that
15567 this_scroll_margin can be zero. */
15568 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15569 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15570 /* Line is completely visible last line in window
15571 and PT is to be set in the next line. */
15572 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15573 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15574 && !row
->ends_at_zv_p
15575 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15578 else if (PT
< w
->last_point
)
15580 /* Cursor has to be moved backward. Note that PT >=
15581 CHARPOS (startp) because of the outer if-statement. */
15582 while (!row
->mode_line_p
15583 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15584 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15585 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15586 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15587 row
> w
->current_matrix
->rows
15588 && (row
-1)->ends_in_newline_from_string_p
))))
15589 && (row
->y
> top_scroll_margin
15590 || CHARPOS (startp
) == BEGV
))
15592 eassert (row
->enabled_p
);
15596 /* Consider the following case: Window starts at BEGV,
15597 there is invisible, intangible text at BEGV, so that
15598 display starts at some point START > BEGV. It can
15599 happen that we are called with PT somewhere between
15600 BEGV and START. Try to handle that case. */
15601 if (row
< w
->current_matrix
->rows
15602 || row
->mode_line_p
)
15604 row
= w
->current_matrix
->rows
;
15605 if (row
->mode_line_p
)
15609 /* Due to newlines in overlay strings, we may have to
15610 skip forward over overlay strings. */
15611 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15612 && MATRIX_ROW_END_CHARPOS (row
) == PT
15613 && !cursor_row_p (row
))
15616 /* If within the scroll margin, scroll. */
15617 if (row
->y
< top_scroll_margin
15618 && CHARPOS (startp
) != BEGV
)
15623 /* Cursor did not move. So don't scroll even if cursor line
15624 is partially visible, as it was so before. */
15625 rc
= CURSOR_MOVEMENT_SUCCESS
;
15628 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15629 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15631 /* if PT is not in the glyph row, give up. */
15632 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15635 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15636 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15638 struct glyph_row
*row1
;
15640 /* If rows are bidi-reordered and point moved, back up
15641 until we find a row that does not belong to a
15642 continuation line. This is because we must consider
15643 all rows of a continued line as candidates for the
15644 new cursor positioning, since row start and end
15645 positions change non-linearly with vertical position
15647 /* FIXME: Revisit this when glyph ``spilling'' in
15648 continuation lines' rows is implemented for
15649 bidi-reordered rows. */
15650 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15651 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15654 /* If we hit the beginning of the displayed portion
15655 without finding the first row of a continued
15659 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15662 eassert (row
->enabled_p
);
15667 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15668 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15669 /* Make sure this isn't a header line by any chance, since
15670 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15671 && !row
->mode_line_p
15672 && make_cursor_line_fully_visible_p
)
15674 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15675 && !row
->ends_at_zv_p
15676 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15677 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15678 else if (row
->height
> window_box_height (w
))
15680 /* If we end up in a partially visible line, let's
15681 make it fully visible, except when it's taller
15682 than the window, in which case we can't do much
15685 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15689 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15690 if (!cursor_row_fully_visible_p (w
, 0, 1))
15691 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15693 rc
= CURSOR_MOVEMENT_SUCCESS
;
15697 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15698 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15699 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15701 /* With bidi-reordered rows, there could be more than
15702 one candidate row whose start and end positions
15703 occlude point. We need to let set_cursor_from_row
15704 find the best candidate. */
15705 /* FIXME: Revisit this when glyph ``spilling'' in
15706 continuation lines' rows is implemented for
15707 bidi-reordered rows. */
15712 int at_zv_p
= 0, exact_match_p
= 0;
15714 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15715 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15716 && cursor_row_p (row
))
15717 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15719 /* As soon as we've found the exact match for point,
15720 or the first suitable row whose ends_at_zv_p flag
15721 is set, we are done. */
15724 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15725 w
->cursor
.vpos
)->ends_at_zv_p
;
15727 && w
->cursor
.hpos
>= 0
15728 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15731 struct glyph_row
*candidate
=
15732 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15734 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15735 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15738 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15739 || (INTEGERP (g
->object
)
15740 && (g
->charpos
== PT
15741 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15743 if (at_zv_p
|| exact_match_p
)
15745 rc
= CURSOR_MOVEMENT_SUCCESS
;
15749 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15753 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15754 || row
->continued_p
)
15755 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15756 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15757 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15758 /* If we didn't find any candidate rows, or exited the
15759 loop before all the candidates were examined, signal
15760 to the caller that this method failed. */
15761 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15763 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15764 && !row
->continued_p
))
15765 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15767 rc
= CURSOR_MOVEMENT_SUCCESS
;
15773 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15775 rc
= CURSOR_MOVEMENT_SUCCESS
;
15780 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15781 && MATRIX_ROW_START_CHARPOS (row
) == PT
15782 && cursor_row_p (row
));
15792 set_vertical_scroll_bar (struct window
*w
)
15794 ptrdiff_t start
, end
, whole
;
15796 /* Calculate the start and end positions for the current window.
15797 At some point, it would be nice to choose between scrollbars
15798 which reflect the whole buffer size, with special markers
15799 indicating narrowing, and scrollbars which reflect only the
15802 Note that mini-buffers sometimes aren't displaying any text. */
15803 if (!MINI_WINDOW_P (w
)
15804 || (w
== XWINDOW (minibuf_window
)
15805 && NILP (echo_area_buffer
[0])))
15807 struct buffer
*buf
= XBUFFER (w
->contents
);
15808 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15809 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15810 /* I don't think this is guaranteed to be right. For the
15811 moment, we'll pretend it is. */
15812 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15816 if (whole
< (end
- start
))
15817 whole
= end
- start
;
15820 start
= end
= whole
= 0;
15822 /* Indicate what this scroll bar ought to be displaying now. */
15823 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15824 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15825 (w
, end
- start
, whole
, start
);
15830 set_horizontal_scroll_bar (struct window
*w
)
15832 int start
, end
, whole
, portion
;
15834 if (!MINI_WINDOW_P (w
)
15835 || (w
== XWINDOW (minibuf_window
)
15836 && NILP (echo_area_buffer
[0])))
15838 struct buffer
*b
= XBUFFER (w
->contents
);
15839 struct buffer
*old_buffer
= NULL
;
15841 struct text_pos startp
;
15843 if (b
!= current_buffer
)
15845 old_buffer
= current_buffer
;
15846 set_buffer_internal (b
);
15849 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15850 start_display (&it
, w
, startp
);
15851 it
.last_visible_x
= INT_MAX
;
15852 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15853 MOVE_TO_X
| MOVE_TO_Y
);
15854 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15855 window_box_height (w), -1,
15856 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15858 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15859 end
= start
+ window_box_width (w
, TEXT_AREA
);
15860 portion
= end
- start
;
15861 /* After enlarging a horizontally scrolled window such that it
15862 gets at least as wide as the text it contains, make sure that
15863 the thumb doesn't fill the entire scroll bar so we can still
15864 drag it back to see the entire text. */
15865 whole
= max (whole
, end
);
15871 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15872 if (EQ (pdir
, Qright_to_left
))
15874 start
= whole
- end
;
15875 end
= start
+ portion
;
15880 set_buffer_internal (old_buffer
);
15883 start
= end
= whole
= portion
= 0;
15885 w
->hscroll_whole
= whole
;
15887 /* Indicate what this scroll bar ought to be displaying now. */
15888 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15889 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15890 (w
, portion
, whole
, start
);
15894 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15895 selected_window is redisplayed.
15897 We can return without actually redisplaying the window if fonts has been
15898 changed on window's frame. In that case, redisplay_internal will retry.
15900 As one of the important parts of redisplaying a window, we need to
15901 decide whether the previous window-start position (stored in the
15902 window's w->start marker position) is still valid, and if it isn't,
15903 recompute it. Some details about that:
15905 . The previous window-start could be in a continuation line, in
15906 which case we need to recompute it when the window width
15907 changes. See compute_window_start_on_continuation_line and its
15910 . The text that changed since last redisplay could include the
15911 previous window-start position. In that case, we try to salvage
15912 what we can from the current glyph matrix by calling
15913 try_scrolling, which see.
15915 . Some Emacs command could force us to use a specific window-start
15916 position by setting the window's force_start flag, or gently
15917 propose doing that by setting the window's optional_new_start
15918 flag. In these cases, we try using the specified start point if
15919 that succeeds (i.e. the window desired matrix is successfully
15920 recomputed, and point location is within the window). In case
15921 of optional_new_start, we first check if the specified start
15922 position is feasible, i.e. if it will allow point to be
15923 displayed in the window. If using the specified start point
15924 fails, e.g., if new fonts are needed to be loaded, we abort the
15925 redisplay cycle and leave it up to the next cycle to figure out
15928 . Note that the window's force_start flag is sometimes set by
15929 redisplay itself, when it decides that the previous window start
15930 point is fine and should be kept. Search for "goto force_start"
15931 below to see the details. Like the values of window-start
15932 specified outside of redisplay, these internally-deduced values
15933 are tested for feasibility, and ignored if found to be
15936 . Note that the function try_window, used to completely redisplay
15937 a window, accepts the window's start point as its argument.
15938 This is used several times in the redisplay code to control
15939 where the window start will be, according to user options such
15940 as scroll-conservatively, and also to ensure the screen line
15941 showing point will be fully (as opposed to partially) visible on
15945 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15947 struct window
*w
= XWINDOW (window
);
15948 struct frame
*f
= XFRAME (w
->frame
);
15949 struct buffer
*buffer
= XBUFFER (w
->contents
);
15950 struct buffer
*old
= current_buffer
;
15951 struct text_pos lpoint
, opoint
, startp
;
15952 int update_mode_line
;
15955 /* Record it now because it's overwritten. */
15956 bool current_matrix_up_to_date_p
= false;
15957 bool used_current_matrix_p
= false;
15958 /* This is less strict than current_matrix_up_to_date_p.
15959 It indicates that the buffer contents and narrowing are unchanged. */
15960 bool buffer_unchanged_p
= false;
15961 int temp_scroll_step
= 0;
15962 ptrdiff_t count
= SPECPDL_INDEX ();
15964 int centering_position
= -1;
15965 int last_line_misfit
= 0;
15966 ptrdiff_t beg_unchanged
, end_unchanged
;
15967 int frame_line_height
;
15969 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15973 *w
->desired_matrix
->method
= 0;
15976 if (!just_this_one_p
15977 && REDISPLAY_SOME_P ()
15980 && !buffer
->text
->redisplay
15981 && BUF_PT (buffer
) == w
->last_point
)
15984 /* Make sure that both W's markers are valid. */
15985 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15986 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15988 /* We come here again if we need to run window-text-change-functions
15991 reconsider_clip_changes (w
);
15992 frame_line_height
= default_line_pixel_height (w
);
15994 /* Has the mode line to be updated? */
15995 update_mode_line
= (w
->update_mode_line
15996 || update_mode_lines
15997 || buffer
->clip_changed
15998 || buffer
->prevent_redisplay_optimizations_p
);
16000 if (!just_this_one_p
)
16001 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16002 cleverly elsewhere. */
16003 w
->must_be_updated_p
= true;
16005 if (MINI_WINDOW_P (w
))
16007 if (w
== XWINDOW (echo_area_window
)
16008 && !NILP (echo_area_buffer
[0]))
16010 if (update_mode_line
)
16011 /* We may have to update a tty frame's menu bar or a
16012 tool-bar. Example `M-x C-h C-h C-g'. */
16013 goto finish_menu_bars
;
16015 /* We've already displayed the echo area glyphs in this window. */
16016 goto finish_scroll_bars
;
16018 else if ((w
!= XWINDOW (minibuf_window
)
16019 || minibuf_level
== 0)
16020 /* When buffer is nonempty, redisplay window normally. */
16021 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16022 /* Quail displays non-mini buffers in minibuffer window.
16023 In that case, redisplay the window normally. */
16024 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16026 /* W is a mini-buffer window, but it's not active, so clear
16028 int yb
= window_text_bottom_y (w
);
16029 struct glyph_row
*row
;
16032 for (y
= 0, row
= w
->desired_matrix
->rows
;
16034 y
+= row
->height
, ++row
)
16035 blank_row (w
, row
, y
);
16036 goto finish_scroll_bars
;
16039 clear_glyph_matrix (w
->desired_matrix
);
16042 /* Otherwise set up data on this window; select its buffer and point
16044 /* Really select the buffer, for the sake of buffer-local
16046 set_buffer_internal_1 (XBUFFER (w
->contents
));
16048 current_matrix_up_to_date_p
16049 = (w
->window_end_valid
16050 && !current_buffer
->clip_changed
16051 && !current_buffer
->prevent_redisplay_optimizations_p
16052 && !window_outdated (w
));
16054 /* Run the window-text-change-functions
16055 if it is possible that the text on the screen has changed
16056 (either due to modification of the text, or any other reason). */
16057 if (!current_matrix_up_to_date_p
16058 && !NILP (Vwindow_text_change_functions
))
16060 safe_run_hooks (Qwindow_text_change_functions
);
16064 beg_unchanged
= BEG_UNCHANGED
;
16065 end_unchanged
= END_UNCHANGED
;
16067 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16069 specbind (Qinhibit_point_motion_hooks
, Qt
);
16072 = (w
->window_end_valid
16073 && !current_buffer
->clip_changed
16074 && !window_outdated (w
));
16076 /* When windows_or_buffers_changed is non-zero, we can't rely
16077 on the window end being valid, so set it to zero there. */
16078 if (windows_or_buffers_changed
)
16080 /* If window starts on a continuation line, maybe adjust the
16081 window start in case the window's width changed. */
16082 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16083 compute_window_start_on_continuation_line (w
);
16085 w
->window_end_valid
= false;
16086 /* If so, we also can't rely on current matrix
16087 and should not fool try_cursor_movement below. */
16088 current_matrix_up_to_date_p
= false;
16091 /* Some sanity checks. */
16092 CHECK_WINDOW_END (w
);
16093 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16095 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16098 if (mode_line_update_needed (w
))
16099 update_mode_line
= 1;
16101 /* Point refers normally to the selected window. For any other
16102 window, set up appropriate value. */
16103 if (!EQ (window
, selected_window
))
16105 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16106 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16111 new_pt_byte
= BEGV_BYTE
;
16112 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16114 else if (new_pt
> (ZV
- 1))
16117 new_pt_byte
= ZV_BYTE
;
16118 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16121 /* We don't use SET_PT so that the point-motion hooks don't run. */
16122 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16125 /* If any of the character widths specified in the display table
16126 have changed, invalidate the width run cache. It's true that
16127 this may be a bit late to catch such changes, but the rest of
16128 redisplay goes (non-fatally) haywire when the display table is
16129 changed, so why should we worry about doing any better? */
16130 if (current_buffer
->width_run_cache
16131 || (current_buffer
->base_buffer
16132 && current_buffer
->base_buffer
->width_run_cache
))
16134 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16136 if (! disptab_matches_widthtab
16137 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16139 struct buffer
*buf
= current_buffer
;
16141 if (buf
->base_buffer
)
16142 buf
= buf
->base_buffer
;
16143 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16144 recompute_width_table (current_buffer
, disptab
);
16148 /* If window-start is screwed up, choose a new one. */
16149 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16152 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16154 /* If someone specified a new starting point but did not insist,
16155 check whether it can be used. */
16156 if (w
->optional_new_start
16157 && CHARPOS (startp
) >= BEGV
16158 && CHARPOS (startp
) <= ZV
)
16160 w
->optional_new_start
= 0;
16161 start_display (&it
, w
, startp
);
16162 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16163 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16164 if (IT_CHARPOS (it
) == PT
)
16165 w
->force_start
= 1;
16166 /* IT may overshoot PT if text at PT is invisible. */
16167 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16168 w
->force_start
= 1;
16173 /* Handle case where place to start displaying has been specified,
16174 unless the specified location is outside the accessible range. */
16175 if (w
->force_start
|| window_frozen_p (w
))
16177 /* We set this later on if we have to adjust point. */
16180 w
->force_start
= 0;
16182 w
->window_end_valid
= 0;
16184 /* Forget any recorded base line for line number display. */
16185 if (!buffer_unchanged_p
)
16186 w
->base_line_number
= 0;
16188 /* Redisplay the mode line. Select the buffer properly for that.
16189 Also, run the hook window-scroll-functions
16190 because we have scrolled. */
16191 /* Note, we do this after clearing force_start because
16192 if there's an error, it is better to forget about force_start
16193 than to get into an infinite loop calling the hook functions
16194 and having them get more errors. */
16195 if (!update_mode_line
16196 || ! NILP (Vwindow_scroll_functions
))
16198 update_mode_line
= 1;
16199 w
->update_mode_line
= 1;
16200 startp
= run_window_scroll_functions (window
, startp
);
16203 if (CHARPOS (startp
) < BEGV
)
16204 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16205 else if (CHARPOS (startp
) > ZV
)
16206 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16208 /* Redisplay, then check if cursor has been set during the
16209 redisplay. Give up if new fonts were loaded. */
16210 /* We used to issue a CHECK_MARGINS argument to try_window here,
16211 but this causes scrolling to fail when point begins inside
16212 the scroll margin (bug#148) -- cyd */
16213 if (!try_window (window
, startp
, 0))
16215 w
->force_start
= 1;
16216 clear_glyph_matrix (w
->desired_matrix
);
16217 goto need_larger_matrices
;
16220 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16222 /* If point does not appear, try to move point so it does
16223 appear. The desired matrix has been built above, so we
16224 can use it here. */
16225 new_vpos
= window_box_height (w
) / 2;
16228 if (!cursor_row_fully_visible_p (w
, 0, 0))
16230 /* Point does appear, but on a line partly visible at end of window.
16231 Move it back to a fully-visible line. */
16232 new_vpos
= window_box_height (w
);
16233 /* But if window_box_height suggests a Y coordinate that is
16234 not less than we already have, that line will clearly not
16235 be fully visible, so give up and scroll the display.
16236 This can happen when the default face uses a font whose
16237 dimensions are different from the frame's default
16239 if (new_vpos
>= w
->cursor
.y
)
16241 w
->cursor
.vpos
= -1;
16242 clear_glyph_matrix (w
->desired_matrix
);
16243 goto try_to_scroll
;
16246 else if (w
->cursor
.vpos
>= 0)
16248 /* Some people insist on not letting point enter the scroll
16249 margin, even though this part handles windows that didn't
16251 int window_total_lines
16252 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16253 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16254 int pixel_margin
= margin
* frame_line_height
;
16255 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16257 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16258 below, which finds the row to move point to, advances by
16259 the Y coordinate of the _next_ row, see the definition of
16260 MATRIX_ROW_BOTTOM_Y. */
16261 if (w
->cursor
.vpos
< margin
+ header_line
)
16263 w
->cursor
.vpos
= -1;
16264 clear_glyph_matrix (w
->desired_matrix
);
16265 goto try_to_scroll
;
16269 int window_height
= window_box_height (w
);
16272 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16273 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16275 w
->cursor
.vpos
= -1;
16276 clear_glyph_matrix (w
->desired_matrix
);
16277 goto try_to_scroll
;
16282 /* If we need to move point for either of the above reasons,
16283 now actually do it. */
16286 struct glyph_row
*row
;
16288 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16289 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16292 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16293 MATRIX_ROW_START_BYTEPOS (row
));
16295 if (w
!= XWINDOW (selected_window
))
16296 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16297 else if (current_buffer
== old
)
16298 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16300 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16302 /* If we are highlighting the region, then we just changed
16303 the region, so redisplay to show it. */
16304 /* FIXME: We need to (re)run pre-redisplay-function! */
16305 /* if (markpos_of_region () >= 0)
16307 clear_glyph_matrix (w->desired_matrix);
16308 if (!try_window (window, startp, 0))
16309 goto need_larger_matrices;
16315 debug_method_add (w
, "forced window start");
16320 /* Handle case where text has not changed, only point, and it has
16321 not moved off the frame, and we are not retrying after hscroll.
16322 (current_matrix_up_to_date_p is nonzero when retrying.) */
16323 if (current_matrix_up_to_date_p
16324 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16325 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16329 case CURSOR_MOVEMENT_SUCCESS
:
16330 used_current_matrix_p
= 1;
16333 case CURSOR_MOVEMENT_MUST_SCROLL
:
16334 goto try_to_scroll
;
16340 /* If current starting point was originally the beginning of a line
16341 but no longer is, find a new starting point. */
16342 else if (w
->start_at_line_beg
16343 && !(CHARPOS (startp
) <= BEGV
16344 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16347 debug_method_add (w
, "recenter 1");
16352 /* Try scrolling with try_window_id. Value is > 0 if update has
16353 been done, it is -1 if we know that the same window start will
16354 not work. It is 0 if unsuccessful for some other reason. */
16355 else if ((tem
= try_window_id (w
)) != 0)
16358 debug_method_add (w
, "try_window_id %d", tem
);
16361 if (f
->fonts_changed
)
16362 goto need_larger_matrices
;
16366 /* Otherwise try_window_id has returned -1 which means that we
16367 don't want the alternative below this comment to execute. */
16369 else if (CHARPOS (startp
) >= BEGV
16370 && CHARPOS (startp
) <= ZV
16371 && PT
>= CHARPOS (startp
)
16372 && (CHARPOS (startp
) < ZV
16373 /* Avoid starting at end of buffer. */
16374 || CHARPOS (startp
) == BEGV
16375 || !window_outdated (w
)))
16377 int d1
, d2
, d3
, d4
, d5
, d6
;
16379 /* If first window line is a continuation line, and window start
16380 is inside the modified region, but the first change is before
16381 current window start, we must select a new window start.
16383 However, if this is the result of a down-mouse event (e.g. by
16384 extending the mouse-drag-overlay), we don't want to select a
16385 new window start, since that would change the position under
16386 the mouse, resulting in an unwanted mouse-movement rather
16387 than a simple mouse-click. */
16388 if (!w
->start_at_line_beg
16389 && NILP (do_mouse_tracking
)
16390 && CHARPOS (startp
) > BEGV
16391 && CHARPOS (startp
) > BEG
+ beg_unchanged
16392 && CHARPOS (startp
) <= Z
- end_unchanged
16393 /* Even if w->start_at_line_beg is nil, a new window may
16394 start at a line_beg, since that's how set_buffer_window
16395 sets it. So, we need to check the return value of
16396 compute_window_start_on_continuation_line. (See also
16398 && XMARKER (w
->start
)->buffer
== current_buffer
16399 && compute_window_start_on_continuation_line (w
)
16400 /* It doesn't make sense to force the window start like we
16401 do at label force_start if it is already known that point
16402 will not be visible in the resulting window, because
16403 doing so will move point from its correct position
16404 instead of scrolling the window to bring point into view.
16406 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16408 w
->force_start
= 1;
16409 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16414 debug_method_add (w
, "same window start");
16417 /* Try to redisplay starting at same place as before.
16418 If point has not moved off frame, accept the results. */
16419 if (!current_matrix_up_to_date_p
16420 /* Don't use try_window_reusing_current_matrix in this case
16421 because a window scroll function can have changed the
16423 || !NILP (Vwindow_scroll_functions
)
16424 || MINI_WINDOW_P (w
)
16425 || !(used_current_matrix_p
16426 = try_window_reusing_current_matrix (w
)))
16428 IF_DEBUG (debug_method_add (w
, "1"));
16429 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16430 /* -1 means we need to scroll.
16431 0 means we need new matrices, but fonts_changed
16432 is set in that case, so we will detect it below. */
16433 goto try_to_scroll
;
16436 if (f
->fonts_changed
)
16437 goto need_larger_matrices
;
16439 if (w
->cursor
.vpos
>= 0)
16441 if (!just_this_one_p
16442 || current_buffer
->clip_changed
16443 || BEG_UNCHANGED
< CHARPOS (startp
))
16444 /* Forget any recorded base line for line number display. */
16445 w
->base_line_number
= 0;
16447 if (!cursor_row_fully_visible_p (w
, 1, 0))
16449 clear_glyph_matrix (w
->desired_matrix
);
16450 last_line_misfit
= 1;
16452 /* Drop through and scroll. */
16457 clear_glyph_matrix (w
->desired_matrix
);
16462 /* Redisplay the mode line. Select the buffer properly for that. */
16463 if (!update_mode_line
)
16465 update_mode_line
= 1;
16466 w
->update_mode_line
= 1;
16469 /* Try to scroll by specified few lines. */
16470 if ((scroll_conservatively
16471 || emacs_scroll_step
16472 || temp_scroll_step
16473 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16474 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16475 && CHARPOS (startp
) >= BEGV
16476 && CHARPOS (startp
) <= ZV
)
16478 /* The function returns -1 if new fonts were loaded, 1 if
16479 successful, 0 if not successful. */
16480 int ss
= try_scrolling (window
, just_this_one_p
,
16481 scroll_conservatively
,
16483 temp_scroll_step
, last_line_misfit
);
16486 case SCROLLING_SUCCESS
:
16489 case SCROLLING_NEED_LARGER_MATRICES
:
16490 goto need_larger_matrices
;
16492 case SCROLLING_FAILED
:
16500 /* Finally, just choose a place to start which positions point
16501 according to user preferences. */
16506 debug_method_add (w
, "recenter");
16509 /* Forget any previously recorded base line for line number display. */
16510 if (!buffer_unchanged_p
)
16511 w
->base_line_number
= 0;
16513 /* Determine the window start relative to point. */
16514 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16515 it
.current_y
= it
.last_visible_y
;
16516 if (centering_position
< 0)
16518 int window_total_lines
16519 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16522 ? min (scroll_margin
, window_total_lines
/ 4)
16524 ptrdiff_t margin_pos
= CHARPOS (startp
);
16525 Lisp_Object aggressive
;
16528 /* If there is a scroll margin at the top of the window, find
16529 its character position. */
16531 /* Cannot call start_display if startp is not in the
16532 accessible region of the buffer. This can happen when we
16533 have just switched to a different buffer and/or changed
16534 its restriction. In that case, startp is initialized to
16535 the character position 1 (BEGV) because we did not yet
16536 have chance to display the buffer even once. */
16537 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16540 void *it1data
= NULL
;
16542 SAVE_IT (it1
, it
, it1data
);
16543 start_display (&it1
, w
, startp
);
16544 move_it_vertically (&it1
, margin
* frame_line_height
);
16545 margin_pos
= IT_CHARPOS (it1
);
16546 RESTORE_IT (&it
, &it
, it1data
);
16548 scrolling_up
= PT
> margin_pos
;
16551 ? BVAR (current_buffer
, scroll_up_aggressively
)
16552 : BVAR (current_buffer
, scroll_down_aggressively
);
16554 if (!MINI_WINDOW_P (w
)
16555 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16559 /* Setting scroll-conservatively overrides
16560 scroll-*-aggressively. */
16561 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16563 double float_amount
= XFLOATINT (aggressive
);
16565 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16566 if (pt_offset
== 0 && float_amount
> 0)
16568 if (pt_offset
&& margin
> 0)
16571 /* Compute how much to move the window start backward from
16572 point so that point will be displayed where the user
16576 centering_position
= it
.last_visible_y
;
16578 centering_position
-= pt_offset
;
16579 centering_position
-=
16580 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16581 + WINDOW_HEADER_LINE_HEIGHT (w
);
16582 /* Don't let point enter the scroll margin near top of
16584 if (centering_position
< margin
* frame_line_height
)
16585 centering_position
= margin
* frame_line_height
;
16588 centering_position
= margin
* frame_line_height
+ pt_offset
;
16591 /* Set the window start half the height of the window backward
16593 centering_position
= window_box_height (w
) / 2;
16595 move_it_vertically_backward (&it
, centering_position
);
16597 eassert (IT_CHARPOS (it
) >= BEGV
);
16599 /* The function move_it_vertically_backward may move over more
16600 than the specified y-distance. If it->w is small, e.g. a
16601 mini-buffer window, we may end up in front of the window's
16602 display area. Start displaying at the start of the line
16603 containing PT in this case. */
16604 if (it
.current_y
<= 0)
16606 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16607 move_it_vertically_backward (&it
, 0);
16611 it
.current_x
= it
.hpos
= 0;
16613 /* Set the window start position here explicitly, to avoid an
16614 infinite loop in case the functions in window-scroll-functions
16616 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16618 /* Run scroll hooks. */
16619 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16621 /* Redisplay the window. */
16622 if (!current_matrix_up_to_date_p
16623 || windows_or_buffers_changed
16624 || f
->cursor_type_changed
16625 /* Don't use try_window_reusing_current_matrix in this case
16626 because it can have changed the buffer. */
16627 || !NILP (Vwindow_scroll_functions
)
16628 || !just_this_one_p
16629 || MINI_WINDOW_P (w
)
16630 || !(used_current_matrix_p
16631 = try_window_reusing_current_matrix (w
)))
16632 try_window (window
, startp
, 0);
16634 /* If new fonts have been loaded (due to fontsets), give up. We
16635 have to start a new redisplay since we need to re-adjust glyph
16637 if (f
->fonts_changed
)
16638 goto need_larger_matrices
;
16640 /* If cursor did not appear assume that the middle of the window is
16641 in the first line of the window. Do it again with the next line.
16642 (Imagine a window of height 100, displaying two lines of height
16643 60. Moving back 50 from it->last_visible_y will end in the first
16645 if (w
->cursor
.vpos
< 0)
16647 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16649 clear_glyph_matrix (w
->desired_matrix
);
16650 move_it_by_lines (&it
, 1);
16651 try_window (window
, it
.current
.pos
, 0);
16653 else if (PT
< IT_CHARPOS (it
))
16655 clear_glyph_matrix (w
->desired_matrix
);
16656 move_it_by_lines (&it
, -1);
16657 try_window (window
, it
.current
.pos
, 0);
16661 /* Not much we can do about it. */
16665 /* Consider the following case: Window starts at BEGV, there is
16666 invisible, intangible text at BEGV, so that display starts at
16667 some point START > BEGV. It can happen that we are called with
16668 PT somewhere between BEGV and START. Try to handle that case,
16669 and similar ones. */
16670 if (w
->cursor
.vpos
< 0)
16672 /* First, try locating the proper glyph row for PT. */
16673 struct glyph_row
*row
=
16674 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16676 /* Sometimes point is at the beginning of invisible text that is
16677 before the 1st character displayed in the row. In that case,
16678 row_containing_pos fails to find the row, because no glyphs
16679 with appropriate buffer positions are present in the row.
16680 Therefore, we next try to find the row which shows the 1st
16681 position after the invisible text. */
16685 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16688 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16691 Lisp_Object invis_end
=
16692 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16695 if (NATNUMP (invis_end
))
16696 alt_pos
= XFASTINT (invis_end
);
16699 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16703 /* Finally, fall back on the first row of the window after the
16704 header line (if any). This is slightly better than not
16705 displaying the cursor at all. */
16708 row
= w
->current_matrix
->rows
;
16709 if (row
->mode_line_p
)
16712 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16715 if (!cursor_row_fully_visible_p (w
, 0, 0))
16717 /* If vscroll is enabled, disable it and try again. */
16721 clear_glyph_matrix (w
->desired_matrix
);
16725 /* Users who set scroll-conservatively to a large number want
16726 point just above/below the scroll margin. If we ended up
16727 with point's row partially visible, move the window start to
16728 make that row fully visible and out of the margin. */
16729 if (scroll_conservatively
> SCROLL_LIMIT
)
16731 int window_total_lines
16732 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16735 ? min (scroll_margin
, window_total_lines
/ 4)
16737 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16739 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16740 clear_glyph_matrix (w
->desired_matrix
);
16741 if (1 == try_window (window
, it
.current
.pos
,
16742 TRY_WINDOW_CHECK_MARGINS
))
16746 /* If centering point failed to make the whole line visible,
16747 put point at the top instead. That has to make the whole line
16748 visible, if it can be done. */
16749 if (centering_position
== 0)
16752 clear_glyph_matrix (w
->desired_matrix
);
16753 centering_position
= 0;
16759 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16760 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16761 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16763 /* Display the mode line, if we must. */
16764 if ((update_mode_line
16765 /* If window not full width, must redo its mode line
16766 if (a) the window to its side is being redone and
16767 (b) we do a frame-based redisplay. This is a consequence
16768 of how inverted lines are drawn in frame-based redisplay. */
16769 || (!just_this_one_p
16770 && !FRAME_WINDOW_P (f
)
16771 && !WINDOW_FULL_WIDTH_P (w
))
16772 /* Line number to display. */
16773 || w
->base_line_pos
> 0
16774 /* Column number is displayed and different from the one displayed. */
16775 || (w
->column_number_displayed
!= -1
16776 && (w
->column_number_displayed
!= current_column ())))
16777 /* This means that the window has a mode line. */
16778 && (WINDOW_WANTS_MODELINE_P (w
)
16779 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16782 display_mode_lines (w
);
16784 /* If mode line height has changed, arrange for a thorough
16785 immediate redisplay using the correct mode line height. */
16786 if (WINDOW_WANTS_MODELINE_P (w
)
16787 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16789 f
->fonts_changed
= 1;
16790 w
->mode_line_height
= -1;
16791 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16792 = DESIRED_MODE_LINE_HEIGHT (w
);
16795 /* If header line height has changed, arrange for a thorough
16796 immediate redisplay using the correct header line height. */
16797 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16798 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16800 f
->fonts_changed
= 1;
16801 w
->header_line_height
= -1;
16802 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16803 = DESIRED_HEADER_LINE_HEIGHT (w
);
16806 if (f
->fonts_changed
)
16807 goto need_larger_matrices
;
16810 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16812 w
->base_line_pos
= 0;
16813 w
->base_line_number
= 0;
16818 /* When we reach a frame's selected window, redo the frame's menu bar. */
16819 if (update_mode_line
16820 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16822 int redisplay_menu_p
= 0;
16824 if (FRAME_WINDOW_P (f
))
16826 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16827 || defined (HAVE_NS) || defined (USE_GTK)
16828 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16830 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16834 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16836 if (redisplay_menu_p
)
16837 display_menu_bar (w
);
16839 #ifdef HAVE_WINDOW_SYSTEM
16840 if (FRAME_WINDOW_P (f
))
16842 #if defined (USE_GTK) || defined (HAVE_NS)
16843 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16844 redisplay_tool_bar (f
);
16846 if (WINDOWP (f
->tool_bar_window
)
16847 && (FRAME_TOOL_BAR_LINES (f
) > 0
16848 || !NILP (Vauto_resize_tool_bars
))
16849 && redisplay_tool_bar (f
))
16850 ignore_mouse_drag_p
= 1;
16856 #ifdef HAVE_WINDOW_SYSTEM
16857 if (FRAME_WINDOW_P (f
)
16858 && update_window_fringes (w
, (just_this_one_p
16859 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16860 || w
->pseudo_window_p
)))
16864 if (draw_window_fringes (w
, 1))
16866 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16867 x_draw_right_divider (w
);
16869 x_draw_vertical_border (w
);
16875 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16876 x_draw_bottom_divider (w
);
16877 #endif /* HAVE_WINDOW_SYSTEM */
16879 /* We go to this label, with fonts_changed set, if it is
16880 necessary to try again using larger glyph matrices.
16881 We have to redeem the scroll bar even in this case,
16882 because the loop in redisplay_internal expects that. */
16883 need_larger_matrices
:
16885 finish_scroll_bars
:
16887 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16889 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16890 /* Set the thumb's position and size. */
16891 set_vertical_scroll_bar (w
);
16893 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16894 /* Set the thumb's position and size. */
16895 set_horizontal_scroll_bar (w
);
16897 /* Note that we actually used the scroll bar attached to this
16898 window, so it shouldn't be deleted at the end of redisplay. */
16899 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16900 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16903 /* Restore current_buffer and value of point in it. The window
16904 update may have changed the buffer, so first make sure `opoint'
16905 is still valid (Bug#6177). */
16906 if (CHARPOS (opoint
) < BEGV
)
16907 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16908 else if (CHARPOS (opoint
) > ZV
)
16909 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16911 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16913 set_buffer_internal_1 (old
);
16914 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16915 shorter. This can be caused by log truncation in *Messages*. */
16916 if (CHARPOS (lpoint
) <= ZV
)
16917 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16919 unbind_to (count
, Qnil
);
16923 /* Build the complete desired matrix of WINDOW with a window start
16924 buffer position POS.
16926 Value is 1 if successful. It is zero if fonts were loaded during
16927 redisplay which makes re-adjusting glyph matrices necessary, and -1
16928 if point would appear in the scroll margins.
16929 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16930 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16934 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16936 struct window
*w
= XWINDOW (window
);
16938 struct glyph_row
*last_text_row
= NULL
;
16939 struct frame
*f
= XFRAME (w
->frame
);
16940 int frame_line_height
= default_line_pixel_height (w
);
16942 /* Make POS the new window start. */
16943 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16945 /* Mark cursor position as unknown. No overlay arrow seen. */
16946 w
->cursor
.vpos
= -1;
16947 overlay_arrow_seen
= 0;
16949 /* Initialize iterator and info to start at POS. */
16950 start_display (&it
, w
, pos
);
16951 it
.glyph_row
->reversed_p
= false;
16953 /* Display all lines of W. */
16954 while (it
.current_y
< it
.last_visible_y
)
16956 if (display_line (&it
))
16957 last_text_row
= it
.glyph_row
- 1;
16958 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16962 /* Don't let the cursor end in the scroll margins. */
16963 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16964 && !MINI_WINDOW_P (w
))
16966 int this_scroll_margin
;
16967 int window_total_lines
16968 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16970 if (scroll_margin
> 0)
16972 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16973 this_scroll_margin
*= frame_line_height
;
16976 this_scroll_margin
= 0;
16978 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16979 && w
->cursor
.y
< this_scroll_margin
16980 && CHARPOS (pos
) > BEGV
16981 && IT_CHARPOS (it
) < ZV
)
16982 /* rms: considering make_cursor_line_fully_visible_p here
16983 seems to give wrong results. We don't want to recenter
16984 when the last line is partly visible, we want to allow
16985 that case to be handled in the usual way. */
16986 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16988 w
->cursor
.vpos
= -1;
16989 clear_glyph_matrix (w
->desired_matrix
);
16994 /* If bottom moved off end of frame, change mode line percentage. */
16995 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16996 w
->update_mode_line
= 1;
16998 /* Set window_end_pos to the offset of the last character displayed
16999 on the window from the end of current_buffer. Set
17000 window_end_vpos to its row number. */
17003 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17004 adjust_window_ends (w
, last_text_row
, 0);
17006 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17007 w
->window_end_vpos
)));
17011 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17012 w
->window_end_pos
= Z
- ZV
;
17013 w
->window_end_vpos
= 0;
17016 /* But that is not valid info until redisplay finishes. */
17017 w
->window_end_valid
= 0;
17023 /************************************************************************
17024 Window redisplay reusing current matrix when buffer has not changed
17025 ************************************************************************/
17027 /* Try redisplay of window W showing an unchanged buffer with a
17028 different window start than the last time it was displayed by
17029 reusing its current matrix. Value is non-zero if successful.
17030 W->start is the new window start. */
17033 try_window_reusing_current_matrix (struct window
*w
)
17035 struct frame
*f
= XFRAME (w
->frame
);
17036 struct glyph_row
*bottom_row
;
17039 struct text_pos start
, new_start
;
17040 int nrows_scrolled
, i
;
17041 struct glyph_row
*last_text_row
;
17042 struct glyph_row
*last_reused_text_row
;
17043 struct glyph_row
*start_row
;
17044 int start_vpos
, min_y
, max_y
;
17047 if (inhibit_try_window_reusing
)
17051 if (/* This function doesn't handle terminal frames. */
17052 !FRAME_WINDOW_P (f
)
17053 /* Don't try to reuse the display if windows have been split
17055 || windows_or_buffers_changed
17056 || f
->cursor_type_changed
)
17059 /* Can't do this if showing trailing whitespace. */
17060 if (!NILP (Vshow_trailing_whitespace
))
17063 /* If top-line visibility has changed, give up. */
17064 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17065 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17068 /* Give up if old or new display is scrolled vertically. We could
17069 make this function handle this, but right now it doesn't. */
17070 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17071 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17074 /* The variable new_start now holds the new window start. The old
17075 start `start' can be determined from the current matrix. */
17076 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17077 start
= start_row
->minpos
;
17078 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17080 /* Clear the desired matrix for the display below. */
17081 clear_glyph_matrix (w
->desired_matrix
);
17083 if (CHARPOS (new_start
) <= CHARPOS (start
))
17085 /* Don't use this method if the display starts with an ellipsis
17086 displayed for invisible text. It's not easy to handle that case
17087 below, and it's certainly not worth the effort since this is
17088 not a frequent case. */
17089 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17092 IF_DEBUG (debug_method_add (w
, "twu1"));
17094 /* Display up to a row that can be reused. The variable
17095 last_text_row is set to the last row displayed that displays
17096 text. Note that it.vpos == 0 if or if not there is a
17097 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17098 start_display (&it
, w
, new_start
);
17099 w
->cursor
.vpos
= -1;
17100 last_text_row
= last_reused_text_row
= NULL
;
17102 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17104 /* If we have reached into the characters in the START row,
17105 that means the line boundaries have changed. So we
17106 can't start copying with the row START. Maybe it will
17107 work to start copying with the following row. */
17108 while (IT_CHARPOS (it
) > CHARPOS (start
))
17110 /* Advance to the next row as the "start". */
17112 start
= start_row
->minpos
;
17113 /* If there are no more rows to try, or just one, give up. */
17114 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17115 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17116 || CHARPOS (start
) == ZV
)
17118 clear_glyph_matrix (w
->desired_matrix
);
17122 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17124 /* If we have reached alignment, we can copy the rest of the
17126 if (IT_CHARPOS (it
) == CHARPOS (start
)
17127 /* Don't accept "alignment" inside a display vector,
17128 since start_row could have started in the middle of
17129 that same display vector (thus their character
17130 positions match), and we have no way of telling if
17131 that is the case. */
17132 && it
.current
.dpvec_index
< 0)
17135 it
.glyph_row
->reversed_p
= false;
17136 if (display_line (&it
))
17137 last_text_row
= it
.glyph_row
- 1;
17141 /* A value of current_y < last_visible_y means that we stopped
17142 at the previous window start, which in turn means that we
17143 have at least one reusable row. */
17144 if (it
.current_y
< it
.last_visible_y
)
17146 struct glyph_row
*row
;
17148 /* IT.vpos always starts from 0; it counts text lines. */
17149 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17151 /* Find PT if not already found in the lines displayed. */
17152 if (w
->cursor
.vpos
< 0)
17154 int dy
= it
.current_y
- start_row
->y
;
17156 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17157 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17159 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17160 dy
, nrows_scrolled
);
17163 clear_glyph_matrix (w
->desired_matrix
);
17168 /* Scroll the display. Do it before the current matrix is
17169 changed. The problem here is that update has not yet
17170 run, i.e. part of the current matrix is not up to date.
17171 scroll_run_hook will clear the cursor, and use the
17172 current matrix to get the height of the row the cursor is
17174 run
.current_y
= start_row
->y
;
17175 run
.desired_y
= it
.current_y
;
17176 run
.height
= it
.last_visible_y
- it
.current_y
;
17178 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17181 FRAME_RIF (f
)->update_window_begin_hook (w
);
17182 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17183 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17184 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17188 /* Shift current matrix down by nrows_scrolled lines. */
17189 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17190 rotate_matrix (w
->current_matrix
,
17192 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17195 /* Disable lines that must be updated. */
17196 for (i
= 0; i
< nrows_scrolled
; ++i
)
17197 (start_row
+ i
)->enabled_p
= false;
17199 /* Re-compute Y positions. */
17200 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17201 max_y
= it
.last_visible_y
;
17202 for (row
= start_row
+ nrows_scrolled
;
17206 row
->y
= it
.current_y
;
17207 row
->visible_height
= row
->height
;
17209 if (row
->y
< min_y
)
17210 row
->visible_height
-= min_y
- row
->y
;
17211 if (row
->y
+ row
->height
> max_y
)
17212 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17213 if (row
->fringe_bitmap_periodic_p
)
17214 row
->redraw_fringe_bitmaps_p
= 1;
17216 it
.current_y
+= row
->height
;
17218 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17219 last_reused_text_row
= row
;
17220 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17224 /* Disable lines in the current matrix which are now
17225 below the window. */
17226 for (++row
; row
< bottom_row
; ++row
)
17227 row
->enabled_p
= row
->mode_line_p
= 0;
17230 /* Update window_end_pos etc.; last_reused_text_row is the last
17231 reused row from the current matrix containing text, if any.
17232 The value of last_text_row is the last displayed line
17233 containing text. */
17234 if (last_reused_text_row
)
17235 adjust_window_ends (w
, last_reused_text_row
, 1);
17236 else if (last_text_row
)
17237 adjust_window_ends (w
, last_text_row
, 0);
17240 /* This window must be completely empty. */
17241 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17242 w
->window_end_pos
= Z
- ZV
;
17243 w
->window_end_vpos
= 0;
17245 w
->window_end_valid
= 0;
17247 /* Update hint: don't try scrolling again in update_window. */
17248 w
->desired_matrix
->no_scrolling_p
= 1;
17251 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17255 else if (CHARPOS (new_start
) > CHARPOS (start
))
17257 struct glyph_row
*pt_row
, *row
;
17258 struct glyph_row
*first_reusable_row
;
17259 struct glyph_row
*first_row_to_display
;
17261 int yb
= window_text_bottom_y (w
);
17263 /* Find the row starting at new_start, if there is one. Don't
17264 reuse a partially visible line at the end. */
17265 first_reusable_row
= start_row
;
17266 while (first_reusable_row
->enabled_p
17267 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17268 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17269 < CHARPOS (new_start
)))
17270 ++first_reusable_row
;
17272 /* Give up if there is no row to reuse. */
17273 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17274 || !first_reusable_row
->enabled_p
17275 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17276 != CHARPOS (new_start
)))
17279 /* We can reuse fully visible rows beginning with
17280 first_reusable_row to the end of the window. Set
17281 first_row_to_display to the first row that cannot be reused.
17282 Set pt_row to the row containing point, if there is any. */
17284 for (first_row_to_display
= first_reusable_row
;
17285 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17286 ++first_row_to_display
)
17288 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17289 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17290 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17291 && first_row_to_display
->ends_at_zv_p
17292 && pt_row
== NULL
)))
17293 pt_row
= first_row_to_display
;
17296 /* Start displaying at the start of first_row_to_display. */
17297 eassert (first_row_to_display
->y
< yb
);
17298 init_to_row_start (&it
, w
, first_row_to_display
);
17300 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17302 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17304 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17305 + WINDOW_HEADER_LINE_HEIGHT (w
));
17307 /* Display lines beginning with first_row_to_display in the
17308 desired matrix. Set last_text_row to the last row displayed
17309 that displays text. */
17310 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17311 if (pt_row
== NULL
)
17312 w
->cursor
.vpos
= -1;
17313 last_text_row
= NULL
;
17314 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17315 if (display_line (&it
))
17316 last_text_row
= it
.glyph_row
- 1;
17318 /* If point is in a reused row, adjust y and vpos of the cursor
17322 w
->cursor
.vpos
-= nrows_scrolled
;
17323 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17326 /* Give up if point isn't in a row displayed or reused. (This
17327 also handles the case where w->cursor.vpos < nrows_scrolled
17328 after the calls to display_line, which can happen with scroll
17329 margins. See bug#1295.) */
17330 if (w
->cursor
.vpos
< 0)
17332 clear_glyph_matrix (w
->desired_matrix
);
17336 /* Scroll the display. */
17337 run
.current_y
= first_reusable_row
->y
;
17338 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17339 run
.height
= it
.last_visible_y
- run
.current_y
;
17340 dy
= run
.current_y
- run
.desired_y
;
17345 FRAME_RIF (f
)->update_window_begin_hook (w
);
17346 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17347 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17348 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17352 /* Adjust Y positions of reused rows. */
17353 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17354 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17355 max_y
= it
.last_visible_y
;
17356 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17359 row
->visible_height
= row
->height
;
17360 if (row
->y
< min_y
)
17361 row
->visible_height
-= min_y
- row
->y
;
17362 if (row
->y
+ row
->height
> max_y
)
17363 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17364 if (row
->fringe_bitmap_periodic_p
)
17365 row
->redraw_fringe_bitmaps_p
= 1;
17368 /* Scroll the current matrix. */
17369 eassert (nrows_scrolled
> 0);
17370 rotate_matrix (w
->current_matrix
,
17372 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17375 /* Disable rows not reused. */
17376 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17377 row
->enabled_p
= false;
17379 /* Point may have moved to a different line, so we cannot assume that
17380 the previous cursor position is valid; locate the correct row. */
17383 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17385 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17386 && !row
->ends_at_zv_p
;
17390 w
->cursor
.y
= row
->y
;
17392 if (row
< bottom_row
)
17394 /* Can't simply scan the row for point with
17395 bidi-reordered glyph rows. Let set_cursor_from_row
17396 figure out where to put the cursor, and if it fails,
17398 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17400 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17403 clear_glyph_matrix (w
->desired_matrix
);
17409 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17410 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17413 && (!BUFFERP (glyph
->object
)
17414 || glyph
->charpos
< PT
);
17418 w
->cursor
.x
+= glyph
->pixel_width
;
17424 /* Adjust window end. A null value of last_text_row means that
17425 the window end is in reused rows which in turn means that
17426 only its vpos can have changed. */
17428 adjust_window_ends (w
, last_text_row
, 0);
17430 w
->window_end_vpos
-= nrows_scrolled
;
17432 w
->window_end_valid
= 0;
17433 w
->desired_matrix
->no_scrolling_p
= 1;
17436 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17446 /************************************************************************
17447 Window redisplay reusing current matrix when buffer has changed
17448 ************************************************************************/
17450 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17451 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17452 ptrdiff_t *, ptrdiff_t *);
17453 static struct glyph_row
*
17454 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17455 struct glyph_row
*);
17458 /* Return the last row in MATRIX displaying text. If row START is
17459 non-null, start searching with that row. IT gives the dimensions
17460 of the display. Value is null if matrix is empty; otherwise it is
17461 a pointer to the row found. */
17463 static struct glyph_row
*
17464 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17465 struct glyph_row
*start
)
17467 struct glyph_row
*row
, *row_found
;
17469 /* Set row_found to the last row in IT->w's current matrix
17470 displaying text. The loop looks funny but think of partially
17473 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17474 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17476 eassert (row
->enabled_p
);
17478 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17487 /* Return the last row in the current matrix of W that is not affected
17488 by changes at the start of current_buffer that occurred since W's
17489 current matrix was built. Value is null if no such row exists.
17491 BEG_UNCHANGED us the number of characters unchanged at the start of
17492 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17493 first changed character in current_buffer. Characters at positions <
17494 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17495 when the current matrix was built. */
17497 static struct glyph_row
*
17498 find_last_unchanged_at_beg_row (struct window
*w
)
17500 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17501 struct glyph_row
*row
;
17502 struct glyph_row
*row_found
= NULL
;
17503 int yb
= window_text_bottom_y (w
);
17505 /* Find the last row displaying unchanged text. */
17506 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17507 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17508 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17511 if (/* If row ends before first_changed_pos, it is unchanged,
17512 except in some case. */
17513 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17514 /* When row ends in ZV and we write at ZV it is not
17516 && !row
->ends_at_zv_p
17517 /* When first_changed_pos is the end of a continued line,
17518 row is not unchanged because it may be no longer
17520 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17521 && (row
->continued_p
17522 || row
->exact_window_width_line_p
))
17523 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17524 needs to be recomputed, so don't consider this row as
17525 unchanged. This happens when the last line was
17526 bidi-reordered and was killed immediately before this
17527 redisplay cycle. In that case, ROW->end stores the
17528 buffer position of the first visual-order character of
17529 the killed text, which is now beyond ZV. */
17530 && CHARPOS (row
->end
.pos
) <= ZV
)
17533 /* Stop if last visible row. */
17534 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17542 /* Find the first glyph row in the current matrix of W that is not
17543 affected by changes at the end of current_buffer since the
17544 time W's current matrix was built.
17546 Return in *DELTA the number of chars by which buffer positions in
17547 unchanged text at the end of current_buffer must be adjusted.
17549 Return in *DELTA_BYTES the corresponding number of bytes.
17551 Value is null if no such row exists, i.e. all rows are affected by
17554 static struct glyph_row
*
17555 find_first_unchanged_at_end_row (struct window
*w
,
17556 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17558 struct glyph_row
*row
;
17559 struct glyph_row
*row_found
= NULL
;
17561 *delta
= *delta_bytes
= 0;
17563 /* Display must not have been paused, otherwise the current matrix
17564 is not up to date. */
17565 eassert (w
->window_end_valid
);
17567 /* A value of window_end_pos >= END_UNCHANGED means that the window
17568 end is in the range of changed text. If so, there is no
17569 unchanged row at the end of W's current matrix. */
17570 if (w
->window_end_pos
>= END_UNCHANGED
)
17573 /* Set row to the last row in W's current matrix displaying text. */
17574 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17576 /* If matrix is entirely empty, no unchanged row exists. */
17577 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17579 /* The value of row is the last glyph row in the matrix having a
17580 meaningful buffer position in it. The end position of row
17581 corresponds to window_end_pos. This allows us to translate
17582 buffer positions in the current matrix to current buffer
17583 positions for characters not in changed text. */
17585 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17586 ptrdiff_t Z_BYTE_old
=
17587 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17588 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17589 struct glyph_row
*first_text_row
17590 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17592 *delta
= Z
- Z_old
;
17593 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17595 /* Set last_unchanged_pos to the buffer position of the last
17596 character in the buffer that has not been changed. Z is the
17597 index + 1 of the last character in current_buffer, i.e. by
17598 subtracting END_UNCHANGED we get the index of the last
17599 unchanged character, and we have to add BEG to get its buffer
17601 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17602 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17604 /* Search backward from ROW for a row displaying a line that
17605 starts at a minimum position >= last_unchanged_pos_old. */
17606 for (; row
> first_text_row
; --row
)
17608 /* This used to abort, but it can happen.
17609 It is ok to just stop the search instead here. KFS. */
17610 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17613 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17618 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17624 /* Make sure that glyph rows in the current matrix of window W
17625 reference the same glyph memory as corresponding rows in the
17626 frame's frame matrix. This function is called after scrolling W's
17627 current matrix on a terminal frame in try_window_id and
17628 try_window_reusing_current_matrix. */
17631 sync_frame_with_window_matrix_rows (struct window
*w
)
17633 struct frame
*f
= XFRAME (w
->frame
);
17634 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17636 /* Preconditions: W must be a leaf window and full-width. Its frame
17637 must have a frame matrix. */
17638 eassert (BUFFERP (w
->contents
));
17639 eassert (WINDOW_FULL_WIDTH_P (w
));
17640 eassert (!FRAME_WINDOW_P (f
));
17642 /* If W is a full-width window, glyph pointers in W's current matrix
17643 have, by definition, to be the same as glyph pointers in the
17644 corresponding frame matrix. Note that frame matrices have no
17645 marginal areas (see build_frame_matrix). */
17646 window_row
= w
->current_matrix
->rows
;
17647 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17648 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17649 while (window_row
< window_row_end
)
17651 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17652 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17654 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17655 frame_row
->glyphs
[TEXT_AREA
] = start
;
17656 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17657 frame_row
->glyphs
[LAST_AREA
] = end
;
17659 /* Disable frame rows whose corresponding window rows have
17660 been disabled in try_window_id. */
17661 if (!window_row
->enabled_p
)
17662 frame_row
->enabled_p
= false;
17664 ++window_row
, ++frame_row
;
17669 /* Find the glyph row in window W containing CHARPOS. Consider all
17670 rows between START and END (not inclusive). END null means search
17671 all rows to the end of the display area of W. Value is the row
17672 containing CHARPOS or null. */
17675 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17676 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17678 struct glyph_row
*row
= start
;
17679 struct glyph_row
*best_row
= NULL
;
17680 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17683 /* If we happen to start on a header-line, skip that. */
17684 if (row
->mode_line_p
)
17687 if ((end
&& row
>= end
) || !row
->enabled_p
)
17690 last_y
= window_text_bottom_y (w
) - dy
;
17694 /* Give up if we have gone too far. */
17695 if (end
&& row
>= end
)
17697 /* This formerly returned if they were equal.
17698 I think that both quantities are of a "last plus one" type;
17699 if so, when they are equal, the row is within the screen. -- rms. */
17700 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17703 /* If it is in this row, return this row. */
17704 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17705 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17706 /* The end position of a row equals the start
17707 position of the next row. If CHARPOS is there, we
17708 would rather consider it displayed in the next
17709 line, except when this line ends in ZV. */
17710 && !row_for_charpos_p (row
, charpos
)))
17711 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17715 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17716 || (!best_row
&& !row
->continued_p
))
17718 /* In bidi-reordered rows, there could be several rows whose
17719 edges surround CHARPOS, all of these rows belonging to
17720 the same continued line. We need to find the row which
17721 fits CHARPOS the best. */
17722 for (g
= row
->glyphs
[TEXT_AREA
];
17723 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17726 if (!STRINGP (g
->object
))
17728 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17730 mindif
= eabs (g
->charpos
- charpos
);
17732 /* Exact match always wins. */
17739 else if (best_row
&& !row
->continued_p
)
17746 /* Try to redisplay window W by reusing its existing display. W's
17747 current matrix must be up to date when this function is called,
17748 i.e. window_end_valid must be nonzero.
17752 >= 1 if successful, i.e. display has been updated
17754 1 means the changes were in front of a newline that precedes
17755 the window start, and the whole current matrix was reused
17756 2 means the changes were after the last position displayed
17757 in the window, and the whole current matrix was reused
17758 3 means portions of the current matrix were reused, while
17759 some of the screen lines were redrawn
17760 -1 if redisplay with same window start is known not to succeed
17761 0 if otherwise unsuccessful
17763 The following steps are performed:
17765 1. Find the last row in the current matrix of W that is not
17766 affected by changes at the start of current_buffer. If no such row
17769 2. Find the first row in W's current matrix that is not affected by
17770 changes at the end of current_buffer. Maybe there is no such row.
17772 3. Display lines beginning with the row + 1 found in step 1 to the
17773 row found in step 2 or, if step 2 didn't find a row, to the end of
17776 4. If cursor is not known to appear on the window, give up.
17778 5. If display stopped at the row found in step 2, scroll the
17779 display and current matrix as needed.
17781 6. Maybe display some lines at the end of W, if we must. This can
17782 happen under various circumstances, like a partially visible line
17783 becoming fully visible, or because newly displayed lines are displayed
17784 in smaller font sizes.
17786 7. Update W's window end information. */
17789 try_window_id (struct window
*w
)
17791 struct frame
*f
= XFRAME (w
->frame
);
17792 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17793 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17794 struct glyph_row
*last_unchanged_at_beg_row
;
17795 struct glyph_row
*first_unchanged_at_end_row
;
17796 struct glyph_row
*row
;
17797 struct glyph_row
*bottom_row
;
17800 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17802 struct text_pos start_pos
;
17804 int first_unchanged_at_end_vpos
= 0;
17805 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17806 struct text_pos start
;
17807 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17810 if (inhibit_try_window_id
)
17814 /* This is handy for debugging. */
17816 #define GIVE_UP(X) \
17818 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17822 #define GIVE_UP(X) return 0
17825 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17827 /* Don't use this for mini-windows because these can show
17828 messages and mini-buffers, and we don't handle that here. */
17829 if (MINI_WINDOW_P (w
))
17832 /* This flag is used to prevent redisplay optimizations. */
17833 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17836 /* This function's optimizations cannot be used if overlays have
17837 changed in the buffer displayed by the window, so give up if they
17839 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17842 /* Verify that narrowing has not changed.
17843 Also verify that we were not told to prevent redisplay optimizations.
17844 It would be nice to further
17845 reduce the number of cases where this prevents try_window_id. */
17846 if (current_buffer
->clip_changed
17847 || current_buffer
->prevent_redisplay_optimizations_p
)
17850 /* Window must either use window-based redisplay or be full width. */
17851 if (!FRAME_WINDOW_P (f
)
17852 && (!FRAME_LINE_INS_DEL_OK (f
)
17853 || !WINDOW_FULL_WIDTH_P (w
)))
17856 /* Give up if point is known NOT to appear in W. */
17857 if (PT
< CHARPOS (start
))
17860 /* Another way to prevent redisplay optimizations. */
17861 if (w
->last_modified
== 0)
17864 /* Verify that window is not hscrolled. */
17865 if (w
->hscroll
!= 0)
17868 /* Verify that display wasn't paused. */
17869 if (!w
->window_end_valid
)
17872 /* Likewise if highlighting trailing whitespace. */
17873 if (!NILP (Vshow_trailing_whitespace
))
17876 /* Can't use this if overlay arrow position and/or string have
17878 if (overlay_arrows_changed_p ())
17881 /* When word-wrap is on, adding a space to the first word of a
17882 wrapped line can change the wrap position, altering the line
17883 above it. It might be worthwhile to handle this more
17884 intelligently, but for now just redisplay from scratch. */
17885 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17888 /* Under bidi reordering, adding or deleting a character in the
17889 beginning of a paragraph, before the first strong directional
17890 character, can change the base direction of the paragraph (unless
17891 the buffer specifies a fixed paragraph direction), which will
17892 require to redisplay the whole paragraph. It might be worthwhile
17893 to find the paragraph limits and widen the range of redisplayed
17894 lines to that, but for now just give up this optimization and
17895 redisplay from scratch. */
17896 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17897 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17900 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17901 only if buffer has really changed. The reason is that the gap is
17902 initially at Z for freshly visited files. The code below would
17903 set end_unchanged to 0 in that case. */
17904 if (MODIFF
> SAVE_MODIFF
17905 /* This seems to happen sometimes after saving a buffer. */
17906 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17908 if (GPT
- BEG
< BEG_UNCHANGED
)
17909 BEG_UNCHANGED
= GPT
- BEG
;
17910 if (Z
- GPT
< END_UNCHANGED
)
17911 END_UNCHANGED
= Z
- GPT
;
17914 /* The position of the first and last character that has been changed. */
17915 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17916 last_changed_charpos
= Z
- END_UNCHANGED
;
17918 /* If window starts after a line end, and the last change is in
17919 front of that newline, then changes don't affect the display.
17920 This case happens with stealth-fontification. Note that although
17921 the display is unchanged, glyph positions in the matrix have to
17922 be adjusted, of course. */
17923 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17924 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17925 && ((last_changed_charpos
< CHARPOS (start
)
17926 && CHARPOS (start
) == BEGV
)
17927 || (last_changed_charpos
< CHARPOS (start
) - 1
17928 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17930 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17931 struct glyph_row
*r0
;
17933 /* Compute how many chars/bytes have been added to or removed
17934 from the buffer. */
17935 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17936 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17937 Z_delta
= Z
- Z_old
;
17938 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17940 /* Give up if PT is not in the window. Note that it already has
17941 been checked at the start of try_window_id that PT is not in
17942 front of the window start. */
17943 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17946 /* If window start is unchanged, we can reuse the whole matrix
17947 as is, after adjusting glyph positions. No need to compute
17948 the window end again, since its offset from Z hasn't changed. */
17949 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17950 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17951 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17952 /* PT must not be in a partially visible line. */
17953 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17954 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17956 /* Adjust positions in the glyph matrix. */
17957 if (Z_delta
|| Z_delta_bytes
)
17959 struct glyph_row
*r1
17960 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17961 increment_matrix_positions (w
->current_matrix
,
17962 MATRIX_ROW_VPOS (r0
, current_matrix
),
17963 MATRIX_ROW_VPOS (r1
, current_matrix
),
17964 Z_delta
, Z_delta_bytes
);
17967 /* Set the cursor. */
17968 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17970 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17975 /* Handle the case that changes are all below what is displayed in
17976 the window, and that PT is in the window. This shortcut cannot
17977 be taken if ZV is visible in the window, and text has been added
17978 there that is visible in the window. */
17979 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17980 /* ZV is not visible in the window, or there are no
17981 changes at ZV, actually. */
17982 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17983 || first_changed_charpos
== last_changed_charpos
))
17985 struct glyph_row
*r0
;
17987 /* Give up if PT is not in the window. Note that it already has
17988 been checked at the start of try_window_id that PT is not in
17989 front of the window start. */
17990 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17993 /* If window start is unchanged, we can reuse the whole matrix
17994 as is, without changing glyph positions since no text has
17995 been added/removed in front of the window end. */
17996 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17997 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17998 /* PT must not be in a partially visible line. */
17999 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18000 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18002 /* We have to compute the window end anew since text
18003 could have been added/removed after it. */
18004 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18005 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18007 /* Set the cursor. */
18008 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18010 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18015 /* Give up if window start is in the changed area.
18017 The condition used to read
18019 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18021 but why that was tested escapes me at the moment. */
18022 if (CHARPOS (start
) >= first_changed_charpos
18023 && CHARPOS (start
) <= last_changed_charpos
)
18026 /* Check that window start agrees with the start of the first glyph
18027 row in its current matrix. Check this after we know the window
18028 start is not in changed text, otherwise positions would not be
18030 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18031 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18034 /* Give up if the window ends in strings. Overlay strings
18035 at the end are difficult to handle, so don't try. */
18036 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18037 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18040 /* Compute the position at which we have to start displaying new
18041 lines. Some of the lines at the top of the window might be
18042 reusable because they are not displaying changed text. Find the
18043 last row in W's current matrix not affected by changes at the
18044 start of current_buffer. Value is null if changes start in the
18045 first line of window. */
18046 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18047 if (last_unchanged_at_beg_row
)
18049 /* Avoid starting to display in the middle of a character, a TAB
18050 for instance. This is easier than to set up the iterator
18051 exactly, and it's not a frequent case, so the additional
18052 effort wouldn't really pay off. */
18053 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18054 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18055 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18056 --last_unchanged_at_beg_row
;
18058 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18061 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18063 start_pos
= it
.current
.pos
;
18065 /* Start displaying new lines in the desired matrix at the same
18066 vpos we would use in the current matrix, i.e. below
18067 last_unchanged_at_beg_row. */
18068 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18070 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18071 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18073 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18077 /* There are no reusable lines at the start of the window.
18078 Start displaying in the first text line. */
18079 start_display (&it
, w
, start
);
18080 it
.vpos
= it
.first_vpos
;
18081 start_pos
= it
.current
.pos
;
18084 /* Find the first row that is not affected by changes at the end of
18085 the buffer. Value will be null if there is no unchanged row, in
18086 which case we must redisplay to the end of the window. delta
18087 will be set to the value by which buffer positions beginning with
18088 first_unchanged_at_end_row have to be adjusted due to text
18090 first_unchanged_at_end_row
18091 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18092 IF_DEBUG (debug_delta
= delta
);
18093 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18095 /* Set stop_pos to the buffer position up to which we will have to
18096 display new lines. If first_unchanged_at_end_row != NULL, this
18097 is the buffer position of the start of the line displayed in that
18098 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18099 that we don't stop at a buffer position. */
18101 if (first_unchanged_at_end_row
)
18103 eassert (last_unchanged_at_beg_row
== NULL
18104 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18106 /* If this is a continuation line, move forward to the next one
18107 that isn't. Changes in lines above affect this line.
18108 Caution: this may move first_unchanged_at_end_row to a row
18109 not displaying text. */
18110 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18111 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18112 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18113 < it
.last_visible_y
))
18114 ++first_unchanged_at_end_row
;
18116 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18117 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18118 >= it
.last_visible_y
))
18119 first_unchanged_at_end_row
= NULL
;
18122 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18124 first_unchanged_at_end_vpos
18125 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18126 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18129 else if (last_unchanged_at_beg_row
== NULL
)
18135 /* Either there is no unchanged row at the end, or the one we have
18136 now displays text. This is a necessary condition for the window
18137 end pos calculation at the end of this function. */
18138 eassert (first_unchanged_at_end_row
== NULL
18139 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18141 debug_last_unchanged_at_beg_vpos
18142 = (last_unchanged_at_beg_row
18143 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18145 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18147 #endif /* GLYPH_DEBUG */
18150 /* Display new lines. Set last_text_row to the last new line
18151 displayed which has text on it, i.e. might end up as being the
18152 line where the window_end_vpos is. */
18153 w
->cursor
.vpos
= -1;
18154 last_text_row
= NULL
;
18155 overlay_arrow_seen
= 0;
18156 if (it
.current_y
< it
.last_visible_y
18157 && !f
->fonts_changed
18158 && (first_unchanged_at_end_row
== NULL
18159 || IT_CHARPOS (it
) < stop_pos
))
18160 it
.glyph_row
->reversed_p
= false;
18161 while (it
.current_y
< it
.last_visible_y
18162 && !f
->fonts_changed
18163 && (first_unchanged_at_end_row
== NULL
18164 || IT_CHARPOS (it
) < stop_pos
))
18166 if (display_line (&it
))
18167 last_text_row
= it
.glyph_row
- 1;
18170 if (f
->fonts_changed
)
18174 /* Compute differences in buffer positions, y-positions etc. for
18175 lines reused at the bottom of the window. Compute what we can
18177 if (first_unchanged_at_end_row
18178 /* No lines reused because we displayed everything up to the
18179 bottom of the window. */
18180 && it
.current_y
< it
.last_visible_y
)
18183 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18185 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18186 run
.current_y
= first_unchanged_at_end_row
->y
;
18187 run
.desired_y
= run
.current_y
+ dy
;
18188 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18192 delta
= delta_bytes
= dvpos
= dy
18193 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18194 first_unchanged_at_end_row
= NULL
;
18196 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18199 /* Find the cursor if not already found. We have to decide whether
18200 PT will appear on this window (it sometimes doesn't, but this is
18201 not a very frequent case.) This decision has to be made before
18202 the current matrix is altered. A value of cursor.vpos < 0 means
18203 that PT is either in one of the lines beginning at
18204 first_unchanged_at_end_row or below the window. Don't care for
18205 lines that might be displayed later at the window end; as
18206 mentioned, this is not a frequent case. */
18207 if (w
->cursor
.vpos
< 0)
18209 /* Cursor in unchanged rows at the top? */
18210 if (PT
< CHARPOS (start_pos
)
18211 && last_unchanged_at_beg_row
)
18213 row
= row_containing_pos (w
, PT
,
18214 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18215 last_unchanged_at_beg_row
+ 1, 0);
18217 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18220 /* Start from first_unchanged_at_end_row looking for PT. */
18221 else if (first_unchanged_at_end_row
)
18223 row
= row_containing_pos (w
, PT
- delta
,
18224 first_unchanged_at_end_row
, NULL
, 0);
18226 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18227 delta_bytes
, dy
, dvpos
);
18230 /* Give up if cursor was not found. */
18231 if (w
->cursor
.vpos
< 0)
18233 clear_glyph_matrix (w
->desired_matrix
);
18238 /* Don't let the cursor end in the scroll margins. */
18240 int this_scroll_margin
, cursor_height
;
18241 int frame_line_height
= default_line_pixel_height (w
);
18242 int window_total_lines
18243 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18245 this_scroll_margin
=
18246 max (0, min (scroll_margin
, window_total_lines
/ 4));
18247 this_scroll_margin
*= frame_line_height
;
18248 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18250 if ((w
->cursor
.y
< this_scroll_margin
18251 && CHARPOS (start
) > BEGV
)
18252 /* Old redisplay didn't take scroll margin into account at the bottom,
18253 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18254 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18255 ? cursor_height
+ this_scroll_margin
18256 : 1)) > it
.last_visible_y
)
18258 w
->cursor
.vpos
= -1;
18259 clear_glyph_matrix (w
->desired_matrix
);
18264 /* Scroll the display. Do it before changing the current matrix so
18265 that xterm.c doesn't get confused about where the cursor glyph is
18267 if (dy
&& run
.height
)
18271 if (FRAME_WINDOW_P (f
))
18273 FRAME_RIF (f
)->update_window_begin_hook (w
);
18274 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18275 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18276 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18280 /* Terminal frame. In this case, dvpos gives the number of
18281 lines to scroll by; dvpos < 0 means scroll up. */
18283 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18284 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18285 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18286 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18287 + window_internal_height (w
));
18289 #if defined (HAVE_GPM) || defined (MSDOS)
18290 x_clear_window_mouse_face (w
);
18292 /* Perform the operation on the screen. */
18295 /* Scroll last_unchanged_at_beg_row to the end of the
18296 window down dvpos lines. */
18297 set_terminal_window (f
, end
);
18299 /* On dumb terminals delete dvpos lines at the end
18300 before inserting dvpos empty lines. */
18301 if (!FRAME_SCROLL_REGION_OK (f
))
18302 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18304 /* Insert dvpos empty lines in front of
18305 last_unchanged_at_beg_row. */
18306 ins_del_lines (f
, from
, dvpos
);
18308 else if (dvpos
< 0)
18310 /* Scroll up last_unchanged_at_beg_vpos to the end of
18311 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18312 set_terminal_window (f
, end
);
18314 /* Delete dvpos lines in front of
18315 last_unchanged_at_beg_vpos. ins_del_lines will set
18316 the cursor to the given vpos and emit |dvpos| delete
18318 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18320 /* On a dumb terminal insert dvpos empty lines at the
18322 if (!FRAME_SCROLL_REGION_OK (f
))
18323 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18326 set_terminal_window (f
, 0);
18332 /* Shift reused rows of the current matrix to the right position.
18333 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18335 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18336 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18339 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18340 bottom_vpos
, dvpos
);
18341 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18344 else if (dvpos
> 0)
18346 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18347 bottom_vpos
, dvpos
);
18348 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18349 first_unchanged_at_end_vpos
+ dvpos
);
18352 /* For frame-based redisplay, make sure that current frame and window
18353 matrix are in sync with respect to glyph memory. */
18354 if (!FRAME_WINDOW_P (f
))
18355 sync_frame_with_window_matrix_rows (w
);
18357 /* Adjust buffer positions in reused rows. */
18358 if (delta
|| delta_bytes
)
18359 increment_matrix_positions (current_matrix
,
18360 first_unchanged_at_end_vpos
+ dvpos
,
18361 bottom_vpos
, delta
, delta_bytes
);
18363 /* Adjust Y positions. */
18365 shift_glyph_matrix (w
, current_matrix
,
18366 first_unchanged_at_end_vpos
+ dvpos
,
18369 if (first_unchanged_at_end_row
)
18371 first_unchanged_at_end_row
+= dvpos
;
18372 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18373 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18374 first_unchanged_at_end_row
= NULL
;
18377 /* If scrolling up, there may be some lines to display at the end of
18379 last_text_row_at_end
= NULL
;
18382 /* Scrolling up can leave for example a partially visible line
18383 at the end of the window to be redisplayed. */
18384 /* Set last_row to the glyph row in the current matrix where the
18385 window end line is found. It has been moved up or down in
18386 the matrix by dvpos. */
18387 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18388 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18390 /* If last_row is the window end line, it should display text. */
18391 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18393 /* If window end line was partially visible before, begin
18394 displaying at that line. Otherwise begin displaying with the
18395 line following it. */
18396 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18398 init_to_row_start (&it
, w
, last_row
);
18399 it
.vpos
= last_vpos
;
18400 it
.current_y
= last_row
->y
;
18404 init_to_row_end (&it
, w
, last_row
);
18405 it
.vpos
= 1 + last_vpos
;
18406 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18410 /* We may start in a continuation line. If so, we have to
18411 get the right continuation_lines_width and current_x. */
18412 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18413 it
.hpos
= it
.current_x
= 0;
18415 /* Display the rest of the lines at the window end. */
18416 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18417 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18419 /* Is it always sure that the display agrees with lines in
18420 the current matrix? I don't think so, so we mark rows
18421 displayed invalid in the current matrix by setting their
18422 enabled_p flag to zero. */
18423 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18424 if (display_line (&it
))
18425 last_text_row_at_end
= it
.glyph_row
- 1;
18429 /* Update window_end_pos and window_end_vpos. */
18430 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18432 /* Window end line if one of the preserved rows from the current
18433 matrix. Set row to the last row displaying text in current
18434 matrix starting at first_unchanged_at_end_row, after
18436 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18437 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18438 first_unchanged_at_end_row
);
18439 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18440 adjust_window_ends (w
, row
, 1);
18441 eassert (w
->window_end_bytepos
>= 0);
18442 IF_DEBUG (debug_method_add (w
, "A"));
18444 else if (last_text_row_at_end
)
18446 adjust_window_ends (w
, last_text_row_at_end
, 0);
18447 eassert (w
->window_end_bytepos
>= 0);
18448 IF_DEBUG (debug_method_add (w
, "B"));
18450 else if (last_text_row
)
18452 /* We have displayed either to the end of the window or at the
18453 end of the window, i.e. the last row with text is to be found
18454 in the desired matrix. */
18455 adjust_window_ends (w
, last_text_row
, 0);
18456 eassert (w
->window_end_bytepos
>= 0);
18458 else if (first_unchanged_at_end_row
== NULL
18459 && last_text_row
== NULL
18460 && last_text_row_at_end
== NULL
)
18462 /* Displayed to end of window, but no line containing text was
18463 displayed. Lines were deleted at the end of the window. */
18464 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18465 int vpos
= w
->window_end_vpos
;
18466 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18467 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18470 row
== NULL
&& vpos
>= first_vpos
;
18471 --vpos
, --current_row
, --desired_row
)
18473 if (desired_row
->enabled_p
)
18475 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18478 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18482 eassert (row
!= NULL
);
18483 w
->window_end_vpos
= vpos
+ 1;
18484 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18485 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18486 eassert (w
->window_end_bytepos
>= 0);
18487 IF_DEBUG (debug_method_add (w
, "C"));
18492 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18493 debug_end_vpos
= w
->window_end_vpos
));
18495 /* Record that display has not been completed. */
18496 w
->window_end_valid
= 0;
18497 w
->desired_matrix
->no_scrolling_p
= 1;
18505 /***********************************************************************
18506 More debugging support
18507 ***********************************************************************/
18511 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18512 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18513 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18516 /* Dump the contents of glyph matrix MATRIX on stderr.
18518 GLYPHS 0 means don't show glyph contents.
18519 GLYPHS 1 means show glyphs in short form
18520 GLYPHS > 1 means show glyphs in long form. */
18523 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18526 for (i
= 0; i
< matrix
->nrows
; ++i
)
18527 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18531 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18532 the glyph row and area where the glyph comes from. */
18535 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18537 if (glyph
->type
== CHAR_GLYPH
18538 || glyph
->type
== GLYPHLESS_GLYPH
)
18541 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18542 glyph
- row
->glyphs
[TEXT_AREA
],
18543 (glyph
->type
== CHAR_GLYPH
18547 (BUFFERP (glyph
->object
)
18549 : (STRINGP (glyph
->object
)
18551 : (INTEGERP (glyph
->object
)
18554 glyph
->pixel_width
,
18556 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18560 glyph
->left_box_line_p
,
18561 glyph
->right_box_line_p
);
18563 else if (glyph
->type
== STRETCH_GLYPH
)
18566 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18567 glyph
- row
->glyphs
[TEXT_AREA
],
18570 (BUFFERP (glyph
->object
)
18572 : (STRINGP (glyph
->object
)
18574 : (INTEGERP (glyph
->object
)
18577 glyph
->pixel_width
,
18581 glyph
->left_box_line_p
,
18582 glyph
->right_box_line_p
);
18584 else if (glyph
->type
== IMAGE_GLYPH
)
18587 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18588 glyph
- row
->glyphs
[TEXT_AREA
],
18591 (BUFFERP (glyph
->object
)
18593 : (STRINGP (glyph
->object
)
18595 : (INTEGERP (glyph
->object
)
18598 glyph
->pixel_width
,
18602 glyph
->left_box_line_p
,
18603 glyph
->right_box_line_p
);
18605 else if (glyph
->type
== COMPOSITE_GLYPH
)
18608 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18609 glyph
- row
->glyphs
[TEXT_AREA
],
18612 (BUFFERP (glyph
->object
)
18614 : (STRINGP (glyph
->object
)
18616 : (INTEGERP (glyph
->object
)
18619 glyph
->pixel_width
,
18621 if (glyph
->u
.cmp
.automatic
)
18624 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18625 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18627 glyph
->left_box_line_p
,
18628 glyph
->right_box_line_p
);
18633 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18634 GLYPHS 0 means don't show glyph contents.
18635 GLYPHS 1 means show glyphs in short form
18636 GLYPHS > 1 means show glyphs in long form. */
18639 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18643 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18644 fprintf (stderr
, "==============================================================================\n");
18646 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18647 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18649 MATRIX_ROW_START_CHARPOS (row
),
18650 MATRIX_ROW_END_CHARPOS (row
),
18651 row
->used
[TEXT_AREA
],
18652 row
->contains_overlapping_glyphs_p
,
18654 row
->truncated_on_left_p
,
18655 row
->truncated_on_right_p
,
18657 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18658 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18661 row
->ends_in_middle_of_char_p
,
18662 row
->starts_in_middle_of_char_p
,
18668 row
->visible_height
,
18671 /* The next 3 lines should align to "Start" in the header. */
18672 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18673 row
->end
.overlay_string_index
,
18674 row
->continuation_lines_width
);
18675 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18676 CHARPOS (row
->start
.string_pos
),
18677 CHARPOS (row
->end
.string_pos
));
18678 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18679 row
->end
.dpvec_index
);
18686 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18688 struct glyph
*glyph
= row
->glyphs
[area
];
18689 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18691 /* Glyph for a line end in text. */
18692 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18695 if (glyph
< glyph_end
)
18696 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18698 for (; glyph
< glyph_end
; ++glyph
)
18699 dump_glyph (row
, glyph
, area
);
18702 else if (glyphs
== 1)
18705 char s
[SHRT_MAX
+ 4];
18707 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18711 for (i
= 0; i
< row
->used
[area
]; ++i
)
18713 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18714 if (i
== row
->used
[area
] - 1
18715 && area
== TEXT_AREA
18716 && INTEGERP (glyph
->object
)
18717 && glyph
->type
== CHAR_GLYPH
18718 && glyph
->u
.ch
== ' ')
18720 strcpy (&s
[i
], "[\\n]");
18723 else if (glyph
->type
== CHAR_GLYPH
18724 && glyph
->u
.ch
< 0x80
18725 && glyph
->u
.ch
>= ' ')
18726 s
[i
] = glyph
->u
.ch
;
18732 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18738 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18739 Sdump_glyph_matrix
, 0, 1, "p",
18740 doc
: /* Dump the current matrix of the selected window to stderr.
18741 Shows contents of glyph row structures. With non-nil
18742 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18743 glyphs in short form, otherwise show glyphs in long form. */)
18744 (Lisp_Object glyphs
)
18746 struct window
*w
= XWINDOW (selected_window
);
18747 struct buffer
*buffer
= XBUFFER (w
->contents
);
18749 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18750 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18751 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18752 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18753 fprintf (stderr
, "=============================================\n");
18754 dump_glyph_matrix (w
->current_matrix
,
18755 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18760 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18761 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18764 struct frame
*f
= XFRAME (selected_frame
);
18765 dump_glyph_matrix (f
->current_matrix
, 1);
18770 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18771 doc
: /* Dump glyph row ROW to stderr.
18772 GLYPH 0 means don't dump glyphs.
18773 GLYPH 1 means dump glyphs in short form.
18774 GLYPH > 1 or omitted means dump glyphs in long form. */)
18775 (Lisp_Object row
, Lisp_Object glyphs
)
18777 struct glyph_matrix
*matrix
;
18780 CHECK_NUMBER (row
);
18781 matrix
= XWINDOW (selected_window
)->current_matrix
;
18783 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18784 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18786 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18791 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18792 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18793 GLYPH 0 means don't dump glyphs.
18794 GLYPH 1 means dump glyphs in short form.
18795 GLYPH > 1 or omitted means dump glyphs in long form.
18797 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18799 (Lisp_Object row
, Lisp_Object glyphs
)
18801 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18802 struct frame
*sf
= SELECTED_FRAME ();
18803 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18806 CHECK_NUMBER (row
);
18808 if (vpos
>= 0 && vpos
< m
->nrows
)
18809 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18810 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18816 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18817 doc
: /* Toggle tracing of redisplay.
18818 With ARG, turn tracing on if and only if ARG is positive. */)
18822 trace_redisplay_p
= !trace_redisplay_p
;
18825 arg
= Fprefix_numeric_value (arg
);
18826 trace_redisplay_p
= XINT (arg
) > 0;
18833 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18834 doc
: /* Like `format', but print result to stderr.
18835 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18836 (ptrdiff_t nargs
, Lisp_Object
*args
)
18838 Lisp_Object s
= Fformat (nargs
, args
);
18839 fprintf (stderr
, "%s", SDATA (s
));
18843 #endif /* GLYPH_DEBUG */
18847 /***********************************************************************
18848 Building Desired Matrix Rows
18849 ***********************************************************************/
18851 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18852 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18854 static struct glyph_row
*
18855 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18857 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18858 struct buffer
*buffer
= XBUFFER (w
->contents
);
18859 struct buffer
*old
= current_buffer
;
18860 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18861 int arrow_len
= SCHARS (overlay_arrow_string
);
18862 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18863 const unsigned char *p
;
18866 int n_glyphs_before
;
18868 set_buffer_temp (buffer
);
18869 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18870 scratch_glyph_row
.reversed_p
= false;
18871 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18872 SET_TEXT_POS (it
.position
, 0, 0);
18874 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18876 while (p
< arrow_end
)
18878 Lisp_Object face
, ilisp
;
18880 /* Get the next character. */
18882 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18885 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18886 if (! ASCII_CHAR_P (it
.c
))
18887 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18891 /* Get its face. */
18892 ilisp
= make_number (p
- arrow_string
);
18893 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18894 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18896 /* Compute its width, get its glyphs. */
18897 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18898 SET_TEXT_POS (it
.position
, -1, -1);
18899 PRODUCE_GLYPHS (&it
);
18901 /* If this character doesn't fit any more in the line, we have
18902 to remove some glyphs. */
18903 if (it
.current_x
> it
.last_visible_x
)
18905 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18910 set_buffer_temp (old
);
18911 return it
.glyph_row
;
18915 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18916 glyphs to insert is determined by produce_special_glyphs. */
18919 insert_left_trunc_glyphs (struct it
*it
)
18921 struct it truncate_it
;
18922 struct glyph
*from
, *end
, *to
, *toend
;
18924 eassert (!FRAME_WINDOW_P (it
->f
)
18925 || (!it
->glyph_row
->reversed_p
18926 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18927 || (it
->glyph_row
->reversed_p
18928 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18930 /* Get the truncation glyphs. */
18932 truncate_it
.current_x
= 0;
18933 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18934 truncate_it
.glyph_row
= &scratch_glyph_row
;
18935 truncate_it
.area
= TEXT_AREA
;
18936 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18937 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18938 truncate_it
.object
= make_number (0);
18939 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18941 /* Overwrite glyphs from IT with truncation glyphs. */
18942 if (!it
->glyph_row
->reversed_p
)
18944 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18946 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18947 end
= from
+ tused
;
18948 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18949 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18950 if (FRAME_WINDOW_P (it
->f
))
18952 /* On GUI frames, when variable-size fonts are displayed,
18953 the truncation glyphs may need more pixels than the row's
18954 glyphs they overwrite. We overwrite more glyphs to free
18955 enough screen real estate, and enlarge the stretch glyph
18956 on the right (see display_line), if there is one, to
18957 preserve the screen position of the truncation glyphs on
18960 struct glyph
*g
= to
;
18963 /* The first glyph could be partially visible, in which case
18964 it->glyph_row->x will be negative. But we want the left
18965 truncation glyphs to be aligned at the left margin of the
18966 window, so we override the x coordinate at which the row
18968 it
->glyph_row
->x
= 0;
18969 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18971 w
+= g
->pixel_width
;
18974 if (g
- to
- tused
> 0)
18976 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18977 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18979 used
= it
->glyph_row
->used
[TEXT_AREA
];
18980 if (it
->glyph_row
->truncated_on_right_p
18981 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18982 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18985 int extra
= w
- it
->truncation_pixel_width
;
18987 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18994 /* There may be padding glyphs left over. Overwrite them too. */
18995 if (!FRAME_WINDOW_P (it
->f
))
18997 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18999 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19006 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19010 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19012 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19013 that back to front. */
19014 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19015 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19016 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19017 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19018 if (FRAME_WINDOW_P (it
->f
))
19021 struct glyph
*g
= to
;
19023 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19025 w
+= g
->pixel_width
;
19028 if (to
- g
- tused
> 0)
19030 if (it
->glyph_row
->truncated_on_right_p
19031 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19032 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19034 int extra
= w
- it
->truncation_pixel_width
;
19036 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19040 while (from
>= end
&& to
>= toend
)
19042 if (!FRAME_WINDOW_P (it
->f
))
19044 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19047 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19048 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19049 while (from
>= end
&& to
>= toend
)
19055 /* Need to free some room before prepending additional
19057 int move_by
= from
- end
+ 1;
19058 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19059 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19061 for ( ; g
>= g0
; g
--)
19063 while (from
>= end
)
19065 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19070 /* Compute the hash code for ROW. */
19072 row_hash (struct glyph_row
*row
)
19075 unsigned hashval
= 0;
19077 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19078 for (k
= 0; k
< row
->used
[area
]; ++k
)
19079 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19080 + row
->glyphs
[area
][k
].u
.val
19081 + row
->glyphs
[area
][k
].face_id
19082 + row
->glyphs
[area
][k
].padding_p
19083 + (row
->glyphs
[area
][k
].type
<< 2));
19088 /* Compute the pixel height and width of IT->glyph_row.
19090 Most of the time, ascent and height of a display line will be equal
19091 to the max_ascent and max_height values of the display iterator
19092 structure. This is not the case if
19094 1. We hit ZV without displaying anything. In this case, max_ascent
19095 and max_height will be zero.
19097 2. We have some glyphs that don't contribute to the line height.
19098 (The glyph row flag contributes_to_line_height_p is for future
19099 pixmap extensions).
19101 The first case is easily covered by using default values because in
19102 these cases, the line height does not really matter, except that it
19103 must not be zero. */
19106 compute_line_metrics (struct it
*it
)
19108 struct glyph_row
*row
= it
->glyph_row
;
19110 if (FRAME_WINDOW_P (it
->f
))
19112 int i
, min_y
, max_y
;
19114 /* The line may consist of one space only, that was added to
19115 place the cursor on it. If so, the row's height hasn't been
19117 if (row
->height
== 0)
19119 if (it
->max_ascent
+ it
->max_descent
== 0)
19120 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19121 row
->ascent
= it
->max_ascent
;
19122 row
->height
= it
->max_ascent
+ it
->max_descent
;
19123 row
->phys_ascent
= it
->max_phys_ascent
;
19124 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19125 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19128 /* Compute the width of this line. */
19129 row
->pixel_width
= row
->x
;
19130 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19131 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19133 eassert (row
->pixel_width
>= 0);
19134 eassert (row
->ascent
>= 0 && row
->height
> 0);
19136 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19137 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19139 /* If first line's physical ascent is larger than its logical
19140 ascent, use the physical ascent, and make the row taller.
19141 This makes accented characters fully visible. */
19142 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19143 && row
->phys_ascent
> row
->ascent
)
19145 row
->height
+= row
->phys_ascent
- row
->ascent
;
19146 row
->ascent
= row
->phys_ascent
;
19149 /* Compute how much of the line is visible. */
19150 row
->visible_height
= row
->height
;
19152 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19153 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19155 if (row
->y
< min_y
)
19156 row
->visible_height
-= min_y
- row
->y
;
19157 if (row
->y
+ row
->height
> max_y
)
19158 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19162 row
->pixel_width
= row
->used
[TEXT_AREA
];
19163 if (row
->continued_p
)
19164 row
->pixel_width
-= it
->continuation_pixel_width
;
19165 else if (row
->truncated_on_right_p
)
19166 row
->pixel_width
-= it
->truncation_pixel_width
;
19167 row
->ascent
= row
->phys_ascent
= 0;
19168 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19169 row
->extra_line_spacing
= 0;
19172 /* Compute a hash code for this row. */
19173 row
->hash
= row_hash (row
);
19175 it
->max_ascent
= it
->max_descent
= 0;
19176 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19180 /* Append one space to the glyph row of iterator IT if doing a
19181 window-based redisplay. The space has the same face as
19182 IT->face_id. Value is non-zero if a space was added.
19184 This function is called to make sure that there is always one glyph
19185 at the end of a glyph row that the cursor can be set on under
19186 window-systems. (If there weren't such a glyph we would not know
19187 how wide and tall a box cursor should be displayed).
19189 At the same time this space let's a nicely handle clearing to the
19190 end of the line if the row ends in italic text. */
19193 append_space_for_newline (struct it
*it
, int default_face_p
)
19195 if (FRAME_WINDOW_P (it
->f
))
19197 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19199 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19200 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19202 /* Save some values that must not be changed.
19203 Must save IT->c and IT->len because otherwise
19204 ITERATOR_AT_END_P wouldn't work anymore after
19205 append_space_for_newline has been called. */
19206 enum display_element_type saved_what
= it
->what
;
19207 int saved_c
= it
->c
, saved_len
= it
->len
;
19208 int saved_char_to_display
= it
->char_to_display
;
19209 int saved_x
= it
->current_x
;
19210 int saved_face_id
= it
->face_id
;
19211 int saved_box_end
= it
->end_of_box_run_p
;
19212 struct text_pos saved_pos
;
19213 Lisp_Object saved_object
;
19216 saved_object
= it
->object
;
19217 saved_pos
= it
->position
;
19219 it
->what
= IT_CHARACTER
;
19220 memset (&it
->position
, 0, sizeof it
->position
);
19221 it
->object
= make_number (0);
19222 it
->c
= it
->char_to_display
= ' ';
19225 /* If the default face was remapped, be sure to use the
19226 remapped face for the appended newline. */
19227 if (default_face_p
)
19228 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19229 else if (it
->face_before_selective_p
)
19230 it
->face_id
= it
->saved_face_id
;
19231 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19232 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19233 /* In R2L rows, we will prepend a stretch glyph that will
19234 have the end_of_box_run_p flag set for it, so there's no
19235 need for the appended newline glyph to have that flag
19237 if (it
->glyph_row
->reversed_p
19238 /* But if the appended newline glyph goes all the way to
19239 the end of the row, there will be no stretch glyph,
19240 so leave the box flag set. */
19241 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19242 it
->end_of_box_run_p
= 0;
19244 PRODUCE_GLYPHS (it
);
19246 it
->override_ascent
= -1;
19247 it
->constrain_row_ascent_descent_p
= 0;
19248 it
->current_x
= saved_x
;
19249 it
->object
= saved_object
;
19250 it
->position
= saved_pos
;
19251 it
->what
= saved_what
;
19252 it
->face_id
= saved_face_id
;
19253 it
->len
= saved_len
;
19255 it
->char_to_display
= saved_char_to_display
;
19256 it
->end_of_box_run_p
= saved_box_end
;
19265 /* Extend the face of the last glyph in the text area of IT->glyph_row
19266 to the end of the display line. Called from display_line. If the
19267 glyph row is empty, add a space glyph to it so that we know the
19268 face to draw. Set the glyph row flag fill_line_p. If the glyph
19269 row is R2L, prepend a stretch glyph to cover the empty space to the
19270 left of the leftmost glyph. */
19273 extend_face_to_end_of_line (struct it
*it
)
19275 struct face
*face
, *default_face
;
19276 struct frame
*f
= it
->f
;
19278 /* If line is already filled, do nothing. Non window-system frames
19279 get a grace of one more ``pixel'' because their characters are
19280 1-``pixel'' wide, so they hit the equality too early. This grace
19281 is needed only for R2L rows that are not continued, to produce
19282 one extra blank where we could display the cursor. */
19283 if ((it
->current_x
>= it
->last_visible_x
19284 + (!FRAME_WINDOW_P (f
)
19285 && it
->glyph_row
->reversed_p
19286 && !it
->glyph_row
->continued_p
))
19287 /* If the window has display margins, we will need to extend
19288 their face even if the text area is filled. */
19289 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19290 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19293 /* The default face, possibly remapped. */
19294 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19296 /* Face extension extends the background and box of IT->face_id
19297 to the end of the line. If the background equals the background
19298 of the frame, we don't have to do anything. */
19299 if (it
->face_before_selective_p
)
19300 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19302 face
= FACE_FROM_ID (f
, it
->face_id
);
19304 if (FRAME_WINDOW_P (f
)
19305 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19306 && face
->box
== FACE_NO_BOX
19307 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19308 #ifdef HAVE_WINDOW_SYSTEM
19311 && !it
->glyph_row
->reversed_p
)
19314 /* Set the glyph row flag indicating that the face of the last glyph
19315 in the text area has to be drawn to the end of the text area. */
19316 it
->glyph_row
->fill_line_p
= 1;
19318 /* If current character of IT is not ASCII, make sure we have the
19319 ASCII face. This will be automatically undone the next time
19320 get_next_display_element returns a multibyte character. Note
19321 that the character will always be single byte in unibyte
19323 if (!ASCII_CHAR_P (it
->c
))
19325 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19328 if (FRAME_WINDOW_P (f
))
19330 /* If the row is empty, add a space with the current face of IT,
19331 so that we know which face to draw. */
19332 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19334 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19335 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19336 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19338 /* Mode line and the header line don't have margins, and
19339 likewise the frame's tool-bar window, if there is any. */
19340 if (!(it
->glyph_row
->mode_line_p
19341 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19342 || (WINDOWP (f
->tool_bar_window
)
19343 && it
->w
== XWINDOW (f
->tool_bar_window
))
19347 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19348 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19350 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19351 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19353 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19355 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19356 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19358 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19359 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19361 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19364 #ifdef HAVE_WINDOW_SYSTEM
19365 if (it
->glyph_row
->reversed_p
)
19367 /* Prepend a stretch glyph to the row, such that the
19368 rightmost glyph will be drawn flushed all the way to the
19369 right margin of the window. The stretch glyph that will
19370 occupy the empty space, if any, to the left of the
19372 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19373 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19374 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19376 int row_width
, stretch_ascent
, stretch_width
;
19377 struct text_pos saved_pos
;
19378 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19380 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19381 row_width
+= g
->pixel_width
;
19382 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19383 if (stretch_width
> 0)
19386 (((it
->ascent
+ it
->descent
)
19387 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19388 saved_pos
= it
->position
;
19389 memset (&it
->position
, 0, sizeof it
->position
);
19390 saved_avoid_cursor
= it
->avoid_cursor_p
;
19391 it
->avoid_cursor_p
= 1;
19392 saved_face_id
= it
->face_id
;
19393 saved_box_start
= it
->start_of_box_run_p
;
19394 /* The last row's stretch glyph should get the default
19395 face, to avoid painting the rest of the window with
19396 the region face, if the region ends at ZV. */
19397 if (it
->glyph_row
->ends_at_zv_p
)
19398 it
->face_id
= default_face
->id
;
19400 it
->face_id
= face
->id
;
19401 it
->start_of_box_run_p
= 0;
19402 append_stretch_glyph (it
, make_number (0), stretch_width
,
19403 it
->ascent
+ it
->descent
, stretch_ascent
);
19404 it
->position
= saved_pos
;
19405 it
->avoid_cursor_p
= saved_avoid_cursor
;
19406 it
->face_id
= saved_face_id
;
19407 it
->start_of_box_run_p
= saved_box_start
;
19409 /* If stretch_width comes out negative, it means that the
19410 last glyph is only partially visible. In R2L rows, we
19411 want the leftmost glyph to be partially visible, so we
19412 need to give the row the corresponding left offset. */
19413 if (stretch_width
< 0)
19414 it
->glyph_row
->x
= stretch_width
;
19416 #endif /* HAVE_WINDOW_SYSTEM */
19420 /* Save some values that must not be changed. */
19421 int saved_x
= it
->current_x
;
19422 struct text_pos saved_pos
;
19423 Lisp_Object saved_object
;
19424 enum display_element_type saved_what
= it
->what
;
19425 int saved_face_id
= it
->face_id
;
19427 saved_object
= it
->object
;
19428 saved_pos
= it
->position
;
19430 it
->what
= IT_CHARACTER
;
19431 memset (&it
->position
, 0, sizeof it
->position
);
19432 it
->object
= make_number (0);
19433 it
->c
= it
->char_to_display
= ' ';
19436 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19437 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19438 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19439 && !it
->glyph_row
->mode_line_p
19440 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19442 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19443 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19445 for (it
->current_x
= 0; g
< e
; g
++)
19446 it
->current_x
+= g
->pixel_width
;
19448 it
->area
= LEFT_MARGIN_AREA
;
19449 it
->face_id
= default_face
->id
;
19450 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19451 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19453 PRODUCE_GLYPHS (it
);
19454 /* term.c:produce_glyphs advances it->current_x only for
19456 it
->current_x
+= it
->pixel_width
;
19459 it
->current_x
= saved_x
;
19460 it
->area
= TEXT_AREA
;
19463 /* The last row's blank glyphs should get the default face, to
19464 avoid painting the rest of the window with the region face,
19465 if the region ends at ZV. */
19466 if (it
->glyph_row
->ends_at_zv_p
)
19467 it
->face_id
= default_face
->id
;
19469 it
->face_id
= face
->id
;
19470 PRODUCE_GLYPHS (it
);
19472 while (it
->current_x
<= it
->last_visible_x
)
19473 PRODUCE_GLYPHS (it
);
19475 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19476 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19477 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19478 && !it
->glyph_row
->mode_line_p
19479 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19481 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19482 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19484 for ( ; g
< e
; g
++)
19485 it
->current_x
+= g
->pixel_width
;
19487 it
->area
= RIGHT_MARGIN_AREA
;
19488 it
->face_id
= default_face
->id
;
19489 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19490 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19492 PRODUCE_GLYPHS (it
);
19493 it
->current_x
+= it
->pixel_width
;
19496 it
->area
= TEXT_AREA
;
19499 /* Don't count these blanks really. It would let us insert a left
19500 truncation glyph below and make us set the cursor on them, maybe. */
19501 it
->current_x
= saved_x
;
19502 it
->object
= saved_object
;
19503 it
->position
= saved_pos
;
19504 it
->what
= saved_what
;
19505 it
->face_id
= saved_face_id
;
19510 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19511 trailing whitespace. */
19514 trailing_whitespace_p (ptrdiff_t charpos
)
19516 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19519 while (bytepos
< ZV_BYTE
19520 && (c
= FETCH_CHAR (bytepos
),
19521 c
== ' ' || c
== '\t'))
19524 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19526 if (bytepos
!= PT_BYTE
)
19533 /* Highlight trailing whitespace, if any, in ROW. */
19536 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19538 int used
= row
->used
[TEXT_AREA
];
19542 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19543 struct glyph
*glyph
= start
+ used
- 1;
19545 if (row
->reversed_p
)
19547 /* Right-to-left rows need to be processed in the opposite
19548 direction, so swap the edge pointers. */
19550 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19553 /* Skip over glyphs inserted to display the cursor at the
19554 end of a line, for extending the face of the last glyph
19555 to the end of the line on terminals, and for truncation
19556 and continuation glyphs. */
19557 if (!row
->reversed_p
)
19559 while (glyph
>= start
19560 && glyph
->type
== CHAR_GLYPH
19561 && INTEGERP (glyph
->object
))
19566 while (glyph
<= start
19567 && glyph
->type
== CHAR_GLYPH
19568 && INTEGERP (glyph
->object
))
19572 /* If last glyph is a space or stretch, and it's trailing
19573 whitespace, set the face of all trailing whitespace glyphs in
19574 IT->glyph_row to `trailing-whitespace'. */
19575 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19576 && BUFFERP (glyph
->object
)
19577 && (glyph
->type
== STRETCH_GLYPH
19578 || (glyph
->type
== CHAR_GLYPH
19579 && glyph
->u
.ch
== ' '))
19580 && trailing_whitespace_p (glyph
->charpos
))
19582 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19586 if (!row
->reversed_p
)
19588 while (glyph
>= start
19589 && BUFFERP (glyph
->object
)
19590 && (glyph
->type
== STRETCH_GLYPH
19591 || (glyph
->type
== CHAR_GLYPH
19592 && glyph
->u
.ch
== ' ')))
19593 (glyph
--)->face_id
= face_id
;
19597 while (glyph
<= start
19598 && BUFFERP (glyph
->object
)
19599 && (glyph
->type
== STRETCH_GLYPH
19600 || (glyph
->type
== CHAR_GLYPH
19601 && glyph
->u
.ch
== ' ')))
19602 (glyph
++)->face_id
= face_id
;
19609 /* Value is non-zero if glyph row ROW should be
19610 considered to hold the buffer position CHARPOS. */
19613 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19617 if (charpos
== CHARPOS (row
->end
.pos
)
19618 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19620 /* Suppose the row ends on a string.
19621 Unless the row is continued, that means it ends on a newline
19622 in the string. If it's anything other than a display string
19623 (e.g., a before-string from an overlay), we don't want the
19624 cursor there. (This heuristic seems to give the optimal
19625 behavior for the various types of multi-line strings.)
19626 One exception: if the string has `cursor' property on one of
19627 its characters, we _do_ want the cursor there. */
19628 if (CHARPOS (row
->end
.string_pos
) >= 0)
19630 if (row
->continued_p
)
19634 /* Check for `display' property. */
19635 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19636 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19637 struct glyph
*glyph
;
19640 for (glyph
= end
; glyph
>= beg
; --glyph
)
19641 if (STRINGP (glyph
->object
))
19644 = Fget_char_property (make_number (charpos
),
19648 && display_prop_string_p (prop
, glyph
->object
));
19649 /* If there's a `cursor' property on one of the
19650 string's characters, this row is a cursor row,
19651 even though this is not a display string. */
19654 Lisp_Object s
= glyph
->object
;
19656 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19658 ptrdiff_t gpos
= glyph
->charpos
;
19660 if (!NILP (Fget_char_property (make_number (gpos
),
19672 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19674 /* If the row ends in middle of a real character,
19675 and the line is continued, we want the cursor here.
19676 That's because CHARPOS (ROW->end.pos) would equal
19677 PT if PT is before the character. */
19678 if (!row
->ends_in_ellipsis_p
)
19679 result
= row
->continued_p
;
19681 /* If the row ends in an ellipsis, then
19682 CHARPOS (ROW->end.pos) will equal point after the
19683 invisible text. We want that position to be displayed
19684 after the ellipsis. */
19687 /* If the row ends at ZV, display the cursor at the end of that
19688 row instead of at the start of the row below. */
19689 else if (row
->ends_at_zv_p
)
19698 /* Value is non-zero if glyph row ROW should be
19699 used to hold the cursor. */
19702 cursor_row_p (struct glyph_row
*row
)
19704 return row_for_charpos_p (row
, PT
);
19709 /* Push the property PROP so that it will be rendered at the current
19710 position in IT. Return 1 if PROP was successfully pushed, 0
19711 otherwise. Called from handle_line_prefix to handle the
19712 `line-prefix' and `wrap-prefix' properties. */
19715 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19717 struct text_pos pos
=
19718 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19720 eassert (it
->method
== GET_FROM_BUFFER
19721 || it
->method
== GET_FROM_DISPLAY_VECTOR
19722 || it
->method
== GET_FROM_STRING
);
19724 /* We need to save the current buffer/string position, so it will be
19725 restored by pop_it, because iterate_out_of_display_property
19726 depends on that being set correctly, but some situations leave
19727 it->position not yet set when this function is called. */
19728 push_it (it
, &pos
);
19730 if (STRINGP (prop
))
19732 if (SCHARS (prop
) == 0)
19739 it
->string_from_prefix_prop_p
= 1;
19740 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19741 it
->current
.overlay_string_index
= -1;
19742 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19743 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19744 it
->method
= GET_FROM_STRING
;
19745 it
->stop_charpos
= 0;
19747 it
->base_level_stop
= 0;
19749 /* Force paragraph direction to be that of the parent
19751 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19752 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19754 it
->paragraph_embedding
= L2R
;
19756 /* Set up the bidi iterator for this display string. */
19759 it
->bidi_it
.string
.lstring
= it
->string
;
19760 it
->bidi_it
.string
.s
= NULL
;
19761 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19762 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19763 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19764 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19765 it
->bidi_it
.w
= it
->w
;
19766 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19769 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19771 it
->method
= GET_FROM_STRETCH
;
19774 #ifdef HAVE_WINDOW_SYSTEM
19775 else if (IMAGEP (prop
))
19777 it
->what
= IT_IMAGE
;
19778 it
->image_id
= lookup_image (it
->f
, prop
);
19779 it
->method
= GET_FROM_IMAGE
;
19781 #endif /* HAVE_WINDOW_SYSTEM */
19784 pop_it (it
); /* bogus display property, give up */
19791 /* Return the character-property PROP at the current position in IT. */
19794 get_it_property (struct it
*it
, Lisp_Object prop
)
19796 Lisp_Object position
, object
= it
->object
;
19798 if (STRINGP (object
))
19799 position
= make_number (IT_STRING_CHARPOS (*it
));
19800 else if (BUFFERP (object
))
19802 position
= make_number (IT_CHARPOS (*it
));
19803 object
= it
->window
;
19808 return Fget_char_property (position
, prop
, object
);
19811 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19814 handle_line_prefix (struct it
*it
)
19816 Lisp_Object prefix
;
19818 if (it
->continuation_lines_width
> 0)
19820 prefix
= get_it_property (it
, Qwrap_prefix
);
19822 prefix
= Vwrap_prefix
;
19826 prefix
= get_it_property (it
, Qline_prefix
);
19828 prefix
= Vline_prefix
;
19830 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19832 /* If the prefix is wider than the window, and we try to wrap
19833 it, it would acquire its own wrap prefix, and so on till the
19834 iterator stack overflows. So, don't wrap the prefix. */
19835 it
->line_wrap
= TRUNCATE
;
19836 it
->avoid_cursor_p
= 1;
19842 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19843 only for R2L lines from display_line and display_string, when they
19844 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19845 the line/string needs to be continued on the next glyph row. */
19847 unproduce_glyphs (struct it
*it
, int n
)
19849 struct glyph
*glyph
, *end
;
19851 eassert (it
->glyph_row
);
19852 eassert (it
->glyph_row
->reversed_p
);
19853 eassert (it
->area
== TEXT_AREA
);
19854 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19856 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19857 n
= it
->glyph_row
->used
[TEXT_AREA
];
19858 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19859 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19860 for ( ; glyph
< end
; glyph
++)
19861 glyph
[-n
] = *glyph
;
19864 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19865 and ROW->maxpos. */
19867 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19868 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19869 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19871 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19872 lines' rows is implemented for bidi-reordered rows. */
19874 /* ROW->minpos is the value of min_pos, the minimal buffer position
19875 we have in ROW, or ROW->start.pos if that is smaller. */
19876 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19877 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19879 /* We didn't find buffer positions smaller than ROW->start, or
19880 didn't find _any_ valid buffer positions in any of the glyphs,
19881 so we must trust the iterator's computed positions. */
19882 row
->minpos
= row
->start
.pos
;
19885 max_pos
= CHARPOS (it
->current
.pos
);
19886 max_bpos
= BYTEPOS (it
->current
.pos
);
19889 /* Here are the various use-cases for ending the row, and the
19890 corresponding values for ROW->maxpos:
19892 Line ends in a newline from buffer eol_pos + 1
19893 Line is continued from buffer max_pos + 1
19894 Line is truncated on right it->current.pos
19895 Line ends in a newline from string max_pos + 1(*)
19896 (*) + 1 only when line ends in a forward scan
19897 Line is continued from string max_pos
19898 Line is continued from display vector max_pos
19899 Line is entirely from a string min_pos == max_pos
19900 Line is entirely from a display vector min_pos == max_pos
19901 Line that ends at ZV ZV
19903 If you discover other use-cases, please add them here as
19905 if (row
->ends_at_zv_p
)
19906 row
->maxpos
= it
->current
.pos
;
19907 else if (row
->used
[TEXT_AREA
])
19909 int seen_this_string
= 0;
19910 struct glyph_row
*r1
= row
- 1;
19912 /* Did we see the same display string on the previous row? */
19913 if (STRINGP (it
->object
)
19914 /* this is not the first row */
19915 && row
> it
->w
->desired_matrix
->rows
19916 /* previous row is not the header line */
19917 && !r1
->mode_line_p
19918 /* previous row also ends in a newline from a string */
19919 && r1
->ends_in_newline_from_string_p
)
19921 struct glyph
*start
, *end
;
19923 /* Search for the last glyph of the previous row that came
19924 from buffer or string. Depending on whether the row is
19925 L2R or R2L, we need to process it front to back or the
19926 other way round. */
19927 if (!r1
->reversed_p
)
19929 start
= r1
->glyphs
[TEXT_AREA
];
19930 end
= start
+ r1
->used
[TEXT_AREA
];
19931 /* Glyphs inserted by redisplay have an integer (zero)
19932 as their object. */
19934 && INTEGERP ((end
- 1)->object
)
19935 && (end
- 1)->charpos
<= 0)
19939 if (EQ ((end
- 1)->object
, it
->object
))
19940 seen_this_string
= 1;
19943 /* If all the glyphs of the previous row were inserted
19944 by redisplay, it means the previous row was
19945 produced from a single newline, which is only
19946 possible if that newline came from the same string
19947 as the one which produced this ROW. */
19948 seen_this_string
= 1;
19952 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19953 start
= end
+ r1
->used
[TEXT_AREA
];
19955 && INTEGERP ((end
+ 1)->object
)
19956 && (end
+ 1)->charpos
<= 0)
19960 if (EQ ((end
+ 1)->object
, it
->object
))
19961 seen_this_string
= 1;
19964 seen_this_string
= 1;
19967 /* Take note of each display string that covers a newline only
19968 once, the first time we see it. This is for when a display
19969 string includes more than one newline in it. */
19970 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19972 /* If we were scanning the buffer forward when we displayed
19973 the string, we want to account for at least one buffer
19974 position that belongs to this row (position covered by
19975 the display string), so that cursor positioning will
19976 consider this row as a candidate when point is at the end
19977 of the visual line represented by this row. This is not
19978 required when scanning back, because max_pos will already
19979 have a much larger value. */
19980 if (CHARPOS (row
->end
.pos
) > max_pos
)
19981 INC_BOTH (max_pos
, max_bpos
);
19982 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19984 else if (CHARPOS (it
->eol_pos
) > 0)
19985 SET_TEXT_POS (row
->maxpos
,
19986 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19987 else if (row
->continued_p
)
19989 /* If max_pos is different from IT's current position, it
19990 means IT->method does not belong to the display element
19991 at max_pos. However, it also means that the display
19992 element at max_pos was displayed in its entirety on this
19993 line, which is equivalent to saying that the next line
19994 starts at the next buffer position. */
19995 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19996 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19999 INC_BOTH (max_pos
, max_bpos
);
20000 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20003 else if (row
->truncated_on_right_p
)
20004 /* display_line already called reseat_at_next_visible_line_start,
20005 which puts the iterator at the beginning of the next line, in
20006 the logical order. */
20007 row
->maxpos
= it
->current
.pos
;
20008 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20009 /* A line that is entirely from a string/image/stretch... */
20010 row
->maxpos
= row
->minpos
;
20015 row
->maxpos
= it
->current
.pos
;
20018 /* Construct the glyph row IT->glyph_row in the desired matrix of
20019 IT->w from text at the current position of IT. See dispextern.h
20020 for an overview of struct it. Value is non-zero if
20021 IT->glyph_row displays text, as opposed to a line displaying ZV
20025 display_line (struct it
*it
)
20027 struct glyph_row
*row
= it
->glyph_row
;
20028 Lisp_Object overlay_arrow_string
;
20030 void *wrap_data
= NULL
;
20031 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20032 int wrap_row_used
= -1;
20033 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20034 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20035 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20036 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20037 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20039 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20040 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20041 bool pending_handle_line_prefix
= false;
20043 /* We always start displaying at hpos zero even if hscrolled. */
20044 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20046 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20047 >= it
->w
->desired_matrix
->nrows
)
20049 it
->w
->nrows_scale_factor
++;
20050 it
->f
->fonts_changed
= 1;
20054 /* Clear the result glyph row and enable it. */
20055 prepare_desired_row (it
->w
, row
, false);
20057 row
->y
= it
->current_y
;
20058 row
->start
= it
->start
;
20059 row
->continuation_lines_width
= it
->continuation_lines_width
;
20060 row
->displays_text_p
= 1;
20061 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20062 it
->starts_in_middle_of_char_p
= 0;
20064 /* Arrange the overlays nicely for our purposes. Usually, we call
20065 display_line on only one line at a time, in which case this
20066 can't really hurt too much, or we call it on lines which appear
20067 one after another in the buffer, in which case all calls to
20068 recenter_overlay_lists but the first will be pretty cheap. */
20069 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20071 /* Move over display elements that are not visible because we are
20072 hscrolled. This may stop at an x-position < IT->first_visible_x
20073 if the first glyph is partially visible or if we hit a line end. */
20074 if (it
->current_x
< it
->first_visible_x
)
20076 enum move_it_result move_result
;
20078 this_line_min_pos
= row
->start
.pos
;
20079 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20080 MOVE_TO_POS
| MOVE_TO_X
);
20081 /* If we are under a large hscroll, move_it_in_display_line_to
20082 could hit the end of the line without reaching
20083 it->first_visible_x. Pretend that we did reach it. This is
20084 especially important on a TTY, where we will call
20085 extend_face_to_end_of_line, which needs to know how many
20086 blank glyphs to produce. */
20087 if (it
->current_x
< it
->first_visible_x
20088 && (move_result
== MOVE_NEWLINE_OR_CR
20089 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20090 it
->current_x
= it
->first_visible_x
;
20092 /* Record the smallest positions seen while we moved over
20093 display elements that are not visible. This is needed by
20094 redisplay_internal for optimizing the case where the cursor
20095 stays inside the same line. The rest of this function only
20096 considers positions that are actually displayed, so
20097 RECORD_MAX_MIN_POS will not otherwise record positions that
20098 are hscrolled to the left of the left edge of the window. */
20099 min_pos
= CHARPOS (this_line_min_pos
);
20100 min_bpos
= BYTEPOS (this_line_min_pos
);
20102 else if (it
->area
== TEXT_AREA
)
20104 /* We only do this when not calling move_it_in_display_line_to
20105 above, because that function calls itself handle_line_prefix. */
20106 handle_line_prefix (it
);
20110 /* Line-prefix and wrap-prefix are always displayed in the text
20111 area. But if this is the first call to display_line after
20112 init_iterator, the iterator might have been set up to write
20113 into a marginal area, e.g. if the line begins with some
20114 display property that writes to the margins. So we need to
20115 wait with the call to handle_line_prefix until whatever
20116 writes to the margin has done its job. */
20117 pending_handle_line_prefix
= true;
20120 /* Get the initial row height. This is either the height of the
20121 text hscrolled, if there is any, or zero. */
20122 row
->ascent
= it
->max_ascent
;
20123 row
->height
= it
->max_ascent
+ it
->max_descent
;
20124 row
->phys_ascent
= it
->max_phys_ascent
;
20125 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20126 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20128 /* Utility macro to record max and min buffer positions seen until now. */
20129 #define RECORD_MAX_MIN_POS(IT) \
20132 int composition_p = !STRINGP ((IT)->string) \
20133 && ((IT)->what == IT_COMPOSITION); \
20134 ptrdiff_t current_pos = \
20135 composition_p ? (IT)->cmp_it.charpos \
20136 : IT_CHARPOS (*(IT)); \
20137 ptrdiff_t current_bpos = \
20138 composition_p ? CHAR_TO_BYTE (current_pos) \
20139 : IT_BYTEPOS (*(IT)); \
20140 if (current_pos < min_pos) \
20142 min_pos = current_pos; \
20143 min_bpos = current_bpos; \
20145 if (IT_CHARPOS (*it) > max_pos) \
20147 max_pos = IT_CHARPOS (*it); \
20148 max_bpos = IT_BYTEPOS (*it); \
20153 /* Loop generating characters. The loop is left with IT on the next
20154 character to display. */
20157 int n_glyphs_before
, hpos_before
, x_before
;
20159 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20161 /* Retrieve the next thing to display. Value is zero if end of
20163 if (!get_next_display_element (it
))
20165 /* Maybe add a space at the end of this line that is used to
20166 display the cursor there under X. Set the charpos of the
20167 first glyph of blank lines not corresponding to any text
20169 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20170 row
->exact_window_width_line_p
= 1;
20171 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20172 || row
->used
[TEXT_AREA
] == 0)
20174 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20175 row
->displays_text_p
= 0;
20177 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20178 && (!MINI_WINDOW_P (it
->w
)
20179 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20180 row
->indicate_empty_line_p
= 1;
20183 it
->continuation_lines_width
= 0;
20184 row
->ends_at_zv_p
= 1;
20185 /* A row that displays right-to-left text must always have
20186 its last face extended all the way to the end of line,
20187 even if this row ends in ZV, because we still write to
20188 the screen left to right. We also need to extend the
20189 last face if the default face is remapped to some
20190 different face, otherwise the functions that clear
20191 portions of the screen will clear with the default face's
20192 background color. */
20193 if (row
->reversed_p
20194 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20195 extend_face_to_end_of_line (it
);
20199 /* Now, get the metrics of what we want to display. This also
20200 generates glyphs in `row' (which is IT->glyph_row). */
20201 n_glyphs_before
= row
->used
[TEXT_AREA
];
20204 /* Remember the line height so far in case the next element doesn't
20205 fit on the line. */
20206 if (it
->line_wrap
!= TRUNCATE
)
20208 ascent
= it
->max_ascent
;
20209 descent
= it
->max_descent
;
20210 phys_ascent
= it
->max_phys_ascent
;
20211 phys_descent
= it
->max_phys_descent
;
20213 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20215 if (IT_DISPLAYING_WHITESPACE (it
))
20219 SAVE_IT (wrap_it
, *it
, wrap_data
);
20221 wrap_row_used
= row
->used
[TEXT_AREA
];
20222 wrap_row_ascent
= row
->ascent
;
20223 wrap_row_height
= row
->height
;
20224 wrap_row_phys_ascent
= row
->phys_ascent
;
20225 wrap_row_phys_height
= row
->phys_height
;
20226 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20227 wrap_row_min_pos
= min_pos
;
20228 wrap_row_min_bpos
= min_bpos
;
20229 wrap_row_max_pos
= max_pos
;
20230 wrap_row_max_bpos
= max_bpos
;
20236 PRODUCE_GLYPHS (it
);
20238 /* If this display element was in marginal areas, continue with
20240 if (it
->area
!= TEXT_AREA
)
20242 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20243 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20244 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20245 row
->phys_height
= max (row
->phys_height
,
20246 it
->max_phys_ascent
+ it
->max_phys_descent
);
20247 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20248 it
->max_extra_line_spacing
);
20249 set_iterator_to_next (it
, 1);
20250 /* If we didn't handle the line/wrap prefix above, and the
20251 call to set_iterator_to_next just switched to TEXT_AREA,
20252 process the prefix now. */
20253 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20255 pending_handle_line_prefix
= false;
20256 handle_line_prefix (it
);
20261 /* Does the display element fit on the line? If we truncate
20262 lines, we should draw past the right edge of the window. If
20263 we don't truncate, we want to stop so that we can display the
20264 continuation glyph before the right margin. If lines are
20265 continued, there are two possible strategies for characters
20266 resulting in more than 1 glyph (e.g. tabs): Display as many
20267 glyphs as possible in this line and leave the rest for the
20268 continuation line, or display the whole element in the next
20269 line. Original redisplay did the former, so we do it also. */
20270 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20271 hpos_before
= it
->hpos
;
20274 if (/* Not a newline. */
20276 /* Glyphs produced fit entirely in the line. */
20277 && it
->current_x
< it
->last_visible_x
)
20279 it
->hpos
+= nglyphs
;
20280 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20281 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20282 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20283 row
->phys_height
= max (row
->phys_height
,
20284 it
->max_phys_ascent
+ it
->max_phys_descent
);
20285 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20286 it
->max_extra_line_spacing
);
20287 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20288 /* In R2L rows, we arrange in extend_face_to_end_of_line
20289 to add a right offset to the line, by a suitable
20290 change to the stretch glyph that is the leftmost
20291 glyph of the line. */
20292 && !row
->reversed_p
)
20293 row
->x
= x
- it
->first_visible_x
;
20294 /* Record the maximum and minimum buffer positions seen so
20295 far in glyphs that will be displayed by this row. */
20297 RECORD_MAX_MIN_POS (it
);
20302 struct glyph
*glyph
;
20304 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20306 /* Identify the glyphs added by the last call to
20307 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20308 the previous glyphs. */
20309 if (!row
->reversed_p
)
20310 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20312 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20313 new_x
= x
+ glyph
->pixel_width
;
20315 if (/* Lines are continued. */
20316 it
->line_wrap
!= TRUNCATE
20317 && (/* Glyph doesn't fit on the line. */
20318 new_x
> it
->last_visible_x
20319 /* Or it fits exactly on a window system frame. */
20320 || (new_x
== it
->last_visible_x
20321 && FRAME_WINDOW_P (it
->f
)
20322 && (row
->reversed_p
20323 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20324 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20326 /* End of a continued line. */
20329 || (new_x
== it
->last_visible_x
20330 && FRAME_WINDOW_P (it
->f
)
20331 && (row
->reversed_p
20332 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20333 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20335 /* Current glyph is the only one on the line or
20336 fits exactly on the line. We must continue
20337 the line because we can't draw the cursor
20338 after the glyph. */
20339 row
->continued_p
= 1;
20340 it
->current_x
= new_x
;
20341 it
->continuation_lines_width
+= new_x
;
20343 if (i
== nglyphs
- 1)
20345 /* If line-wrap is on, check if a previous
20346 wrap point was found. */
20347 if (wrap_row_used
> 0
20348 /* Even if there is a previous wrap
20349 point, continue the line here as
20350 usual, if (i) the previous character
20351 was a space or tab AND (ii) the
20352 current character is not. */
20354 || IT_DISPLAYING_WHITESPACE (it
)))
20357 /* Record the maximum and minimum buffer
20358 positions seen so far in glyphs that will be
20359 displayed by this row. */
20361 RECORD_MAX_MIN_POS (it
);
20362 set_iterator_to_next (it
, 1);
20363 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20365 if (!get_next_display_element (it
))
20367 row
->exact_window_width_line_p
= 1;
20368 it
->continuation_lines_width
= 0;
20369 row
->continued_p
= 0;
20370 row
->ends_at_zv_p
= 1;
20372 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20374 row
->continued_p
= 0;
20375 row
->exact_window_width_line_p
= 1;
20379 else if (it
->bidi_p
)
20380 RECORD_MAX_MIN_POS (it
);
20381 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20382 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20383 extend_face_to_end_of_line (it
);
20385 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20386 && !FRAME_WINDOW_P (it
->f
))
20388 /* A padding glyph that doesn't fit on this line.
20389 This means the whole character doesn't fit
20391 if (row
->reversed_p
)
20392 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20393 - n_glyphs_before
);
20394 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20396 /* Fill the rest of the row with continuation
20397 glyphs like in 20.x. */
20398 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20399 < row
->glyphs
[1 + TEXT_AREA
])
20400 produce_special_glyphs (it
, IT_CONTINUATION
);
20402 row
->continued_p
= 1;
20403 it
->current_x
= x_before
;
20404 it
->continuation_lines_width
+= x_before
;
20406 /* Restore the height to what it was before the
20407 element not fitting on the line. */
20408 it
->max_ascent
= ascent
;
20409 it
->max_descent
= descent
;
20410 it
->max_phys_ascent
= phys_ascent
;
20411 it
->max_phys_descent
= phys_descent
;
20412 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20413 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20414 extend_face_to_end_of_line (it
);
20416 else if (wrap_row_used
> 0)
20419 if (row
->reversed_p
)
20420 unproduce_glyphs (it
,
20421 row
->used
[TEXT_AREA
] - wrap_row_used
);
20422 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20423 it
->continuation_lines_width
+= wrap_x
;
20424 row
->used
[TEXT_AREA
] = wrap_row_used
;
20425 row
->ascent
= wrap_row_ascent
;
20426 row
->height
= wrap_row_height
;
20427 row
->phys_ascent
= wrap_row_phys_ascent
;
20428 row
->phys_height
= wrap_row_phys_height
;
20429 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20430 min_pos
= wrap_row_min_pos
;
20431 min_bpos
= wrap_row_min_bpos
;
20432 max_pos
= wrap_row_max_pos
;
20433 max_bpos
= wrap_row_max_bpos
;
20434 row
->continued_p
= 1;
20435 row
->ends_at_zv_p
= 0;
20436 row
->exact_window_width_line_p
= 0;
20437 it
->continuation_lines_width
+= x
;
20439 /* Make sure that a non-default face is extended
20440 up to the right margin of the window. */
20441 extend_face_to_end_of_line (it
);
20443 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20445 /* A TAB that extends past the right edge of the
20446 window. This produces a single glyph on
20447 window system frames. We leave the glyph in
20448 this row and let it fill the row, but don't
20449 consume the TAB. */
20450 if ((row
->reversed_p
20451 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20452 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20453 produce_special_glyphs (it
, IT_CONTINUATION
);
20454 it
->continuation_lines_width
+= it
->last_visible_x
;
20455 row
->ends_in_middle_of_char_p
= 1;
20456 row
->continued_p
= 1;
20457 glyph
->pixel_width
= it
->last_visible_x
- x
;
20458 it
->starts_in_middle_of_char_p
= 1;
20459 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20460 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20461 extend_face_to_end_of_line (it
);
20465 /* Something other than a TAB that draws past
20466 the right edge of the window. Restore
20467 positions to values before the element. */
20468 if (row
->reversed_p
)
20469 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20470 - (n_glyphs_before
+ i
));
20471 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20473 /* Display continuation glyphs. */
20474 it
->current_x
= x_before
;
20475 it
->continuation_lines_width
+= x
;
20476 if (!FRAME_WINDOW_P (it
->f
)
20477 || (row
->reversed_p
20478 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20479 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20480 produce_special_glyphs (it
, IT_CONTINUATION
);
20481 row
->continued_p
= 1;
20483 extend_face_to_end_of_line (it
);
20485 if (nglyphs
> 1 && i
> 0)
20487 row
->ends_in_middle_of_char_p
= 1;
20488 it
->starts_in_middle_of_char_p
= 1;
20491 /* Restore the height to what it was before the
20492 element not fitting on the line. */
20493 it
->max_ascent
= ascent
;
20494 it
->max_descent
= descent
;
20495 it
->max_phys_ascent
= phys_ascent
;
20496 it
->max_phys_descent
= phys_descent
;
20501 else if (new_x
> it
->first_visible_x
)
20503 /* Increment number of glyphs actually displayed. */
20506 /* Record the maximum and minimum buffer positions
20507 seen so far in glyphs that will be displayed by
20510 RECORD_MAX_MIN_POS (it
);
20512 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20513 /* Glyph is partially visible, i.e. row starts at
20514 negative X position. Don't do that in R2L
20515 rows, where we arrange to add a right offset to
20516 the line in extend_face_to_end_of_line, by a
20517 suitable change to the stretch glyph that is
20518 the leftmost glyph of the line. */
20519 row
->x
= x
- it
->first_visible_x
;
20520 /* When the last glyph of an R2L row only fits
20521 partially on the line, we need to set row->x to a
20522 negative offset, so that the leftmost glyph is
20523 the one that is partially visible. */
20524 if (row
->reversed_p
&& new_x
> it
->last_visible_x
)
20525 row
->x
= it
->last_visible_x
- new_x
;
20529 /* Glyph is completely off the left margin of the
20530 window. This should not happen because of the
20531 move_it_in_display_line at the start of this
20532 function, unless the text display area of the
20533 window is empty. */
20534 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20537 /* Even if this display element produced no glyphs at all,
20538 we want to record its position. */
20539 if (it
->bidi_p
&& nglyphs
== 0)
20540 RECORD_MAX_MIN_POS (it
);
20542 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20543 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20544 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20545 row
->phys_height
= max (row
->phys_height
,
20546 it
->max_phys_ascent
+ it
->max_phys_descent
);
20547 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20548 it
->max_extra_line_spacing
);
20550 /* End of this display line if row is continued. */
20551 if (row
->continued_p
|| row
->ends_at_zv_p
)
20556 /* Is this a line end? If yes, we're also done, after making
20557 sure that a non-default face is extended up to the right
20558 margin of the window. */
20559 if (ITERATOR_AT_END_OF_LINE_P (it
))
20561 int used_before
= row
->used
[TEXT_AREA
];
20563 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20565 /* Add a space at the end of the line that is used to
20566 display the cursor there. */
20567 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20568 append_space_for_newline (it
, 0);
20570 /* Extend the face to the end of the line. */
20571 extend_face_to_end_of_line (it
);
20573 /* Make sure we have the position. */
20574 if (used_before
== 0)
20575 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20577 /* Record the position of the newline, for use in
20579 it
->eol_pos
= it
->current
.pos
;
20581 /* Consume the line end. This skips over invisible lines. */
20582 set_iterator_to_next (it
, 1);
20583 it
->continuation_lines_width
= 0;
20587 /* Proceed with next display element. Note that this skips
20588 over lines invisible because of selective display. */
20589 set_iterator_to_next (it
, 1);
20591 /* If we truncate lines, we are done when the last displayed
20592 glyphs reach past the right margin of the window. */
20593 if (it
->line_wrap
== TRUNCATE
20594 && ((FRAME_WINDOW_P (it
->f
)
20595 /* Images are preprocessed in produce_image_glyph such
20596 that they are cropped at the right edge of the
20597 window, so an image glyph will always end exactly at
20598 last_visible_x, even if there's no right fringe. */
20599 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20600 ? (it
->current_x
>= it
->last_visible_x
)
20601 : (it
->current_x
> it
->last_visible_x
)))
20603 /* Maybe add truncation glyphs. */
20604 if (!FRAME_WINDOW_P (it
->f
)
20605 || (row
->reversed_p
20606 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20607 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20611 if (!row
->reversed_p
)
20613 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20614 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20619 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20620 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20622 /* Remove any padding glyphs at the front of ROW, to
20623 make room for the truncation glyphs we will be
20624 adding below. The loop below always inserts at
20625 least one truncation glyph, so also remove the
20626 last glyph added to ROW. */
20627 unproduce_glyphs (it
, i
+ 1);
20628 /* Adjust i for the loop below. */
20629 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20632 /* produce_special_glyphs overwrites the last glyph, so
20633 we don't want that if we want to keep that last
20634 glyph, which means it's an image. */
20635 if (it
->current_x
> it
->last_visible_x
)
20637 it
->current_x
= x_before
;
20638 if (!FRAME_WINDOW_P (it
->f
))
20640 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20642 row
->used
[TEXT_AREA
] = i
;
20643 produce_special_glyphs (it
, IT_TRUNCATION
);
20648 row
->used
[TEXT_AREA
] = i
;
20649 produce_special_glyphs (it
, IT_TRUNCATION
);
20651 it
->hpos
= hpos_before
;
20654 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20656 /* Don't truncate if we can overflow newline into fringe. */
20657 if (!get_next_display_element (it
))
20659 it
->continuation_lines_width
= 0;
20660 row
->ends_at_zv_p
= 1;
20661 row
->exact_window_width_line_p
= 1;
20664 if (ITERATOR_AT_END_OF_LINE_P (it
))
20666 row
->exact_window_width_line_p
= 1;
20667 goto at_end_of_line
;
20669 it
->current_x
= x_before
;
20670 it
->hpos
= hpos_before
;
20673 row
->truncated_on_right_p
= 1;
20674 it
->continuation_lines_width
= 0;
20675 reseat_at_next_visible_line_start (it
, 0);
20676 /* We insist below that IT's position be at ZV because in
20677 bidi-reordered lines the character at visible line start
20678 might not be the character that follows the newline in
20679 the logical order. */
20680 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20681 row
->ends_at_zv_p
=
20682 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20684 row
->ends_at_zv_p
= false;
20690 bidi_unshelve_cache (wrap_data
, 1);
20692 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20693 at the left window margin. */
20694 if (it
->first_visible_x
20695 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20697 if (!FRAME_WINDOW_P (it
->f
)
20698 || (((row
->reversed_p
20699 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20700 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20701 /* Don't let insert_left_trunc_glyphs overwrite the
20702 first glyph of the row if it is an image. */
20703 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20704 insert_left_trunc_glyphs (it
);
20705 row
->truncated_on_left_p
= 1;
20708 /* Remember the position at which this line ends.
20710 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20711 cannot be before the call to find_row_edges below, since that is
20712 where these positions are determined. */
20713 row
->end
= it
->current
;
20716 row
->minpos
= row
->start
.pos
;
20717 row
->maxpos
= row
->end
.pos
;
20721 /* ROW->minpos and ROW->maxpos must be the smallest and
20722 `1 + the largest' buffer positions in ROW. But if ROW was
20723 bidi-reordered, these two positions can be anywhere in the
20724 row, so we must determine them now. */
20725 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20728 /* If the start of this line is the overlay arrow-position, then
20729 mark this glyph row as the one containing the overlay arrow.
20730 This is clearly a mess with variable size fonts. It would be
20731 better to let it be displayed like cursors under X. */
20732 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20733 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20734 !NILP (overlay_arrow_string
)))
20736 /* Overlay arrow in window redisplay is a fringe bitmap. */
20737 if (STRINGP (overlay_arrow_string
))
20739 struct glyph_row
*arrow_row
20740 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20741 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20742 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20743 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20744 struct glyph
*p2
, *end
;
20746 /* Copy the arrow glyphs. */
20747 while (glyph
< arrow_end
)
20750 /* Throw away padding glyphs. */
20752 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20753 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20759 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20764 eassert (INTEGERP (overlay_arrow_string
));
20765 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20767 overlay_arrow_seen
= 1;
20770 /* Highlight trailing whitespace. */
20771 if (!NILP (Vshow_trailing_whitespace
))
20772 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20774 /* Compute pixel dimensions of this line. */
20775 compute_line_metrics (it
);
20777 /* Implementation note: No changes in the glyphs of ROW or in their
20778 faces can be done past this point, because compute_line_metrics
20779 computes ROW's hash value and stores it within the glyph_row
20782 /* Record whether this row ends inside an ellipsis. */
20783 row
->ends_in_ellipsis_p
20784 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20785 && it
->ellipsis_p
);
20787 /* Save fringe bitmaps in this row. */
20788 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20789 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20790 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20791 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20793 it
->left_user_fringe_bitmap
= 0;
20794 it
->left_user_fringe_face_id
= 0;
20795 it
->right_user_fringe_bitmap
= 0;
20796 it
->right_user_fringe_face_id
= 0;
20798 /* Maybe set the cursor. */
20799 cvpos
= it
->w
->cursor
.vpos
;
20801 /* In bidi-reordered rows, keep checking for proper cursor
20802 position even if one has been found already, because buffer
20803 positions in such rows change non-linearly with ROW->VPOS,
20804 when a line is continued. One exception: when we are at ZV,
20805 display cursor on the first suitable glyph row, since all
20806 the empty rows after that also have their position set to ZV. */
20807 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20808 lines' rows is implemented for bidi-reordered rows. */
20810 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20811 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20812 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20813 && cursor_row_p (row
))
20814 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20816 /* Prepare for the next line. This line starts horizontally at (X
20817 HPOS) = (0 0). Vertical positions are incremented. As a
20818 convenience for the caller, IT->glyph_row is set to the next
20820 it
->current_x
= it
->hpos
= 0;
20821 it
->current_y
+= row
->height
;
20822 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20825 /* The next row should by default use the same value of the
20826 reversed_p flag as this one. set_iterator_to_next decides when
20827 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20828 the flag accordingly. */
20829 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20830 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20831 it
->start
= row
->end
;
20832 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20834 #undef RECORD_MAX_MIN_POS
20837 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20838 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20839 doc
: /* Return paragraph direction at point in BUFFER.
20840 Value is either `left-to-right' or `right-to-left'.
20841 If BUFFER is omitted or nil, it defaults to the current buffer.
20843 Paragraph direction determines how the text in the paragraph is displayed.
20844 In left-to-right paragraphs, text begins at the left margin of the window
20845 and the reading direction is generally left to right. In right-to-left
20846 paragraphs, text begins at the right margin and is read from right to left.
20848 See also `bidi-paragraph-direction'. */)
20849 (Lisp_Object buffer
)
20851 struct buffer
*buf
= current_buffer
;
20852 struct buffer
*old
= buf
;
20854 if (! NILP (buffer
))
20856 CHECK_BUFFER (buffer
);
20857 buf
= XBUFFER (buffer
);
20860 if (NILP (BVAR (buf
, bidi_display_reordering
))
20861 || NILP (BVAR (buf
, enable_multibyte_characters
))
20862 /* When we are loading loadup.el, the character property tables
20863 needed for bidi iteration are not yet available. */
20864 || !NILP (Vpurify_flag
))
20865 return Qleft_to_right
;
20866 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20867 return BVAR (buf
, bidi_paragraph_direction
);
20870 /* Determine the direction from buffer text. We could try to
20871 use current_matrix if it is up to date, but this seems fast
20872 enough as it is. */
20873 struct bidi_it itb
;
20874 ptrdiff_t pos
= BUF_PT (buf
);
20875 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20877 void *itb_data
= bidi_shelve_cache ();
20879 set_buffer_temp (buf
);
20880 /* bidi_paragraph_init finds the base direction of the paragraph
20881 by searching forward from paragraph start. We need the base
20882 direction of the current or _previous_ paragraph, so we need
20883 to make sure we are within that paragraph. To that end, find
20884 the previous non-empty line. */
20885 if (pos
>= ZV
&& pos
> BEGV
)
20886 DEC_BOTH (pos
, bytepos
);
20887 if (fast_looking_at (build_local_string ("[\f\t ]*\n"),
20888 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20890 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20891 || c
== ' ' || c
== '\t' || c
== '\f')
20893 if (bytepos
<= BEGV_BYTE
)
20898 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20901 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20902 itb
.paragraph_dir
= NEUTRAL_DIR
;
20903 itb
.string
.s
= NULL
;
20904 itb
.string
.lstring
= Qnil
;
20905 itb
.string
.bufpos
= 0;
20906 itb
.string
.from_disp_str
= 0;
20907 itb
.string
.unibyte
= 0;
20908 /* We have no window to use here for ignoring window-specific
20909 overlays. Using NULL for window pointer will cause
20910 compute_display_string_pos to use the current buffer. */
20912 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20913 bidi_unshelve_cache (itb_data
, 0);
20914 set_buffer_temp (old
);
20915 switch (itb
.paragraph_dir
)
20918 return Qleft_to_right
;
20921 return Qright_to_left
;
20929 DEFUN ("move-point-visually", Fmove_point_visually
,
20930 Smove_point_visually
, 1, 1, 0,
20931 doc
: /* Move point in the visual order in the specified DIRECTION.
20932 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20935 Value is the new character position of point. */)
20936 (Lisp_Object direction
)
20938 struct window
*w
= XWINDOW (selected_window
);
20939 struct buffer
*b
= XBUFFER (w
->contents
);
20940 struct glyph_row
*row
;
20942 Lisp_Object paragraph_dir
;
20944 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20945 (!(ROW)->continued_p \
20946 && INTEGERP ((GLYPH)->object) \
20947 && (GLYPH)->type == CHAR_GLYPH \
20948 && (GLYPH)->u.ch == ' ' \
20949 && (GLYPH)->charpos >= 0 \
20950 && !(GLYPH)->avoid_cursor_p)
20952 CHECK_NUMBER (direction
);
20953 dir
= XINT (direction
);
20959 /* If current matrix is up-to-date, we can use the information
20960 recorded in the glyphs, at least as long as the goal is on the
20962 if (w
->window_end_valid
20963 && !windows_or_buffers_changed
20965 && !b
->clip_changed
20966 && !b
->prevent_redisplay_optimizations_p
20967 && !window_outdated (w
)
20968 /* We rely below on the cursor coordinates to be up to date, but
20969 we cannot trust them if some command moved point since the
20970 last complete redisplay. */
20971 && w
->last_point
== BUF_PT (b
)
20972 && w
->cursor
.vpos
>= 0
20973 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20974 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20976 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20977 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20978 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20980 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20982 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20984 SET_PT (g
->charpos
);
20985 w
->cursor
.vpos
= -1;
20986 return make_number (PT
);
20988 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20992 if (BUFFERP (gpt
->object
))
20995 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20996 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20998 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21000 else if (BUFFERP (g
->object
))
21001 new_pos
= g
->charpos
;
21005 w
->cursor
.vpos
= -1;
21006 return make_number (PT
);
21008 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21010 /* Glyphs inserted at the end of a non-empty line for
21011 positioning the cursor have zero charpos, so we must
21012 deduce the value of point by other means. */
21013 if (g
->charpos
> 0)
21014 SET_PT (g
->charpos
);
21015 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21017 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21018 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21021 w
->cursor
.vpos
= -1;
21022 return make_number (PT
);
21025 if (g
== e
|| INTEGERP (g
->object
))
21027 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21028 goto simulate_display
;
21029 if (!row
->reversed_p
)
21033 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21034 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21035 goto simulate_display
;
21039 if (row
->reversed_p
&& !row
->continued_p
)
21041 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21042 w
->cursor
.vpos
= -1;
21043 return make_number (PT
);
21045 g
= row
->glyphs
[TEXT_AREA
];
21046 e
= g
+ row
->used
[TEXT_AREA
];
21047 for ( ; g
< e
; g
++)
21049 if (BUFFERP (g
->object
)
21050 /* Empty lines have only one glyph, which stands
21051 for the newline, and whose charpos is the
21052 buffer position of the newline. */
21053 || ROW_GLYPH_NEWLINE_P (row
, g
)
21054 /* When the buffer ends in a newline, the line at
21055 EOB also has one glyph, but its charpos is -1. */
21056 || (row
->ends_at_zv_p
21057 && !row
->reversed_p
21058 && INTEGERP (g
->object
)
21059 && g
->type
== CHAR_GLYPH
21060 && g
->u
.ch
== ' '))
21062 if (g
->charpos
> 0)
21063 SET_PT (g
->charpos
);
21064 else if (!row
->reversed_p
21065 && row
->ends_at_zv_p
21070 w
->cursor
.vpos
= -1;
21071 return make_number (PT
);
21077 if (!row
->reversed_p
&& !row
->continued_p
)
21079 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21080 w
->cursor
.vpos
= -1;
21081 return make_number (PT
);
21083 e
= row
->glyphs
[TEXT_AREA
];
21084 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21085 for ( ; g
>= e
; g
--)
21087 if (BUFFERP (g
->object
)
21088 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21090 /* Empty R2L lines on GUI frames have the buffer
21091 position of the newline stored in the stretch
21093 || g
->type
== STRETCH_GLYPH
21094 || (row
->ends_at_zv_p
21096 && INTEGERP (g
->object
)
21097 && g
->type
== CHAR_GLYPH
21098 && g
->u
.ch
== ' '))
21100 if (g
->charpos
> 0)
21101 SET_PT (g
->charpos
);
21102 else if (row
->reversed_p
21103 && row
->ends_at_zv_p
21108 w
->cursor
.vpos
= -1;
21109 return make_number (PT
);
21118 /* If we wind up here, we failed to move by using the glyphs, so we
21119 need to simulate display instead. */
21122 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21124 paragraph_dir
= Qleft_to_right
;
21125 if (EQ (paragraph_dir
, Qright_to_left
))
21127 if (PT
<= BEGV
&& dir
< 0)
21128 xsignal0 (Qbeginning_of_buffer
);
21129 else if (PT
>= ZV
&& dir
> 0)
21130 xsignal0 (Qend_of_buffer
);
21133 struct text_pos pt
;
21135 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21137 bool overshoot_expected
= false;
21138 bool target_is_eol_p
= false;
21140 /* Setup the arena. */
21141 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21142 start_display (&it
, w
, pt
);
21144 if (it
.cmp_it
.id
< 0
21145 && it
.method
== GET_FROM_STRING
21146 && it
.area
== TEXT_AREA
21147 && it
.string_from_display_prop_p
21148 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21149 overshoot_expected
= true;
21151 /* Find the X coordinate of point. We start from the beginning
21152 of this or previous line to make sure we are before point in
21153 the logical order (since the move_it_* functions can only
21156 reseat_at_previous_visible_line_start (&it
);
21157 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21158 if (IT_CHARPOS (it
) != PT
)
21160 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21161 -1, -1, -1, MOVE_TO_POS
);
21162 /* If we missed point because the character there is
21163 displayed out of a display vector that has more than one
21164 glyph, retry expecting overshoot. */
21165 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21166 && it
.current
.dpvec_index
> 0
21167 && !overshoot_expected
)
21169 overshoot_expected
= true;
21172 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21173 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21175 pt_x
= it
.current_x
;
21177 if (dir
> 0 || overshoot_expected
)
21179 struct glyph_row
*row
= it
.glyph_row
;
21181 /* When point is at beginning of line, we don't have
21182 information about the glyph there loaded into struct
21183 it. Calling get_next_display_element fixes that. */
21185 get_next_display_element (&it
);
21186 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21187 it
.glyph_row
= NULL
;
21188 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21189 it
.glyph_row
= row
;
21190 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21191 it, lest it will become out of sync with it's buffer
21193 it
.current_x
= pt_x
;
21196 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21197 pixel_width
= it
.pixel_width
;
21198 if (overshoot_expected
&& at_eol_p
)
21200 else if (pixel_width
<= 0)
21203 /* If there's a display string (or something similar) at point,
21204 we are actually at the glyph to the left of point, so we need
21205 to correct the X coordinate. */
21206 if (overshoot_expected
)
21209 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21211 pt_x
+= pixel_width
;
21214 /* Compute target X coordinate, either to the left or to the
21215 right of point. On TTY frames, all characters have the same
21216 pixel width of 1, so we can use that. On GUI frames we don't
21217 have an easy way of getting at the pixel width of the
21218 character to the left of point, so we use a different method
21219 of getting to that place. */
21221 target_x
= pt_x
+ pixel_width
;
21223 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21225 /* Target X coordinate could be one line above or below the line
21226 of point, in which case we need to adjust the target X
21227 coordinate. Also, if moving to the left, we need to begin at
21228 the left edge of the point's screen line. */
21233 start_display (&it
, w
, pt
);
21234 reseat_at_previous_visible_line_start (&it
);
21235 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21237 move_it_by_lines (&it
, pt_vpos
);
21241 move_it_by_lines (&it
, -1);
21242 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21243 target_is_eol_p
= true;
21244 /* Under word-wrap, we don't know the x coordinate of
21245 the last character displayed on the previous line,
21246 which immediately precedes the wrap point. To find
21247 out its x coordinate, we try moving to the right
21248 margin of the window, which will stop at the wrap
21249 point, and then reset target_x to point at the
21250 character that precedes the wrap point. This is not
21251 needed on GUI frames, because (see below) there we
21252 move from the left margin one grapheme cluster at a
21253 time, and stop when we hit the wrap point. */
21254 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21256 void *it_data
= NULL
;
21259 SAVE_IT (it2
, it
, it_data
);
21260 move_it_in_display_line_to (&it
, ZV
, target_x
,
21261 MOVE_TO_POS
| MOVE_TO_X
);
21262 /* If we arrived at target_x, that _is_ the last
21263 character on the previous line. */
21264 if (it
.current_x
!= target_x
)
21265 target_x
= it
.current_x
- 1;
21266 RESTORE_IT (&it
, &it2
, it_data
);
21273 || (target_x
>= it
.last_visible_x
21274 && it
.line_wrap
!= TRUNCATE
))
21277 move_it_by_lines (&it
, 0);
21278 move_it_by_lines (&it
, 1);
21283 /* Move to the target X coordinate. */
21284 #ifdef HAVE_WINDOW_SYSTEM
21285 /* On GUI frames, as we don't know the X coordinate of the
21286 character to the left of point, moving point to the left
21287 requires walking, one grapheme cluster at a time, until we
21288 find ourself at a place immediately to the left of the
21289 character at point. */
21290 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21292 struct text_pos new_pos
;
21293 enum move_it_result rc
= MOVE_X_REACHED
;
21295 if (it
.current_x
== 0)
21296 get_next_display_element (&it
);
21297 if (it
.what
== IT_COMPOSITION
)
21299 new_pos
.charpos
= it
.cmp_it
.charpos
;
21300 new_pos
.bytepos
= -1;
21303 new_pos
= it
.current
.pos
;
21305 while (it
.current_x
+ it
.pixel_width
<= target_x
21306 && (rc
== MOVE_X_REACHED
21307 /* Under word-wrap, move_it_in_display_line_to
21308 stops at correct coordinates, but sometimes
21309 returns MOVE_POS_MATCH_OR_ZV. */
21310 || (it
.line_wrap
== WORD_WRAP
21311 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21313 int new_x
= it
.current_x
+ it
.pixel_width
;
21315 /* For composed characters, we want the position of the
21316 first character in the grapheme cluster (usually, the
21317 composition's base character), whereas it.current
21318 might give us the position of the _last_ one, e.g. if
21319 the composition is rendered in reverse due to bidi
21321 if (it
.what
== IT_COMPOSITION
)
21323 new_pos
.charpos
= it
.cmp_it
.charpos
;
21324 new_pos
.bytepos
= -1;
21327 new_pos
= it
.current
.pos
;
21328 if (new_x
== it
.current_x
)
21330 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21331 MOVE_TO_POS
| MOVE_TO_X
);
21332 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21335 /* The previous position we saw in the loop is the one we
21337 if (new_pos
.bytepos
== -1)
21338 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21339 it
.current
.pos
= new_pos
;
21343 if (it
.current_x
!= target_x
)
21344 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21346 /* When lines are truncated, the above loop will stop at the
21347 window edge. But we want to get to the end of line, even if
21348 it is beyond the window edge; automatic hscroll will then
21349 scroll the window to show point as appropriate. */
21350 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21351 && get_next_display_element (&it
))
21353 struct text_pos new_pos
= it
.current
.pos
;
21355 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21357 set_iterator_to_next (&it
, 0);
21358 if (it
.method
== GET_FROM_BUFFER
)
21359 new_pos
= it
.current
.pos
;
21360 if (!get_next_display_element (&it
))
21364 it
.current
.pos
= new_pos
;
21367 /* If we ended up in a display string that covers point, move to
21368 buffer position to the right in the visual order. */
21371 while (IT_CHARPOS (it
) == PT
)
21373 set_iterator_to_next (&it
, 0);
21374 if (!get_next_display_element (&it
))
21379 /* Move point to that position. */
21380 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21383 return make_number (PT
);
21385 #undef ROW_GLYPH_NEWLINE_P
21389 /***********************************************************************
21391 ***********************************************************************/
21393 /* Redisplay the menu bar in the frame for window W.
21395 The menu bar of X frames that don't have X toolkit support is
21396 displayed in a special window W->frame->menu_bar_window.
21398 The menu bar of terminal frames is treated specially as far as
21399 glyph matrices are concerned. Menu bar lines are not part of
21400 windows, so the update is done directly on the frame matrix rows
21401 for the menu bar. */
21404 display_menu_bar (struct window
*w
)
21406 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21411 /* Don't do all this for graphical frames. */
21413 if (FRAME_W32_P (f
))
21416 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21422 if (FRAME_NS_P (f
))
21424 #endif /* HAVE_NS */
21426 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21427 eassert (!FRAME_WINDOW_P (f
));
21428 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21429 it
.first_visible_x
= 0;
21430 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21431 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21432 if (FRAME_WINDOW_P (f
))
21434 /* Menu bar lines are displayed in the desired matrix of the
21435 dummy window menu_bar_window. */
21436 struct window
*menu_w
;
21437 menu_w
= XWINDOW (f
->menu_bar_window
);
21438 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21440 it
.first_visible_x
= 0;
21441 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21444 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21446 /* This is a TTY frame, i.e. character hpos/vpos are used as
21448 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21450 it
.first_visible_x
= 0;
21451 it
.last_visible_x
= FRAME_COLS (f
);
21454 /* FIXME: This should be controlled by a user option. See the
21455 comments in redisplay_tool_bar and display_mode_line about
21457 it
.paragraph_embedding
= L2R
;
21459 /* Clear all rows of the menu bar. */
21460 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21462 struct glyph_row
*row
= it
.glyph_row
+ i
;
21463 clear_glyph_row (row
);
21464 row
->enabled_p
= true;
21465 row
->full_width_p
= 1;
21466 row
->reversed_p
= false;
21469 /* Display all items of the menu bar. */
21470 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21471 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21473 Lisp_Object string
;
21475 /* Stop at nil string. */
21476 string
= AREF (items
, i
+ 1);
21480 /* Remember where item was displayed. */
21481 ASET (items
, i
+ 3, make_number (it
.hpos
));
21483 /* Display the item, pad with one space. */
21484 if (it
.current_x
< it
.last_visible_x
)
21485 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21486 SCHARS (string
) + 1, 0, 0, -1);
21489 /* Fill out the line with spaces. */
21490 if (it
.current_x
< it
.last_visible_x
)
21491 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21493 /* Compute the total height of the lines. */
21494 compute_line_metrics (&it
);
21497 /* Deep copy of a glyph row, including the glyphs. */
21499 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21501 struct glyph
*pointers
[1 + LAST_AREA
];
21502 int to_used
= to
->used
[TEXT_AREA
];
21504 /* Save glyph pointers of TO. */
21505 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21507 /* Do a structure assignment. */
21510 /* Restore original glyph pointers of TO. */
21511 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21513 /* Copy the glyphs. */
21514 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21515 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21517 /* If we filled only part of the TO row, fill the rest with
21518 space_glyph (which will display as empty space). */
21519 if (to_used
> from
->used
[TEXT_AREA
])
21520 fill_up_frame_row_with_spaces (to
, to_used
);
21523 /* Display one menu item on a TTY, by overwriting the glyphs in the
21524 frame F's desired glyph matrix with glyphs produced from the menu
21525 item text. Called from term.c to display TTY drop-down menus one
21528 ITEM_TEXT is the menu item text as a C string.
21530 FACE_ID is the face ID to be used for this menu item. FACE_ID
21531 could specify one of 3 faces: a face for an enabled item, a face
21532 for a disabled item, or a face for a selected item.
21534 X and Y are coordinates of the first glyph in the frame's desired
21535 matrix to be overwritten by the menu item. Since this is a TTY, Y
21536 is the zero-based number of the glyph row and X is the zero-based
21537 glyph number in the row, starting from left, where to start
21538 displaying the item.
21540 SUBMENU non-zero means this menu item drops down a submenu, which
21541 should be indicated by displaying a proper visual cue after the
21545 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21546 int x
, int y
, int submenu
)
21549 struct frame
*f
= SELECTED_FRAME ();
21550 struct window
*w
= XWINDOW (f
->selected_window
);
21551 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21552 struct glyph_row
*row
;
21553 size_t item_len
= strlen (item_text
);
21555 eassert (FRAME_TERMCAP_P (f
));
21557 /* Don't write beyond the matrix's last row. This can happen for
21558 TTY screens that are not high enough to show the entire menu.
21559 (This is actually a bit of defensive programming, as
21560 tty_menu_display already limits the number of menu items to one
21561 less than the number of screen lines.) */
21562 if (y
>= f
->desired_matrix
->nrows
)
21565 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21566 it
.first_visible_x
= 0;
21567 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21568 row
= it
.glyph_row
;
21569 /* Start with the row contents from the current matrix. */
21570 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21571 saved_width
= row
->full_width_p
;
21572 row
->full_width_p
= 1;
21573 saved_reversed
= row
->reversed_p
;
21574 row
->reversed_p
= 0;
21575 row
->enabled_p
= true;
21577 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21579 eassert (x
< f
->desired_matrix
->matrix_w
);
21580 it
.current_x
= it
.hpos
= x
;
21581 it
.current_y
= it
.vpos
= y
;
21582 saved_used
= row
->used
[TEXT_AREA
];
21583 saved_truncated
= row
->truncated_on_right_p
;
21584 row
->used
[TEXT_AREA
] = x
;
21585 it
.face_id
= face_id
;
21586 it
.line_wrap
= TRUNCATE
;
21588 /* FIXME: This should be controlled by a user option. See the
21589 comments in redisplay_tool_bar and display_mode_line about this.
21590 Also, if paragraph_embedding could ever be R2L, changes will be
21591 needed to avoid shifting to the right the row characters in
21592 term.c:append_glyph. */
21593 it
.paragraph_embedding
= L2R
;
21595 /* Pad with a space on the left. */
21596 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21598 /* Display the menu item, pad with spaces to WIDTH. */
21601 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21602 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21604 /* Indicate with " >" that there's a submenu. */
21605 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21606 FRAME_COLS (f
) - 1, -1);
21609 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21610 width
, 0, FRAME_COLS (f
) - 1, -1);
21612 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21613 row
->truncated_on_right_p
= saved_truncated
;
21614 row
->hash
= row_hash (row
);
21615 row
->full_width_p
= saved_width
;
21616 row
->reversed_p
= saved_reversed
;
21619 /***********************************************************************
21621 ***********************************************************************/
21623 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21624 FORCE is non-zero, redisplay mode lines unconditionally.
21625 Otherwise, redisplay only mode lines that are garbaged. Value is
21626 the number of windows whose mode lines were redisplayed. */
21629 redisplay_mode_lines (Lisp_Object window
, bool force
)
21633 while (!NILP (window
))
21635 struct window
*w
= XWINDOW (window
);
21637 if (WINDOWP (w
->contents
))
21638 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21640 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21641 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21643 struct text_pos lpoint
;
21644 struct buffer
*old
= current_buffer
;
21646 /* Set the window's buffer for the mode line display. */
21647 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21648 set_buffer_internal_1 (XBUFFER (w
->contents
));
21650 /* Point refers normally to the selected window. For any
21651 other window, set up appropriate value. */
21652 if (!EQ (window
, selected_window
))
21654 struct text_pos pt
;
21656 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21657 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21660 /* Display mode lines. */
21661 clear_glyph_matrix (w
->desired_matrix
);
21662 if (display_mode_lines (w
))
21665 /* Restore old settings. */
21666 set_buffer_internal_1 (old
);
21667 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21677 /* Display the mode and/or header line of window W. Value is the
21678 sum number of mode lines and header lines displayed. */
21681 display_mode_lines (struct window
*w
)
21683 Lisp_Object old_selected_window
= selected_window
;
21684 Lisp_Object old_selected_frame
= selected_frame
;
21685 Lisp_Object new_frame
= w
->frame
;
21686 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21689 selected_frame
= new_frame
;
21690 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21691 or window's point, then we'd need select_window_1 here as well. */
21692 XSETWINDOW (selected_window
, w
);
21693 XFRAME (new_frame
)->selected_window
= selected_window
;
21695 /* These will be set while the mode line specs are processed. */
21696 line_number_displayed
= 0;
21697 w
->column_number_displayed
= -1;
21699 if (WINDOW_WANTS_MODELINE_P (w
))
21701 struct window
*sel_w
= XWINDOW (old_selected_window
);
21703 /* Select mode line face based on the real selected window. */
21704 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21705 BVAR (current_buffer
, mode_line_format
));
21709 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21711 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21712 BVAR (current_buffer
, header_line_format
));
21716 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21717 selected_frame
= old_selected_frame
;
21718 selected_window
= old_selected_window
;
21720 w
->must_be_updated_p
= true;
21725 /* Display mode or header line of window W. FACE_ID specifies which
21726 line to display; it is either MODE_LINE_FACE_ID or
21727 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21728 display. Value is the pixel height of the mode/header line
21732 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21736 ptrdiff_t count
= SPECPDL_INDEX ();
21738 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21739 /* Don't extend on a previously drawn mode-line.
21740 This may happen if called from pos_visible_p. */
21741 it
.glyph_row
->enabled_p
= false;
21742 prepare_desired_row (w
, it
.glyph_row
, true);
21744 it
.glyph_row
->mode_line_p
= 1;
21746 /* FIXME: This should be controlled by a user option. But
21747 supporting such an option is not trivial, since the mode line is
21748 made up of many separate strings. */
21749 it
.paragraph_embedding
= L2R
;
21751 record_unwind_protect (unwind_format_mode_line
,
21752 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21754 mode_line_target
= MODE_LINE_DISPLAY
;
21756 /* Temporarily make frame's keyboard the current kboard so that
21757 kboard-local variables in the mode_line_format will get the right
21759 push_kboard (FRAME_KBOARD (it
.f
));
21760 record_unwind_save_match_data ();
21761 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21764 unbind_to (count
, Qnil
);
21766 /* Fill up with spaces. */
21767 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21769 compute_line_metrics (&it
);
21770 it
.glyph_row
->full_width_p
= 1;
21771 it
.glyph_row
->continued_p
= 0;
21772 it
.glyph_row
->truncated_on_left_p
= 0;
21773 it
.glyph_row
->truncated_on_right_p
= 0;
21775 /* Make a 3D mode-line have a shadow at its right end. */
21776 face
= FACE_FROM_ID (it
.f
, face_id
);
21777 extend_face_to_end_of_line (&it
);
21778 if (face
->box
!= FACE_NO_BOX
)
21780 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21781 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21782 last
->right_box_line_p
= 1;
21785 return it
.glyph_row
->height
;
21788 /* Move element ELT in LIST to the front of LIST.
21789 Return the updated list. */
21792 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21794 register Lisp_Object tail
, prev
;
21795 register Lisp_Object tem
;
21799 while (CONSP (tail
))
21805 /* Splice out the link TAIL. */
21807 list
= XCDR (tail
);
21809 Fsetcdr (prev
, XCDR (tail
));
21811 /* Now make it the first. */
21812 Fsetcdr (tail
, list
);
21817 tail
= XCDR (tail
);
21821 /* Not found--return unchanged LIST. */
21825 /* Contribute ELT to the mode line for window IT->w. How it
21826 translates into text depends on its data type.
21828 IT describes the display environment in which we display, as usual.
21830 DEPTH is the depth in recursion. It is used to prevent
21831 infinite recursion here.
21833 FIELD_WIDTH is the number of characters the display of ELT should
21834 occupy in the mode line, and PRECISION is the maximum number of
21835 characters to display from ELT's representation. See
21836 display_string for details.
21838 Returns the hpos of the end of the text generated by ELT.
21840 PROPS is a property list to add to any string we encounter.
21842 If RISKY is nonzero, remove (disregard) any properties in any string
21843 we encounter, and ignore :eval and :propertize.
21845 The global variable `mode_line_target' determines whether the
21846 output is passed to `store_mode_line_noprop',
21847 `store_mode_line_string', or `display_string'. */
21850 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21851 Lisp_Object elt
, Lisp_Object props
, int risky
)
21853 int n
= 0, field
, prec
;
21858 elt
= build_string ("*too-deep*");
21862 switch (XTYPE (elt
))
21866 /* A string: output it and check for %-constructs within it. */
21868 ptrdiff_t offset
= 0;
21870 if (SCHARS (elt
) > 0
21871 && (!NILP (props
) || risky
))
21873 Lisp_Object oprops
, aelt
;
21874 oprops
= Ftext_properties_at (make_number (0), elt
);
21876 /* If the starting string's properties are not what
21877 we want, translate the string. Also, if the string
21878 is risky, do that anyway. */
21880 if (NILP (Fequal (props
, oprops
)) || risky
)
21882 /* If the starting string has properties,
21883 merge the specified ones onto the existing ones. */
21884 if (! NILP (oprops
) && !risky
)
21888 oprops
= Fcopy_sequence (oprops
);
21890 while (CONSP (tem
))
21892 oprops
= Fplist_put (oprops
, XCAR (tem
),
21893 XCAR (XCDR (tem
)));
21894 tem
= XCDR (XCDR (tem
));
21899 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21900 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21902 /* AELT is what we want. Move it to the front
21903 without consing. */
21905 mode_line_proptrans_alist
21906 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21912 /* If AELT has the wrong props, it is useless.
21913 so get rid of it. */
21915 mode_line_proptrans_alist
21916 = Fdelq (aelt
, mode_line_proptrans_alist
);
21918 elt
= Fcopy_sequence (elt
);
21919 Fset_text_properties (make_number (0), Flength (elt
),
21921 /* Add this item to mode_line_proptrans_alist. */
21922 mode_line_proptrans_alist
21923 = Fcons (Fcons (elt
, props
),
21924 mode_line_proptrans_alist
);
21925 /* Truncate mode_line_proptrans_alist
21926 to at most 50 elements. */
21927 tem
= Fnthcdr (make_number (50),
21928 mode_line_proptrans_alist
);
21930 XSETCDR (tem
, Qnil
);
21939 prec
= precision
- n
;
21940 switch (mode_line_target
)
21942 case MODE_LINE_NOPROP
:
21943 case MODE_LINE_TITLE
:
21944 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21946 case MODE_LINE_STRING
:
21947 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21949 case MODE_LINE_DISPLAY
:
21950 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21951 0, prec
, 0, STRING_MULTIBYTE (elt
));
21958 /* Handle the non-literal case. */
21960 while ((precision
<= 0 || n
< precision
)
21961 && SREF (elt
, offset
) != 0
21962 && (mode_line_target
!= MODE_LINE_DISPLAY
21963 || it
->current_x
< it
->last_visible_x
))
21965 ptrdiff_t last_offset
= offset
;
21967 /* Advance to end of string or next format specifier. */
21968 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21971 if (offset
- 1 != last_offset
)
21973 ptrdiff_t nchars
, nbytes
;
21975 /* Output to end of string or up to '%'. Field width
21976 is length of string. Don't output more than
21977 PRECISION allows us. */
21980 prec
= c_string_width (SDATA (elt
) + last_offset
,
21981 offset
- last_offset
, precision
- n
,
21984 switch (mode_line_target
)
21986 case MODE_LINE_NOPROP
:
21987 case MODE_LINE_TITLE
:
21988 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21990 case MODE_LINE_STRING
:
21992 ptrdiff_t bytepos
= last_offset
;
21993 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21994 ptrdiff_t endpos
= (precision
<= 0
21995 ? string_byte_to_char (elt
, offset
)
21996 : charpos
+ nchars
);
21998 n
+= store_mode_line_string (NULL
,
21999 Fsubstring (elt
, make_number (charpos
),
22000 make_number (endpos
)),
22004 case MODE_LINE_DISPLAY
:
22006 ptrdiff_t bytepos
= last_offset
;
22007 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22009 if (precision
<= 0)
22010 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22011 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22013 STRING_MULTIBYTE (elt
));
22018 else /* c == '%' */
22020 ptrdiff_t percent_position
= offset
;
22022 /* Get the specified minimum width. Zero means
22025 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22026 field
= field
* 10 + c
- '0';
22028 /* Don't pad beyond the total padding allowed. */
22029 if (field_width
- n
> 0 && field
> field_width
- n
)
22030 field
= field_width
- n
;
22032 /* Note that either PRECISION <= 0 or N < PRECISION. */
22033 prec
= precision
- n
;
22036 n
+= display_mode_element (it
, depth
, field
, prec
,
22037 Vglobal_mode_string
, props
,
22042 ptrdiff_t bytepos
, charpos
;
22044 Lisp_Object string
;
22046 bytepos
= percent_position
;
22047 charpos
= (STRING_MULTIBYTE (elt
)
22048 ? string_byte_to_char (elt
, bytepos
)
22050 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22051 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22053 switch (mode_line_target
)
22055 case MODE_LINE_NOPROP
:
22056 case MODE_LINE_TITLE
:
22057 n
+= store_mode_line_noprop (spec
, field
, prec
);
22059 case MODE_LINE_STRING
:
22061 Lisp_Object tem
= build_string (spec
);
22062 props
= Ftext_properties_at (make_number (charpos
), elt
);
22063 /* Should only keep face property in props */
22064 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22067 case MODE_LINE_DISPLAY
:
22069 int nglyphs_before
, nwritten
;
22071 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22072 nwritten
= display_string (spec
, string
, elt
,
22077 /* Assign to the glyphs written above the
22078 string where the `%x' came from, position
22082 struct glyph
*glyph
22083 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22087 for (i
= 0; i
< nwritten
; ++i
)
22089 glyph
[i
].object
= elt
;
22090 glyph
[i
].charpos
= charpos
;
22107 /* A symbol: process the value of the symbol recursively
22108 as if it appeared here directly. Avoid error if symbol void.
22109 Special case: if value of symbol is a string, output the string
22112 register Lisp_Object tem
;
22114 /* If the variable is not marked as risky to set
22115 then its contents are risky to use. */
22116 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22119 tem
= Fboundp (elt
);
22122 tem
= Fsymbol_value (elt
);
22123 /* If value is a string, output that string literally:
22124 don't check for % within it. */
22128 if (!EQ (tem
, elt
))
22130 /* Give up right away for nil or t. */
22140 register Lisp_Object car
, tem
;
22142 /* A cons cell: five distinct cases.
22143 If first element is :eval or :propertize, do something special.
22144 If first element is a string or a cons, process all the elements
22145 and effectively concatenate them.
22146 If first element is a negative number, truncate displaying cdr to
22147 at most that many characters. If positive, pad (with spaces)
22148 to at least that many characters.
22149 If first element is a symbol, process the cadr or caddr recursively
22150 according to whether the symbol's value is non-nil or nil. */
22152 if (EQ (car
, QCeval
))
22154 /* An element of the form (:eval FORM) means evaluate FORM
22155 and use the result as mode line elements. */
22160 if (CONSP (XCDR (elt
)))
22163 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22164 n
+= display_mode_element (it
, depth
, field_width
- n
,
22165 precision
- n
, spec
, props
,
22169 else if (EQ (car
, QCpropertize
))
22171 /* An element of the form (:propertize ELT PROPS...)
22172 means display ELT but applying properties PROPS. */
22177 if (CONSP (XCDR (elt
)))
22178 n
+= display_mode_element (it
, depth
, field_width
- n
,
22179 precision
- n
, XCAR (XCDR (elt
)),
22180 XCDR (XCDR (elt
)), risky
);
22182 else if (SYMBOLP (car
))
22184 tem
= Fboundp (car
);
22188 /* elt is now the cdr, and we know it is a cons cell.
22189 Use its car if CAR has a non-nil value. */
22192 tem
= Fsymbol_value (car
);
22199 /* Symbol's value is nil (or symbol is unbound)
22200 Get the cddr of the original list
22201 and if possible find the caddr and use that. */
22205 else if (!CONSP (elt
))
22210 else if (INTEGERP (car
))
22212 register int lim
= XINT (car
);
22216 /* Negative int means reduce maximum width. */
22217 if (precision
<= 0)
22220 precision
= min (precision
, -lim
);
22224 /* Padding specified. Don't let it be more than
22225 current maximum. */
22227 lim
= min (precision
, lim
);
22229 /* If that's more padding than already wanted, queue it.
22230 But don't reduce padding already specified even if
22231 that is beyond the current truncation point. */
22232 field_width
= max (lim
, field_width
);
22236 else if (STRINGP (car
) || CONSP (car
))
22238 Lisp_Object halftail
= elt
;
22242 && (precision
<= 0 || n
< precision
))
22244 n
+= display_mode_element (it
, depth
,
22245 /* Do padding only after the last
22246 element in the list. */
22247 (! CONSP (XCDR (elt
))
22250 precision
- n
, XCAR (elt
),
22254 if ((len
& 1) == 0)
22255 halftail
= XCDR (halftail
);
22256 /* Check for cycle. */
22257 if (EQ (halftail
, elt
))
22266 elt
= build_string ("*invalid*");
22270 /* Pad to FIELD_WIDTH. */
22271 if (field_width
> 0 && n
< field_width
)
22273 switch (mode_line_target
)
22275 case MODE_LINE_NOPROP
:
22276 case MODE_LINE_TITLE
:
22277 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22279 case MODE_LINE_STRING
:
22280 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22282 case MODE_LINE_DISPLAY
:
22283 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22292 /* Store a mode-line string element in mode_line_string_list.
22294 If STRING is non-null, display that C string. Otherwise, the Lisp
22295 string LISP_STRING is displayed.
22297 FIELD_WIDTH is the minimum number of output glyphs to produce.
22298 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22299 with spaces. FIELD_WIDTH <= 0 means don't pad.
22301 PRECISION is the maximum number of characters to output from
22302 STRING. PRECISION <= 0 means don't truncate the string.
22304 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22305 properties to the string.
22307 PROPS are the properties to add to the string.
22308 The mode_line_string_face face property is always added to the string.
22312 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22313 int field_width
, int precision
, Lisp_Object props
)
22318 if (string
!= NULL
)
22320 len
= strlen (string
);
22321 if (precision
> 0 && len
> precision
)
22323 lisp_string
= make_string (string
, len
);
22325 props
= mode_line_string_face_prop
;
22326 else if (!NILP (mode_line_string_face
))
22328 Lisp_Object face
= Fplist_get (props
, Qface
);
22329 props
= Fcopy_sequence (props
);
22331 face
= mode_line_string_face
;
22333 face
= list2 (face
, mode_line_string_face
);
22334 props
= Fplist_put (props
, Qface
, face
);
22336 Fadd_text_properties (make_number (0), make_number (len
),
22337 props
, lisp_string
);
22341 len
= XFASTINT (Flength (lisp_string
));
22342 if (precision
> 0 && len
> precision
)
22345 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22348 if (!NILP (mode_line_string_face
))
22352 props
= Ftext_properties_at (make_number (0), lisp_string
);
22353 face
= Fplist_get (props
, Qface
);
22355 face
= mode_line_string_face
;
22357 face
= list2 (face
, mode_line_string_face
);
22358 props
= list2 (Qface
, face
);
22360 lisp_string
= Fcopy_sequence (lisp_string
);
22363 Fadd_text_properties (make_number (0), make_number (len
),
22364 props
, lisp_string
);
22369 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22373 if (field_width
> len
)
22375 field_width
-= len
;
22376 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22378 Fadd_text_properties (make_number (0), make_number (field_width
),
22379 props
, lisp_string
);
22380 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22388 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22390 doc
: /* Format a string out of a mode line format specification.
22391 First arg FORMAT specifies the mode line format (see `mode-line-format'
22392 for details) to use.
22394 By default, the format is evaluated for the currently selected window.
22396 Optional second arg FACE specifies the face property to put on all
22397 characters for which no face is specified. The value nil means the
22398 default face. The value t means whatever face the window's mode line
22399 currently uses (either `mode-line' or `mode-line-inactive',
22400 depending on whether the window is the selected window or not).
22401 An integer value means the value string has no text
22404 Optional third and fourth args WINDOW and BUFFER specify the window
22405 and buffer to use as the context for the formatting (defaults
22406 are the selected window and the WINDOW's buffer). */)
22407 (Lisp_Object format
, Lisp_Object face
,
22408 Lisp_Object window
, Lisp_Object buffer
)
22413 struct buffer
*old_buffer
= NULL
;
22415 int no_props
= INTEGERP (face
);
22416 ptrdiff_t count
= SPECPDL_INDEX ();
22418 int string_start
= 0;
22420 w
= decode_any_window (window
);
22421 XSETWINDOW (window
, w
);
22424 buffer
= w
->contents
;
22425 CHECK_BUFFER (buffer
);
22427 /* Make formatting the modeline a non-op when noninteractive, otherwise
22428 there will be problems later caused by a partially initialized frame. */
22429 if (NILP (format
) || noninteractive
)
22430 return empty_unibyte_string
;
22435 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22436 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22437 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22438 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22439 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22440 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22441 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22444 old_buffer
= current_buffer
;
22446 /* Save things including mode_line_proptrans_alist,
22447 and set that to nil so that we don't alter the outer value. */
22448 record_unwind_protect (unwind_format_mode_line
,
22449 format_mode_line_unwind_data
22450 (XFRAME (WINDOW_FRAME (w
)),
22451 old_buffer
, selected_window
, 1));
22452 mode_line_proptrans_alist
= Qnil
;
22454 Fselect_window (window
, Qt
);
22455 set_buffer_internal_1 (XBUFFER (buffer
));
22457 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22461 mode_line_target
= MODE_LINE_NOPROP
;
22462 mode_line_string_face_prop
= Qnil
;
22463 mode_line_string_list
= Qnil
;
22464 string_start
= MODE_LINE_NOPROP_LEN (0);
22468 mode_line_target
= MODE_LINE_STRING
;
22469 mode_line_string_list
= Qnil
;
22470 mode_line_string_face
= face
;
22471 mode_line_string_face_prop
22472 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22475 push_kboard (FRAME_KBOARD (it
.f
));
22476 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22481 len
= MODE_LINE_NOPROP_LEN (string_start
);
22482 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22486 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22487 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22488 empty_unibyte_string
);
22491 unbind_to (count
, Qnil
);
22495 /* Write a null-terminated, right justified decimal representation of
22496 the positive integer D to BUF using a minimal field width WIDTH. */
22499 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22501 register char *p
= buf
;
22509 *p
++ = d
% 10 + '0';
22514 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22525 /* Write a null-terminated, right justified decimal and "human
22526 readable" representation of the nonnegative integer D to BUF using
22527 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22529 static const char power_letter
[] =
22543 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22545 /* We aim to represent the nonnegative integer D as
22546 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22547 ptrdiff_t quotient
= d
;
22549 /* -1 means: do not use TENTHS. */
22553 /* Length of QUOTIENT.TENTHS as a string. */
22559 if (quotient
>= 1000)
22561 /* Scale to the appropriate EXPONENT. */
22564 remainder
= quotient
% 1000;
22568 while (quotient
>= 1000);
22570 /* Round to nearest and decide whether to use TENTHS or not. */
22573 tenths
= remainder
/ 100;
22574 if (remainder
% 100 >= 50)
22581 if (quotient
== 10)
22589 if (remainder
>= 500)
22591 if (quotient
< 999)
22602 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22603 if (tenths
== -1 && quotient
<= 99)
22610 p
= psuffix
= buf
+ max (width
, length
);
22612 /* Print EXPONENT. */
22613 *psuffix
++ = power_letter
[exponent
];
22616 /* Print TENTHS. */
22619 *--p
= '0' + tenths
;
22623 /* Print QUOTIENT. */
22626 int digit
= quotient
% 10;
22627 *--p
= '0' + digit
;
22629 while ((quotient
/= 10) != 0);
22631 /* Print leading spaces. */
22636 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22637 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22638 type of CODING_SYSTEM. Return updated pointer into BUF. */
22640 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22643 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22646 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22647 const unsigned char *eol_str
;
22649 /* The EOL conversion we are using. */
22650 Lisp_Object eoltype
;
22652 val
= CODING_SYSTEM_SPEC (coding_system
);
22655 if (!VECTORP (val
)) /* Not yet decided. */
22657 *buf
++ = multibyte
? '-' : ' ';
22659 eoltype
= eol_mnemonic_undecided
;
22660 /* Don't mention EOL conversion if it isn't decided. */
22665 Lisp_Object eolvalue
;
22667 attrs
= AREF (val
, 0);
22668 eolvalue
= AREF (val
, 2);
22671 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22676 /* The EOL conversion that is normal on this system. */
22678 if (NILP (eolvalue
)) /* Not yet decided. */
22679 eoltype
= eol_mnemonic_undecided
;
22680 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22681 eoltype
= eol_mnemonic_undecided
;
22682 else /* eolvalue is Qunix, Qdos, or Qmac. */
22683 eoltype
= (EQ (eolvalue
, Qunix
)
22684 ? eol_mnemonic_unix
22685 : (EQ (eolvalue
, Qdos
) == 1
22686 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22692 /* Mention the EOL conversion if it is not the usual one. */
22693 if (STRINGP (eoltype
))
22695 eol_str
= SDATA (eoltype
);
22696 eol_str_len
= SBYTES (eoltype
);
22698 else if (CHARACTERP (eoltype
))
22700 int c
= XFASTINT (eoltype
);
22701 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
22705 eol_str
= invalid_eol_type
;
22706 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22708 memcpy (buf
, eol_str
, eol_str_len
);
22709 buf
+= eol_str_len
;
22715 /* Return a string for the output of a mode line %-spec for window W,
22716 generated by character C. FIELD_WIDTH > 0 means pad the string
22717 returned with spaces to that value. Return a Lisp string in
22718 *STRING if the resulting string is taken from that Lisp string.
22720 Note we operate on the current buffer for most purposes. */
22722 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22724 static const char *
22725 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22726 Lisp_Object
*string
)
22729 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22730 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22731 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22732 produce strings from numerical values, so limit preposterously
22733 large values of FIELD_WIDTH to avoid overrunning the buffer's
22734 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22735 bytes plus the terminating null. */
22736 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22737 struct buffer
*b
= current_buffer
;
22745 if (!NILP (BVAR (b
, read_only
)))
22747 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22752 /* This differs from %* only for a modified read-only buffer. */
22753 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22755 if (!NILP (BVAR (b
, read_only
)))
22760 /* This differs from %* in ignoring read-only-ness. */
22761 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22773 if (command_loop_level
> 5)
22775 p
= decode_mode_spec_buf
;
22776 for (i
= 0; i
< command_loop_level
; i
++)
22779 return decode_mode_spec_buf
;
22787 if (command_loop_level
> 5)
22789 p
= decode_mode_spec_buf
;
22790 for (i
= 0; i
< command_loop_level
; i
++)
22793 return decode_mode_spec_buf
;
22800 /* Let lots_of_dashes be a string of infinite length. */
22801 if (mode_line_target
== MODE_LINE_NOPROP
22802 || mode_line_target
== MODE_LINE_STRING
)
22804 if (field_width
<= 0
22805 || field_width
> sizeof (lots_of_dashes
))
22807 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22808 decode_mode_spec_buf
[i
] = '-';
22809 decode_mode_spec_buf
[i
] = '\0';
22810 return decode_mode_spec_buf
;
22813 return lots_of_dashes
;
22817 obj
= BVAR (b
, name
);
22821 /* %c and %l are ignored in `frame-title-format'.
22822 (In redisplay_internal, the frame title is drawn _before_ the
22823 windows are updated, so the stuff which depends on actual
22824 window contents (such as %l) may fail to render properly, or
22825 even crash emacs.) */
22826 if (mode_line_target
== MODE_LINE_TITLE
)
22830 ptrdiff_t col
= current_column ();
22831 w
->column_number_displayed
= col
;
22832 pint2str (decode_mode_spec_buf
, width
, col
);
22833 return decode_mode_spec_buf
;
22837 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
22839 if (NILP (Vmemory_full
))
22842 return "!MEM FULL! ";
22849 /* %F displays the frame name. */
22850 if (!NILP (f
->title
))
22851 return SSDATA (f
->title
);
22852 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22853 return SSDATA (f
->name
);
22857 obj
= BVAR (b
, filename
);
22862 ptrdiff_t size
= ZV
- BEGV
;
22863 pint2str (decode_mode_spec_buf
, width
, size
);
22864 return decode_mode_spec_buf
;
22869 ptrdiff_t size
= ZV
- BEGV
;
22870 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22871 return decode_mode_spec_buf
;
22876 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22877 ptrdiff_t topline
, nlines
, height
;
22880 /* %c and %l are ignored in `frame-title-format'. */
22881 if (mode_line_target
== MODE_LINE_TITLE
)
22884 startpos
= marker_position (w
->start
);
22885 startpos_byte
= marker_byte_position (w
->start
);
22886 height
= WINDOW_TOTAL_LINES (w
);
22888 /* If we decided that this buffer isn't suitable for line numbers,
22889 don't forget that too fast. */
22890 if (w
->base_line_pos
== -1)
22893 /* If the buffer is very big, don't waste time. */
22894 if (INTEGERP (Vline_number_display_limit
)
22895 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22897 w
->base_line_pos
= 0;
22898 w
->base_line_number
= 0;
22902 if (w
->base_line_number
> 0
22903 && w
->base_line_pos
> 0
22904 && w
->base_line_pos
<= startpos
)
22906 line
= w
->base_line_number
;
22907 linepos
= w
->base_line_pos
;
22908 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22913 linepos
= BUF_BEGV (b
);
22914 linepos_byte
= BUF_BEGV_BYTE (b
);
22917 /* Count lines from base line to window start position. */
22918 nlines
= display_count_lines (linepos_byte
,
22922 topline
= nlines
+ line
;
22924 /* Determine a new base line, if the old one is too close
22925 or too far away, or if we did not have one.
22926 "Too close" means it's plausible a scroll-down would
22927 go back past it. */
22928 if (startpos
== BUF_BEGV (b
))
22930 w
->base_line_number
= topline
;
22931 w
->base_line_pos
= BUF_BEGV (b
);
22933 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22934 || linepos
== BUF_BEGV (b
))
22936 ptrdiff_t limit
= BUF_BEGV (b
);
22937 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22938 ptrdiff_t position
;
22939 ptrdiff_t distance
=
22940 (height
* 2 + 30) * line_number_display_limit_width
;
22942 if (startpos
- distance
> limit
)
22944 limit
= startpos
- distance
;
22945 limit_byte
= CHAR_TO_BYTE (limit
);
22948 nlines
= display_count_lines (startpos_byte
,
22950 - (height
* 2 + 30),
22952 /* If we couldn't find the lines we wanted within
22953 line_number_display_limit_width chars per line,
22954 give up on line numbers for this window. */
22955 if (position
== limit_byte
&& limit
== startpos
- distance
)
22957 w
->base_line_pos
= -1;
22958 w
->base_line_number
= 0;
22962 w
->base_line_number
= topline
- nlines
;
22963 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22966 /* Now count lines from the start pos to point. */
22967 nlines
= display_count_lines (startpos_byte
,
22968 PT_BYTE
, PT
, &junk
);
22970 /* Record that we did display the line number. */
22971 line_number_displayed
= 1;
22973 /* Make the string to show. */
22974 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22975 return decode_mode_spec_buf
;
22978 char *p
= decode_mode_spec_buf
;
22979 int pad
= width
- 2;
22985 return decode_mode_spec_buf
;
22991 obj
= BVAR (b
, mode_name
);
22995 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23001 ptrdiff_t pos
= marker_position (w
->start
);
23002 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23004 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23006 if (pos
<= BUF_BEGV (b
))
23011 else if (pos
<= BUF_BEGV (b
))
23015 if (total
> 1000000)
23016 /* Do it differently for a large value, to avoid overflow. */
23017 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23019 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23020 /* We can't normally display a 3-digit number,
23021 so get us a 2-digit number that is close. */
23024 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23025 return decode_mode_spec_buf
;
23029 /* Display percentage of size above the bottom of the screen. */
23032 ptrdiff_t toppos
= marker_position (w
->start
);
23033 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23034 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23036 if (botpos
>= BUF_ZV (b
))
23038 if (toppos
<= BUF_BEGV (b
))
23045 if (total
> 1000000)
23046 /* Do it differently for a large value, to avoid overflow. */
23047 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23049 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23050 /* We can't normally display a 3-digit number,
23051 so get us a 2-digit number that is close. */
23054 if (toppos
<= BUF_BEGV (b
))
23055 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23057 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23058 return decode_mode_spec_buf
;
23063 /* status of process */
23064 obj
= Fget_buffer_process (Fcurrent_buffer ());
23066 return "no process";
23068 obj
= Fsymbol_name (Fprocess_status (obj
));
23074 ptrdiff_t count
= inhibit_garbage_collection ();
23075 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23076 Lisp_Object val
= Qnil
;
23078 if (STRINGP (curdir
))
23079 val
= call1 (intern ("file-remote-p"), curdir
);
23081 unbind_to (count
, Qnil
);
23090 /* coding-system (not including end-of-line format) */
23092 /* coding-system (including end-of-line type) */
23094 int eol_flag
= (c
== 'Z');
23095 char *p
= decode_mode_spec_buf
;
23097 if (! FRAME_WINDOW_P (f
))
23099 /* No need to mention EOL here--the terminal never needs
23100 to do EOL conversion. */
23101 p
= decode_mode_spec_coding (CODING_ID_NAME
23102 (FRAME_KEYBOARD_CODING (f
)->id
),
23104 p
= decode_mode_spec_coding (CODING_ID_NAME
23105 (FRAME_TERMINAL_CODING (f
)->id
),
23108 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23111 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23112 #ifdef subprocesses
23113 obj
= Fget_buffer_process (Fcurrent_buffer ());
23114 if (PROCESSP (obj
))
23116 p
= decode_mode_spec_coding
23117 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23118 p
= decode_mode_spec_coding
23119 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23121 #endif /* subprocesses */
23124 return decode_mode_spec_buf
;
23131 return SSDATA (obj
);
23138 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23139 means count lines back from START_BYTE. But don't go beyond
23140 LIMIT_BYTE. Return the number of lines thus found (always
23143 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23144 either the position COUNT lines after/before START_BYTE, if we
23145 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23149 display_count_lines (ptrdiff_t start_byte
,
23150 ptrdiff_t limit_byte
, ptrdiff_t count
,
23151 ptrdiff_t *byte_pos_ptr
)
23153 register unsigned char *cursor
;
23154 unsigned char *base
;
23156 register ptrdiff_t ceiling
;
23157 register unsigned char *ceiling_addr
;
23158 ptrdiff_t orig_count
= count
;
23160 /* If we are not in selective display mode,
23161 check only for newlines. */
23162 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23163 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23167 while (start_byte
< limit_byte
)
23169 ceiling
= BUFFER_CEILING_OF (start_byte
);
23170 ceiling
= min (limit_byte
- 1, ceiling
);
23171 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23172 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23176 if (selective_display
)
23178 while (*cursor
!= '\n' && *cursor
!= 015
23179 && ++cursor
!= ceiling_addr
)
23181 if (cursor
== ceiling_addr
)
23186 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23195 start_byte
+= cursor
- base
;
23196 *byte_pos_ptr
= start_byte
;
23200 while (cursor
< ceiling_addr
);
23202 start_byte
+= ceiling_addr
- base
;
23207 while (start_byte
> limit_byte
)
23209 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23210 ceiling
= max (limit_byte
, ceiling
);
23211 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23212 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23215 if (selective_display
)
23217 while (--cursor
>= ceiling_addr
23218 && *cursor
!= '\n' && *cursor
!= 015)
23220 if (cursor
< ceiling_addr
)
23225 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23232 start_byte
+= cursor
- base
+ 1;
23233 *byte_pos_ptr
= start_byte
;
23234 /* When scanning backwards, we should
23235 not count the newline posterior to which we stop. */
23236 return - orig_count
- 1;
23239 start_byte
+= ceiling_addr
- base
;
23243 *byte_pos_ptr
= limit_byte
;
23246 return - orig_count
+ count
;
23247 return orig_count
- count
;
23253 /***********************************************************************
23255 ***********************************************************************/
23257 /* Display a NUL-terminated string, starting with index START.
23259 If STRING is non-null, display that C string. Otherwise, the Lisp
23260 string LISP_STRING is displayed. There's a case that STRING is
23261 non-null and LISP_STRING is not nil. It means STRING is a string
23262 data of LISP_STRING. In that case, we display LISP_STRING while
23263 ignoring its text properties.
23265 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23266 FACE_STRING. Display STRING or LISP_STRING with the face at
23267 FACE_STRING_POS in FACE_STRING:
23269 Display the string in the environment given by IT, but use the
23270 standard display table, temporarily.
23272 FIELD_WIDTH is the minimum number of output glyphs to produce.
23273 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23274 with spaces. If STRING has more characters, more than FIELD_WIDTH
23275 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23277 PRECISION is the maximum number of characters to output from
23278 STRING. PRECISION < 0 means don't truncate the string.
23280 This is roughly equivalent to printf format specifiers:
23282 FIELD_WIDTH PRECISION PRINTF
23283 ----------------------------------------
23289 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23290 display them, and < 0 means obey the current buffer's value of
23291 enable_multibyte_characters.
23293 Value is the number of columns displayed. */
23296 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23297 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23298 int field_width
, int precision
, int max_x
, int multibyte
)
23300 int hpos_at_start
= it
->hpos
;
23301 int saved_face_id
= it
->face_id
;
23302 struct glyph_row
*row
= it
->glyph_row
;
23303 ptrdiff_t it_charpos
;
23305 /* Initialize the iterator IT for iteration over STRING beginning
23306 with index START. */
23307 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23308 precision
, field_width
, multibyte
);
23309 if (string
&& STRINGP (lisp_string
))
23310 /* LISP_STRING is the one returned by decode_mode_spec. We should
23311 ignore its text properties. */
23312 it
->stop_charpos
= it
->end_charpos
;
23314 /* If displaying STRING, set up the face of the iterator from
23315 FACE_STRING, if that's given. */
23316 if (STRINGP (face_string
))
23322 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23323 0, &endptr
, it
->base_face_id
, 0);
23324 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23325 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23328 /* Set max_x to the maximum allowed X position. Don't let it go
23329 beyond the right edge of the window. */
23331 max_x
= it
->last_visible_x
;
23333 max_x
= min (max_x
, it
->last_visible_x
);
23335 /* Skip over display elements that are not visible. because IT->w is
23337 if (it
->current_x
< it
->first_visible_x
)
23338 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23339 MOVE_TO_POS
| MOVE_TO_X
);
23341 row
->ascent
= it
->max_ascent
;
23342 row
->height
= it
->max_ascent
+ it
->max_descent
;
23343 row
->phys_ascent
= it
->max_phys_ascent
;
23344 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23345 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23347 if (STRINGP (it
->string
))
23348 it_charpos
= IT_STRING_CHARPOS (*it
);
23350 it_charpos
= IT_CHARPOS (*it
);
23352 /* This condition is for the case that we are called with current_x
23353 past last_visible_x. */
23354 while (it
->current_x
< max_x
)
23356 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23358 /* Get the next display element. */
23359 if (!get_next_display_element (it
))
23362 /* Produce glyphs. */
23363 x_before
= it
->current_x
;
23364 n_glyphs_before
= row
->used
[TEXT_AREA
];
23365 PRODUCE_GLYPHS (it
);
23367 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23370 while (i
< nglyphs
)
23372 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23374 if (it
->line_wrap
!= TRUNCATE
23375 && x
+ glyph
->pixel_width
> max_x
)
23377 /* End of continued line or max_x reached. */
23378 if (CHAR_GLYPH_PADDING_P (*glyph
))
23380 /* A wide character is unbreakable. */
23381 if (row
->reversed_p
)
23382 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23383 - n_glyphs_before
);
23384 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23385 it
->current_x
= x_before
;
23389 if (row
->reversed_p
)
23390 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23391 - (n_glyphs_before
+ i
));
23392 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23397 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23399 /* Glyph is at least partially visible. */
23401 if (x
< it
->first_visible_x
)
23402 row
->x
= x
- it
->first_visible_x
;
23406 /* Glyph is off the left margin of the display area.
23407 Should not happen. */
23411 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23412 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23413 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23414 row
->phys_height
= max (row
->phys_height
,
23415 it
->max_phys_ascent
+ it
->max_phys_descent
);
23416 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23417 it
->max_extra_line_spacing
);
23418 x
+= glyph
->pixel_width
;
23422 /* Stop if max_x reached. */
23426 /* Stop at line ends. */
23427 if (ITERATOR_AT_END_OF_LINE_P (it
))
23429 it
->continuation_lines_width
= 0;
23433 set_iterator_to_next (it
, 1);
23434 if (STRINGP (it
->string
))
23435 it_charpos
= IT_STRING_CHARPOS (*it
);
23437 it_charpos
= IT_CHARPOS (*it
);
23439 /* Stop if truncating at the right edge. */
23440 if (it
->line_wrap
== TRUNCATE
23441 && it
->current_x
>= it
->last_visible_x
)
23443 /* Add truncation mark, but don't do it if the line is
23444 truncated at a padding space. */
23445 if (it_charpos
< it
->string_nchars
)
23447 if (!FRAME_WINDOW_P (it
->f
))
23451 if (it
->current_x
> it
->last_visible_x
)
23453 if (!row
->reversed_p
)
23455 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23456 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23461 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23462 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23464 unproduce_glyphs (it
, ii
+ 1);
23465 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23467 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23469 row
->used
[TEXT_AREA
] = ii
;
23470 produce_special_glyphs (it
, IT_TRUNCATION
);
23473 produce_special_glyphs (it
, IT_TRUNCATION
);
23475 row
->truncated_on_right_p
= 1;
23481 /* Maybe insert a truncation at the left. */
23482 if (it
->first_visible_x
23485 if (!FRAME_WINDOW_P (it
->f
)
23486 || (row
->reversed_p
23487 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23488 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23489 insert_left_trunc_glyphs (it
);
23490 row
->truncated_on_left_p
= 1;
23493 it
->face_id
= saved_face_id
;
23495 /* Value is number of columns displayed. */
23496 return it
->hpos
- hpos_at_start
;
23501 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23502 appears as an element of LIST or as the car of an element of LIST.
23503 If PROPVAL is a list, compare each element against LIST in that
23504 way, and return 1/2 if any element of PROPVAL is found in LIST.
23505 Otherwise return 0. This function cannot quit.
23506 The return value is 2 if the text is invisible but with an ellipsis
23507 and 1 if it's invisible and without an ellipsis. */
23510 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23512 register Lisp_Object tail
, proptail
;
23514 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23516 register Lisp_Object tem
;
23518 if (EQ (propval
, tem
))
23520 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23521 return NILP (XCDR (tem
)) ? 1 : 2;
23524 if (CONSP (propval
))
23526 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23528 Lisp_Object propelt
;
23529 propelt
= XCAR (proptail
);
23530 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23532 register Lisp_Object tem
;
23534 if (EQ (propelt
, tem
))
23536 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23537 return NILP (XCDR (tem
)) ? 1 : 2;
23545 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23546 doc
: /* Non-nil if the property makes the text invisible.
23547 POS-OR-PROP can be a marker or number, in which case it is taken to be
23548 a position in the current buffer and the value of the `invisible' property
23549 is checked; or it can be some other value, which is then presumed to be the
23550 value of the `invisible' property of the text of interest.
23551 The non-nil value returned can be t for truly invisible text or something
23552 else if the text is replaced by an ellipsis. */)
23553 (Lisp_Object pos_or_prop
)
23556 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23557 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23559 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23560 return (invis
== 0 ? Qnil
23562 : make_number (invis
));
23565 /* Calculate a width or height in pixels from a specification using
23566 the following elements:
23569 NUM - a (fractional) multiple of the default font width/height
23570 (NUM) - specifies exactly NUM pixels
23571 UNIT - a fixed number of pixels, see below.
23572 ELEMENT - size of a display element in pixels, see below.
23573 (NUM . SPEC) - equals NUM * SPEC
23574 (+ SPEC SPEC ...) - add pixel values
23575 (- SPEC SPEC ...) - subtract pixel values
23576 (- SPEC) - negate pixel value
23579 INT or FLOAT - a number constant
23580 SYMBOL - use symbol's (buffer local) variable binding.
23583 in - pixels per inch *)
23584 mm - pixels per 1/1000 meter *)
23585 cm - pixels per 1/100 meter *)
23586 width - width of current font in pixels.
23587 height - height of current font in pixels.
23589 *) using the ratio(s) defined in display-pixels-per-inch.
23593 left-fringe - left fringe width in pixels
23594 right-fringe - right fringe width in pixels
23596 left-margin - left margin width in pixels
23597 right-margin - right margin width in pixels
23599 scroll-bar - scroll-bar area width in pixels
23603 Pixels corresponding to 5 inches:
23606 Total width of non-text areas on left side of window (if scroll-bar is on left):
23607 '(space :width (+ left-fringe left-margin scroll-bar))
23609 Align to first text column (in header line):
23610 '(space :align-to 0)
23612 Align to middle of text area minus half the width of variable `my-image'
23613 containing a loaded image:
23614 '(space :align-to (0.5 . (- text my-image)))
23616 Width of left margin minus width of 1 character in the default font:
23617 '(space :width (- left-margin 1))
23619 Width of left margin minus width of 2 characters in the current font:
23620 '(space :width (- left-margin (2 . width)))
23622 Center 1 character over left-margin (in header line):
23623 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23625 Different ways to express width of left fringe plus left margin minus one pixel:
23626 '(space :width (- (+ left-fringe left-margin) (1)))
23627 '(space :width (+ left-fringe left-margin (- (1))))
23628 '(space :width (+ left-fringe left-margin (-1)))
23633 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23634 struct font
*font
, int width_p
, int *align_to
)
23638 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23639 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23642 return OK_PIXELS (0);
23644 eassert (FRAME_LIVE_P (it
->f
));
23646 if (SYMBOLP (prop
))
23648 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23650 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23652 if (unit
[0] == 'i' && unit
[1] == 'n')
23654 else if (unit
[0] == 'm' && unit
[1] == 'm')
23656 else if (unit
[0] == 'c' && unit
[1] == 'm')
23662 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23663 : FRAME_RES_Y (it
->f
));
23666 return OK_PIXELS (ppi
/ pixels
);
23671 #ifdef HAVE_WINDOW_SYSTEM
23672 if (EQ (prop
, Qheight
))
23673 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23674 if (EQ (prop
, Qwidth
))
23675 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23677 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23678 return OK_PIXELS (1);
23681 if (EQ (prop
, Qtext
))
23682 return OK_PIXELS (width_p
23683 ? window_box_width (it
->w
, TEXT_AREA
)
23684 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23686 if (align_to
&& *align_to
< 0)
23689 if (EQ (prop
, Qleft
))
23690 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23691 if (EQ (prop
, Qright
))
23692 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23693 if (EQ (prop
, Qcenter
))
23694 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23695 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23696 if (EQ (prop
, Qleft_fringe
))
23697 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23698 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23699 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23700 if (EQ (prop
, Qright_fringe
))
23701 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23702 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23703 : window_box_right_offset (it
->w
, TEXT_AREA
));
23704 if (EQ (prop
, Qleft_margin
))
23705 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23706 if (EQ (prop
, Qright_margin
))
23707 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23708 if (EQ (prop
, Qscroll_bar
))
23709 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23711 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23712 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23713 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23718 if (EQ (prop
, Qleft_fringe
))
23719 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23720 if (EQ (prop
, Qright_fringe
))
23721 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23722 if (EQ (prop
, Qleft_margin
))
23723 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23724 if (EQ (prop
, Qright_margin
))
23725 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23726 if (EQ (prop
, Qscroll_bar
))
23727 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23730 prop
= buffer_local_value (prop
, it
->w
->contents
);
23731 if (EQ (prop
, Qunbound
))
23735 if (INTEGERP (prop
) || FLOATP (prop
))
23737 int base_unit
= (width_p
23738 ? FRAME_COLUMN_WIDTH (it
->f
)
23739 : FRAME_LINE_HEIGHT (it
->f
));
23740 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23745 Lisp_Object car
= XCAR (prop
);
23746 Lisp_Object cdr
= XCDR (prop
);
23750 #ifdef HAVE_WINDOW_SYSTEM
23751 if (FRAME_WINDOW_P (it
->f
)
23752 && valid_image_p (prop
))
23754 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23755 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23757 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23760 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23766 while (CONSP (cdr
))
23768 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23769 font
, width_p
, align_to
))
23772 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23777 if (EQ (car
, Qminus
))
23779 return OK_PIXELS (pixels
);
23782 car
= buffer_local_value (car
, it
->w
->contents
);
23783 if (EQ (car
, Qunbound
))
23787 if (INTEGERP (car
) || FLOATP (car
))
23790 pixels
= XFLOATINT (car
);
23792 return OK_PIXELS (pixels
);
23793 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23794 font
, width_p
, align_to
))
23795 return OK_PIXELS (pixels
* fact
);
23806 /***********************************************************************
23808 ***********************************************************************/
23810 #ifdef HAVE_WINDOW_SYSTEM
23815 dump_glyph_string (struct glyph_string
*s
)
23817 fprintf (stderr
, "glyph string\n");
23818 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23819 s
->x
, s
->y
, s
->width
, s
->height
);
23820 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23821 fprintf (stderr
, " hl = %d\n", s
->hl
);
23822 fprintf (stderr
, " left overhang = %d, right = %d\n",
23823 s
->left_overhang
, s
->right_overhang
);
23824 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23825 fprintf (stderr
, " extends to end of line = %d\n",
23826 s
->extends_to_end_of_line_p
);
23827 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23828 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23831 #endif /* GLYPH_DEBUG */
23833 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23834 of XChar2b structures for S; it can't be allocated in
23835 init_glyph_string because it must be allocated via `alloca'. W
23836 is the window on which S is drawn. ROW and AREA are the glyph row
23837 and area within the row from which S is constructed. START is the
23838 index of the first glyph structure covered by S. HL is a
23839 face-override for drawing S. */
23842 #define OPTIONAL_HDC(hdc) HDC hdc,
23843 #define DECLARE_HDC(hdc) HDC hdc;
23844 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23845 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23848 #ifndef OPTIONAL_HDC
23849 #define OPTIONAL_HDC(hdc)
23850 #define DECLARE_HDC(hdc)
23851 #define ALLOCATE_HDC(hdc, f)
23852 #define RELEASE_HDC(hdc, f)
23856 init_glyph_string (struct glyph_string
*s
,
23858 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23859 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23861 memset (s
, 0, sizeof *s
);
23863 s
->f
= XFRAME (w
->frame
);
23867 s
->display
= FRAME_X_DISPLAY (s
->f
);
23868 s
->window
= FRAME_X_WINDOW (s
->f
);
23869 s
->char2b
= char2b
;
23873 s
->first_glyph
= row
->glyphs
[area
] + start
;
23874 s
->height
= row
->height
;
23875 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23876 s
->ybase
= s
->y
+ row
->ascent
;
23880 /* Append the list of glyph strings with head H and tail T to the list
23881 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23884 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23885 struct glyph_string
*h
, struct glyph_string
*t
)
23899 /* Prepend the list of glyph strings with head H and tail T to the
23900 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23904 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23905 struct glyph_string
*h
, struct glyph_string
*t
)
23919 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23920 Set *HEAD and *TAIL to the resulting list. */
23923 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23924 struct glyph_string
*s
)
23926 s
->next
= s
->prev
= NULL
;
23927 append_glyph_string_lists (head
, tail
, s
, s
);
23931 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23932 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23933 make sure that X resources for the face returned are allocated.
23934 Value is a pointer to a realized face that is ready for display if
23935 DISPLAY_P is non-zero. */
23937 static struct face
*
23938 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23939 XChar2b
*char2b
, int display_p
)
23941 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23946 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23948 if (code
== FONT_INVALID_CODE
)
23951 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23953 /* Make sure X resources of the face are allocated. */
23954 #ifdef HAVE_X_WINDOWS
23958 eassert (face
!= NULL
);
23959 prepare_face_for_display (f
, face
);
23966 /* Get face and two-byte form of character glyph GLYPH on frame F.
23967 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23968 a pointer to a realized face that is ready for display. */
23970 static struct face
*
23971 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23972 XChar2b
*char2b
, int *two_byte_p
)
23977 eassert (glyph
->type
== CHAR_GLYPH
);
23978 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23980 /* Make sure X resources of the face are allocated. */
23981 eassert (face
!= NULL
);
23982 prepare_face_for_display (f
, face
);
23989 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23990 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23992 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23994 if (code
== FONT_INVALID_CODE
)
23998 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24003 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24004 Return 1 if FONT has a glyph for C, otherwise return 0. */
24007 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24011 if (CHAR_BYTE8_P (c
))
24012 code
= CHAR_TO_BYTE8 (c
);
24014 code
= font
->driver
->encode_char (font
, c
);
24016 if (code
== FONT_INVALID_CODE
)
24018 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24023 /* Fill glyph string S with composition components specified by S->cmp.
24025 BASE_FACE is the base face of the composition.
24026 S->cmp_from is the index of the first component for S.
24028 OVERLAPS non-zero means S should draw the foreground only, and use
24029 its physical height for clipping. See also draw_glyphs.
24031 Value is the index of a component not in S. */
24034 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24038 /* For all glyphs of this composition, starting at the offset
24039 S->cmp_from, until we reach the end of the definition or encounter a
24040 glyph that requires the different face, add it to S. */
24045 s
->for_overlaps
= overlaps
;
24048 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24050 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24052 /* TAB in a composition means display glyphs with padding space
24053 on the left or right. */
24056 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24059 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24066 s
->font
= s
->face
->font
;
24068 else if (s
->face
!= face
)
24076 if (s
->face
== NULL
)
24078 s
->face
= base_face
->ascii_face
;
24079 s
->font
= s
->face
->font
;
24082 /* All glyph strings for the same composition has the same width,
24083 i.e. the width set for the first component of the composition. */
24084 s
->width
= s
->first_glyph
->pixel_width
;
24086 /* If the specified font could not be loaded, use the frame's
24087 default font, but record the fact that we couldn't load it in
24088 the glyph string so that we can draw rectangles for the
24089 characters of the glyph string. */
24090 if (s
->font
== NULL
)
24092 s
->font_not_found_p
= 1;
24093 s
->font
= FRAME_FONT (s
->f
);
24096 /* Adjust base line for subscript/superscript text. */
24097 s
->ybase
+= s
->first_glyph
->voffset
;
24099 /* This glyph string must always be drawn with 16-bit functions. */
24106 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24107 int start
, int end
, int overlaps
)
24109 struct glyph
*glyph
, *last
;
24110 Lisp_Object lgstring
;
24113 s
->for_overlaps
= overlaps
;
24114 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24115 last
= s
->row
->glyphs
[s
->area
] + end
;
24116 s
->cmp_id
= glyph
->u
.cmp
.id
;
24117 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24118 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24119 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24120 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24121 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24123 while (glyph
< last
24124 && glyph
->u
.cmp
.automatic
24125 && glyph
->u
.cmp
.id
== s
->cmp_id
24126 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24127 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24129 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24131 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24132 unsigned code
= LGLYPH_CODE (lglyph
);
24134 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24136 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24137 return glyph
- s
->row
->glyphs
[s
->area
];
24141 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24142 See the comment of fill_glyph_string for arguments.
24143 Value is the index of the first glyph not in S. */
24147 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24148 int start
, int end
, int overlaps
)
24150 struct glyph
*glyph
, *last
;
24153 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24154 s
->for_overlaps
= overlaps
;
24155 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24156 last
= s
->row
->glyphs
[s
->area
] + end
;
24157 voffset
= glyph
->voffset
;
24158 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24159 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24161 s
->width
= glyph
->pixel_width
;
24163 while (glyph
< last
24164 && glyph
->type
== GLYPHLESS_GLYPH
24165 && glyph
->voffset
== voffset
24166 && glyph
->face_id
== face_id
)
24169 s
->width
+= glyph
->pixel_width
;
24172 s
->ybase
+= voffset
;
24173 return glyph
- s
->row
->glyphs
[s
->area
];
24177 /* Fill glyph string S from a sequence of character glyphs.
24179 FACE_ID is the face id of the string. START is the index of the
24180 first glyph to consider, END is the index of the last + 1.
24181 OVERLAPS non-zero means S should draw the foreground only, and use
24182 its physical height for clipping. See also draw_glyphs.
24184 Value is the index of the first glyph not in S. */
24187 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24188 int start
, int end
, int overlaps
)
24190 struct glyph
*glyph
, *last
;
24192 int glyph_not_available_p
;
24194 eassert (s
->f
== XFRAME (s
->w
->frame
));
24195 eassert (s
->nchars
== 0);
24196 eassert (start
>= 0 && end
> start
);
24198 s
->for_overlaps
= overlaps
;
24199 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24200 last
= s
->row
->glyphs
[s
->area
] + end
;
24201 voffset
= glyph
->voffset
;
24202 s
->padding_p
= glyph
->padding_p
;
24203 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24205 while (glyph
< last
24206 && glyph
->type
== CHAR_GLYPH
24207 && glyph
->voffset
== voffset
24208 /* Same face id implies same font, nowadays. */
24209 && glyph
->face_id
== face_id
24210 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24214 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24215 s
->char2b
+ s
->nchars
,
24217 s
->two_byte_p
= two_byte_p
;
24219 eassert (s
->nchars
<= end
- start
);
24220 s
->width
+= glyph
->pixel_width
;
24221 if (glyph
++->padding_p
!= s
->padding_p
)
24225 s
->font
= s
->face
->font
;
24227 /* If the specified font could not be loaded, use the frame's font,
24228 but record the fact that we couldn't load it in
24229 S->font_not_found_p so that we can draw rectangles for the
24230 characters of the glyph string. */
24231 if (s
->font
== NULL
|| glyph_not_available_p
)
24233 s
->font_not_found_p
= 1;
24234 s
->font
= FRAME_FONT (s
->f
);
24237 /* Adjust base line for subscript/superscript text. */
24238 s
->ybase
+= voffset
;
24240 eassert (s
->face
&& s
->face
->gc
);
24241 return glyph
- s
->row
->glyphs
[s
->area
];
24245 /* Fill glyph string S from image glyph S->first_glyph. */
24248 fill_image_glyph_string (struct glyph_string
*s
)
24250 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24251 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24253 s
->slice
= s
->first_glyph
->slice
.img
;
24254 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24255 s
->font
= s
->face
->font
;
24256 s
->width
= s
->first_glyph
->pixel_width
;
24258 /* Adjust base line for subscript/superscript text. */
24259 s
->ybase
+= s
->first_glyph
->voffset
;
24263 /* Fill glyph string S from a sequence of stretch glyphs.
24265 START is the index of the first glyph to consider,
24266 END is the index of the last + 1.
24268 Value is the index of the first glyph not in S. */
24271 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24273 struct glyph
*glyph
, *last
;
24274 int voffset
, face_id
;
24276 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24278 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24279 last
= s
->row
->glyphs
[s
->area
] + end
;
24280 face_id
= glyph
->face_id
;
24281 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24282 s
->font
= s
->face
->font
;
24283 s
->width
= glyph
->pixel_width
;
24285 voffset
= glyph
->voffset
;
24289 && glyph
->type
== STRETCH_GLYPH
24290 && glyph
->voffset
== voffset
24291 && glyph
->face_id
== face_id
);
24293 s
->width
+= glyph
->pixel_width
;
24295 /* Adjust base line for subscript/superscript text. */
24296 s
->ybase
+= voffset
;
24298 /* The case that face->gc == 0 is handled when drawing the glyph
24299 string by calling prepare_face_for_display. */
24301 return glyph
- s
->row
->glyphs
[s
->area
];
24304 static struct font_metrics
*
24305 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24307 static struct font_metrics metrics
;
24312 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24313 if (code
== FONT_INVALID_CODE
)
24315 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24320 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24321 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24322 assumed to be zero. */
24325 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24327 *left
= *right
= 0;
24329 if (glyph
->type
== CHAR_GLYPH
)
24333 struct font_metrics
*pcm
;
24335 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24336 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24338 if (pcm
->rbearing
> pcm
->width
)
24339 *right
= pcm
->rbearing
- pcm
->width
;
24340 if (pcm
->lbearing
< 0)
24341 *left
= -pcm
->lbearing
;
24344 else if (glyph
->type
== COMPOSITE_GLYPH
)
24346 if (! glyph
->u
.cmp
.automatic
)
24348 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24350 if (cmp
->rbearing
> cmp
->pixel_width
)
24351 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24352 if (cmp
->lbearing
< 0)
24353 *left
= - cmp
->lbearing
;
24357 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24358 struct font_metrics metrics
;
24360 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24361 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24362 if (metrics
.rbearing
> metrics
.width
)
24363 *right
= metrics
.rbearing
- metrics
.width
;
24364 if (metrics
.lbearing
< 0)
24365 *left
= - metrics
.lbearing
;
24371 /* Return the index of the first glyph preceding glyph string S that
24372 is overwritten by S because of S's left overhang. Value is -1
24373 if no glyphs are overwritten. */
24376 left_overwritten (struct glyph_string
*s
)
24380 if (s
->left_overhang
)
24383 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24384 int first
= s
->first_glyph
- glyphs
;
24386 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24387 x
-= glyphs
[i
].pixel_width
;
24398 /* Return the index of the first glyph preceding glyph string S that
24399 is overwriting S because of its right overhang. Value is -1 if no
24400 glyph in front of S overwrites S. */
24403 left_overwriting (struct glyph_string
*s
)
24406 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24407 int first
= s
->first_glyph
- glyphs
;
24411 for (i
= first
- 1; i
>= 0; --i
)
24414 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24417 x
-= glyphs
[i
].pixel_width
;
24424 /* Return the index of the last glyph following glyph string S that is
24425 overwritten by S because of S's right overhang. Value is -1 if
24426 no such glyph is found. */
24429 right_overwritten (struct glyph_string
*s
)
24433 if (s
->right_overhang
)
24436 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24437 int first
= (s
->first_glyph
- glyphs
24438 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24439 int end
= s
->row
->used
[s
->area
];
24441 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24442 x
+= glyphs
[i
].pixel_width
;
24451 /* Return the index of the last glyph following glyph string S that
24452 overwrites S because of its left overhang. Value is negative
24453 if no such glyph is found. */
24456 right_overwriting (struct glyph_string
*s
)
24459 int end
= s
->row
->used
[s
->area
];
24460 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24461 int first
= (s
->first_glyph
- glyphs
24462 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24466 for (i
= first
; i
< end
; ++i
)
24469 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24472 x
+= glyphs
[i
].pixel_width
;
24479 /* Set background width of glyph string S. START is the index of the
24480 first glyph following S. LAST_X is the right-most x-position + 1
24481 in the drawing area. */
24484 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24486 /* If the face of this glyph string has to be drawn to the end of
24487 the drawing area, set S->extends_to_end_of_line_p. */
24489 if (start
== s
->row
->used
[s
->area
]
24490 && ((s
->row
->fill_line_p
24491 && (s
->hl
== DRAW_NORMAL_TEXT
24492 || s
->hl
== DRAW_IMAGE_RAISED
24493 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24494 || s
->hl
== DRAW_MOUSE_FACE
))
24495 s
->extends_to_end_of_line_p
= 1;
24497 /* If S extends its face to the end of the line, set its
24498 background_width to the distance to the right edge of the drawing
24500 if (s
->extends_to_end_of_line_p
)
24501 s
->background_width
= last_x
- s
->x
+ 1;
24503 s
->background_width
= s
->width
;
24507 /* Compute overhangs and x-positions for glyph string S and its
24508 predecessors, or successors. X is the starting x-position for S.
24509 BACKWARD_P non-zero means process predecessors. */
24512 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24518 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24519 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24529 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24530 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24540 /* The following macros are only called from draw_glyphs below.
24541 They reference the following parameters of that function directly:
24542 `w', `row', `area', and `overlap_p'
24543 as well as the following local variables:
24544 `s', `f', and `hdc' (in W32) */
24547 /* On W32, silently add local `hdc' variable to argument list of
24548 init_glyph_string. */
24549 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24550 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24552 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24553 init_glyph_string (s, char2b, w, row, area, start, hl)
24556 /* Add a glyph string for a stretch glyph to the list of strings
24557 between HEAD and TAIL. START is the index of the stretch glyph in
24558 row area AREA of glyph row ROW. END is the index of the last glyph
24559 in that glyph row area. X is the current output position assigned
24560 to the new glyph string constructed. HL overrides that face of the
24561 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24562 is the right-most x-position of the drawing area. */
24564 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24565 and below -- keep them on one line. */
24566 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24569 s = alloca (sizeof *s); \
24570 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24571 START = fill_stretch_glyph_string (s, START, END); \
24572 append_glyph_string (&HEAD, &TAIL, s); \
24578 /* Add a glyph string for an image glyph to the list of strings
24579 between HEAD and TAIL. START is the index of the image glyph in
24580 row area AREA of glyph row ROW. END is the index of the last glyph
24581 in that glyph row area. X is the current output position assigned
24582 to the new glyph string constructed. HL overrides that face of the
24583 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24584 is the right-most x-position of the drawing area. */
24586 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24589 s = alloca (sizeof *s); \
24590 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24591 fill_image_glyph_string (s); \
24592 append_glyph_string (&HEAD, &TAIL, s); \
24599 /* Add a glyph string for a sequence of character glyphs to the list
24600 of strings between HEAD and TAIL. START is the index of the first
24601 glyph in row area AREA of glyph row ROW that is part of the new
24602 glyph string. END is the index of the last glyph in that glyph row
24603 area. X is the current output position assigned to the new glyph
24604 string constructed. HL overrides that face of the glyph; e.g. it
24605 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24606 right-most x-position of the drawing area. */
24608 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24614 face_id = (row)->glyphs[area][START].face_id; \
24616 s = alloca (sizeof *s); \
24617 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24618 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24619 append_glyph_string (&HEAD, &TAIL, s); \
24621 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24626 /* Add a glyph string for a composite sequence to the list of strings
24627 between HEAD and TAIL. START is the index of the first glyph in
24628 row area AREA of glyph row ROW that is part of the new glyph
24629 string. END is the index of the last glyph in that glyph row area.
24630 X is the current output position assigned to the new glyph string
24631 constructed. HL overrides that face of the glyph; e.g. it is
24632 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24633 x-position of the drawing area. */
24635 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24637 int face_id = (row)->glyphs[area][START].face_id; \
24638 struct face *base_face = FACE_FROM_ID (f, face_id); \
24639 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24640 struct composition *cmp = composition_table[cmp_id]; \
24642 struct glyph_string *first_s = NULL; \
24645 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
24647 /* Make glyph_strings for each glyph sequence that is drawable by \
24648 the same face, and append them to HEAD/TAIL. */ \
24649 for (n = 0; n < cmp->glyph_len;) \
24651 s = alloca (sizeof *s); \
24652 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24653 append_glyph_string (&(HEAD), &(TAIL), s); \
24659 n = fill_composite_glyph_string (s, base_face, overlaps); \
24667 /* Add a glyph string for a glyph-string sequence to the list of strings
24668 between HEAD and TAIL. */
24670 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24674 Lisp_Object gstring; \
24676 face_id = (row)->glyphs[area][START].face_id; \
24677 gstring = (composition_gstring_from_id \
24678 ((row)->glyphs[area][START].u.cmp.id)); \
24679 s = alloca (sizeof *s); \
24680 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
24681 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24682 append_glyph_string (&(HEAD), &(TAIL), s); \
24684 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24688 /* Add a glyph string for a sequence of glyphless character's glyphs
24689 to the list of strings between HEAD and TAIL. The meanings of
24690 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24692 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24697 face_id = (row)->glyphs[area][START].face_id; \
24699 s = alloca (sizeof *s); \
24700 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24701 append_glyph_string (&HEAD, &TAIL, s); \
24703 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24709 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24710 of AREA of glyph row ROW on window W between indices START and END.
24711 HL overrides the face for drawing glyph strings, e.g. it is
24712 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24713 x-positions of the drawing area.
24715 This is an ugly monster macro construct because we must use alloca
24716 to allocate glyph strings (because draw_glyphs can be called
24717 asynchronously). */
24719 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24722 HEAD = TAIL = NULL; \
24723 while (START < END) \
24725 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24726 switch (first_glyph->type) \
24729 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24733 case COMPOSITE_GLYPH: \
24734 if (first_glyph->u.cmp.automatic) \
24735 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24738 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24742 case STRETCH_GLYPH: \
24743 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24747 case IMAGE_GLYPH: \
24748 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24752 case GLYPHLESS_GLYPH: \
24753 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24763 set_glyph_string_background_width (s, START, LAST_X); \
24770 /* Draw glyphs between START and END in AREA of ROW on window W,
24771 starting at x-position X. X is relative to AREA in W. HL is a
24772 face-override with the following meaning:
24774 DRAW_NORMAL_TEXT draw normally
24775 DRAW_CURSOR draw in cursor face
24776 DRAW_MOUSE_FACE draw in mouse face.
24777 DRAW_INVERSE_VIDEO draw in mode line face
24778 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24779 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24781 If OVERLAPS is non-zero, draw only the foreground of characters and
24782 clip to the physical height of ROW. Non-zero value also defines
24783 the overlapping part to be drawn:
24785 OVERLAPS_PRED overlap with preceding rows
24786 OVERLAPS_SUCC overlap with succeeding rows
24787 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24788 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24790 Value is the x-position reached, relative to AREA of W. */
24793 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24794 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24795 enum draw_glyphs_face hl
, int overlaps
)
24797 struct glyph_string
*head
, *tail
;
24798 struct glyph_string
*s
;
24799 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24800 int i
, j
, x_reached
, last_x
, area_left
= 0;
24801 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24804 ALLOCATE_HDC (hdc
, f
);
24806 /* Let's rather be paranoid than getting a SEGV. */
24807 end
= min (end
, row
->used
[area
]);
24808 start
= clip_to_bounds (0, start
, end
);
24810 /* Translate X to frame coordinates. Set last_x to the right
24811 end of the drawing area. */
24812 if (row
->full_width_p
)
24814 /* X is relative to the left edge of W, without scroll bars
24816 area_left
= WINDOW_LEFT_EDGE_X (w
);
24817 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24818 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24822 area_left
= window_box_left (w
, area
);
24823 last_x
= area_left
+ window_box_width (w
, area
);
24827 /* Build a doubly-linked list of glyph_string structures between
24828 head and tail from what we have to draw. Note that the macro
24829 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24830 the reason we use a separate variable `i'. */
24833 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24835 x_reached
= tail
->x
+ tail
->background_width
;
24839 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24840 the row, redraw some glyphs in front or following the glyph
24841 strings built above. */
24842 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24844 struct glyph_string
*h
, *t
;
24845 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24846 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24847 int check_mouse_face
= 0;
24850 /* If mouse highlighting is on, we may need to draw adjacent
24851 glyphs using mouse-face highlighting. */
24852 if (area
== TEXT_AREA
&& row
->mouse_face_p
24853 && hlinfo
->mouse_face_beg_row
>= 0
24854 && hlinfo
->mouse_face_end_row
>= 0)
24856 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24858 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24859 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24861 check_mouse_face
= 1;
24862 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24863 ? hlinfo
->mouse_face_beg_col
: 0;
24864 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24865 ? hlinfo
->mouse_face_end_col
24866 : row
->used
[TEXT_AREA
];
24870 /* Compute overhangs for all glyph strings. */
24871 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24872 for (s
= head
; s
; s
= s
->next
)
24873 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24875 /* Prepend glyph strings for glyphs in front of the first glyph
24876 string that are overwritten because of the first glyph
24877 string's left overhang. The background of all strings
24878 prepended must be drawn because the first glyph string
24880 i
= left_overwritten (head
);
24883 enum draw_glyphs_face overlap_hl
;
24885 /* If this row contains mouse highlighting, attempt to draw
24886 the overlapped glyphs with the correct highlight. This
24887 code fails if the overlap encompasses more than one glyph
24888 and mouse-highlight spans only some of these glyphs.
24889 However, making it work perfectly involves a lot more
24890 code, and I don't know if the pathological case occurs in
24891 practice, so we'll stick to this for now. --- cyd */
24892 if (check_mouse_face
24893 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24894 overlap_hl
= DRAW_MOUSE_FACE
;
24896 overlap_hl
= DRAW_NORMAL_TEXT
;
24898 if (hl
!= overlap_hl
)
24901 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24902 overlap_hl
, dummy_x
, last_x
);
24904 compute_overhangs_and_x (t
, head
->x
, 1);
24905 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24906 if (clip_head
== NULL
)
24910 /* Prepend glyph strings for glyphs in front of the first glyph
24911 string that overwrite that glyph string because of their
24912 right overhang. For these strings, only the foreground must
24913 be drawn, because it draws over the glyph string at `head'.
24914 The background must not be drawn because this would overwrite
24915 right overhangs of preceding glyphs for which no glyph
24917 i
= left_overwriting (head
);
24920 enum draw_glyphs_face overlap_hl
;
24922 if (check_mouse_face
24923 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24924 overlap_hl
= DRAW_MOUSE_FACE
;
24926 overlap_hl
= DRAW_NORMAL_TEXT
;
24928 if (hl
== overlap_hl
|| clip_head
== NULL
)
24930 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24931 overlap_hl
, dummy_x
, last_x
);
24932 for (s
= h
; s
; s
= s
->next
)
24933 s
->background_filled_p
= 1;
24934 compute_overhangs_and_x (t
, head
->x
, 1);
24935 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24938 /* Append glyphs strings for glyphs following the last glyph
24939 string tail that are overwritten by tail. The background of
24940 these strings has to be drawn because tail's foreground draws
24942 i
= right_overwritten (tail
);
24945 enum draw_glyphs_face overlap_hl
;
24947 if (check_mouse_face
24948 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24949 overlap_hl
= DRAW_MOUSE_FACE
;
24951 overlap_hl
= DRAW_NORMAL_TEXT
;
24953 if (hl
!= overlap_hl
)
24955 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24956 overlap_hl
, x
, last_x
);
24957 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24958 we don't have `end = i;' here. */
24959 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24960 append_glyph_string_lists (&head
, &tail
, h
, t
);
24961 if (clip_tail
== NULL
)
24965 /* Append glyph strings for glyphs following the last glyph
24966 string tail that overwrite tail. The foreground of such
24967 glyphs has to be drawn because it writes into the background
24968 of tail. The background must not be drawn because it could
24969 paint over the foreground of following glyphs. */
24970 i
= right_overwriting (tail
);
24973 enum draw_glyphs_face overlap_hl
;
24974 if (check_mouse_face
24975 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24976 overlap_hl
= DRAW_MOUSE_FACE
;
24978 overlap_hl
= DRAW_NORMAL_TEXT
;
24980 if (hl
== overlap_hl
|| clip_tail
== NULL
)
24982 i
++; /* We must include the Ith glyph. */
24983 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24984 overlap_hl
, x
, last_x
);
24985 for (s
= h
; s
; s
= s
->next
)
24986 s
->background_filled_p
= 1;
24987 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24988 append_glyph_string_lists (&head
, &tail
, h
, t
);
24990 if (clip_head
|| clip_tail
)
24991 for (s
= head
; s
; s
= s
->next
)
24993 s
->clip_head
= clip_head
;
24994 s
->clip_tail
= clip_tail
;
24998 /* Draw all strings. */
24999 for (s
= head
; s
; s
= s
->next
)
25000 FRAME_RIF (f
)->draw_glyph_string (s
);
25003 /* When focus a sole frame and move horizontally, this sets on_p to 0
25004 causing a failure to erase prev cursor position. */
25005 if (area
== TEXT_AREA
25006 && !row
->full_width_p
25007 /* When drawing overlapping rows, only the glyph strings'
25008 foreground is drawn, which doesn't erase a cursor
25012 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25013 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25014 : (tail
? tail
->x
+ tail
->background_width
: x
));
25018 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25019 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25023 /* Value is the x-position up to which drawn, relative to AREA of W.
25024 This doesn't include parts drawn because of overhangs. */
25025 if (row
->full_width_p
)
25026 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25028 x_reached
-= area_left
;
25030 RELEASE_HDC (hdc
, f
);
25036 /* Expand row matrix if too narrow. Don't expand if area
25039 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25041 if (!it->f->fonts_changed \
25042 && (it->glyph_row->glyphs[area] \
25043 < it->glyph_row->glyphs[area + 1])) \
25045 it->w->ncols_scale_factor++; \
25046 it->f->fonts_changed = 1; \
25050 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25051 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25054 append_glyph (struct it
*it
)
25056 struct glyph
*glyph
;
25057 enum glyph_row_area area
= it
->area
;
25059 eassert (it
->glyph_row
);
25060 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25062 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25063 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25065 /* If the glyph row is reversed, we need to prepend the glyph
25066 rather than append it. */
25067 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25071 /* Make room for the additional glyph. */
25072 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25074 glyph
= it
->glyph_row
->glyphs
[area
];
25076 glyph
->charpos
= CHARPOS (it
->position
);
25077 glyph
->object
= it
->object
;
25078 if (it
->pixel_width
> 0)
25080 glyph
->pixel_width
= it
->pixel_width
;
25081 glyph
->padding_p
= 0;
25085 /* Assure at least 1-pixel width. Otherwise, cursor can't
25086 be displayed correctly. */
25087 glyph
->pixel_width
= 1;
25088 glyph
->padding_p
= 1;
25090 glyph
->ascent
= it
->ascent
;
25091 glyph
->descent
= it
->descent
;
25092 glyph
->voffset
= it
->voffset
;
25093 glyph
->type
= CHAR_GLYPH
;
25094 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25095 glyph
->multibyte_p
= it
->multibyte_p
;
25096 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25098 /* In R2L rows, the left and the right box edges need to be
25099 drawn in reverse direction. */
25100 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25101 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25105 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25106 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25108 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25109 || it
->phys_descent
> it
->descent
);
25110 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25111 glyph
->face_id
= it
->face_id
;
25112 glyph
->u
.ch
= it
->char_to_display
;
25113 glyph
->slice
.img
= null_glyph_slice
;
25114 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25117 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25118 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25120 glyph
->bidi_type
= it
->bidi_it
.type
;
25124 glyph
->resolved_level
= 0;
25125 glyph
->bidi_type
= UNKNOWN_BT
;
25127 ++it
->glyph_row
->used
[area
];
25130 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25133 /* Store one glyph for the composition IT->cmp_it.id in
25134 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25138 append_composite_glyph (struct it
*it
)
25140 struct glyph
*glyph
;
25141 enum glyph_row_area area
= it
->area
;
25143 eassert (it
->glyph_row
);
25145 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25146 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25148 /* If the glyph row is reversed, we need to prepend the glyph
25149 rather than append it. */
25150 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25154 /* Make room for the new glyph. */
25155 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25157 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25159 glyph
->charpos
= it
->cmp_it
.charpos
;
25160 glyph
->object
= it
->object
;
25161 glyph
->pixel_width
= it
->pixel_width
;
25162 glyph
->ascent
= it
->ascent
;
25163 glyph
->descent
= it
->descent
;
25164 glyph
->voffset
= it
->voffset
;
25165 glyph
->type
= COMPOSITE_GLYPH
;
25166 if (it
->cmp_it
.ch
< 0)
25168 glyph
->u
.cmp
.automatic
= 0;
25169 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25170 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25174 glyph
->u
.cmp
.automatic
= 1;
25175 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25176 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25177 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25179 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25180 glyph
->multibyte_p
= it
->multibyte_p
;
25181 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25183 /* In R2L rows, the left and the right box edges need to be
25184 drawn in reverse direction. */
25185 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25186 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25190 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25191 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25193 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25194 || it
->phys_descent
> it
->descent
);
25195 glyph
->padding_p
= 0;
25196 glyph
->glyph_not_available_p
= 0;
25197 glyph
->face_id
= it
->face_id
;
25198 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25201 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25202 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25204 glyph
->bidi_type
= it
->bidi_it
.type
;
25206 ++it
->glyph_row
->used
[area
];
25209 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25213 /* Change IT->ascent and IT->height according to the setting of
25217 take_vertical_position_into_account (struct it
*it
)
25221 if (it
->voffset
< 0)
25222 /* Increase the ascent so that we can display the text higher
25224 it
->ascent
-= it
->voffset
;
25226 /* Increase the descent so that we can display the text lower
25228 it
->descent
+= it
->voffset
;
25233 /* Produce glyphs/get display metrics for the image IT is loaded with.
25234 See the description of struct display_iterator in dispextern.h for
25235 an overview of struct display_iterator. */
25238 produce_image_glyph (struct it
*it
)
25242 int glyph_ascent
, crop
;
25243 struct glyph_slice slice
;
25245 eassert (it
->what
== IT_IMAGE
);
25247 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25249 /* Make sure X resources of the face is loaded. */
25250 prepare_face_for_display (it
->f
, face
);
25252 if (it
->image_id
< 0)
25254 /* Fringe bitmap. */
25255 it
->ascent
= it
->phys_ascent
= 0;
25256 it
->descent
= it
->phys_descent
= 0;
25257 it
->pixel_width
= 0;
25262 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25264 /* Make sure X resources of the image is loaded. */
25265 prepare_image_for_display (it
->f
, img
);
25267 slice
.x
= slice
.y
= 0;
25268 slice
.width
= img
->width
;
25269 slice
.height
= img
->height
;
25271 if (INTEGERP (it
->slice
.x
))
25272 slice
.x
= XINT (it
->slice
.x
);
25273 else if (FLOATP (it
->slice
.x
))
25274 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25276 if (INTEGERP (it
->slice
.y
))
25277 slice
.y
= XINT (it
->slice
.y
);
25278 else if (FLOATP (it
->slice
.y
))
25279 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25281 if (INTEGERP (it
->slice
.width
))
25282 slice
.width
= XINT (it
->slice
.width
);
25283 else if (FLOATP (it
->slice
.width
))
25284 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25286 if (INTEGERP (it
->slice
.height
))
25287 slice
.height
= XINT (it
->slice
.height
);
25288 else if (FLOATP (it
->slice
.height
))
25289 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25291 if (slice
.x
>= img
->width
)
25292 slice
.x
= img
->width
;
25293 if (slice
.y
>= img
->height
)
25294 slice
.y
= img
->height
;
25295 if (slice
.x
+ slice
.width
>= img
->width
)
25296 slice
.width
= img
->width
- slice
.x
;
25297 if (slice
.y
+ slice
.height
> img
->height
)
25298 slice
.height
= img
->height
- slice
.y
;
25300 if (slice
.width
== 0 || slice
.height
== 0)
25303 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25305 it
->descent
= slice
.height
- glyph_ascent
;
25307 it
->descent
+= img
->vmargin
;
25308 if (slice
.y
+ slice
.height
== img
->height
)
25309 it
->descent
+= img
->vmargin
;
25310 it
->phys_descent
= it
->descent
;
25312 it
->pixel_width
= slice
.width
;
25314 it
->pixel_width
+= img
->hmargin
;
25315 if (slice
.x
+ slice
.width
== img
->width
)
25316 it
->pixel_width
+= img
->hmargin
;
25318 /* It's quite possible for images to have an ascent greater than
25319 their height, so don't get confused in that case. */
25320 if (it
->descent
< 0)
25325 if (face
->box
!= FACE_NO_BOX
)
25327 if (face
->box_line_width
> 0)
25330 it
->ascent
+= face
->box_line_width
;
25331 if (slice
.y
+ slice
.height
== img
->height
)
25332 it
->descent
+= face
->box_line_width
;
25335 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25336 it
->pixel_width
+= eabs (face
->box_line_width
);
25337 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25338 it
->pixel_width
+= eabs (face
->box_line_width
);
25341 take_vertical_position_into_account (it
);
25343 /* Automatically crop wide image glyphs at right edge so we can
25344 draw the cursor on same display row. */
25345 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25346 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25348 it
->pixel_width
-= crop
;
25349 slice
.width
-= crop
;
25354 struct glyph
*glyph
;
25355 enum glyph_row_area area
= it
->area
;
25357 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25358 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25360 glyph
->charpos
= CHARPOS (it
->position
);
25361 glyph
->object
= it
->object
;
25362 glyph
->pixel_width
= it
->pixel_width
;
25363 glyph
->ascent
= glyph_ascent
;
25364 glyph
->descent
= it
->descent
;
25365 glyph
->voffset
= it
->voffset
;
25366 glyph
->type
= IMAGE_GLYPH
;
25367 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25368 glyph
->multibyte_p
= it
->multibyte_p
;
25369 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25371 /* In R2L rows, the left and the right box edges need to be
25372 drawn in reverse direction. */
25373 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25374 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25378 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25379 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25381 glyph
->overlaps_vertically_p
= 0;
25382 glyph
->padding_p
= 0;
25383 glyph
->glyph_not_available_p
= 0;
25384 glyph
->face_id
= it
->face_id
;
25385 glyph
->u
.img_id
= img
->id
;
25386 glyph
->slice
.img
= slice
;
25387 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25390 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25391 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25393 glyph
->bidi_type
= it
->bidi_it
.type
;
25395 ++it
->glyph_row
->used
[area
];
25398 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25403 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25404 of the glyph, WIDTH and HEIGHT are the width and height of the
25405 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25408 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25409 int width
, int height
, int ascent
)
25411 struct glyph
*glyph
;
25412 enum glyph_row_area area
= it
->area
;
25414 eassert (ascent
>= 0 && ascent
<= height
);
25416 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25417 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25419 /* If the glyph row is reversed, we need to prepend the glyph
25420 rather than append it. */
25421 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25425 /* Make room for the additional glyph. */
25426 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25428 glyph
= it
->glyph_row
->glyphs
[area
];
25430 /* Decrease the width of the first glyph of the row that
25431 begins before first_visible_x (e.g., due to hscroll).
25432 This is so the overall width of the row becomes smaller
25433 by the scroll amount, and the stretch glyph appended by
25434 extend_face_to_end_of_line will be wider, to shift the
25435 row glyphs to the right. (In L2R rows, the corresponding
25436 left-shift effect is accomplished by setting row->x to a
25437 negative value, which won't work with R2L rows.)
25439 This must leave us with a positive value of WIDTH, since
25440 otherwise the call to move_it_in_display_line_to at the
25441 beginning of display_line would have got past the entire
25442 first glyph, and then it->current_x would have been
25443 greater or equal to it->first_visible_x. */
25444 if (it
->current_x
< it
->first_visible_x
)
25445 width
-= it
->first_visible_x
- it
->current_x
;
25446 eassert (width
> 0);
25448 glyph
->charpos
= CHARPOS (it
->position
);
25449 glyph
->object
= object
;
25450 glyph
->pixel_width
= width
;
25451 glyph
->ascent
= ascent
;
25452 glyph
->descent
= height
- ascent
;
25453 glyph
->voffset
= it
->voffset
;
25454 glyph
->type
= STRETCH_GLYPH
;
25455 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25456 glyph
->multibyte_p
= it
->multibyte_p
;
25457 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25459 /* In R2L rows, the left and the right box edges need to be
25460 drawn in reverse direction. */
25461 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25462 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25466 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25467 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25469 glyph
->overlaps_vertically_p
= 0;
25470 glyph
->padding_p
= 0;
25471 glyph
->glyph_not_available_p
= 0;
25472 glyph
->face_id
= it
->face_id
;
25473 glyph
->u
.stretch
.ascent
= ascent
;
25474 glyph
->u
.stretch
.height
= height
;
25475 glyph
->slice
.img
= null_glyph_slice
;
25476 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25479 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25480 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25482 glyph
->bidi_type
= it
->bidi_it
.type
;
25486 glyph
->resolved_level
= 0;
25487 glyph
->bidi_type
= UNKNOWN_BT
;
25489 ++it
->glyph_row
->used
[area
];
25492 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25495 #endif /* HAVE_WINDOW_SYSTEM */
25497 /* Produce a stretch glyph for iterator IT. IT->object is the value
25498 of the glyph property displayed. The value must be a list
25499 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25502 1. `:width WIDTH' specifies that the space should be WIDTH *
25503 canonical char width wide. WIDTH may be an integer or floating
25506 2. `:relative-width FACTOR' specifies that the width of the stretch
25507 should be computed from the width of the first character having the
25508 `glyph' property, and should be FACTOR times that width.
25510 3. `:align-to HPOS' specifies that the space should be wide enough
25511 to reach HPOS, a value in canonical character units.
25513 Exactly one of the above pairs must be present.
25515 4. `:height HEIGHT' specifies that the height of the stretch produced
25516 should be HEIGHT, measured in canonical character units.
25518 5. `:relative-height FACTOR' specifies that the height of the
25519 stretch should be FACTOR times the height of the characters having
25520 the glyph property.
25522 Either none or exactly one of 4 or 5 must be present.
25524 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25525 of the stretch should be used for the ascent of the stretch.
25526 ASCENT must be in the range 0 <= ASCENT <= 100. */
25529 produce_stretch_glyph (struct it
*it
)
25531 /* (space :width WIDTH :height HEIGHT ...) */
25532 Lisp_Object prop
, plist
;
25533 int width
= 0, height
= 0, align_to
= -1;
25534 int zero_width_ok_p
= 0;
25536 struct font
*font
= NULL
;
25538 #ifdef HAVE_WINDOW_SYSTEM
25540 int zero_height_ok_p
= 0;
25542 if (FRAME_WINDOW_P (it
->f
))
25544 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25545 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25546 prepare_face_for_display (it
->f
, face
);
25550 /* List should start with `space'. */
25551 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25552 plist
= XCDR (it
->object
);
25554 /* Compute the width of the stretch. */
25555 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25556 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25558 /* Absolute width `:width WIDTH' specified and valid. */
25559 zero_width_ok_p
= 1;
25562 #ifdef HAVE_WINDOW_SYSTEM
25563 else if (FRAME_WINDOW_P (it
->f
)
25564 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25566 /* Relative width `:relative-width FACTOR' specified and valid.
25567 Compute the width of the characters having the `glyph'
25570 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25573 if (it
->multibyte_p
)
25574 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25577 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25578 if (! ASCII_CHAR_P (it2
.c
))
25579 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25582 it2
.glyph_row
= NULL
;
25583 it2
.what
= IT_CHARACTER
;
25584 x_produce_glyphs (&it2
);
25585 width
= NUMVAL (prop
) * it2
.pixel_width
;
25587 #endif /* HAVE_WINDOW_SYSTEM */
25588 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25589 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25591 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25592 align_to
= (align_to
< 0
25594 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25595 else if (align_to
< 0)
25596 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25597 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25598 zero_width_ok_p
= 1;
25601 /* Nothing specified -> width defaults to canonical char width. */
25602 width
= FRAME_COLUMN_WIDTH (it
->f
);
25604 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25607 #ifdef HAVE_WINDOW_SYSTEM
25608 /* Compute height. */
25609 if (FRAME_WINDOW_P (it
->f
))
25611 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25612 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25615 zero_height_ok_p
= 1;
25617 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25619 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25621 height
= FONT_HEIGHT (font
);
25623 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25626 /* Compute percentage of height used for ascent. If
25627 `:ascent ASCENT' is present and valid, use that. Otherwise,
25628 derive the ascent from the font in use. */
25629 if (prop
= Fplist_get (plist
, QCascent
),
25630 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25631 ascent
= height
* NUMVAL (prop
) / 100.0;
25632 else if (!NILP (prop
)
25633 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25634 ascent
= min (max (0, (int)tem
), height
);
25636 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25639 #endif /* HAVE_WINDOW_SYSTEM */
25642 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25643 && it
->current_x
+ width
> it
->last_visible_x
)
25645 width
= it
->last_visible_x
- it
->current_x
;
25646 #ifdef HAVE_WINDOW_SYSTEM
25647 /* Subtract one more pixel from the stretch width, but only on
25648 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25649 width
-= FRAME_WINDOW_P (it
->f
);
25653 if (width
> 0 && height
> 0 && it
->glyph_row
)
25655 Lisp_Object o_object
= it
->object
;
25656 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25659 if (!STRINGP (object
))
25660 object
= it
->w
->contents
;
25661 #ifdef HAVE_WINDOW_SYSTEM
25662 if (FRAME_WINDOW_P (it
->f
))
25663 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25667 it
->object
= object
;
25668 it
->char_to_display
= ' ';
25669 it
->pixel_width
= it
->len
= 1;
25671 tty_append_glyph (it
);
25672 it
->object
= o_object
;
25676 it
->pixel_width
= width
;
25677 #ifdef HAVE_WINDOW_SYSTEM
25678 if (FRAME_WINDOW_P (it
->f
))
25680 it
->ascent
= it
->phys_ascent
= ascent
;
25681 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25682 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25683 take_vertical_position_into_account (it
);
25687 it
->nglyphs
= width
;
25690 /* Get information about special display element WHAT in an
25691 environment described by IT. WHAT is one of IT_TRUNCATION or
25692 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25693 non-null glyph_row member. This function ensures that fields like
25694 face_id, c, len of IT are left untouched. */
25697 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25704 temp_it
.object
= make_number (0);
25705 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25707 if (what
== IT_CONTINUATION
)
25709 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25710 if (it
->bidi_it
.paragraph_dir
== R2L
)
25711 SET_GLYPH_FROM_CHAR (glyph
, '/');
25713 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25715 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25717 /* FIXME: Should we mirror GC for R2L lines? */
25718 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25719 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25722 else if (what
== IT_TRUNCATION
)
25724 /* Truncation glyph. */
25725 SET_GLYPH_FROM_CHAR (glyph
, '$');
25727 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25729 /* FIXME: Should we mirror GC for R2L lines? */
25730 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25731 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25737 #ifdef HAVE_WINDOW_SYSTEM
25738 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25739 is turned off, we precede the truncation/continuation glyphs by a
25740 stretch glyph whose width is computed such that these special
25741 glyphs are aligned at the window margin, even when very different
25742 fonts are used in different glyph rows. */
25743 if (FRAME_WINDOW_P (temp_it
.f
)
25744 /* init_iterator calls this with it->glyph_row == NULL, and it
25745 wants only the pixel width of the truncation/continuation
25747 && temp_it
.glyph_row
25748 /* insert_left_trunc_glyphs calls us at the beginning of the
25749 row, and it has its own calculation of the stretch glyph
25751 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25752 && (temp_it
.glyph_row
->reversed_p
25753 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25754 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25756 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25758 if (stretch_width
> 0)
25760 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25761 struct font
*font
=
25762 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25763 int stretch_ascent
=
25764 (((temp_it
.ascent
+ temp_it
.descent
)
25765 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25767 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25768 temp_it
.ascent
+ temp_it
.descent
,
25775 temp_it
.what
= IT_CHARACTER
;
25777 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25778 temp_it
.face_id
= GLYPH_FACE (glyph
);
25779 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25781 PRODUCE_GLYPHS (&temp_it
);
25782 it
->pixel_width
= temp_it
.pixel_width
;
25783 it
->nglyphs
= temp_it
.pixel_width
;
25786 #ifdef HAVE_WINDOW_SYSTEM
25788 /* Calculate line-height and line-spacing properties.
25789 An integer value specifies explicit pixel value.
25790 A float value specifies relative value to current face height.
25791 A cons (float . face-name) specifies relative value to
25792 height of specified face font.
25794 Returns height in pixels, or nil. */
25798 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25799 int boff
, int override
)
25801 Lisp_Object face_name
= Qnil
;
25802 int ascent
, descent
, height
;
25804 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25809 face_name
= XCAR (val
);
25811 if (!NUMBERP (val
))
25812 val
= make_number (1);
25813 if (NILP (face_name
))
25815 height
= it
->ascent
+ it
->descent
;
25820 if (NILP (face_name
))
25822 font
= FRAME_FONT (it
->f
);
25823 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25825 else if (EQ (face_name
, Qt
))
25834 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25836 return make_number (-1);
25838 face
= FACE_FROM_ID (it
->f
, face_id
);
25841 return make_number (-1);
25842 boff
= font
->baseline_offset
;
25843 if (font
->vertical_centering
)
25844 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25847 ascent
= FONT_BASE (font
) + boff
;
25848 descent
= FONT_DESCENT (font
) - boff
;
25852 it
->override_ascent
= ascent
;
25853 it
->override_descent
= descent
;
25854 it
->override_boff
= boff
;
25857 height
= ascent
+ descent
;
25861 height
= (int)(XFLOAT_DATA (val
) * height
);
25862 else if (INTEGERP (val
))
25863 height
*= XINT (val
);
25865 return make_number (height
);
25869 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25870 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25871 and only if this is for a character for which no font was found.
25873 If the display method (it->glyphless_method) is
25874 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25875 length of the acronym or the hexadecimal string, UPPER_XOFF and
25876 UPPER_YOFF are pixel offsets for the upper part of the string,
25877 LOWER_XOFF and LOWER_YOFF are for the lower part.
25879 For the other display methods, LEN through LOWER_YOFF are zero. */
25882 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25883 short upper_xoff
, short upper_yoff
,
25884 short lower_xoff
, short lower_yoff
)
25886 struct glyph
*glyph
;
25887 enum glyph_row_area area
= it
->area
;
25889 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25890 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25892 /* If the glyph row is reversed, we need to prepend the glyph
25893 rather than append it. */
25894 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25898 /* Make room for the additional glyph. */
25899 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25901 glyph
= it
->glyph_row
->glyphs
[area
];
25903 glyph
->charpos
= CHARPOS (it
->position
);
25904 glyph
->object
= it
->object
;
25905 glyph
->pixel_width
= it
->pixel_width
;
25906 glyph
->ascent
= it
->ascent
;
25907 glyph
->descent
= it
->descent
;
25908 glyph
->voffset
= it
->voffset
;
25909 glyph
->type
= GLYPHLESS_GLYPH
;
25910 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25911 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25912 glyph
->u
.glyphless
.len
= len
;
25913 glyph
->u
.glyphless
.ch
= it
->c
;
25914 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25915 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25916 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25917 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25918 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25919 glyph
->multibyte_p
= it
->multibyte_p
;
25920 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25922 /* In R2L rows, the left and the right box edges need to be
25923 drawn in reverse direction. */
25924 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25925 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25929 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25930 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25932 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25933 || it
->phys_descent
> it
->descent
);
25934 glyph
->padding_p
= 0;
25935 glyph
->glyph_not_available_p
= 0;
25936 glyph
->face_id
= face_id
;
25937 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25940 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25941 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25943 glyph
->bidi_type
= it
->bidi_it
.type
;
25945 ++it
->glyph_row
->used
[area
];
25948 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25952 /* Produce a glyph for a glyphless character for iterator IT.
25953 IT->glyphless_method specifies which method to use for displaying
25954 the character. See the description of enum
25955 glyphless_display_method in dispextern.h for the detail.
25957 FOR_NO_FONT is nonzero if and only if this is for a character for
25958 which no font was found. ACRONYM, if non-nil, is an acronym string
25959 for the character. */
25962 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25967 int base_width
, base_height
, width
, height
;
25968 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25971 /* Get the metrics of the base font. We always refer to the current
25973 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25974 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25975 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25976 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25977 base_height
= it
->ascent
+ it
->descent
;
25978 base_width
= font
->average_width
;
25980 face_id
= merge_glyphless_glyph_face (it
);
25982 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25984 it
->pixel_width
= THIN_SPACE_WIDTH
;
25986 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25988 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25990 width
= CHAR_WIDTH (it
->c
);
25993 else if (width
> 4)
25995 it
->pixel_width
= base_width
* width
;
25997 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26003 unsigned int code
[6];
26005 int ascent
, descent
;
26006 struct font_metrics metrics_upper
, metrics_lower
;
26008 face
= FACE_FROM_ID (it
->f
, face_id
);
26009 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26010 prepare_face_for_display (it
->f
, face
);
26012 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26014 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26015 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26016 if (CONSP (acronym
))
26017 acronym
= XCAR (acronym
);
26018 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26022 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26023 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26026 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26027 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26028 upper_len
= (len
+ 1) / 2;
26029 font
->driver
->text_extents (font
, code
, upper_len
,
26031 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26036 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26037 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26038 upper_xoff
= upper_yoff
= 2; /* the typical case */
26039 if (base_width
>= width
)
26041 /* Align the upper to the left, the lower to the right. */
26042 it
->pixel_width
= base_width
;
26043 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26047 /* Center the shorter one. */
26048 it
->pixel_width
= width
;
26049 if (metrics_upper
.width
>= metrics_lower
.width
)
26050 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26053 /* FIXME: This code doesn't look right. It formerly was
26054 missing the "lower_xoff = 0;", which couldn't have
26055 been right since it left lower_xoff uninitialized. */
26057 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26061 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26062 top, bottom, and between upper and lower strings. */
26063 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26064 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26065 /* Center vertically.
26066 H:base_height, D:base_descent
26067 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26069 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26070 descent = D - H/2 + h/2;
26071 lower_yoff = descent - 2 - ld;
26072 upper_yoff = lower_yoff - la - 1 - ud; */
26073 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26074 descent
= it
->descent
- (base_height
- height
) / 2;
26075 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26076 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26077 - metrics_upper
.descent
);
26078 /* Don't make the height shorter than the base height. */
26079 if (height
> base_height
)
26081 it
->ascent
= ascent
;
26082 it
->descent
= descent
;
26086 it
->phys_ascent
= it
->ascent
;
26087 it
->phys_descent
= it
->descent
;
26089 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26090 upper_xoff
, upper_yoff
,
26091 lower_xoff
, lower_yoff
);
26093 take_vertical_position_into_account (it
);
26098 Produce glyphs/get display metrics for the display element IT is
26099 loaded with. See the description of struct it in dispextern.h
26100 for an overview of struct it. */
26103 x_produce_glyphs (struct it
*it
)
26105 int extra_line_spacing
= it
->extra_line_spacing
;
26107 it
->glyph_not_available_p
= 0;
26109 if (it
->what
== IT_CHARACTER
)
26112 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26113 struct font
*font
= face
->font
;
26114 struct font_metrics
*pcm
= NULL
;
26115 int boff
; /* Baseline offset. */
26119 /* When no suitable font is found, display this character by
26120 the method specified in the first extra slot of
26121 Vglyphless_char_display. */
26122 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26124 eassert (it
->what
== IT_GLYPHLESS
);
26125 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26129 boff
= font
->baseline_offset
;
26130 if (font
->vertical_centering
)
26131 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26133 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26139 if (it
->override_ascent
>= 0)
26141 it
->ascent
= it
->override_ascent
;
26142 it
->descent
= it
->override_descent
;
26143 boff
= it
->override_boff
;
26147 it
->ascent
= FONT_BASE (font
) + boff
;
26148 it
->descent
= FONT_DESCENT (font
) - boff
;
26151 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26153 pcm
= get_per_char_metric (font
, &char2b
);
26154 if (pcm
->width
== 0
26155 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26161 it
->phys_ascent
= pcm
->ascent
+ boff
;
26162 it
->phys_descent
= pcm
->descent
- boff
;
26163 it
->pixel_width
= pcm
->width
;
26167 it
->glyph_not_available_p
= 1;
26168 it
->phys_ascent
= it
->ascent
;
26169 it
->phys_descent
= it
->descent
;
26170 it
->pixel_width
= font
->space_width
;
26173 if (it
->constrain_row_ascent_descent_p
)
26175 if (it
->descent
> it
->max_descent
)
26177 it
->ascent
+= it
->descent
- it
->max_descent
;
26178 it
->descent
= it
->max_descent
;
26180 if (it
->ascent
> it
->max_ascent
)
26182 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26183 it
->ascent
= it
->max_ascent
;
26185 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26186 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26187 extra_line_spacing
= 0;
26190 /* If this is a space inside a region of text with
26191 `space-width' property, change its width. */
26192 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26194 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26196 /* If face has a box, add the box thickness to the character
26197 height. If character has a box line to the left and/or
26198 right, add the box line width to the character's width. */
26199 if (face
->box
!= FACE_NO_BOX
)
26201 int thick
= face
->box_line_width
;
26205 it
->ascent
+= thick
;
26206 it
->descent
+= thick
;
26211 if (it
->start_of_box_run_p
)
26212 it
->pixel_width
+= thick
;
26213 if (it
->end_of_box_run_p
)
26214 it
->pixel_width
+= thick
;
26217 /* If face has an overline, add the height of the overline
26218 (1 pixel) and a 1 pixel margin to the character height. */
26219 if (face
->overline_p
)
26220 it
->ascent
+= overline_margin
;
26222 if (it
->constrain_row_ascent_descent_p
)
26224 if (it
->ascent
> it
->max_ascent
)
26225 it
->ascent
= it
->max_ascent
;
26226 if (it
->descent
> it
->max_descent
)
26227 it
->descent
= it
->max_descent
;
26230 take_vertical_position_into_account (it
);
26232 /* If we have to actually produce glyphs, do it. */
26237 /* Translate a space with a `space-width' property
26238 into a stretch glyph. */
26239 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26240 / FONT_HEIGHT (font
));
26241 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26242 it
->ascent
+ it
->descent
, ascent
);
26247 /* If characters with lbearing or rbearing are displayed
26248 in this line, record that fact in a flag of the
26249 glyph row. This is used to optimize X output code. */
26250 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26251 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26253 if (! stretched_p
&& it
->pixel_width
== 0)
26254 /* We assure that all visible glyphs have at least 1-pixel
26256 it
->pixel_width
= 1;
26258 else if (it
->char_to_display
== '\n')
26260 /* A newline has no width, but we need the height of the
26261 line. But if previous part of the line sets a height,
26262 don't increase that height. */
26264 Lisp_Object height
;
26265 Lisp_Object total_height
= Qnil
;
26267 it
->override_ascent
= -1;
26268 it
->pixel_width
= 0;
26271 height
= get_it_property (it
, Qline_height
);
26272 /* Split (line-height total-height) list. */
26274 && CONSP (XCDR (height
))
26275 && NILP (XCDR (XCDR (height
))))
26277 total_height
= XCAR (XCDR (height
));
26278 height
= XCAR (height
);
26280 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26282 if (it
->override_ascent
>= 0)
26284 it
->ascent
= it
->override_ascent
;
26285 it
->descent
= it
->override_descent
;
26286 boff
= it
->override_boff
;
26290 it
->ascent
= FONT_BASE (font
) + boff
;
26291 it
->descent
= FONT_DESCENT (font
) - boff
;
26294 if (EQ (height
, Qt
))
26296 if (it
->descent
> it
->max_descent
)
26298 it
->ascent
+= it
->descent
- it
->max_descent
;
26299 it
->descent
= it
->max_descent
;
26301 if (it
->ascent
> it
->max_ascent
)
26303 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26304 it
->ascent
= it
->max_ascent
;
26306 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26307 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26308 it
->constrain_row_ascent_descent_p
= 1;
26309 extra_line_spacing
= 0;
26313 Lisp_Object spacing
;
26315 it
->phys_ascent
= it
->ascent
;
26316 it
->phys_descent
= it
->descent
;
26318 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26319 && face
->box
!= FACE_NO_BOX
26320 && face
->box_line_width
> 0)
26322 it
->ascent
+= face
->box_line_width
;
26323 it
->descent
+= face
->box_line_width
;
26326 && XINT (height
) > it
->ascent
+ it
->descent
)
26327 it
->ascent
= XINT (height
) - it
->descent
;
26329 if (!NILP (total_height
))
26330 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26333 spacing
= get_it_property (it
, Qline_spacing
);
26334 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26336 if (INTEGERP (spacing
))
26338 extra_line_spacing
= XINT (spacing
);
26339 if (!NILP (total_height
))
26340 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26344 else /* i.e. (it->char_to_display == '\t') */
26346 if (font
->space_width
> 0)
26348 int tab_width
= it
->tab_width
* font
->space_width
;
26349 int x
= it
->current_x
+ it
->continuation_lines_width
;
26350 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26352 /* If the distance from the current position to the next tab
26353 stop is less than a space character width, use the
26354 tab stop after that. */
26355 if (next_tab_x
- x
< font
->space_width
)
26356 next_tab_x
+= tab_width
;
26358 it
->pixel_width
= next_tab_x
- x
;
26360 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26361 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26365 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26366 it
->ascent
+ it
->descent
, it
->ascent
);
26371 it
->pixel_width
= 0;
26376 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26378 /* A static composition.
26380 Note: A composition is represented as one glyph in the
26381 glyph matrix. There are no padding glyphs.
26383 Important note: pixel_width, ascent, and descent are the
26384 values of what is drawn by draw_glyphs (i.e. the values of
26385 the overall glyphs composed). */
26386 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26387 int boff
; /* baseline offset */
26388 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26389 int glyph_len
= cmp
->glyph_len
;
26390 struct font
*font
= face
->font
;
26394 /* If we have not yet calculated pixel size data of glyphs of
26395 the composition for the current face font, calculate them
26396 now. Theoretically, we have to check all fonts for the
26397 glyphs, but that requires much time and memory space. So,
26398 here we check only the font of the first glyph. This may
26399 lead to incorrect display, but it's very rare, and C-l
26400 (recenter-top-bottom) can correct the display anyway. */
26401 if (! cmp
->font
|| cmp
->font
!= font
)
26403 /* Ascent and descent of the font of the first character
26404 of this composition (adjusted by baseline offset).
26405 Ascent and descent of overall glyphs should not be less
26406 than these, respectively. */
26407 int font_ascent
, font_descent
, font_height
;
26408 /* Bounding box of the overall glyphs. */
26409 int leftmost
, rightmost
, lowest
, highest
;
26410 int lbearing
, rbearing
;
26411 int i
, width
, ascent
, descent
;
26412 int left_padded
= 0, right_padded
= 0;
26413 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26415 struct font_metrics
*pcm
;
26416 int font_not_found_p
;
26419 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26420 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26422 if (glyph_len
< cmp
->glyph_len
)
26424 for (i
= 0; i
< glyph_len
; i
++)
26426 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26428 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26433 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26434 : IT_CHARPOS (*it
));
26435 /* If no suitable font is found, use the default font. */
26436 font_not_found_p
= font
== NULL
;
26437 if (font_not_found_p
)
26439 face
= face
->ascii_face
;
26442 boff
= font
->baseline_offset
;
26443 if (font
->vertical_centering
)
26444 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26445 font_ascent
= FONT_BASE (font
) + boff
;
26446 font_descent
= FONT_DESCENT (font
) - boff
;
26447 font_height
= FONT_HEIGHT (font
);
26452 if (! font_not_found_p
)
26454 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26456 pcm
= get_per_char_metric (font
, &char2b
);
26459 /* Initialize the bounding box. */
26462 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26463 ascent
= pcm
->ascent
;
26464 descent
= pcm
->descent
;
26465 lbearing
= pcm
->lbearing
;
26466 rbearing
= pcm
->rbearing
;
26470 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26471 ascent
= FONT_BASE (font
);
26472 descent
= FONT_DESCENT (font
);
26479 lowest
= - descent
+ boff
;
26480 highest
= ascent
+ boff
;
26482 if (! font_not_found_p
26483 && font
->default_ascent
26484 && CHAR_TABLE_P (Vuse_default_ascent
)
26485 && !NILP (Faref (Vuse_default_ascent
,
26486 make_number (it
->char_to_display
))))
26487 highest
= font
->default_ascent
+ boff
;
26489 /* Draw the first glyph at the normal position. It may be
26490 shifted to right later if some other glyphs are drawn
26492 cmp
->offsets
[i
* 2] = 0;
26493 cmp
->offsets
[i
* 2 + 1] = boff
;
26494 cmp
->lbearing
= lbearing
;
26495 cmp
->rbearing
= rbearing
;
26497 /* Set cmp->offsets for the remaining glyphs. */
26498 for (i
++; i
< glyph_len
; i
++)
26500 int left
, right
, btm
, top
;
26501 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26503 struct face
*this_face
;
26507 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26508 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26509 font
= this_face
->font
;
26515 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26517 pcm
= get_per_char_metric (font
, &char2b
);
26520 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26523 width
= pcm
->width
;
26524 ascent
= pcm
->ascent
;
26525 descent
= pcm
->descent
;
26526 lbearing
= pcm
->lbearing
;
26527 rbearing
= pcm
->rbearing
;
26528 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26530 /* Relative composition with or without
26531 alternate chars. */
26532 left
= (leftmost
+ rightmost
- width
) / 2;
26533 btm
= - descent
+ boff
;
26534 if (font
->relative_compose
26535 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26536 || NILP (Faref (Vignore_relative_composition
,
26537 make_number (ch
)))))
26540 if (- descent
>= font
->relative_compose
)
26541 /* One extra pixel between two glyphs. */
26543 else if (ascent
<= 0)
26544 /* One extra pixel between two glyphs. */
26545 btm
= lowest
- 1 - ascent
- descent
;
26550 /* A composition rule is specified by an integer
26551 value that encodes global and new reference
26552 points (GREF and NREF). GREF and NREF are
26553 specified by numbers as below:
26555 0---1---2 -- ascent
26559 9--10--11 -- center
26561 ---3---4---5--- baseline
26563 6---7---8 -- descent
26565 int rule
= COMPOSITION_RULE (cmp
, i
);
26566 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26568 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26569 grefx
= gref
% 3, nrefx
= nref
% 3;
26570 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26572 xoff
= font_height
* (xoff
- 128) / 256;
26574 yoff
= font_height
* (yoff
- 128) / 256;
26577 + grefx
* (rightmost
- leftmost
) / 2
26578 - nrefx
* width
/ 2
26581 btm
= ((grefy
== 0 ? highest
26583 : grefy
== 2 ? lowest
26584 : (highest
+ lowest
) / 2)
26585 - (nrefy
== 0 ? ascent
+ descent
26586 : nrefy
== 1 ? descent
- boff
26588 : (ascent
+ descent
) / 2)
26592 cmp
->offsets
[i
* 2] = left
;
26593 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26595 /* Update the bounding box of the overall glyphs. */
26598 right
= left
+ width
;
26599 if (left
< leftmost
)
26601 if (right
> rightmost
)
26604 top
= btm
+ descent
+ ascent
;
26610 if (cmp
->lbearing
> left
+ lbearing
)
26611 cmp
->lbearing
= left
+ lbearing
;
26612 if (cmp
->rbearing
< left
+ rbearing
)
26613 cmp
->rbearing
= left
+ rbearing
;
26617 /* If there are glyphs whose x-offsets are negative,
26618 shift all glyphs to the right and make all x-offsets
26622 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26623 cmp
->offsets
[i
* 2] -= leftmost
;
26624 rightmost
-= leftmost
;
26625 cmp
->lbearing
-= leftmost
;
26626 cmp
->rbearing
-= leftmost
;
26629 if (left_padded
&& cmp
->lbearing
< 0)
26631 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26632 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26633 rightmost
-= cmp
->lbearing
;
26634 cmp
->rbearing
-= cmp
->lbearing
;
26637 if (right_padded
&& rightmost
< cmp
->rbearing
)
26639 rightmost
= cmp
->rbearing
;
26642 cmp
->pixel_width
= rightmost
;
26643 cmp
->ascent
= highest
;
26644 cmp
->descent
= - lowest
;
26645 if (cmp
->ascent
< font_ascent
)
26646 cmp
->ascent
= font_ascent
;
26647 if (cmp
->descent
< font_descent
)
26648 cmp
->descent
= font_descent
;
26652 && (cmp
->lbearing
< 0
26653 || cmp
->rbearing
> cmp
->pixel_width
))
26654 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26656 it
->pixel_width
= cmp
->pixel_width
;
26657 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26658 it
->descent
= it
->phys_descent
= cmp
->descent
;
26659 if (face
->box
!= FACE_NO_BOX
)
26661 int thick
= face
->box_line_width
;
26665 it
->ascent
+= thick
;
26666 it
->descent
+= thick
;
26671 if (it
->start_of_box_run_p
)
26672 it
->pixel_width
+= thick
;
26673 if (it
->end_of_box_run_p
)
26674 it
->pixel_width
+= thick
;
26677 /* If face has an overline, add the height of the overline
26678 (1 pixel) and a 1 pixel margin to the character height. */
26679 if (face
->overline_p
)
26680 it
->ascent
+= overline_margin
;
26682 take_vertical_position_into_account (it
);
26683 if (it
->ascent
< 0)
26685 if (it
->descent
< 0)
26688 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26689 append_composite_glyph (it
);
26691 else if (it
->what
== IT_COMPOSITION
)
26693 /* A dynamic (automatic) composition. */
26694 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26695 Lisp_Object gstring
;
26696 struct font_metrics metrics
;
26700 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26702 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26705 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26706 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26707 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26708 it
->descent
= it
->phys_descent
= metrics
.descent
;
26709 if (face
->box
!= FACE_NO_BOX
)
26711 int thick
= face
->box_line_width
;
26715 it
->ascent
+= thick
;
26716 it
->descent
+= thick
;
26721 if (it
->start_of_box_run_p
)
26722 it
->pixel_width
+= thick
;
26723 if (it
->end_of_box_run_p
)
26724 it
->pixel_width
+= thick
;
26726 /* If face has an overline, add the height of the overline
26727 (1 pixel) and a 1 pixel margin to the character height. */
26728 if (face
->overline_p
)
26729 it
->ascent
+= overline_margin
;
26730 take_vertical_position_into_account (it
);
26731 if (it
->ascent
< 0)
26733 if (it
->descent
< 0)
26737 append_composite_glyph (it
);
26739 else if (it
->what
== IT_GLYPHLESS
)
26740 produce_glyphless_glyph (it
, 0, Qnil
);
26741 else if (it
->what
== IT_IMAGE
)
26742 produce_image_glyph (it
);
26743 else if (it
->what
== IT_STRETCH
)
26744 produce_stretch_glyph (it
);
26747 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26748 because this isn't true for images with `:ascent 100'. */
26749 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26750 if (it
->area
== TEXT_AREA
)
26751 it
->current_x
+= it
->pixel_width
;
26753 if (extra_line_spacing
> 0)
26755 it
->descent
+= extra_line_spacing
;
26756 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26757 it
->max_extra_line_spacing
= extra_line_spacing
;
26760 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26761 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26762 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26763 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26767 Output LEN glyphs starting at START at the nominal cursor position.
26768 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26769 being updated, and UPDATED_AREA is the area of that row being updated. */
26772 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26773 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26775 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26777 eassert (updated_row
);
26778 /* When the window is hscrolled, cursor hpos can legitimately be out
26779 of bounds, but we draw the cursor at the corresponding window
26780 margin in that case. */
26781 if (!updated_row
->reversed_p
&& chpos
< 0)
26783 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26784 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26788 /* Write glyphs. */
26790 hpos
= start
- updated_row
->glyphs
[updated_area
];
26791 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26792 updated_row
, updated_area
,
26794 DRAW_NORMAL_TEXT
, 0);
26796 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26797 if (updated_area
== TEXT_AREA
26798 && w
->phys_cursor_on_p
26799 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26801 && chpos
< hpos
+ len
)
26802 w
->phys_cursor_on_p
= 0;
26806 /* Advance the output cursor. */
26807 w
->output_cursor
.hpos
+= len
;
26808 w
->output_cursor
.x
= x
;
26813 Insert LEN glyphs from START at the nominal cursor position. */
26816 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26817 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26820 int line_height
, shift_by_width
, shifted_region_width
;
26821 struct glyph_row
*row
;
26822 struct glyph
*glyph
;
26823 int frame_x
, frame_y
;
26826 eassert (updated_row
);
26828 f
= XFRAME (WINDOW_FRAME (w
));
26830 /* Get the height of the line we are in. */
26832 line_height
= row
->height
;
26834 /* Get the width of the glyphs to insert. */
26835 shift_by_width
= 0;
26836 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26837 shift_by_width
+= glyph
->pixel_width
;
26839 /* Get the width of the region to shift right. */
26840 shifted_region_width
= (window_box_width (w
, updated_area
)
26841 - w
->output_cursor
.x
26845 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26846 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26848 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26849 line_height
, shift_by_width
);
26851 /* Write the glyphs. */
26852 hpos
= start
- row
->glyphs
[updated_area
];
26853 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26855 DRAW_NORMAL_TEXT
, 0);
26857 /* Advance the output cursor. */
26858 w
->output_cursor
.hpos
+= len
;
26859 w
->output_cursor
.x
+= shift_by_width
;
26865 Erase the current text line from the nominal cursor position
26866 (inclusive) to pixel column TO_X (exclusive). The idea is that
26867 everything from TO_X onward is already erased.
26869 TO_X is a pixel position relative to UPDATED_AREA of currently
26870 updated window W. TO_X == -1 means clear to the end of this area. */
26873 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26874 enum glyph_row_area updated_area
, int to_x
)
26877 int max_x
, min_y
, max_y
;
26878 int from_x
, from_y
, to_y
;
26880 eassert (updated_row
);
26881 f
= XFRAME (w
->frame
);
26883 if (updated_row
->full_width_p
)
26884 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26885 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26887 max_x
= window_box_width (w
, updated_area
);
26888 max_y
= window_text_bottom_y (w
);
26890 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26891 of window. For TO_X > 0, truncate to end of drawing area. */
26897 to_x
= min (to_x
, max_x
);
26899 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26901 /* Notice if the cursor will be cleared by this operation. */
26902 if (!updated_row
->full_width_p
)
26903 notice_overwritten_cursor (w
, updated_area
,
26904 w
->output_cursor
.x
, -1,
26906 MATRIX_ROW_BOTTOM_Y (updated_row
));
26908 from_x
= w
->output_cursor
.x
;
26910 /* Translate to frame coordinates. */
26911 if (updated_row
->full_width_p
)
26913 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26914 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26918 int area_left
= window_box_left (w
, updated_area
);
26919 from_x
+= area_left
;
26923 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26924 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26925 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26927 /* Prevent inadvertently clearing to end of the X window. */
26928 if (to_x
> from_x
&& to_y
> from_y
)
26931 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26932 to_x
- from_x
, to_y
- from_y
);
26937 #endif /* HAVE_WINDOW_SYSTEM */
26941 /***********************************************************************
26943 ***********************************************************************/
26945 /* Value is the internal representation of the specified cursor type
26946 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26947 of the bar cursor. */
26949 static enum text_cursor_kinds
26950 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26952 enum text_cursor_kinds type
;
26957 if (EQ (arg
, Qbox
))
26958 return FILLED_BOX_CURSOR
;
26960 if (EQ (arg
, Qhollow
))
26961 return HOLLOW_BOX_CURSOR
;
26963 if (EQ (arg
, Qbar
))
26970 && EQ (XCAR (arg
), Qbar
)
26971 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26973 *width
= XINT (XCDR (arg
));
26977 if (EQ (arg
, Qhbar
))
26980 return HBAR_CURSOR
;
26984 && EQ (XCAR (arg
), Qhbar
)
26985 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26987 *width
= XINT (XCDR (arg
));
26988 return HBAR_CURSOR
;
26991 /* Treat anything unknown as "hollow box cursor".
26992 It was bad to signal an error; people have trouble fixing
26993 .Xdefaults with Emacs, when it has something bad in it. */
26994 type
= HOLLOW_BOX_CURSOR
;
26999 /* Set the default cursor types for specified frame. */
27001 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27006 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27007 FRAME_CURSOR_WIDTH (f
) = width
;
27009 /* By default, set up the blink-off state depending on the on-state. */
27011 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27014 FRAME_BLINK_OFF_CURSOR (f
)
27015 = get_specified_cursor_type (XCDR (tem
), &width
);
27016 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27019 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27021 /* Make sure the cursor gets redrawn. */
27022 f
->cursor_type_changed
= 1;
27026 #ifdef HAVE_WINDOW_SYSTEM
27028 /* Return the cursor we want to be displayed in window W. Return
27029 width of bar/hbar cursor through WIDTH arg. Return with
27030 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27031 (i.e. if the `system caret' should track this cursor).
27033 In a mini-buffer window, we want the cursor only to appear if we
27034 are reading input from this window. For the selected window, we
27035 want the cursor type given by the frame parameter or buffer local
27036 setting of cursor-type. If explicitly marked off, draw no cursor.
27037 In all other cases, we want a hollow box cursor. */
27039 static enum text_cursor_kinds
27040 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27041 int *active_cursor
)
27043 struct frame
*f
= XFRAME (w
->frame
);
27044 struct buffer
*b
= XBUFFER (w
->contents
);
27045 int cursor_type
= DEFAULT_CURSOR
;
27046 Lisp_Object alt_cursor
;
27047 int non_selected
= 0;
27049 *active_cursor
= 1;
27052 if (cursor_in_echo_area
27053 && FRAME_HAS_MINIBUF_P (f
)
27054 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27056 if (w
== XWINDOW (echo_area_window
))
27058 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27060 *width
= FRAME_CURSOR_WIDTH (f
);
27061 return FRAME_DESIRED_CURSOR (f
);
27064 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27067 *active_cursor
= 0;
27071 /* Detect a nonselected window or nonselected frame. */
27072 else if (w
!= XWINDOW (f
->selected_window
)
27073 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27075 *active_cursor
= 0;
27077 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27083 /* Never display a cursor in a window in which cursor-type is nil. */
27084 if (NILP (BVAR (b
, cursor_type
)))
27087 /* Get the normal cursor type for this window. */
27088 if (EQ (BVAR (b
, cursor_type
), Qt
))
27090 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27091 *width
= FRAME_CURSOR_WIDTH (f
);
27094 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27096 /* Use cursor-in-non-selected-windows instead
27097 for non-selected window or frame. */
27100 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27101 if (!EQ (Qt
, alt_cursor
))
27102 return get_specified_cursor_type (alt_cursor
, width
);
27103 /* t means modify the normal cursor type. */
27104 if (cursor_type
== FILLED_BOX_CURSOR
)
27105 cursor_type
= HOLLOW_BOX_CURSOR
;
27106 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27108 return cursor_type
;
27111 /* Use normal cursor if not blinked off. */
27112 if (!w
->cursor_off_p
)
27114 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27116 if (cursor_type
== FILLED_BOX_CURSOR
)
27118 /* Using a block cursor on large images can be very annoying.
27119 So use a hollow cursor for "large" images.
27120 If image is not transparent (no mask), also use hollow cursor. */
27121 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27122 if (img
!= NULL
&& IMAGEP (img
->spec
))
27124 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27125 where N = size of default frame font size.
27126 This should cover most of the "tiny" icons people may use. */
27128 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27129 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27130 cursor_type
= HOLLOW_BOX_CURSOR
;
27133 else if (cursor_type
!= NO_CURSOR
)
27135 /* Display current only supports BOX and HOLLOW cursors for images.
27136 So for now, unconditionally use a HOLLOW cursor when cursor is
27137 not a solid box cursor. */
27138 cursor_type
= HOLLOW_BOX_CURSOR
;
27141 return cursor_type
;
27144 /* Cursor is blinked off, so determine how to "toggle" it. */
27146 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27147 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27148 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27150 /* Then see if frame has specified a specific blink off cursor type. */
27151 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27153 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27154 return FRAME_BLINK_OFF_CURSOR (f
);
27158 /* Some people liked having a permanently visible blinking cursor,
27159 while others had very strong opinions against it. So it was
27160 decided to remove it. KFS 2003-09-03 */
27162 /* Finally perform built-in cursor blinking:
27163 filled box <-> hollow box
27164 wide [h]bar <-> narrow [h]bar
27165 narrow [h]bar <-> no cursor
27166 other type <-> no cursor */
27168 if (cursor_type
== FILLED_BOX_CURSOR
)
27169 return HOLLOW_BOX_CURSOR
;
27171 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27174 return cursor_type
;
27182 /* Notice when the text cursor of window W has been completely
27183 overwritten by a drawing operation that outputs glyphs in AREA
27184 starting at X0 and ending at X1 in the line starting at Y0 and
27185 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27186 the rest of the line after X0 has been written. Y coordinates
27187 are window-relative. */
27190 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27191 int x0
, int x1
, int y0
, int y1
)
27193 int cx0
, cx1
, cy0
, cy1
;
27194 struct glyph_row
*row
;
27196 if (!w
->phys_cursor_on_p
)
27198 if (area
!= TEXT_AREA
)
27201 if (w
->phys_cursor
.vpos
< 0
27202 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27203 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27204 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27207 if (row
->cursor_in_fringe_p
)
27209 row
->cursor_in_fringe_p
= 0;
27210 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27211 w
->phys_cursor_on_p
= 0;
27215 cx0
= w
->phys_cursor
.x
;
27216 cx1
= cx0
+ w
->phys_cursor_width
;
27217 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27220 /* The cursor image will be completely removed from the
27221 screen if the output area intersects the cursor area in
27222 y-direction. When we draw in [y0 y1[, and some part of
27223 the cursor is at y < y0, that part must have been drawn
27224 before. When scrolling, the cursor is erased before
27225 actually scrolling, so we don't come here. When not
27226 scrolling, the rows above the old cursor row must have
27227 changed, and in this case these rows must have written
27228 over the cursor image.
27230 Likewise if part of the cursor is below y1, with the
27231 exception of the cursor being in the first blank row at
27232 the buffer and window end because update_text_area
27233 doesn't draw that row. (Except when it does, but
27234 that's handled in update_text_area.) */
27236 cy0
= w
->phys_cursor
.y
;
27237 cy1
= cy0
+ w
->phys_cursor_height
;
27238 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27241 w
->phys_cursor_on_p
= 0;
27244 #endif /* HAVE_WINDOW_SYSTEM */
27247 /************************************************************************
27249 ************************************************************************/
27251 #ifdef HAVE_WINDOW_SYSTEM
27254 Fix the display of area AREA of overlapping row ROW in window W
27255 with respect to the overlapping part OVERLAPS. */
27258 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27259 enum glyph_row_area area
, int overlaps
)
27266 for (i
= 0; i
< row
->used
[area
];)
27268 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27270 int start
= i
, start_x
= x
;
27274 x
+= row
->glyphs
[area
][i
].pixel_width
;
27277 while (i
< row
->used
[area
]
27278 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27280 draw_glyphs (w
, start_x
, row
, area
,
27282 DRAW_NORMAL_TEXT
, overlaps
);
27286 x
+= row
->glyphs
[area
][i
].pixel_width
;
27296 Draw the cursor glyph of window W in glyph row ROW. See the
27297 comment of draw_glyphs for the meaning of HL. */
27300 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27301 enum draw_glyphs_face hl
)
27303 /* If cursor hpos is out of bounds, don't draw garbage. This can
27304 happen in mini-buffer windows when switching between echo area
27305 glyphs and mini-buffer. */
27306 if ((row
->reversed_p
27307 ? (w
->phys_cursor
.hpos
>= 0)
27308 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27310 int on_p
= w
->phys_cursor_on_p
;
27312 int hpos
= w
->phys_cursor
.hpos
;
27314 /* When the window is hscrolled, cursor hpos can legitimately be
27315 out of bounds, but we draw the cursor at the corresponding
27316 window margin in that case. */
27317 if (!row
->reversed_p
&& hpos
< 0)
27319 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27320 hpos
= row
->used
[TEXT_AREA
] - 1;
27322 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27324 w
->phys_cursor_on_p
= on_p
;
27326 if (hl
== DRAW_CURSOR
)
27327 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27328 /* When we erase the cursor, and ROW is overlapped by other
27329 rows, make sure that these overlapping parts of other rows
27331 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27333 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27335 if (row
> w
->current_matrix
->rows
27336 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27337 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27338 OVERLAPS_ERASED_CURSOR
);
27340 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27341 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27342 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27343 OVERLAPS_ERASED_CURSOR
);
27349 /* Erase the image of a cursor of window W from the screen. */
27352 erase_phys_cursor (struct window
*w
)
27354 struct frame
*f
= XFRAME (w
->frame
);
27355 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27356 int hpos
= w
->phys_cursor
.hpos
;
27357 int vpos
= w
->phys_cursor
.vpos
;
27358 int mouse_face_here_p
= 0;
27359 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27360 struct glyph_row
*cursor_row
;
27361 struct glyph
*cursor_glyph
;
27362 enum draw_glyphs_face hl
;
27364 /* No cursor displayed or row invalidated => nothing to do on the
27366 if (w
->phys_cursor_type
== NO_CURSOR
)
27367 goto mark_cursor_off
;
27369 /* VPOS >= active_glyphs->nrows means that window has been resized.
27370 Don't bother to erase the cursor. */
27371 if (vpos
>= active_glyphs
->nrows
)
27372 goto mark_cursor_off
;
27374 /* If row containing cursor is marked invalid, there is nothing we
27376 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27377 if (!cursor_row
->enabled_p
)
27378 goto mark_cursor_off
;
27380 /* If line spacing is > 0, old cursor may only be partially visible in
27381 window after split-window. So adjust visible height. */
27382 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27383 window_text_bottom_y (w
) - cursor_row
->y
);
27385 /* If row is completely invisible, don't attempt to delete a cursor which
27386 isn't there. This can happen if cursor is at top of a window, and
27387 we switch to a buffer with a header line in that window. */
27388 if (cursor_row
->visible_height
<= 0)
27389 goto mark_cursor_off
;
27391 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27392 if (cursor_row
->cursor_in_fringe_p
)
27394 cursor_row
->cursor_in_fringe_p
= 0;
27395 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27396 goto mark_cursor_off
;
27399 /* This can happen when the new row is shorter than the old one.
27400 In this case, either draw_glyphs or clear_end_of_line
27401 should have cleared the cursor. Note that we wouldn't be
27402 able to erase the cursor in this case because we don't have a
27403 cursor glyph at hand. */
27404 if ((cursor_row
->reversed_p
27405 ? (w
->phys_cursor
.hpos
< 0)
27406 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27407 goto mark_cursor_off
;
27409 /* When the window is hscrolled, cursor hpos can legitimately be out
27410 of bounds, but we draw the cursor at the corresponding window
27411 margin in that case. */
27412 if (!cursor_row
->reversed_p
&& hpos
< 0)
27414 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27415 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27417 /* If the cursor is in the mouse face area, redisplay that when
27418 we clear the cursor. */
27419 if (! NILP (hlinfo
->mouse_face_window
)
27420 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27421 /* Don't redraw the cursor's spot in mouse face if it is at the
27422 end of a line (on a newline). The cursor appears there, but
27423 mouse highlighting does not. */
27424 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27425 mouse_face_here_p
= 1;
27427 /* Maybe clear the display under the cursor. */
27428 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27431 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27434 cursor_glyph
= get_phys_cursor_glyph (w
);
27435 if (cursor_glyph
== NULL
)
27436 goto mark_cursor_off
;
27438 width
= cursor_glyph
->pixel_width
;
27439 x
= w
->phys_cursor
.x
;
27445 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27446 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27447 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27450 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27453 /* Erase the cursor by redrawing the character underneath it. */
27454 if (mouse_face_here_p
)
27455 hl
= DRAW_MOUSE_FACE
;
27457 hl
= DRAW_NORMAL_TEXT
;
27458 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27461 w
->phys_cursor_on_p
= 0;
27462 w
->phys_cursor_type
= NO_CURSOR
;
27467 Display or clear cursor of window W. If ON is zero, clear the
27468 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27469 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27472 display_and_set_cursor (struct window
*w
, bool on
,
27473 int hpos
, int vpos
, int x
, int y
)
27475 struct frame
*f
= XFRAME (w
->frame
);
27476 int new_cursor_type
;
27477 int new_cursor_width
;
27479 struct glyph_row
*glyph_row
;
27480 struct glyph
*glyph
;
27482 /* This is pointless on invisible frames, and dangerous on garbaged
27483 windows and frames; in the latter case, the frame or window may
27484 be in the midst of changing its size, and x and y may be off the
27486 if (! FRAME_VISIBLE_P (f
)
27487 || FRAME_GARBAGED_P (f
)
27488 || vpos
>= w
->current_matrix
->nrows
27489 || hpos
>= w
->current_matrix
->matrix_w
)
27492 /* If cursor is off and we want it off, return quickly. */
27493 if (!on
&& !w
->phys_cursor_on_p
)
27496 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27497 /* If cursor row is not enabled, we don't really know where to
27498 display the cursor. */
27499 if (!glyph_row
->enabled_p
)
27501 w
->phys_cursor_on_p
= 0;
27506 if (!glyph_row
->exact_window_width_line_p
27507 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27508 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27510 eassert (input_blocked_p ());
27512 /* Set new_cursor_type to the cursor we want to be displayed. */
27513 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27514 &new_cursor_width
, &active_cursor
);
27516 /* If cursor is currently being shown and we don't want it to be or
27517 it is in the wrong place, or the cursor type is not what we want,
27519 if (w
->phys_cursor_on_p
27521 || w
->phys_cursor
.x
!= x
27522 || w
->phys_cursor
.y
!= y
27523 /* HPOS can be negative in R2L rows whose
27524 exact_window_width_line_p flag is set (i.e. their newline
27525 would "overflow into the fringe"). */
27527 || new_cursor_type
!= w
->phys_cursor_type
27528 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27529 && new_cursor_width
!= w
->phys_cursor_width
)))
27530 erase_phys_cursor (w
);
27532 /* Don't check phys_cursor_on_p here because that flag is only set
27533 to zero in some cases where we know that the cursor has been
27534 completely erased, to avoid the extra work of erasing the cursor
27535 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27536 still not be visible, or it has only been partly erased. */
27539 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27540 w
->phys_cursor_height
= glyph_row
->height
;
27542 /* Set phys_cursor_.* before x_draw_.* is called because some
27543 of them may need the information. */
27544 w
->phys_cursor
.x
= x
;
27545 w
->phys_cursor
.y
= glyph_row
->y
;
27546 w
->phys_cursor
.hpos
= hpos
;
27547 w
->phys_cursor
.vpos
= vpos
;
27550 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27551 new_cursor_type
, new_cursor_width
,
27552 on
, active_cursor
);
27556 /* Switch the display of W's cursor on or off, according to the value
27560 update_window_cursor (struct window
*w
, bool on
)
27562 /* Don't update cursor in windows whose frame is in the process
27563 of being deleted. */
27564 if (w
->current_matrix
)
27566 int hpos
= w
->phys_cursor
.hpos
;
27567 int vpos
= w
->phys_cursor
.vpos
;
27568 struct glyph_row
*row
;
27570 if (vpos
>= w
->current_matrix
->nrows
27571 || hpos
>= w
->current_matrix
->matrix_w
)
27574 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27576 /* When the window is hscrolled, cursor hpos can legitimately be
27577 out of bounds, but we draw the cursor at the corresponding
27578 window margin in that case. */
27579 if (!row
->reversed_p
&& hpos
< 0)
27581 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27582 hpos
= row
->used
[TEXT_AREA
] - 1;
27585 display_and_set_cursor (w
, on
, hpos
, vpos
,
27586 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27592 /* Call update_window_cursor with parameter ON_P on all leaf windows
27593 in the window tree rooted at W. */
27596 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27600 if (WINDOWP (w
->contents
))
27601 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27603 update_window_cursor (w
, on_p
);
27605 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27611 Display the cursor on window W, or clear it, according to ON_P.
27612 Don't change the cursor's position. */
27615 x_update_cursor (struct frame
*f
, bool on_p
)
27617 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27622 Clear the cursor of window W to background color, and mark the
27623 cursor as not shown. This is used when the text where the cursor
27624 is about to be rewritten. */
27627 x_clear_cursor (struct window
*w
)
27629 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27630 update_window_cursor (w
, 0);
27633 #endif /* HAVE_WINDOW_SYSTEM */
27635 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27638 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27639 int start_hpos
, int end_hpos
,
27640 enum draw_glyphs_face draw
)
27642 #ifdef HAVE_WINDOW_SYSTEM
27643 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27645 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27649 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27650 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27654 /* Display the active region described by mouse_face_* according to DRAW. */
27657 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27659 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27660 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27662 if (/* If window is in the process of being destroyed, don't bother
27664 w
->current_matrix
!= NULL
27665 /* Don't update mouse highlight if hidden. */
27666 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27667 /* Recognize when we are called to operate on rows that don't exist
27668 anymore. This can happen when a window is split. */
27669 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27671 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27672 struct glyph_row
*row
, *first
, *last
;
27674 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27675 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27677 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27679 int start_hpos
, end_hpos
, start_x
;
27681 /* For all but the first row, the highlight starts at column 0. */
27684 /* R2L rows have BEG and END in reversed order, but the
27685 screen drawing geometry is always left to right. So
27686 we need to mirror the beginning and end of the
27687 highlighted area in R2L rows. */
27688 if (!row
->reversed_p
)
27690 start_hpos
= hlinfo
->mouse_face_beg_col
;
27691 start_x
= hlinfo
->mouse_face_beg_x
;
27693 else if (row
== last
)
27695 start_hpos
= hlinfo
->mouse_face_end_col
;
27696 start_x
= hlinfo
->mouse_face_end_x
;
27704 else if (row
->reversed_p
&& row
== last
)
27706 start_hpos
= hlinfo
->mouse_face_end_col
;
27707 start_x
= hlinfo
->mouse_face_end_x
;
27717 if (!row
->reversed_p
)
27718 end_hpos
= hlinfo
->mouse_face_end_col
;
27719 else if (row
== first
)
27720 end_hpos
= hlinfo
->mouse_face_beg_col
;
27723 end_hpos
= row
->used
[TEXT_AREA
];
27724 if (draw
== DRAW_NORMAL_TEXT
)
27725 row
->fill_line_p
= 1; /* Clear to end of line */
27728 else if (row
->reversed_p
&& row
== first
)
27729 end_hpos
= hlinfo
->mouse_face_beg_col
;
27732 end_hpos
= row
->used
[TEXT_AREA
];
27733 if (draw
== DRAW_NORMAL_TEXT
)
27734 row
->fill_line_p
= 1; /* Clear to end of line */
27737 if (end_hpos
> start_hpos
)
27739 draw_row_with_mouse_face (w
, start_x
, row
,
27740 start_hpos
, end_hpos
, draw
);
27743 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27747 #ifdef HAVE_WINDOW_SYSTEM
27748 /* When we've written over the cursor, arrange for it to
27749 be displayed again. */
27750 if (FRAME_WINDOW_P (f
)
27751 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27753 int hpos
= w
->phys_cursor
.hpos
;
27755 /* When the window is hscrolled, cursor hpos can legitimately be
27756 out of bounds, but we draw the cursor at the corresponding
27757 window margin in that case. */
27758 if (!row
->reversed_p
&& hpos
< 0)
27760 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27761 hpos
= row
->used
[TEXT_AREA
] - 1;
27764 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27765 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27768 #endif /* HAVE_WINDOW_SYSTEM */
27771 #ifdef HAVE_WINDOW_SYSTEM
27772 /* Change the mouse cursor. */
27773 if (FRAME_WINDOW_P (f
))
27775 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27776 if (draw
== DRAW_NORMAL_TEXT
27777 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27778 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27781 if (draw
== DRAW_MOUSE_FACE
)
27782 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27784 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27786 #endif /* HAVE_WINDOW_SYSTEM */
27790 Clear out the mouse-highlighted active region.
27791 Redraw it un-highlighted first. Value is non-zero if mouse
27792 face was actually drawn unhighlighted. */
27795 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27799 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27801 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27805 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27806 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27807 hlinfo
->mouse_face_window
= Qnil
;
27808 hlinfo
->mouse_face_overlay
= Qnil
;
27812 /* Return true if the coordinates HPOS and VPOS on windows W are
27813 within the mouse face on that window. */
27815 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27817 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27819 /* Quickly resolve the easy cases. */
27820 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27821 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27823 if (vpos
< hlinfo
->mouse_face_beg_row
27824 || vpos
> hlinfo
->mouse_face_end_row
)
27826 if (vpos
> hlinfo
->mouse_face_beg_row
27827 && vpos
< hlinfo
->mouse_face_end_row
)
27830 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27832 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27834 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27837 else if ((vpos
== hlinfo
->mouse_face_beg_row
27838 && hpos
>= hlinfo
->mouse_face_beg_col
)
27839 || (vpos
== hlinfo
->mouse_face_end_row
27840 && hpos
< hlinfo
->mouse_face_end_col
))
27845 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27847 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27850 else if ((vpos
== hlinfo
->mouse_face_beg_row
27851 && hpos
<= hlinfo
->mouse_face_beg_col
)
27852 || (vpos
== hlinfo
->mouse_face_end_row
27853 && hpos
> hlinfo
->mouse_face_end_col
))
27861 True if physical cursor of window W is within mouse face. */
27864 cursor_in_mouse_face_p (struct window
*w
)
27866 int hpos
= w
->phys_cursor
.hpos
;
27867 int vpos
= w
->phys_cursor
.vpos
;
27868 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27870 /* When the window is hscrolled, cursor hpos can legitimately be out
27871 of bounds, but we draw the cursor at the corresponding window
27872 margin in that case. */
27873 if (!row
->reversed_p
&& hpos
< 0)
27875 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27876 hpos
= row
->used
[TEXT_AREA
] - 1;
27878 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27883 /* Find the glyph rows START_ROW and END_ROW of window W that display
27884 characters between buffer positions START_CHARPOS and END_CHARPOS
27885 (excluding END_CHARPOS). DISP_STRING is a display string that
27886 covers these buffer positions. This is similar to
27887 row_containing_pos, but is more accurate when bidi reordering makes
27888 buffer positions change non-linearly with glyph rows. */
27890 rows_from_pos_range (struct window
*w
,
27891 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27892 Lisp_Object disp_string
,
27893 struct glyph_row
**start
, struct glyph_row
**end
)
27895 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27896 int last_y
= window_text_bottom_y (w
);
27897 struct glyph_row
*row
;
27902 while (!first
->enabled_p
27903 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27906 /* Find the START row. */
27908 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27911 /* A row can potentially be the START row if the range of the
27912 characters it displays intersects the range
27913 [START_CHARPOS..END_CHARPOS). */
27914 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27915 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27916 /* See the commentary in row_containing_pos, for the
27917 explanation of the complicated way to check whether
27918 some position is beyond the end of the characters
27919 displayed by a row. */
27920 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27921 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27922 && !row
->ends_at_zv_p
27923 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27924 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27925 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27926 && !row
->ends_at_zv_p
27927 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27929 /* Found a candidate row. Now make sure at least one of the
27930 glyphs it displays has a charpos from the range
27931 [START_CHARPOS..END_CHARPOS).
27933 This is not obvious because bidi reordering could make
27934 buffer positions of a row be 1,2,3,102,101,100, and if we
27935 want to highlight characters in [50..60), we don't want
27936 this row, even though [50..60) does intersect [1..103),
27937 the range of character positions given by the row's start
27938 and end positions. */
27939 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27940 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27944 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27945 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27946 /* A glyph that comes from DISP_STRING is by
27947 definition to be highlighted. */
27948 || EQ (g
->object
, disp_string
))
27957 /* Find the END row. */
27959 /* If the last row is partially visible, start looking for END
27960 from that row, instead of starting from FIRST. */
27961 && !(row
->enabled_p
27962 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27964 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27966 struct glyph_row
*next
= row
+ 1;
27967 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27969 if (!next
->enabled_p
27970 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27971 /* The first row >= START whose range of displayed characters
27972 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27973 is the row END + 1. */
27974 || (start_charpos
< next_start
27975 && end_charpos
< next_start
)
27976 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27977 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27978 && !next
->ends_at_zv_p
27979 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27980 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27981 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27982 && !next
->ends_at_zv_p
27983 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27990 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27991 but none of the characters it displays are in the range, it is
27993 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27994 struct glyph
*s
= g
;
27995 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27999 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28000 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28001 /* If the buffer position of the first glyph in
28002 the row is equal to END_CHARPOS, it means
28003 the last character to be highlighted is the
28004 newline of ROW, and we must consider NEXT as
28006 || (((!next
->reversed_p
&& g
== s
)
28007 || (next
->reversed_p
&& g
== e
- 1))
28008 && (g
->charpos
== end_charpos
28009 /* Special case for when NEXT is an
28010 empty line at ZV. */
28011 || (g
->charpos
== -1
28012 && !row
->ends_at_zv_p
28013 && next_start
== end_charpos
)))))
28014 /* A glyph that comes from DISP_STRING is by
28015 definition to be highlighted. */
28016 || EQ (g
->object
, disp_string
))
28025 /* The first row that ends at ZV must be the last to be
28027 else if (next
->ends_at_zv_p
)
28036 /* This function sets the mouse_face_* elements of HLINFO, assuming
28037 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28038 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28039 for the overlay or run of text properties specifying the mouse
28040 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28041 before-string and after-string that must also be highlighted.
28042 DISP_STRING, if non-nil, is a display string that may cover some
28043 or all of the highlighted text. */
28046 mouse_face_from_buffer_pos (Lisp_Object window
,
28047 Mouse_HLInfo
*hlinfo
,
28048 ptrdiff_t mouse_charpos
,
28049 ptrdiff_t start_charpos
,
28050 ptrdiff_t end_charpos
,
28051 Lisp_Object before_string
,
28052 Lisp_Object after_string
,
28053 Lisp_Object disp_string
)
28055 struct window
*w
= XWINDOW (window
);
28056 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28057 struct glyph_row
*r1
, *r2
;
28058 struct glyph
*glyph
, *end
;
28059 ptrdiff_t ignore
, pos
;
28062 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28063 eassert (NILP (before_string
) || STRINGP (before_string
));
28064 eassert (NILP (after_string
) || STRINGP (after_string
));
28066 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28067 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28069 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28070 /* If the before-string or display-string contains newlines,
28071 rows_from_pos_range skips to its last row. Move back. */
28072 if (!NILP (before_string
) || !NILP (disp_string
))
28074 struct glyph_row
*prev
;
28075 while ((prev
= r1
- 1, prev
>= first
)
28076 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28077 && prev
->used
[TEXT_AREA
] > 0)
28079 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28080 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28081 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28083 || !(EQ (glyph
->object
, before_string
)
28084 || EQ (glyph
->object
, disp_string
)))
28091 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28092 hlinfo
->mouse_face_past_end
= 1;
28094 else if (!NILP (after_string
))
28096 /* If the after-string has newlines, advance to its last row. */
28097 struct glyph_row
*next
;
28098 struct glyph_row
*last
28099 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28101 for (next
= r2
+ 1;
28103 && next
->used
[TEXT_AREA
] > 0
28104 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28108 /* The rest of the display engine assumes that mouse_face_beg_row is
28109 either above mouse_face_end_row or identical to it. But with
28110 bidi-reordered continued lines, the row for START_CHARPOS could
28111 be below the row for END_CHARPOS. If so, swap the rows and store
28112 them in correct order. */
28115 struct glyph_row
*tem
= r2
;
28121 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28122 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28124 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28125 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28126 could be anywhere in the row and in any order. The strategy
28127 below is to find the leftmost and the rightmost glyph that
28128 belongs to either of these 3 strings, or whose position is
28129 between START_CHARPOS and END_CHARPOS, and highlight all the
28130 glyphs between those two. This may cover more than just the text
28131 between START_CHARPOS and END_CHARPOS if the range of characters
28132 strides the bidi level boundary, e.g. if the beginning is in R2L
28133 text while the end is in L2R text or vice versa. */
28134 if (!r1
->reversed_p
)
28136 /* This row is in a left to right paragraph. Scan it left to
28138 glyph
= r1
->glyphs
[TEXT_AREA
];
28139 end
= glyph
+ r1
->used
[TEXT_AREA
];
28142 /* Skip truncation glyphs at the start of the glyph row. */
28143 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28145 && INTEGERP (glyph
->object
)
28146 && glyph
->charpos
< 0;
28148 x
+= glyph
->pixel_width
;
28150 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28151 or DISP_STRING, and the first glyph from buffer whose
28152 position is between START_CHARPOS and END_CHARPOS. */
28154 && !INTEGERP (glyph
->object
)
28155 && !EQ (glyph
->object
, disp_string
)
28156 && !(BUFFERP (glyph
->object
)
28157 && (glyph
->charpos
>= start_charpos
28158 && glyph
->charpos
< end_charpos
));
28161 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28162 are present at buffer positions between START_CHARPOS and
28163 END_CHARPOS, or if they come from an overlay. */
28164 if (EQ (glyph
->object
, before_string
))
28166 pos
= string_buffer_position (before_string
,
28168 /* If pos == 0, it means before_string came from an
28169 overlay, not from a buffer position. */
28170 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28173 else if (EQ (glyph
->object
, after_string
))
28175 pos
= string_buffer_position (after_string
, end_charpos
);
28176 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28179 x
+= glyph
->pixel_width
;
28181 hlinfo
->mouse_face_beg_x
= x
;
28182 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28186 /* This row is in a right to left paragraph. Scan it right to
28190 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28191 glyph
= end
+ r1
->used
[TEXT_AREA
];
28193 /* Skip truncation glyphs at the start of the glyph row. */
28194 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28196 && INTEGERP (glyph
->object
)
28197 && glyph
->charpos
< 0;
28201 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28202 or DISP_STRING, and the first glyph from buffer whose
28203 position is between START_CHARPOS and END_CHARPOS. */
28205 && !INTEGERP (glyph
->object
)
28206 && !EQ (glyph
->object
, disp_string
)
28207 && !(BUFFERP (glyph
->object
)
28208 && (glyph
->charpos
>= start_charpos
28209 && glyph
->charpos
< end_charpos
));
28212 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28213 are present at buffer positions between START_CHARPOS and
28214 END_CHARPOS, or if they come from an overlay. */
28215 if (EQ (glyph
->object
, before_string
))
28217 pos
= string_buffer_position (before_string
, start_charpos
);
28218 /* If pos == 0, it means before_string came from an
28219 overlay, not from a buffer position. */
28220 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28223 else if (EQ (glyph
->object
, after_string
))
28225 pos
= string_buffer_position (after_string
, end_charpos
);
28226 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28231 glyph
++; /* first glyph to the right of the highlighted area */
28232 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28233 x
+= g
->pixel_width
;
28234 hlinfo
->mouse_face_beg_x
= x
;
28235 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28238 /* If the highlight ends in a different row, compute GLYPH and END
28239 for the end row. Otherwise, reuse the values computed above for
28240 the row where the highlight begins. */
28243 if (!r2
->reversed_p
)
28245 glyph
= r2
->glyphs
[TEXT_AREA
];
28246 end
= glyph
+ r2
->used
[TEXT_AREA
];
28251 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28252 glyph
= end
+ r2
->used
[TEXT_AREA
];
28256 if (!r2
->reversed_p
)
28258 /* Skip truncation and continuation glyphs near the end of the
28259 row, and also blanks and stretch glyphs inserted by
28260 extend_face_to_end_of_line. */
28262 && INTEGERP ((end
- 1)->object
))
28264 /* Scan the rest of the glyph row from the end, looking for the
28265 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28266 DISP_STRING, or whose position is between START_CHARPOS
28270 && !INTEGERP (end
->object
)
28271 && !EQ (end
->object
, disp_string
)
28272 && !(BUFFERP (end
->object
)
28273 && (end
->charpos
>= start_charpos
28274 && end
->charpos
< end_charpos
));
28277 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28278 are present at buffer positions between START_CHARPOS and
28279 END_CHARPOS, or if they come from an overlay. */
28280 if (EQ (end
->object
, before_string
))
28282 pos
= string_buffer_position (before_string
, start_charpos
);
28283 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28286 else if (EQ (end
->object
, after_string
))
28288 pos
= string_buffer_position (after_string
, end_charpos
);
28289 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28293 /* Find the X coordinate of the last glyph to be highlighted. */
28294 for (; glyph
<= end
; ++glyph
)
28295 x
+= glyph
->pixel_width
;
28297 hlinfo
->mouse_face_end_x
= x
;
28298 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28302 /* Skip truncation and continuation glyphs near the end of the
28303 row, and also blanks and stretch glyphs inserted by
28304 extend_face_to_end_of_line. */
28308 && INTEGERP (end
->object
))
28310 x
+= end
->pixel_width
;
28313 /* Scan the rest of the glyph row from the end, looking for the
28314 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28315 DISP_STRING, or whose position is between START_CHARPOS
28319 && !INTEGERP (end
->object
)
28320 && !EQ (end
->object
, disp_string
)
28321 && !(BUFFERP (end
->object
)
28322 && (end
->charpos
>= start_charpos
28323 && end
->charpos
< end_charpos
));
28326 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28327 are present at buffer positions between START_CHARPOS and
28328 END_CHARPOS, or if they come from an overlay. */
28329 if (EQ (end
->object
, before_string
))
28331 pos
= string_buffer_position (before_string
, start_charpos
);
28332 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28335 else if (EQ (end
->object
, after_string
))
28337 pos
= string_buffer_position (after_string
, end_charpos
);
28338 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28341 x
+= end
->pixel_width
;
28343 /* If we exited the above loop because we arrived at the last
28344 glyph of the row, and its buffer position is still not in
28345 range, it means the last character in range is the preceding
28346 newline. Bump the end column and x values to get past the
28349 && BUFFERP (end
->object
)
28350 && (end
->charpos
< start_charpos
28351 || end
->charpos
>= end_charpos
))
28353 x
+= end
->pixel_width
;
28356 hlinfo
->mouse_face_end_x
= x
;
28357 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28360 hlinfo
->mouse_face_window
= window
;
28361 hlinfo
->mouse_face_face_id
28362 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28364 !hlinfo
->mouse_face_hidden
, -1);
28365 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28368 /* The following function is not used anymore (replaced with
28369 mouse_face_from_string_pos), but I leave it here for the time
28370 being, in case someone would. */
28372 #if 0 /* not used */
28374 /* Find the position of the glyph for position POS in OBJECT in
28375 window W's current matrix, and return in *X, *Y the pixel
28376 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28378 RIGHT_P non-zero means return the position of the right edge of the
28379 glyph, RIGHT_P zero means return the left edge position.
28381 If no glyph for POS exists in the matrix, return the position of
28382 the glyph with the next smaller position that is in the matrix, if
28383 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28384 exists in the matrix, return the position of the glyph with the
28385 next larger position in OBJECT.
28387 Value is non-zero if a glyph was found. */
28390 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28391 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28393 int yb
= window_text_bottom_y (w
);
28394 struct glyph_row
*r
;
28395 struct glyph
*best_glyph
= NULL
;
28396 struct glyph_row
*best_row
= NULL
;
28399 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28400 r
->enabled_p
&& r
->y
< yb
;
28403 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28404 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28407 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28408 if (EQ (g
->object
, object
))
28410 if (g
->charpos
== pos
)
28417 else if (best_glyph
== NULL
28418 || ((eabs (g
->charpos
- pos
)
28419 < eabs (best_glyph
->charpos
- pos
))
28422 : g
->charpos
> pos
)))
28436 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28440 *x
+= best_glyph
->pixel_width
;
28445 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28448 return best_glyph
!= NULL
;
28450 #endif /* not used */
28452 /* Find the positions of the first and the last glyphs in window W's
28453 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28454 (assumed to be a string), and return in HLINFO's mouse_face_*
28455 members the pixel and column/row coordinates of those glyphs. */
28458 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28459 Lisp_Object object
,
28460 ptrdiff_t startpos
, ptrdiff_t endpos
)
28462 int yb
= window_text_bottom_y (w
);
28463 struct glyph_row
*r
;
28464 struct glyph
*g
, *e
;
28468 /* Find the glyph row with at least one position in the range
28469 [STARTPOS..ENDPOS), and the first glyph in that row whose
28470 position belongs to that range. */
28471 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28472 r
->enabled_p
&& r
->y
< yb
;
28475 if (!r
->reversed_p
)
28477 g
= r
->glyphs
[TEXT_AREA
];
28478 e
= g
+ r
->used
[TEXT_AREA
];
28479 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28480 if (EQ (g
->object
, object
)
28481 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28483 hlinfo
->mouse_face_beg_row
28484 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28485 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28486 hlinfo
->mouse_face_beg_x
= gx
;
28495 e
= r
->glyphs
[TEXT_AREA
];
28496 g
= e
+ r
->used
[TEXT_AREA
];
28497 for ( ; g
> e
; --g
)
28498 if (EQ ((g
-1)->object
, object
)
28499 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28501 hlinfo
->mouse_face_beg_row
28502 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28503 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28504 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28505 gx
+= g1
->pixel_width
;
28506 hlinfo
->mouse_face_beg_x
= gx
;
28518 /* Starting with the next row, look for the first row which does NOT
28519 include any glyphs whose positions are in the range. */
28520 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28522 g
= r
->glyphs
[TEXT_AREA
];
28523 e
= g
+ r
->used
[TEXT_AREA
];
28525 for ( ; g
< e
; ++g
)
28526 if (EQ (g
->object
, object
)
28527 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28536 /* The highlighted region ends on the previous row. */
28539 /* Set the end row. */
28540 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28542 /* Compute and set the end column and the end column's horizontal
28543 pixel coordinate. */
28544 if (!r
->reversed_p
)
28546 g
= r
->glyphs
[TEXT_AREA
];
28547 e
= g
+ r
->used
[TEXT_AREA
];
28548 for ( ; e
> g
; --e
)
28549 if (EQ ((e
-1)->object
, object
)
28550 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28552 hlinfo
->mouse_face_end_col
= e
- g
;
28554 for (gx
= r
->x
; g
< e
; ++g
)
28555 gx
+= g
->pixel_width
;
28556 hlinfo
->mouse_face_end_x
= gx
;
28560 e
= r
->glyphs
[TEXT_AREA
];
28561 g
= e
+ r
->used
[TEXT_AREA
];
28562 for (gx
= r
->x
; e
< g
; ++e
)
28564 if (EQ (e
->object
, object
)
28565 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28567 gx
+= e
->pixel_width
;
28569 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28570 hlinfo
->mouse_face_end_x
= gx
;
28574 #ifdef HAVE_WINDOW_SYSTEM
28576 /* See if position X, Y is within a hot-spot of an image. */
28579 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28581 if (!CONSP (hot_spot
))
28584 if (EQ (XCAR (hot_spot
), Qrect
))
28586 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28587 Lisp_Object rect
= XCDR (hot_spot
);
28591 if (!CONSP (XCAR (rect
)))
28593 if (!CONSP (XCDR (rect
)))
28595 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28597 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28599 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28601 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28605 else if (EQ (XCAR (hot_spot
), Qcircle
))
28607 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28608 Lisp_Object circ
= XCDR (hot_spot
);
28609 Lisp_Object lr
, lx0
, ly0
;
28611 && CONSP (XCAR (circ
))
28612 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28613 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28614 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28616 double r
= XFLOATINT (lr
);
28617 double dx
= XINT (lx0
) - x
;
28618 double dy
= XINT (ly0
) - y
;
28619 return (dx
* dx
+ dy
* dy
<= r
* r
);
28622 else if (EQ (XCAR (hot_spot
), Qpoly
))
28624 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28625 if (VECTORP (XCDR (hot_spot
)))
28627 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28628 Lisp_Object
*poly
= v
->contents
;
28629 ptrdiff_t n
= v
->header
.size
;
28632 Lisp_Object lx
, ly
;
28635 /* Need an even number of coordinates, and at least 3 edges. */
28636 if (n
< 6 || n
& 1)
28639 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28640 If count is odd, we are inside polygon. Pixels on edges
28641 may or may not be included depending on actual geometry of the
28643 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28644 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28646 x0
= XINT (lx
), y0
= XINT (ly
);
28647 for (i
= 0; i
< n
; i
+= 2)
28649 int x1
= x0
, y1
= y0
;
28650 if ((lx
= poly
[i
], !INTEGERP (lx
))
28651 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28653 x0
= XINT (lx
), y0
= XINT (ly
);
28655 /* Does this segment cross the X line? */
28663 if (y
> y0
&& y
> y1
)
28665 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28675 find_hot_spot (Lisp_Object map
, int x
, int y
)
28677 while (CONSP (map
))
28679 if (CONSP (XCAR (map
))
28680 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28688 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28690 doc
: /* Lookup in image map MAP coordinates X and Y.
28691 An image map is an alist where each element has the format (AREA ID PLIST).
28692 An AREA is specified as either a rectangle, a circle, or a polygon:
28693 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28694 pixel coordinates of the upper left and bottom right corners.
28695 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28696 and the radius of the circle; r may be a float or integer.
28697 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28698 vector describes one corner in the polygon.
28699 Returns the alist element for the first matching AREA in MAP. */)
28700 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28708 return find_hot_spot (map
,
28709 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28710 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28714 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28716 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28718 /* Do not change cursor shape while dragging mouse. */
28719 if (!NILP (do_mouse_tracking
))
28722 if (!NILP (pointer
))
28724 if (EQ (pointer
, Qarrow
))
28725 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28726 else if (EQ (pointer
, Qhand
))
28727 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28728 else if (EQ (pointer
, Qtext
))
28729 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28730 else if (EQ (pointer
, intern ("hdrag")))
28731 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28732 else if (EQ (pointer
, intern ("nhdrag")))
28733 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28734 #ifdef HAVE_X_WINDOWS
28735 else if (EQ (pointer
, intern ("vdrag")))
28736 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28738 else if (EQ (pointer
, intern ("hourglass")))
28739 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28740 else if (EQ (pointer
, Qmodeline
))
28741 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28743 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28746 if (cursor
!= No_Cursor
)
28747 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28750 #endif /* HAVE_WINDOW_SYSTEM */
28752 /* Take proper action when mouse has moved to the mode or header line
28753 or marginal area AREA of window W, x-position X and y-position Y.
28754 X is relative to the start of the text display area of W, so the
28755 width of bitmap areas and scroll bars must be subtracted to get a
28756 position relative to the start of the mode line. */
28759 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28760 enum window_part area
)
28762 struct window
*w
= XWINDOW (window
);
28763 struct frame
*f
= XFRAME (w
->frame
);
28764 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28765 #ifdef HAVE_WINDOW_SYSTEM
28766 Display_Info
*dpyinfo
;
28768 Cursor cursor
= No_Cursor
;
28769 Lisp_Object pointer
= Qnil
;
28770 int dx
, dy
, width
, height
;
28772 Lisp_Object string
, object
= Qnil
;
28773 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28775 Lisp_Object mouse_face
;
28776 int original_x_pixel
= x
;
28777 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28778 struct glyph_row
*row
IF_LINT (= 0);
28780 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28785 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28786 returns them in row/column units! */
28787 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28788 &object
, &dx
, &dy
, &width
, &height
);
28790 row
= (area
== ON_MODE_LINE
28791 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28792 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28794 /* Find the glyph under the mouse pointer. */
28795 if (row
->mode_line_p
&& row
->enabled_p
)
28797 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28798 end
= glyph
+ row
->used
[TEXT_AREA
];
28800 for (x0
= original_x_pixel
;
28801 glyph
< end
&& x0
>= glyph
->pixel_width
;
28803 x0
-= glyph
->pixel_width
;
28811 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28812 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28813 returns them in row/column units! */
28814 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28815 &object
, &dx
, &dy
, &width
, &height
);
28820 #ifdef HAVE_WINDOW_SYSTEM
28821 if (IMAGEP (object
))
28823 Lisp_Object image_map
, hotspot
;
28824 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28826 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28828 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28832 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28833 If so, we could look for mouse-enter, mouse-leave
28834 properties in PLIST (and do something...). */
28835 hotspot
= XCDR (hotspot
);
28836 if (CONSP (hotspot
)
28837 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28839 pointer
= Fplist_get (plist
, Qpointer
);
28840 if (NILP (pointer
))
28842 help
= Fplist_get (plist
, Qhelp_echo
);
28845 help_echo_string
= help
;
28846 XSETWINDOW (help_echo_window
, w
);
28847 help_echo_object
= w
->contents
;
28848 help_echo_pos
= charpos
;
28852 if (NILP (pointer
))
28853 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28855 #endif /* HAVE_WINDOW_SYSTEM */
28857 if (STRINGP (string
))
28858 pos
= make_number (charpos
);
28860 /* Set the help text and mouse pointer. If the mouse is on a part
28861 of the mode line without any text (e.g. past the right edge of
28862 the mode line text), use the default help text and pointer. */
28863 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28865 /* Arrange to display the help by setting the global variables
28866 help_echo_string, help_echo_object, and help_echo_pos. */
28869 if (STRINGP (string
))
28870 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28874 help_echo_string
= help
;
28875 XSETWINDOW (help_echo_window
, w
);
28876 help_echo_object
= string
;
28877 help_echo_pos
= charpos
;
28879 else if (area
== ON_MODE_LINE
)
28881 Lisp_Object default_help
28882 = buffer_local_value (Qmode_line_default_help_echo
,
28885 if (STRINGP (default_help
))
28887 help_echo_string
= default_help
;
28888 XSETWINDOW (help_echo_window
, w
);
28889 help_echo_object
= Qnil
;
28890 help_echo_pos
= -1;
28895 #ifdef HAVE_WINDOW_SYSTEM
28896 /* Change the mouse pointer according to what is under it. */
28897 if (FRAME_WINDOW_P (f
))
28899 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28901 || NILP (Vresize_mini_windows
));
28903 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28904 if (STRINGP (string
))
28906 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28908 if (NILP (pointer
))
28909 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28911 /* Change the mouse pointer according to what is under X/Y. */
28913 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28916 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28917 if (!KEYMAPP (map
))
28918 map
= Fget_text_property (pos
, Qkeymap
, string
);
28919 if (!KEYMAPP (map
) && draggable
)
28920 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28923 else if (draggable
)
28924 /* Default mode-line pointer. */
28925 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28930 /* Change the mouse face according to what is under X/Y. */
28931 if (STRINGP (string
))
28933 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28934 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28935 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28940 struct glyph
* tmp_glyph
;
28944 int total_pixel_width
;
28945 ptrdiff_t begpos
, endpos
, ignore
;
28949 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28950 Qmouse_face
, string
, Qnil
);
28956 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28958 endpos
= SCHARS (string
);
28962 /* Calculate the glyph position GPOS of GLYPH in the
28963 displayed string, relative to the beginning of the
28964 highlighted part of the string.
28966 Note: GPOS is different from CHARPOS. CHARPOS is the
28967 position of GLYPH in the internal string object. A mode
28968 line string format has structures which are converted to
28969 a flattened string by the Emacs Lisp interpreter. The
28970 internal string is an element of those structures. The
28971 displayed string is the flattened string. */
28972 tmp_glyph
= row_start_glyph
;
28973 while (tmp_glyph
< glyph
28974 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28975 && begpos
<= tmp_glyph
->charpos
28976 && tmp_glyph
->charpos
< endpos
)))
28978 gpos
= glyph
- tmp_glyph
;
28980 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28981 the highlighted part of the displayed string to which
28982 GLYPH belongs. Note: GSEQ_LENGTH is different from
28983 SCHARS (STRING), because the latter returns the length of
28984 the internal string. */
28985 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28987 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28988 && begpos
<= tmp_glyph
->charpos
28989 && tmp_glyph
->charpos
< endpos
));
28992 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28994 /* Calculate the total pixel width of all the glyphs between
28995 the beginning of the highlighted area and GLYPH. */
28996 total_pixel_width
= 0;
28997 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28998 total_pixel_width
+= tmp_glyph
->pixel_width
;
29000 /* Pre calculation of re-rendering position. Note: X is in
29001 column units here, after the call to mode_line_string or
29002 marginal_area_string. */
29004 vpos
= (area
== ON_MODE_LINE
29005 ? (w
->current_matrix
)->nrows
- 1
29008 /* If GLYPH's position is included in the region that is
29009 already drawn in mouse face, we have nothing to do. */
29010 if ( EQ (window
, hlinfo
->mouse_face_window
)
29011 && (!row
->reversed_p
29012 ? (hlinfo
->mouse_face_beg_col
<= hpos
29013 && hpos
< hlinfo
->mouse_face_end_col
)
29014 /* In R2L rows we swap BEG and END, see below. */
29015 : (hlinfo
->mouse_face_end_col
<= hpos
29016 && hpos
< hlinfo
->mouse_face_beg_col
))
29017 && hlinfo
->mouse_face_beg_row
== vpos
)
29020 if (clear_mouse_face (hlinfo
))
29021 cursor
= No_Cursor
;
29023 if (!row
->reversed_p
)
29025 hlinfo
->mouse_face_beg_col
= hpos
;
29026 hlinfo
->mouse_face_beg_x
= original_x_pixel
29027 - (total_pixel_width
+ dx
);
29028 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29029 hlinfo
->mouse_face_end_x
= 0;
29033 /* In R2L rows, show_mouse_face expects BEG and END
29034 coordinates to be swapped. */
29035 hlinfo
->mouse_face_end_col
= hpos
;
29036 hlinfo
->mouse_face_end_x
= original_x_pixel
29037 - (total_pixel_width
+ dx
);
29038 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29039 hlinfo
->mouse_face_beg_x
= 0;
29042 hlinfo
->mouse_face_beg_row
= vpos
;
29043 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29044 hlinfo
->mouse_face_past_end
= 0;
29045 hlinfo
->mouse_face_window
= window
;
29047 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29052 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29054 if (NILP (pointer
))
29057 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29058 clear_mouse_face (hlinfo
);
29060 #ifdef HAVE_WINDOW_SYSTEM
29061 if (FRAME_WINDOW_P (f
))
29062 define_frame_cursor1 (f
, cursor
, pointer
);
29068 Take proper action when the mouse has moved to position X, Y on
29069 frame F with regards to highlighting portions of display that have
29070 mouse-face properties. Also de-highlight portions of display where
29071 the mouse was before, set the mouse pointer shape as appropriate
29072 for the mouse coordinates, and activate help echo (tooltips).
29073 X and Y can be negative or out of range. */
29076 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29078 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29079 enum window_part part
= ON_NOTHING
;
29080 Lisp_Object window
;
29082 Cursor cursor
= No_Cursor
;
29083 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29086 /* When a menu is active, don't highlight because this looks odd. */
29087 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29088 if (popup_activated ())
29092 if (!f
->glyphs_initialized_p
29093 || f
->pointer_invisible
)
29096 hlinfo
->mouse_face_mouse_x
= x
;
29097 hlinfo
->mouse_face_mouse_y
= y
;
29098 hlinfo
->mouse_face_mouse_frame
= f
;
29100 if (hlinfo
->mouse_face_defer
)
29103 /* Which window is that in? */
29104 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29106 /* If displaying active text in another window, clear that. */
29107 if (! EQ (window
, hlinfo
->mouse_face_window
)
29108 /* Also clear if we move out of text area in same window. */
29109 || (!NILP (hlinfo
->mouse_face_window
)
29112 && part
!= ON_MODE_LINE
29113 && part
!= ON_HEADER_LINE
))
29114 clear_mouse_face (hlinfo
);
29116 /* Not on a window -> return. */
29117 if (!WINDOWP (window
))
29120 /* Reset help_echo_string. It will get recomputed below. */
29121 help_echo_string
= Qnil
;
29123 /* Convert to window-relative pixel coordinates. */
29124 w
= XWINDOW (window
);
29125 frame_to_window_pixel_xy (w
, &x
, &y
);
29127 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29128 /* Handle tool-bar window differently since it doesn't display a
29130 if (EQ (window
, f
->tool_bar_window
))
29132 note_tool_bar_highlight (f
, x
, y
);
29137 /* Mouse is on the mode, header line or margin? */
29138 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29139 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29141 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29143 #ifdef HAVE_WINDOW_SYSTEM
29144 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29146 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29147 /* Show non-text cursor (Bug#16647). */
29155 #ifdef HAVE_WINDOW_SYSTEM
29156 if (part
== ON_VERTICAL_BORDER
)
29158 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29159 help_echo_string
= build_string ("drag-mouse-1: resize");
29161 else if (part
== ON_RIGHT_DIVIDER
)
29163 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29164 help_echo_string
= build_string ("drag-mouse-1: resize");
29166 else if (part
== ON_BOTTOM_DIVIDER
)
29167 if (! WINDOW_BOTTOMMOST_P (w
)
29169 || NILP (Vresize_mini_windows
))
29171 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29172 help_echo_string
= build_string ("drag-mouse-1: resize");
29175 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29176 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29177 || part
== ON_VERTICAL_SCROLL_BAR
29178 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29179 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29181 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29184 /* Are we in a window whose display is up to date?
29185 And verify the buffer's text has not changed. */
29186 b
= XBUFFER (w
->contents
);
29187 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29189 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29191 struct glyph
*glyph
;
29192 Lisp_Object object
;
29193 Lisp_Object mouse_face
= Qnil
, position
;
29194 Lisp_Object
*overlay_vec
= NULL
;
29195 ptrdiff_t i
, noverlays
;
29196 struct buffer
*obuf
;
29197 ptrdiff_t obegv
, ozv
;
29200 /* Find the glyph under X/Y. */
29201 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29203 #ifdef HAVE_WINDOW_SYSTEM
29204 /* Look for :pointer property on image. */
29205 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29207 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29208 if (img
!= NULL
&& IMAGEP (img
->spec
))
29210 Lisp_Object image_map
, hotspot
;
29211 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29213 && (hotspot
= find_hot_spot (image_map
,
29214 glyph
->slice
.img
.x
+ dx
,
29215 glyph
->slice
.img
.y
+ dy
),
29217 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29221 /* Could check XCAR (hotspot) to see if we enter/leave
29223 If so, we could look for mouse-enter, mouse-leave
29224 properties in PLIST (and do something...). */
29225 hotspot
= XCDR (hotspot
);
29226 if (CONSP (hotspot
)
29227 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29229 pointer
= Fplist_get (plist
, Qpointer
);
29230 if (NILP (pointer
))
29232 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29233 if (!NILP (help_echo_string
))
29235 help_echo_window
= window
;
29236 help_echo_object
= glyph
->object
;
29237 help_echo_pos
= glyph
->charpos
;
29241 if (NILP (pointer
))
29242 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29245 #endif /* HAVE_WINDOW_SYSTEM */
29247 /* Clear mouse face if X/Y not over text. */
29249 || area
!= TEXT_AREA
29250 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29251 /* Glyph's OBJECT is an integer for glyphs inserted by the
29252 display engine for its internal purposes, like truncation
29253 and continuation glyphs and blanks beyond the end of
29254 line's text on text terminals. If we are over such a
29255 glyph, we are not over any text. */
29256 || INTEGERP (glyph
->object
)
29257 /* R2L rows have a stretch glyph at their front, which
29258 stands for no text, whereas L2R rows have no glyphs at
29259 all beyond the end of text. Treat such stretch glyphs
29260 like we do with NULL glyphs in L2R rows. */
29261 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29262 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29263 && glyph
->type
== STRETCH_GLYPH
29264 && glyph
->avoid_cursor_p
))
29266 if (clear_mouse_face (hlinfo
))
29267 cursor
= No_Cursor
;
29268 #ifdef HAVE_WINDOW_SYSTEM
29269 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29271 if (area
!= TEXT_AREA
)
29272 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29274 pointer
= Vvoid_text_area_pointer
;
29280 pos
= glyph
->charpos
;
29281 object
= glyph
->object
;
29282 if (!STRINGP (object
) && !BUFFERP (object
))
29285 /* If we get an out-of-range value, return now; avoid an error. */
29286 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29289 /* Make the window's buffer temporarily current for
29290 overlays_at and compute_char_face. */
29291 obuf
= current_buffer
;
29292 current_buffer
= b
;
29298 /* Is this char mouse-active or does it have help-echo? */
29299 position
= make_number (pos
);
29303 if (BUFFERP (object
))
29305 /* Put all the overlays we want in a vector in overlay_vec. */
29306 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29307 /* Sort overlays into increasing priority order. */
29308 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29313 if (NILP (Vmouse_highlight
))
29315 clear_mouse_face (hlinfo
);
29316 goto check_help_echo
;
29319 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29322 cursor
= No_Cursor
;
29324 /* Check mouse-face highlighting. */
29326 /* If there exists an overlay with mouse-face overlapping
29327 the one we are currently highlighting, we have to
29328 check if we enter the overlapping overlay, and then
29329 highlight only that. */
29330 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29331 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29333 /* Find the highest priority overlay with a mouse-face. */
29334 Lisp_Object overlay
= Qnil
;
29335 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29337 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29338 if (!NILP (mouse_face
))
29339 overlay
= overlay_vec
[i
];
29342 /* If we're highlighting the same overlay as before, there's
29343 no need to do that again. */
29344 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29345 goto check_help_echo
;
29346 hlinfo
->mouse_face_overlay
= overlay
;
29348 /* Clear the display of the old active region, if any. */
29349 if (clear_mouse_face (hlinfo
))
29350 cursor
= No_Cursor
;
29352 /* If no overlay applies, get a text property. */
29353 if (NILP (overlay
))
29354 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29356 /* Next, compute the bounds of the mouse highlighting and
29358 if (!NILP (mouse_face
) && STRINGP (object
))
29360 /* The mouse-highlighting comes from a display string
29361 with a mouse-face. */
29365 s
= Fprevious_single_property_change
29366 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29367 e
= Fnext_single_property_change
29368 (position
, Qmouse_face
, object
, Qnil
);
29370 s
= make_number (0);
29372 e
= make_number (SCHARS (object
));
29373 mouse_face_from_string_pos (w
, hlinfo
, object
,
29374 XINT (s
), XINT (e
));
29375 hlinfo
->mouse_face_past_end
= 0;
29376 hlinfo
->mouse_face_window
= window
;
29377 hlinfo
->mouse_face_face_id
29378 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29379 glyph
->face_id
, 1);
29380 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29381 cursor
= No_Cursor
;
29385 /* The mouse-highlighting, if any, comes from an overlay
29386 or text property in the buffer. */
29387 Lisp_Object buffer
IF_LINT (= Qnil
);
29388 Lisp_Object disp_string
IF_LINT (= Qnil
);
29390 if (STRINGP (object
))
29392 /* If we are on a display string with no mouse-face,
29393 check if the text under it has one. */
29394 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29395 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29396 pos
= string_buffer_position (object
, start
);
29399 mouse_face
= get_char_property_and_overlay
29400 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29401 buffer
= w
->contents
;
29402 disp_string
= object
;
29408 disp_string
= Qnil
;
29411 if (!NILP (mouse_face
))
29413 Lisp_Object before
, after
;
29414 Lisp_Object before_string
, after_string
;
29415 /* To correctly find the limits of mouse highlight
29416 in a bidi-reordered buffer, we must not use the
29417 optimization of limiting the search in
29418 previous-single-property-change and
29419 next-single-property-change, because
29420 rows_from_pos_range needs the real start and end
29421 positions to DTRT in this case. That's because
29422 the first row visible in a window does not
29423 necessarily display the character whose position
29424 is the smallest. */
29426 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29427 ? Fmarker_position (w
->start
)
29430 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29431 ? make_number (BUF_Z (XBUFFER (buffer
))
29432 - w
->window_end_pos
)
29435 if (NILP (overlay
))
29437 /* Handle the text property case. */
29438 before
= Fprevious_single_property_change
29439 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29440 after
= Fnext_single_property_change
29441 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29442 before_string
= after_string
= Qnil
;
29446 /* Handle the overlay case. */
29447 before
= Foverlay_start (overlay
);
29448 after
= Foverlay_end (overlay
);
29449 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29450 after_string
= Foverlay_get (overlay
, Qafter_string
);
29452 if (!STRINGP (before_string
)) before_string
= Qnil
;
29453 if (!STRINGP (after_string
)) after_string
= Qnil
;
29456 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29459 : XFASTINT (before
),
29461 ? BUF_Z (XBUFFER (buffer
))
29462 : XFASTINT (after
),
29463 before_string
, after_string
,
29465 cursor
= No_Cursor
;
29472 /* Look for a `help-echo' property. */
29473 if (NILP (help_echo_string
)) {
29474 Lisp_Object help
, overlay
;
29476 /* Check overlays first. */
29477 help
= overlay
= Qnil
;
29478 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29480 overlay
= overlay_vec
[i
];
29481 help
= Foverlay_get (overlay
, Qhelp_echo
);
29486 help_echo_string
= help
;
29487 help_echo_window
= window
;
29488 help_echo_object
= overlay
;
29489 help_echo_pos
= pos
;
29493 Lisp_Object obj
= glyph
->object
;
29494 ptrdiff_t charpos
= glyph
->charpos
;
29496 /* Try text properties. */
29499 && charpos
< SCHARS (obj
))
29501 help
= Fget_text_property (make_number (charpos
),
29505 /* If the string itself doesn't specify a help-echo,
29506 see if the buffer text ``under'' it does. */
29507 struct glyph_row
*r
29508 = MATRIX_ROW (w
->current_matrix
, vpos
);
29509 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29510 ptrdiff_t p
= string_buffer_position (obj
, start
);
29513 help
= Fget_char_property (make_number (p
),
29514 Qhelp_echo
, w
->contents
);
29523 else if (BUFFERP (obj
)
29526 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29531 help_echo_string
= help
;
29532 help_echo_window
= window
;
29533 help_echo_object
= obj
;
29534 help_echo_pos
= charpos
;
29539 #ifdef HAVE_WINDOW_SYSTEM
29540 /* Look for a `pointer' property. */
29541 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29543 /* Check overlays first. */
29544 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29545 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29547 if (NILP (pointer
))
29549 Lisp_Object obj
= glyph
->object
;
29550 ptrdiff_t charpos
= glyph
->charpos
;
29552 /* Try text properties. */
29555 && charpos
< SCHARS (obj
))
29557 pointer
= Fget_text_property (make_number (charpos
),
29559 if (NILP (pointer
))
29561 /* If the string itself doesn't specify a pointer,
29562 see if the buffer text ``under'' it does. */
29563 struct glyph_row
*r
29564 = MATRIX_ROW (w
->current_matrix
, vpos
);
29565 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29566 ptrdiff_t p
= string_buffer_position (obj
, start
);
29568 pointer
= Fget_char_property (make_number (p
),
29569 Qpointer
, w
->contents
);
29572 else if (BUFFERP (obj
)
29575 pointer
= Fget_text_property (make_number (charpos
),
29579 #endif /* HAVE_WINDOW_SYSTEM */
29583 current_buffer
= obuf
;
29589 #ifdef HAVE_WINDOW_SYSTEM
29590 if (FRAME_WINDOW_P (f
))
29591 define_frame_cursor1 (f
, cursor
, pointer
);
29593 /* This is here to prevent a compiler error, about "label at end of
29594 compound statement". */
29601 Clear any mouse-face on window W. This function is part of the
29602 redisplay interface, and is called from try_window_id and similar
29603 functions to ensure the mouse-highlight is off. */
29606 x_clear_window_mouse_face (struct window
*w
)
29608 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29609 Lisp_Object window
;
29612 XSETWINDOW (window
, w
);
29613 if (EQ (window
, hlinfo
->mouse_face_window
))
29614 clear_mouse_face (hlinfo
);
29620 Just discard the mouse face information for frame F, if any.
29621 This is used when the size of F is changed. */
29624 cancel_mouse_face (struct frame
*f
)
29626 Lisp_Object window
;
29627 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29629 window
= hlinfo
->mouse_face_window
;
29630 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29631 reset_mouse_highlight (hlinfo
);
29636 /***********************************************************************
29638 ***********************************************************************/
29640 #ifdef HAVE_WINDOW_SYSTEM
29642 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29643 which intersects rectangle R. R is in window-relative coordinates. */
29646 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29647 enum glyph_row_area area
)
29649 struct glyph
*first
= row
->glyphs
[area
];
29650 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29651 struct glyph
*last
;
29652 int first_x
, start_x
, x
;
29654 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29655 /* If row extends face to end of line write the whole line. */
29656 draw_glyphs (w
, 0, row
, area
,
29657 0, row
->used
[area
],
29658 DRAW_NORMAL_TEXT
, 0);
29661 /* Set START_X to the window-relative start position for drawing glyphs of
29662 AREA. The first glyph of the text area can be partially visible.
29663 The first glyphs of other areas cannot. */
29664 start_x
= window_box_left_offset (w
, area
);
29666 if (area
== TEXT_AREA
)
29669 /* Find the first glyph that must be redrawn. */
29671 && x
+ first
->pixel_width
< r
->x
)
29673 x
+= first
->pixel_width
;
29677 /* Find the last one. */
29681 && x
< r
->x
+ r
->width
)
29683 x
+= last
->pixel_width
;
29689 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29690 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29691 DRAW_NORMAL_TEXT
, 0);
29696 /* Redraw the parts of the glyph row ROW on window W intersecting
29697 rectangle R. R is in window-relative coordinates. Value is
29698 non-zero if mouse-face was overwritten. */
29701 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29703 eassert (row
->enabled_p
);
29705 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29706 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29707 0, row
->used
[TEXT_AREA
],
29708 DRAW_NORMAL_TEXT
, 0);
29711 if (row
->used
[LEFT_MARGIN_AREA
])
29712 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29713 if (row
->used
[TEXT_AREA
])
29714 expose_area (w
, row
, r
, TEXT_AREA
);
29715 if (row
->used
[RIGHT_MARGIN_AREA
])
29716 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29717 draw_row_fringe_bitmaps (w
, row
);
29720 return row
->mouse_face_p
;
29724 /* Redraw those parts of glyphs rows during expose event handling that
29725 overlap other rows. Redrawing of an exposed line writes over parts
29726 of lines overlapping that exposed line; this function fixes that.
29728 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29729 row in W's current matrix that is exposed and overlaps other rows.
29730 LAST_OVERLAPPING_ROW is the last such row. */
29733 expose_overlaps (struct window
*w
,
29734 struct glyph_row
*first_overlapping_row
,
29735 struct glyph_row
*last_overlapping_row
,
29738 struct glyph_row
*row
;
29740 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29741 if (row
->overlapping_p
)
29743 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29746 if (row
->used
[LEFT_MARGIN_AREA
])
29747 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29749 if (row
->used
[TEXT_AREA
])
29750 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29752 if (row
->used
[RIGHT_MARGIN_AREA
])
29753 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29759 /* Return non-zero if W's cursor intersects rectangle R. */
29762 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29764 XRectangle cr
, result
;
29765 struct glyph
*cursor_glyph
;
29766 struct glyph_row
*row
;
29768 if (w
->phys_cursor
.vpos
>= 0
29769 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29770 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29772 && row
->cursor_in_fringe_p
)
29774 /* Cursor is in the fringe. */
29775 cr
.x
= window_box_right_offset (w
,
29776 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29777 ? RIGHT_MARGIN_AREA
29780 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29781 cr
.height
= row
->height
;
29782 return x_intersect_rectangles (&cr
, r
, &result
);
29785 cursor_glyph
= get_phys_cursor_glyph (w
);
29788 /* r is relative to W's box, but w->phys_cursor.x is relative
29789 to left edge of W's TEXT area. Adjust it. */
29790 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29791 cr
.y
= w
->phys_cursor
.y
;
29792 cr
.width
= cursor_glyph
->pixel_width
;
29793 cr
.height
= w
->phys_cursor_height
;
29794 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29795 I assume the effect is the same -- and this is portable. */
29796 return x_intersect_rectangles (&cr
, r
, &result
);
29798 /* If we don't understand the format, pretend we're not in the hot-spot. */
29804 Draw a vertical window border to the right of window W if W doesn't
29805 have vertical scroll bars. */
29808 x_draw_vertical_border (struct window
*w
)
29810 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29812 /* We could do better, if we knew what type of scroll-bar the adjacent
29813 windows (on either side) have... But we don't :-(
29814 However, I think this works ok. ++KFS 2003-04-25 */
29816 /* Redraw borders between horizontally adjacent windows. Don't
29817 do it for frames with vertical scroll bars because either the
29818 right scroll bar of a window, or the left scroll bar of its
29819 neighbor will suffice as a border. */
29820 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29823 /* Note: It is necessary to redraw both the left and the right
29824 borders, for when only this single window W is being
29826 if (!WINDOW_RIGHTMOST_P (w
)
29827 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29829 int x0
, x1
, y0
, y1
;
29831 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29834 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29837 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29840 if (!WINDOW_LEFTMOST_P (w
)
29841 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29843 int x0
, x1
, y0
, y1
;
29845 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29848 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29851 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29856 /* Draw window dividers for window W. */
29859 x_draw_right_divider (struct window
*w
)
29861 struct frame
*f
= WINDOW_XFRAME (w
);
29863 if (w
->mini
|| w
->pseudo_window_p
)
29865 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29867 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29868 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29869 int y0
= WINDOW_TOP_EDGE_Y (w
);
29870 /* The bottom divider prevails. */
29871 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29873 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29878 x_draw_bottom_divider (struct window
*w
)
29880 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29882 if (w
->mini
|| w
->pseudo_window_p
)
29884 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29886 int x0
= WINDOW_LEFT_EDGE_X (w
);
29887 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29888 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29889 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29891 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29895 /* Redraw the part of window W intersection rectangle FR. Pixel
29896 coordinates in FR are frame-relative. Call this function with
29897 input blocked. Value is non-zero if the exposure overwrites
29901 expose_window (struct window
*w
, XRectangle
*fr
)
29903 struct frame
*f
= XFRAME (w
->frame
);
29905 int mouse_face_overwritten_p
= 0;
29907 /* If window is not yet fully initialized, do nothing. This can
29908 happen when toolkit scroll bars are used and a window is split.
29909 Reconfiguring the scroll bar will generate an expose for a newly
29911 if (w
->current_matrix
== NULL
)
29914 /* When we're currently updating the window, display and current
29915 matrix usually don't agree. Arrange for a thorough display
29917 if (w
->must_be_updated_p
)
29919 SET_FRAME_GARBAGED (f
);
29923 /* Frame-relative pixel rectangle of W. */
29924 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29925 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29926 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29927 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29929 if (x_intersect_rectangles (fr
, &wr
, &r
))
29931 int yb
= window_text_bottom_y (w
);
29932 struct glyph_row
*row
;
29933 int cursor_cleared_p
, phys_cursor_on_p
;
29934 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29936 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29937 r
.x
, r
.y
, r
.width
, r
.height
));
29939 /* Convert to window coordinates. */
29940 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29941 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29943 /* Turn off the cursor. */
29944 if (!w
->pseudo_window_p
29945 && phys_cursor_in_rect_p (w
, &r
))
29947 x_clear_cursor (w
);
29948 cursor_cleared_p
= 1;
29951 cursor_cleared_p
= 0;
29953 /* If the row containing the cursor extends face to end of line,
29954 then expose_area might overwrite the cursor outside the
29955 rectangle and thus notice_overwritten_cursor might clear
29956 w->phys_cursor_on_p. We remember the original value and
29957 check later if it is changed. */
29958 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29960 /* Update lines intersecting rectangle R. */
29961 first_overlapping_row
= last_overlapping_row
= NULL
;
29962 for (row
= w
->current_matrix
->rows
;
29967 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29969 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29970 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29971 || (r
.y
>= y0
&& r
.y
< y1
)
29972 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29974 /* A header line may be overlapping, but there is no need
29975 to fix overlapping areas for them. KFS 2005-02-12 */
29976 if (row
->overlapping_p
&& !row
->mode_line_p
)
29978 if (first_overlapping_row
== NULL
)
29979 first_overlapping_row
= row
;
29980 last_overlapping_row
= row
;
29984 if (expose_line (w
, row
, &r
))
29985 mouse_face_overwritten_p
= 1;
29988 else if (row
->overlapping_p
)
29990 /* We must redraw a row overlapping the exposed area. */
29992 ? y0
+ row
->phys_height
> r
.y
29993 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29995 if (first_overlapping_row
== NULL
)
29996 first_overlapping_row
= row
;
29997 last_overlapping_row
= row
;
30005 /* Display the mode line if there is one. */
30006 if (WINDOW_WANTS_MODELINE_P (w
)
30007 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30009 && row
->y
< r
.y
+ r
.height
)
30011 if (expose_line (w
, row
, &r
))
30012 mouse_face_overwritten_p
= 1;
30015 if (!w
->pseudo_window_p
)
30017 /* Fix the display of overlapping rows. */
30018 if (first_overlapping_row
)
30019 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30022 /* Draw border between windows. */
30023 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30024 x_draw_right_divider (w
);
30026 x_draw_vertical_border (w
);
30028 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30029 x_draw_bottom_divider (w
);
30031 /* Turn the cursor on again. */
30032 if (cursor_cleared_p
30033 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30034 update_window_cursor (w
, 1);
30038 return mouse_face_overwritten_p
;
30043 /* Redraw (parts) of all windows in the window tree rooted at W that
30044 intersect R. R contains frame pixel coordinates. Value is
30045 non-zero if the exposure overwrites mouse-face. */
30048 expose_window_tree (struct window
*w
, XRectangle
*r
)
30050 struct frame
*f
= XFRAME (w
->frame
);
30051 int mouse_face_overwritten_p
= 0;
30053 while (w
&& !FRAME_GARBAGED_P (f
))
30055 if (WINDOWP (w
->contents
))
30056 mouse_face_overwritten_p
30057 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30059 mouse_face_overwritten_p
|= expose_window (w
, r
);
30061 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30064 return mouse_face_overwritten_p
;
30069 Redisplay an exposed area of frame F. X and Y are the upper-left
30070 corner of the exposed rectangle. W and H are width and height of
30071 the exposed area. All are pixel values. W or H zero means redraw
30072 the entire frame. */
30075 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30078 int mouse_face_overwritten_p
= 0;
30080 TRACE ((stderr
, "expose_frame "));
30082 /* No need to redraw if frame will be redrawn soon. */
30083 if (FRAME_GARBAGED_P (f
))
30085 TRACE ((stderr
, " garbaged\n"));
30089 /* If basic faces haven't been realized yet, there is no point in
30090 trying to redraw anything. This can happen when we get an expose
30091 event while Emacs is starting, e.g. by moving another window. */
30092 if (FRAME_FACE_CACHE (f
) == NULL
30093 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30095 TRACE ((stderr
, " no faces\n"));
30099 if (w
== 0 || h
== 0)
30102 r
.width
= FRAME_TEXT_WIDTH (f
);
30103 r
.height
= FRAME_TEXT_HEIGHT (f
);
30104 /** r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f); **/
30105 /** r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f); **/
30115 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30116 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30118 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30119 if (WINDOWP (f
->tool_bar_window
))
30120 mouse_face_overwritten_p
30121 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30124 #ifdef HAVE_X_WINDOWS
30126 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30127 if (WINDOWP (f
->menu_bar_window
))
30128 mouse_face_overwritten_p
30129 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30130 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30134 /* Some window managers support a focus-follows-mouse style with
30135 delayed raising of frames. Imagine a partially obscured frame,
30136 and moving the mouse into partially obscured mouse-face on that
30137 frame. The visible part of the mouse-face will be highlighted,
30138 then the WM raises the obscured frame. With at least one WM, KDE
30139 2.1, Emacs is not getting any event for the raising of the frame
30140 (even tried with SubstructureRedirectMask), only Expose events.
30141 These expose events will draw text normally, i.e. not
30142 highlighted. Which means we must redo the highlight here.
30143 Subsume it under ``we love X''. --gerd 2001-08-15 */
30144 /* Included in Windows version because Windows most likely does not
30145 do the right thing if any third party tool offers
30146 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30147 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30149 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30150 if (f
== hlinfo
->mouse_face_mouse_frame
)
30152 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30153 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30154 clear_mouse_face (hlinfo
);
30155 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30162 Determine the intersection of two rectangles R1 and R2. Return
30163 the intersection in *RESULT. Value is non-zero if RESULT is not
30167 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30169 XRectangle
*left
, *right
;
30170 XRectangle
*upper
, *lower
;
30171 int intersection_p
= 0;
30173 /* Rearrange so that R1 is the left-most rectangle. */
30175 left
= r1
, right
= r2
;
30177 left
= r2
, right
= r1
;
30179 /* X0 of the intersection is right.x0, if this is inside R1,
30180 otherwise there is no intersection. */
30181 if (right
->x
<= left
->x
+ left
->width
)
30183 result
->x
= right
->x
;
30185 /* The right end of the intersection is the minimum of
30186 the right ends of left and right. */
30187 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30190 /* Same game for Y. */
30192 upper
= r1
, lower
= r2
;
30194 upper
= r2
, lower
= r1
;
30196 /* The upper end of the intersection is lower.y0, if this is inside
30197 of upper. Otherwise, there is no intersection. */
30198 if (lower
->y
<= upper
->y
+ upper
->height
)
30200 result
->y
= lower
->y
;
30202 /* The lower end of the intersection is the minimum of the lower
30203 ends of upper and lower. */
30204 result
->height
= (min (lower
->y
+ lower
->height
,
30205 upper
->y
+ upper
->height
)
30207 intersection_p
= 1;
30211 return intersection_p
;
30214 #endif /* HAVE_WINDOW_SYSTEM */
30217 /***********************************************************************
30219 ***********************************************************************/
30222 syms_of_xdisp (void)
30224 Vwith_echo_area_save_vector
= Qnil
;
30225 staticpro (&Vwith_echo_area_save_vector
);
30227 Vmessage_stack
= Qnil
;
30228 staticpro (&Vmessage_stack
);
30230 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30231 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30233 message_dolog_marker1
= Fmake_marker ();
30234 staticpro (&message_dolog_marker1
);
30235 message_dolog_marker2
= Fmake_marker ();
30236 staticpro (&message_dolog_marker2
);
30237 message_dolog_marker3
= Fmake_marker ();
30238 staticpro (&message_dolog_marker3
);
30241 defsubr (&Sdump_frame_glyph_matrix
);
30242 defsubr (&Sdump_glyph_matrix
);
30243 defsubr (&Sdump_glyph_row
);
30244 defsubr (&Sdump_tool_bar_row
);
30245 defsubr (&Strace_redisplay
);
30246 defsubr (&Strace_to_stderr
);
30248 #ifdef HAVE_WINDOW_SYSTEM
30249 defsubr (&Stool_bar_height
);
30250 defsubr (&Slookup_image_map
);
30252 defsubr (&Sline_pixel_height
);
30253 defsubr (&Sformat_mode_line
);
30254 defsubr (&Sinvisible_p
);
30255 defsubr (&Scurrent_bidi_paragraph_direction
);
30256 defsubr (&Swindow_text_pixel_size
);
30257 defsubr (&Smove_point_visually
);
30259 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30260 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30261 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30262 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30263 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30264 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30265 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30266 DEFSYM (Qeval
, "eval");
30267 DEFSYM (QCdata
, ":data");
30268 DEFSYM (Qdisplay
, "display");
30269 DEFSYM (Qspace_width
, "space-width");
30270 DEFSYM (Qraise
, "raise");
30271 DEFSYM (Qslice
, "slice");
30272 DEFSYM (Qspace
, "space");
30273 DEFSYM (Qmargin
, "margin");
30274 DEFSYM (Qpointer
, "pointer");
30275 DEFSYM (Qleft_margin
, "left-margin");
30276 DEFSYM (Qright_margin
, "right-margin");
30277 DEFSYM (Qcenter
, "center");
30278 DEFSYM (Qline_height
, "line-height");
30279 DEFSYM (QCalign_to
, ":align-to");
30280 DEFSYM (QCrelative_width
, ":relative-width");
30281 DEFSYM (QCrelative_height
, ":relative-height");
30282 DEFSYM (QCeval
, ":eval");
30283 DEFSYM (QCpropertize
, ":propertize");
30284 DEFSYM (QCfile
, ":file");
30285 DEFSYM (Qfontified
, "fontified");
30286 DEFSYM (Qfontification_functions
, "fontification-functions");
30287 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30288 DEFSYM (Qescape_glyph
, "escape-glyph");
30289 DEFSYM (Qnobreak_space
, "nobreak-space");
30290 DEFSYM (Qimage
, "image");
30291 DEFSYM (Qtext
, "text");
30292 DEFSYM (Qboth
, "both");
30293 DEFSYM (Qboth_horiz
, "both-horiz");
30294 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30295 DEFSYM (QCmap
, ":map");
30296 DEFSYM (QCpointer
, ":pointer");
30297 DEFSYM (Qrect
, "rect");
30298 DEFSYM (Qcircle
, "circle");
30299 DEFSYM (Qpoly
, "poly");
30300 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30301 DEFSYM (Qgrow_only
, "grow-only");
30302 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30303 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30304 DEFSYM (Qposition
, "position");
30305 DEFSYM (Qbuffer_position
, "buffer-position");
30306 DEFSYM (Qobject
, "object");
30307 DEFSYM (Qbar
, "bar");
30308 DEFSYM (Qhbar
, "hbar");
30309 DEFSYM (Qbox
, "box");
30310 DEFSYM (Qhollow
, "hollow");
30311 DEFSYM (Qhand
, "hand");
30312 DEFSYM (Qarrow
, "arrow");
30313 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30315 list_of_error
= list1 (list2 (intern_c_string ("error"),
30316 intern_c_string ("void-variable")));
30317 staticpro (&list_of_error
);
30319 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30320 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30321 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30322 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30324 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30325 staticpro (&echo_buffer
[0]);
30326 staticpro (&echo_buffer
[1]);
30328 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30329 staticpro (&echo_area_buffer
[0]);
30330 staticpro (&echo_area_buffer
[1]);
30332 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30333 staticpro (&Vmessages_buffer_name
);
30335 mode_line_proptrans_alist
= Qnil
;
30336 staticpro (&mode_line_proptrans_alist
);
30337 mode_line_string_list
= Qnil
;
30338 staticpro (&mode_line_string_list
);
30339 mode_line_string_face
= Qnil
;
30340 staticpro (&mode_line_string_face
);
30341 mode_line_string_face_prop
= Qnil
;
30342 staticpro (&mode_line_string_face_prop
);
30343 Vmode_line_unwind_vector
= Qnil
;
30344 staticpro (&Vmode_line_unwind_vector
);
30346 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30348 help_echo_string
= Qnil
;
30349 staticpro (&help_echo_string
);
30350 help_echo_object
= Qnil
;
30351 staticpro (&help_echo_object
);
30352 help_echo_window
= Qnil
;
30353 staticpro (&help_echo_window
);
30354 previous_help_echo_string
= Qnil
;
30355 staticpro (&previous_help_echo_string
);
30356 help_echo_pos
= -1;
30358 DEFSYM (Qright_to_left
, "right-to-left");
30359 DEFSYM (Qleft_to_right
, "left-to-right");
30361 #ifdef HAVE_WINDOW_SYSTEM
30362 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30363 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30364 For example, if a block cursor is over a tab, it will be drawn as
30365 wide as that tab on the display. */);
30366 x_stretch_cursor_p
= 0;
30369 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30370 doc
: /* Non-nil means highlight trailing whitespace.
30371 The face used for trailing whitespace is `trailing-whitespace'. */);
30372 Vshow_trailing_whitespace
= Qnil
;
30374 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30375 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30376 If the value is t, Emacs highlights non-ASCII chars which have the
30377 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30378 or `escape-glyph' face respectively.
30380 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30381 U+2011 (non-breaking hyphen) are affected.
30383 Any other non-nil value means to display these characters as a escape
30384 glyph followed by an ordinary space or hyphen.
30386 A value of nil means no special handling of these characters. */);
30387 Vnobreak_char_display
= Qt
;
30389 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30390 doc
: /* The pointer shape to show in void text areas.
30391 A value of nil means to show the text pointer. Other options are
30392 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30394 Vvoid_text_area_pointer
= Qarrow
;
30396 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30397 doc
: /* Non-nil means don't actually do any redisplay.
30398 This is used for internal purposes. */);
30399 Vinhibit_redisplay
= Qnil
;
30401 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30402 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30403 Vglobal_mode_string
= Qnil
;
30405 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30406 doc
: /* Marker for where to display an arrow on top of the buffer text.
30407 This must be the beginning of a line in order to work.
30408 See also `overlay-arrow-string'. */);
30409 Voverlay_arrow_position
= Qnil
;
30411 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30412 doc
: /* String to display as an arrow in non-window frames.
30413 See also `overlay-arrow-position'. */);
30414 Voverlay_arrow_string
= build_pure_c_string ("=>");
30416 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30417 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30418 The symbols on this list are examined during redisplay to determine
30419 where to display overlay arrows. */);
30420 Voverlay_arrow_variable_list
30421 = list1 (intern_c_string ("overlay-arrow-position"));
30423 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30424 doc
: /* The number of lines to try scrolling a window by when point moves out.
30425 If that fails to bring point back on frame, point is centered instead.
30426 If this is zero, point is always centered after it moves off frame.
30427 If you want scrolling to always be a line at a time, you should set
30428 `scroll-conservatively' to a large value rather than set this to 1. */);
30430 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30431 doc
: /* Scroll up to this many lines, to bring point back on screen.
30432 If point moves off-screen, redisplay will scroll by up to
30433 `scroll-conservatively' lines in order to bring point just barely
30434 onto the screen again. If that cannot be done, then redisplay
30435 recenters point as usual.
30437 If the value is greater than 100, redisplay will never recenter point,
30438 but will always scroll just enough text to bring point into view, even
30439 if you move far away.
30441 A value of zero means always recenter point if it moves off screen. */);
30442 scroll_conservatively
= 0;
30444 DEFVAR_INT ("scroll-margin", scroll_margin
,
30445 doc
: /* Number of lines of margin at the top and bottom of a window.
30446 Recenter the window whenever point gets within this many lines
30447 of the top or bottom of the window. */);
30450 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30451 doc
: /* Pixels per inch value for non-window system displays.
30452 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30453 Vdisplay_pixels_per_inch
= make_float (72.0);
30456 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30459 DEFVAR_LISP ("truncate-partial-width-windows",
30460 Vtruncate_partial_width_windows
,
30461 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30462 For an integer value, truncate lines in each window narrower than the
30463 full frame width, provided the window width is less than that integer;
30464 otherwise, respect the value of `truncate-lines'.
30466 For any other non-nil value, truncate lines in all windows that do
30467 not span the full frame width.
30469 A value of nil means to respect the value of `truncate-lines'.
30471 If `word-wrap' is enabled, you might want to reduce this. */);
30472 Vtruncate_partial_width_windows
= make_number (50);
30474 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30475 doc
: /* Maximum buffer size for which line number should be displayed.
30476 If the buffer is bigger than this, the line number does not appear
30477 in the mode line. A value of nil means no limit. */);
30478 Vline_number_display_limit
= Qnil
;
30480 DEFVAR_INT ("line-number-display-limit-width",
30481 line_number_display_limit_width
,
30482 doc
: /* Maximum line width (in characters) for line number display.
30483 If the average length of the lines near point is bigger than this, then the
30484 line number may be omitted from the mode line. */);
30485 line_number_display_limit_width
= 200;
30487 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30488 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30489 highlight_nonselected_windows
= 0;
30491 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30492 doc
: /* Non-nil if more than one frame is visible on this display.
30493 Minibuffer-only frames don't count, but iconified frames do.
30494 This variable is not guaranteed to be accurate except while processing
30495 `frame-title-format' and `icon-title-format'. */);
30497 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30498 doc
: /* Template for displaying the title bar of visible frames.
30499 \(Assuming the window manager supports this feature.)
30501 This variable has the same structure as `mode-line-format', except that
30502 the %c and %l constructs are ignored. It is used only on frames for
30503 which no explicit name has been set \(see `modify-frame-parameters'). */);
30505 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30506 doc
: /* Template for displaying the title bar of an iconified frame.
30507 \(Assuming the window manager supports this feature.)
30508 This variable has the same structure as `mode-line-format' (which see),
30509 and is used only on frames for which no explicit name has been set
30510 \(see `modify-frame-parameters'). */);
30512 = Vframe_title_format
30513 = listn (CONSTYPE_PURE
, 3,
30514 intern_c_string ("multiple-frames"),
30515 build_pure_c_string ("%b"),
30516 listn (CONSTYPE_PURE
, 4,
30517 empty_unibyte_string
,
30518 intern_c_string ("invocation-name"),
30519 build_pure_c_string ("@"),
30520 intern_c_string ("system-name")));
30522 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30523 doc
: /* Maximum number of lines to keep in the message log buffer.
30524 If nil, disable message logging. If t, log messages but don't truncate
30525 the buffer when it becomes large. */);
30526 Vmessage_log_max
= make_number (1000);
30528 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30529 doc
: /* Functions called before redisplay, if window sizes have changed.
30530 The value should be a list of functions that take one argument.
30531 Just before redisplay, for each frame, if any of its windows have changed
30532 size since the last redisplay, or have been split or deleted,
30533 all the functions in the list are called, with the frame as argument. */);
30534 Vwindow_size_change_functions
= Qnil
;
30536 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30537 doc
: /* List of functions to call before redisplaying a window with scrolling.
30538 Each function is called with two arguments, the window and its new
30539 display-start position. Note that these functions are also called by
30540 `set-window-buffer'. Also note that the value of `window-end' is not
30541 valid when these functions are called.
30543 Warning: Do not use this feature to alter the way the window
30544 is scrolled. It is not designed for that, and such use probably won't
30546 Vwindow_scroll_functions
= Qnil
;
30548 DEFVAR_LISP ("window-text-change-functions",
30549 Vwindow_text_change_functions
,
30550 doc
: /* Functions to call in redisplay when text in the window might change. */);
30551 Vwindow_text_change_functions
= Qnil
;
30553 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30554 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30555 Each function is called with two arguments, the window and the end trigger value.
30556 See `set-window-redisplay-end-trigger'. */);
30557 Vredisplay_end_trigger_functions
= Qnil
;
30559 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30560 doc
: /* Non-nil means autoselect window with mouse pointer.
30561 If nil, do not autoselect windows.
30562 A positive number means delay autoselection by that many seconds: a
30563 window is autoselected only after the mouse has remained in that
30564 window for the duration of the delay.
30565 A negative number has a similar effect, but causes windows to be
30566 autoselected only after the mouse has stopped moving. \(Because of
30567 the way Emacs compares mouse events, you will occasionally wait twice
30568 that time before the window gets selected.\)
30569 Any other value means to autoselect window instantaneously when the
30570 mouse pointer enters it.
30572 Autoselection selects the minibuffer only if it is active, and never
30573 unselects the minibuffer if it is active.
30575 When customizing this variable make sure that the actual value of
30576 `focus-follows-mouse' matches the behavior of your window manager. */);
30577 Vmouse_autoselect_window
= Qnil
;
30579 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30580 doc
: /* Non-nil means automatically resize tool-bars.
30581 This dynamically changes the tool-bar's height to the minimum height
30582 that is needed to make all tool-bar items visible.
30583 If value is `grow-only', the tool-bar's height is only increased
30584 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30585 Vauto_resize_tool_bars
= Qt
;
30587 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30588 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30589 auto_raise_tool_bar_buttons_p
= 1;
30591 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30592 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30593 make_cursor_line_fully_visible_p
= 1;
30595 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30596 doc
: /* Border below tool-bar in pixels.
30597 If an integer, use it as the height of the border.
30598 If it is one of `internal-border-width' or `border-width', use the
30599 value of the corresponding frame parameter.
30600 Otherwise, no border is added below the tool-bar. */);
30601 Vtool_bar_border
= Qinternal_border_width
;
30603 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30604 doc
: /* Margin around tool-bar buttons in pixels.
30605 If an integer, use that for both horizontal and vertical margins.
30606 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30607 HORZ specifying the horizontal margin, and VERT specifying the
30608 vertical margin. */);
30609 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30611 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30612 doc
: /* Relief thickness of tool-bar buttons. */);
30613 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30615 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30616 doc
: /* Tool bar style to use.
30618 image - show images only
30619 text - show text only
30620 both - show both, text below image
30621 both-horiz - show text to the right of the image
30622 text-image-horiz - show text to the left of the image
30623 any other - use system default or image if no system default.
30625 This variable only affects the GTK+ toolkit version of Emacs. */);
30626 Vtool_bar_style
= Qnil
;
30628 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30629 doc
: /* Maximum number of characters a label can have to be shown.
30630 The tool bar style must also show labels for this to have any effect, see
30631 `tool-bar-style'. */);
30632 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30634 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30635 doc
: /* List of functions to call to fontify regions of text.
30636 Each function is called with one argument POS. Functions must
30637 fontify a region starting at POS in the current buffer, and give
30638 fontified regions the property `fontified'. */);
30639 Vfontification_functions
= Qnil
;
30640 Fmake_variable_buffer_local (Qfontification_functions
);
30642 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30643 unibyte_display_via_language_environment
,
30644 doc
: /* Non-nil means display unibyte text according to language environment.
30645 Specifically, this means that raw bytes in the range 160-255 decimal
30646 are displayed by converting them to the equivalent multibyte characters
30647 according to the current language environment. As a result, they are
30648 displayed according to the current fontset.
30650 Note that this variable affects only how these bytes are displayed,
30651 but does not change the fact they are interpreted as raw bytes. */);
30652 unibyte_display_via_language_environment
= 0;
30654 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30655 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30656 If a float, it specifies a fraction of the mini-window frame's height.
30657 If an integer, it specifies a number of lines. */);
30658 Vmax_mini_window_height
= make_float (0.25);
30660 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30661 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30662 A value of nil means don't automatically resize mini-windows.
30663 A value of t means resize them to fit the text displayed in them.
30664 A value of `grow-only', the default, means let mini-windows grow only;
30665 they return to their normal size when the minibuffer is closed, or the
30666 echo area becomes empty. */);
30667 Vresize_mini_windows
= Qgrow_only
;
30669 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30670 doc
: /* Alist specifying how to blink the cursor off.
30671 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30672 `cursor-type' frame-parameter or variable equals ON-STATE,
30673 comparing using `equal', Emacs uses OFF-STATE to specify
30674 how to blink it off. ON-STATE and OFF-STATE are values for
30675 the `cursor-type' frame parameter.
30677 If a frame's ON-STATE has no entry in this list,
30678 the frame's other specifications determine how to blink the cursor off. */);
30679 Vblink_cursor_alist
= Qnil
;
30681 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30682 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30683 If non-nil, windows are automatically scrolled horizontally to make
30684 point visible. */);
30685 automatic_hscrolling_p
= 1;
30686 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30688 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30689 doc
: /* How many columns away from the window edge point is allowed to get
30690 before automatic hscrolling will horizontally scroll the window. */);
30691 hscroll_margin
= 5;
30693 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30694 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30695 When point is less than `hscroll-margin' columns from the window
30696 edge, automatic hscrolling will scroll the window by the amount of columns
30697 determined by this variable. If its value is a positive integer, scroll that
30698 many columns. If it's a positive floating-point number, it specifies the
30699 fraction of the window's width to scroll. If it's nil or zero, point will be
30700 centered horizontally after the scroll. Any other value, including negative
30701 numbers, are treated as if the value were zero.
30703 Automatic hscrolling always moves point outside the scroll margin, so if
30704 point was more than scroll step columns inside the margin, the window will
30705 scroll more than the value given by the scroll step.
30707 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30708 and `scroll-right' overrides this variable's effect. */);
30709 Vhscroll_step
= make_number (0);
30711 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30712 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30713 Bind this around calls to `message' to let it take effect. */);
30714 message_truncate_lines
= 0;
30716 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30717 doc
: /* Normal hook run to update the menu bar definitions.
30718 Redisplay runs this hook before it redisplays the menu bar.
30719 This is used to update menus such as Buffers, whose contents depend on
30721 Vmenu_bar_update_hook
= Qnil
;
30723 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30724 doc
: /* Frame for which we are updating a menu.
30725 The enable predicate for a menu binding should check this variable. */);
30726 Vmenu_updating_frame
= Qnil
;
30728 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30729 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30730 inhibit_menubar_update
= 0;
30732 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30733 doc
: /* Prefix prepended to all continuation lines at display time.
30734 The value may be a string, an image, or a stretch-glyph; it is
30735 interpreted in the same way as the value of a `display' text property.
30737 This variable is overridden by any `wrap-prefix' text or overlay
30740 To add a prefix to non-continuation lines, use `line-prefix'. */);
30741 Vwrap_prefix
= Qnil
;
30742 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30743 Fmake_variable_buffer_local (Qwrap_prefix
);
30745 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30746 doc
: /* Prefix prepended to all non-continuation lines at display time.
30747 The value may be a string, an image, or a stretch-glyph; it is
30748 interpreted in the same way as the value of a `display' text property.
30750 This variable is overridden by any `line-prefix' text or overlay
30753 To add a prefix to continuation lines, use `wrap-prefix'. */);
30754 Vline_prefix
= Qnil
;
30755 DEFSYM (Qline_prefix
, "line-prefix");
30756 Fmake_variable_buffer_local (Qline_prefix
);
30758 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30759 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30760 inhibit_eval_during_redisplay
= 0;
30762 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30763 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30764 inhibit_free_realized_faces
= 0;
30767 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30768 doc
: /* Inhibit try_window_id display optimization. */);
30769 inhibit_try_window_id
= 0;
30771 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30772 doc
: /* Inhibit try_window_reusing display optimization. */);
30773 inhibit_try_window_reusing
= 0;
30775 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30776 doc
: /* Inhibit try_cursor_movement display optimization. */);
30777 inhibit_try_cursor_movement
= 0;
30778 #endif /* GLYPH_DEBUG */
30780 DEFVAR_INT ("overline-margin", overline_margin
,
30781 doc
: /* Space between overline and text, in pixels.
30782 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30783 margin to the character height. */);
30784 overline_margin
= 2;
30786 DEFVAR_INT ("underline-minimum-offset",
30787 underline_minimum_offset
,
30788 doc
: /* Minimum distance between baseline and underline.
30789 This can improve legibility of underlined text at small font sizes,
30790 particularly when using variable `x-use-underline-position-properties'
30791 with fonts that specify an UNDERLINE_POSITION relatively close to the
30792 baseline. The default value is 1. */);
30793 underline_minimum_offset
= 1;
30795 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30796 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30797 This feature only works when on a window system that can change
30798 cursor shapes. */);
30799 display_hourglass_p
= 1;
30801 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30802 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30803 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30805 #ifdef HAVE_WINDOW_SYSTEM
30806 hourglass_atimer
= NULL
;
30807 hourglass_shown_p
= 0;
30808 #endif /* HAVE_WINDOW_SYSTEM */
30810 DEFSYM (Qglyphless_char
, "glyphless-char");
30811 DEFSYM (Qhex_code
, "hex-code");
30812 DEFSYM (Qempty_box
, "empty-box");
30813 DEFSYM (Qthin_space
, "thin-space");
30814 DEFSYM (Qzero_width
, "zero-width");
30816 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30817 doc
: /* Function run just before redisplay.
30818 It is called with one argument, which is the set of windows that are to
30819 be redisplayed. This set can be nil (meaning, only the selected window),
30820 or t (meaning all windows). */);
30821 Vpre_redisplay_function
= intern ("ignore");
30823 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30824 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30826 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30827 doc
: /* Char-table defining glyphless characters.
30828 Each element, if non-nil, should be one of the following:
30829 an ASCII acronym string: display this string in a box
30830 `hex-code': display the hexadecimal code of a character in a box
30831 `empty-box': display as an empty box
30832 `thin-space': display as 1-pixel width space
30833 `zero-width': don't display
30834 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30835 display method for graphical terminals and text terminals respectively.
30836 GRAPHICAL and TEXT should each have one of the values listed above.
30838 The char-table has one extra slot to control the display of a character for
30839 which no font is found. This slot only takes effect on graphical terminals.
30840 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30841 `thin-space'. The default is `empty-box'.
30843 If a character has a non-nil entry in an active display table, the
30844 display table takes effect; in this case, Emacs does not consult
30845 `glyphless-char-display' at all. */);
30846 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30847 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30850 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30851 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30852 Vdebug_on_message
= Qnil
;
30854 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30856 Vredisplay__all_windows_cause
30857 = Fmake_vector (make_number (100), make_number (0));
30859 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30861 Vredisplay__mode_lines_cause
30862 = Fmake_vector (make_number (100), make_number (0));
30866 /* Initialize this module when Emacs starts. */
30871 CHARPOS (this_line_start_pos
) = 0;
30873 if (!noninteractive
)
30875 struct window
*m
= XWINDOW (minibuf_window
);
30876 Lisp_Object frame
= m
->frame
;
30877 struct frame
*f
= XFRAME (frame
);
30878 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30879 struct window
*r
= XWINDOW (root
);
30882 echo_area_window
= minibuf_window
;
30884 r
->top_line
= FRAME_TOP_MARGIN (f
);
30885 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30886 r
->total_cols
= FRAME_COLS (f
);
30887 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30888 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30889 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30891 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
30892 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30893 m
->total_cols
= FRAME_COLS (f
);
30894 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30895 m
->total_lines
= 1;
30896 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30898 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30899 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30900 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30902 /* The default ellipsis glyphs `...'. */
30903 for (i
= 0; i
< 3; ++i
)
30904 default_invis_vector
[i
] = make_number ('.');
30908 /* Allocate the buffer for frame titles.
30909 Also used for `format-mode-line'. */
30911 mode_line_noprop_buf
= xmalloc (size
);
30912 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30913 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30914 mode_line_target
= MODE_LINE_DISPLAY
;
30917 help_echo_showing_p
= 0;
30920 #ifdef HAVE_WINDOW_SYSTEM
30922 /* Platform-independent portion of hourglass implementation. */
30924 /* Timer function of hourglass_atimer. */
30927 show_hourglass (struct atimer
*timer
)
30929 /* The timer implementation will cancel this timer automatically
30930 after this function has run. Set hourglass_atimer to null
30931 so that we know the timer doesn't have to be canceled. */
30932 hourglass_atimer
= NULL
;
30934 if (!hourglass_shown_p
)
30936 Lisp_Object tail
, frame
;
30940 FOR_EACH_FRAME (tail
, frame
)
30942 struct frame
*f
= XFRAME (frame
);
30944 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
30945 && FRAME_RIF (f
)->show_hourglass
)
30946 FRAME_RIF (f
)->show_hourglass (f
);
30949 hourglass_shown_p
= 1;
30954 /* Cancel a currently active hourglass timer, and start a new one. */
30957 start_hourglass (void)
30959 struct timespec delay
;
30961 cancel_hourglass ();
30963 if (INTEGERP (Vhourglass_delay
)
30964 && XINT (Vhourglass_delay
) > 0)
30965 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30966 TYPE_MAXIMUM (time_t)),
30968 else if (FLOATP (Vhourglass_delay
)
30969 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30970 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30972 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30974 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30975 show_hourglass
, NULL
);
30978 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30982 cancel_hourglass (void)
30984 if (hourglass_atimer
)
30986 cancel_atimer (hourglass_atimer
);
30987 hourglass_atimer
= NULL
;
30990 if (hourglass_shown_p
)
30992 Lisp_Object tail
, frame
;
30996 FOR_EACH_FRAME (tail
, frame
)
30998 struct frame
*f
= XFRAME (frame
);
31000 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31001 && FRAME_RIF (f
)->hide_hourglass
)
31002 FRAME_RIF (f
)->hide_hourglass (f
);
31004 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31005 else if (!FRAME_W32_P (f
))
31006 w32_arrow_cursor ();
31010 hourglass_shown_p
= 0;
31015 #endif /* HAVE_WINDOW_SYSTEM */