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 /* Calling line_bottom_y may change it.method, it.position, etc. */
1459 enum it_method it_method
= it
.method
;
1460 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1461 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1463 if (top_y
< window_top_y
)
1464 visible_p
= bottom_y
> window_top_y
;
1465 else if (top_y
< it
.last_visible_y
)
1467 if (bottom_y
>= it
.last_visible_y
1468 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1469 && IT_CHARPOS (it
) < charpos
)
1471 /* When the last line of the window is scanned backwards
1472 under bidi iteration, we could be duped into thinking
1473 that we have passed CHARPOS, when in fact move_it_to
1474 simply stopped short of CHARPOS because it reached
1475 last_visible_y. To see if that's what happened, we call
1476 move_it_to again with a slightly larger vertical limit,
1477 and see if it actually moved vertically; if it did, we
1478 didn't really reach CHARPOS, which is beyond window end. */
1479 struct it save_it
= it
;
1480 /* Why 10? because we don't know how many canonical lines
1481 will the height of the next line(s) be. So we guess. */
1482 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1484 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1485 MOVE_TO_POS
| MOVE_TO_Y
);
1486 if (it
.current_y
> top_y
)
1493 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1495 /* We stopped on the last glyph of a display vector.
1496 Try and recompute. Hack alert! */
1497 if (charpos
< 2 || top
.charpos
>= charpos
)
1498 top_x
= it
.glyph_row
->x
;
1501 struct it it2
, it2_prev
;
1502 /* The idea is to get to the previous buffer
1503 position, consume the character there, and use
1504 the pixel coordinates we get after that. But if
1505 the previous buffer position is also displayed
1506 from a display vector, we need to consume all of
1507 the glyphs from that display vector. */
1508 start_display (&it2
, w
, top
);
1509 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1510 /* If we didn't get to CHARPOS - 1, there's some
1511 replacing display property at that position, and
1512 we stopped after it. That is exactly the place
1513 whose coordinates we want. */
1514 if (IT_CHARPOS (it2
) != charpos
- 1)
1518 /* Iterate until we get out of the display
1519 vector that displays the character at
1522 get_next_display_element (&it2
);
1523 PRODUCE_GLYPHS (&it2
);
1525 set_iterator_to_next (&it2
, 1);
1526 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1527 && IT_CHARPOS (it2
) < charpos
);
1529 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1530 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1531 top_x
= it
.glyph_row
->x
;
1534 top_x
= it2_prev
.current_x
;
1535 top_y
= it2_prev
.current_y
;
1539 else if (IT_CHARPOS (it
) != charpos
)
1541 Lisp_Object cpos
= make_number (charpos
);
1542 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1543 Lisp_Object string
= string_from_display_spec (spec
);
1544 struct text_pos tpos
;
1545 int replacing_spec_p
;
1546 bool newline_in_string
1548 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1550 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1553 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1554 charpos
, FRAME_WINDOW_P (it
.f
)));
1555 /* The tricky code below is needed because there's a
1556 discrepancy between move_it_to and how we set cursor
1557 when PT is at the beginning of a portion of text
1558 covered by a display property or an overlay with a
1559 display property, or the display line ends in a
1560 newline from a display string. move_it_to will stop
1561 _after_ such display strings, whereas
1562 set_cursor_from_row conspires with cursor_row_p to
1563 place the cursor on the first glyph produced from the
1566 /* We have overshoot PT because it is covered by a
1567 display property that replaces the text it covers.
1568 If the string includes embedded newlines, we are also
1569 in the wrong display line. Backtrack to the correct
1570 line, where the display property begins. */
1571 if (replacing_spec_p
)
1573 Lisp_Object startpos
, endpos
;
1574 EMACS_INT start
, end
;
1578 /* Find the first and the last buffer positions
1579 covered by the display string. */
1581 Fnext_single_char_property_change (cpos
, Qdisplay
,
1584 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1586 start
= XFASTINT (startpos
);
1587 end
= XFASTINT (endpos
);
1588 /* Move to the last buffer position before the
1589 display property. */
1590 start_display (&it3
, w
, top
);
1591 if (start
> CHARPOS (top
))
1592 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1593 /* Move forward one more line if the position before
1594 the display string is a newline or if it is the
1595 rightmost character on a line that is
1596 continued or word-wrapped. */
1597 if (it3
.method
== GET_FROM_BUFFER
1599 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1600 move_it_by_lines (&it3
, 1);
1601 else if (move_it_in_display_line_to (&it3
, -1,
1605 == MOVE_LINE_CONTINUED
)
1607 move_it_by_lines (&it3
, 1);
1608 /* When we are under word-wrap, the #$@%!
1609 move_it_by_lines moves 2 lines, so we need to
1611 if (it3
.line_wrap
== WORD_WRAP
)
1612 move_it_by_lines (&it3
, -1);
1615 /* Record the vertical coordinate of the display
1616 line where we wound up. */
1617 top_y
= it3
.current_y
;
1620 /* When characters are reordered for display,
1621 the character displayed to the left of the
1622 display string could be _after_ the display
1623 property in the logical order. Use the
1624 smallest vertical position of these two. */
1625 start_display (&it3
, w
, top
);
1626 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1627 if (it3
.current_y
< top_y
)
1628 top_y
= it3
.current_y
;
1630 /* Move from the top of the window to the beginning
1631 of the display line where the display string
1633 start_display (&it3
, w
, top
);
1634 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1635 /* If it3_moved stays zero after the 'while' loop
1636 below, that means we already were at a newline
1637 before the loop (e.g., the display string begins
1638 with a newline), so we don't need to (and cannot)
1639 inspect the glyphs of it3.glyph_row, because
1640 PRODUCE_GLYPHS will not produce anything for a
1641 newline, and thus it3.glyph_row stays at its
1642 stale content it got at top of the window. */
1644 /* Finally, advance the iterator until we hit the
1645 first display element whose character position is
1646 CHARPOS, or until the first newline from the
1647 display string, which signals the end of the
1649 while (get_next_display_element (&it3
))
1651 PRODUCE_GLYPHS (&it3
);
1652 if (IT_CHARPOS (it3
) == charpos
1653 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1656 set_iterator_to_next (&it3
, 0);
1658 top_x
= it3
.current_x
- it3
.pixel_width
;
1659 /* Normally, we would exit the above loop because we
1660 found the display element whose character
1661 position is CHARPOS. For the contingency that we
1662 didn't, and stopped at the first newline from the
1663 display string, move back over the glyphs
1664 produced from the string, until we find the
1665 rightmost glyph not from the string. */
1667 && newline_in_string
1668 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1670 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1671 + it3
.glyph_row
->used
[TEXT_AREA
];
1673 while (EQ ((g
- 1)->object
, string
))
1676 top_x
-= g
->pixel_width
;
1678 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1679 + it3
.glyph_row
->used
[TEXT_AREA
]);
1685 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1686 *rtop
= max (0, window_top_y
- top_y
);
1687 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1688 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1689 - max (top_y
, window_top_y
)));
1695 /* Either we were asked to provide info about WINDOW_END, or
1696 CHARPOS is in the partially visible glyph row at end of
1699 void *it2data
= NULL
;
1701 SAVE_IT (it2
, it
, it2data
);
1702 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1703 move_it_by_lines (&it
, 1);
1704 if (charpos
< IT_CHARPOS (it
)
1705 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1708 RESTORE_IT (&it2
, &it2
, it2data
);
1709 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1711 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1712 *rtop
= max (0, -it2
.current_y
);
1713 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1714 - it
.last_visible_y
));
1715 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1717 - max (it2
.current_y
,
1718 WINDOW_HEADER_LINE_HEIGHT (w
))));
1722 bidi_unshelve_cache (it2data
, 1);
1724 bidi_unshelve_cache (itdata
, 0);
1727 set_buffer_internal_1 (old_buffer
);
1729 if (visible_p
&& w
->hscroll
> 0)
1731 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1732 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1735 /* Debugging code. */
1737 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1738 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1740 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1747 /* Return the next character from STR. Return in *LEN the length of
1748 the character. This is like STRING_CHAR_AND_LENGTH but never
1749 returns an invalid character. If we find one, we return a `?', but
1750 with the length of the invalid character. */
1753 string_char_and_length (const unsigned char *str
, int *len
)
1757 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1758 if (!CHAR_VALID_P (c
))
1759 /* We may not change the length here because other places in Emacs
1760 don't use this function, i.e. they silently accept invalid
1769 /* Given a position POS containing a valid character and byte position
1770 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1772 static struct text_pos
1773 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1775 eassert (STRINGP (string
) && nchars
>= 0);
1777 if (STRING_MULTIBYTE (string
))
1779 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1784 string_char_and_length (p
, &len
);
1787 BYTEPOS (pos
) += len
;
1791 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1797 /* Value is the text position, i.e. character and byte position,
1798 for character position CHARPOS in STRING. */
1800 static struct text_pos
1801 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1803 struct text_pos pos
;
1804 eassert (STRINGP (string
));
1805 eassert (charpos
>= 0);
1806 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1811 /* Value is a text position, i.e. character and byte position, for
1812 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1813 means recognize multibyte characters. */
1815 static struct text_pos
1816 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1818 struct text_pos pos
;
1820 eassert (s
!= NULL
);
1821 eassert (charpos
>= 0);
1827 SET_TEXT_POS (pos
, 0, 0);
1830 string_char_and_length ((const unsigned char *) s
, &len
);
1833 BYTEPOS (pos
) += len
;
1837 SET_TEXT_POS (pos
, charpos
, charpos
);
1843 /* Value is the number of characters in C string S. MULTIBYTE_P
1844 non-zero means recognize multibyte characters. */
1847 number_of_chars (const char *s
, bool multibyte_p
)
1853 ptrdiff_t rest
= strlen (s
);
1855 const unsigned char *p
= (const unsigned char *) s
;
1857 for (nchars
= 0; rest
> 0; ++nchars
)
1859 string_char_and_length (p
, &len
);
1860 rest
-= len
, p
+= len
;
1864 nchars
= strlen (s
);
1870 /* Compute byte position NEWPOS->bytepos corresponding to
1871 NEWPOS->charpos. POS is a known position in string STRING.
1872 NEWPOS->charpos must be >= POS.charpos. */
1875 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1877 eassert (STRINGP (string
));
1878 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1880 if (STRING_MULTIBYTE (string
))
1881 *newpos
= string_pos_nchars_ahead (pos
, string
,
1882 CHARPOS (*newpos
) - CHARPOS (pos
));
1884 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1888 Return an estimation of the pixel height of mode or header lines on
1889 frame F. FACE_ID specifies what line's height to estimate. */
1892 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1894 #ifdef HAVE_WINDOW_SYSTEM
1895 if (FRAME_WINDOW_P (f
))
1897 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1899 /* This function is called so early when Emacs starts that the face
1900 cache and mode line face are not yet initialized. */
1901 if (FRAME_FACE_CACHE (f
))
1903 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1907 height
= FONT_HEIGHT (face
->font
);
1908 if (face
->box_line_width
> 0)
1909 height
+= 2 * face
->box_line_width
;
1920 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1921 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1922 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1923 not force the value into range. */
1926 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1927 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1930 #ifdef HAVE_WINDOW_SYSTEM
1931 if (FRAME_WINDOW_P (f
))
1933 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1934 even for negative values. */
1936 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1938 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1940 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1941 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1944 STORE_NATIVE_RECT (*bounds
,
1945 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1946 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1947 FRAME_COLUMN_WIDTH (f
) - 1,
1948 FRAME_LINE_HEIGHT (f
) - 1);
1950 /* PXW: Should we clip pixels before converting to columns/lines? */
1955 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1956 pix_x
= FRAME_TOTAL_COLS (f
);
1960 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1961 pix_y
= FRAME_TOTAL_LINES (f
);
1971 /* Find the glyph under window-relative coordinates X/Y in window W.
1972 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1973 strings. Return in *HPOS and *VPOS the row and column number of
1974 the glyph found. Return in *AREA the glyph area containing X.
1975 Value is a pointer to the glyph found or null if X/Y is not on
1976 text, or we can't tell because W's current matrix is not up to
1979 static struct glyph
*
1980 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1981 int *dx
, int *dy
, int *area
)
1983 struct glyph
*glyph
, *end
;
1984 struct glyph_row
*row
= NULL
;
1987 /* Find row containing Y. Give up if some row is not enabled. */
1988 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1990 row
= MATRIX_ROW (w
->current_matrix
, i
);
1991 if (!row
->enabled_p
)
1993 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2000 /* Give up if Y is not in the window. */
2001 if (i
== w
->current_matrix
->nrows
)
2004 /* Get the glyph area containing X. */
2005 if (w
->pseudo_window_p
)
2012 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2014 *area
= LEFT_MARGIN_AREA
;
2015 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2017 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2020 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2024 *area
= RIGHT_MARGIN_AREA
;
2025 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2029 /* Find glyph containing X. */
2030 glyph
= row
->glyphs
[*area
];
2031 end
= glyph
+ row
->used
[*area
];
2033 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2035 x
-= glyph
->pixel_width
;
2045 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2048 *hpos
= glyph
- row
->glyphs
[*area
];
2052 /* Convert frame-relative x/y to coordinates relative to window W.
2053 Takes pseudo-windows into account. */
2056 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2058 if (w
->pseudo_window_p
)
2060 /* A pseudo-window is always full-width, and starts at the
2061 left edge of the frame, plus a frame border. */
2062 struct frame
*f
= XFRAME (w
->frame
);
2063 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2064 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2068 *x
-= WINDOW_LEFT_EDGE_X (w
);
2069 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2073 #ifdef HAVE_WINDOW_SYSTEM
2076 Return in RECTS[] at most N clipping rectangles for glyph string S.
2077 Return the number of stored rectangles. */
2080 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2087 if (s
->row
->full_width_p
)
2089 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2090 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2091 if (s
->row
->mode_line_p
)
2092 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2094 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2096 /* Unless displaying a mode or menu bar line, which are always
2097 fully visible, clip to the visible part of the row. */
2098 if (s
->w
->pseudo_window_p
)
2099 r
.height
= s
->row
->visible_height
;
2101 r
.height
= s
->height
;
2105 /* This is a text line that may be partially visible. */
2106 r
.x
= window_box_left (s
->w
, s
->area
);
2107 r
.width
= window_box_width (s
->w
, s
->area
);
2108 r
.height
= s
->row
->visible_height
;
2112 if (r
.x
< s
->clip_head
->x
)
2114 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2115 r
.width
-= s
->clip_head
->x
- r
.x
;
2118 r
.x
= s
->clip_head
->x
;
2121 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2123 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2124 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2129 /* If S draws overlapping rows, it's sufficient to use the top and
2130 bottom of the window for clipping because this glyph string
2131 intentionally draws over other lines. */
2132 if (s
->for_overlaps
)
2134 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2135 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2137 /* Alas, the above simple strategy does not work for the
2138 environments with anti-aliased text: if the same text is
2139 drawn onto the same place multiple times, it gets thicker.
2140 If the overlap we are processing is for the erased cursor, we
2141 take the intersection with the rectangle of the cursor. */
2142 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2144 XRectangle rc
, r_save
= r
;
2146 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2147 rc
.y
= s
->w
->phys_cursor
.y
;
2148 rc
.width
= s
->w
->phys_cursor_width
;
2149 rc
.height
= s
->w
->phys_cursor_height
;
2151 x_intersect_rectangles (&r_save
, &rc
, &r
);
2156 /* Don't use S->y for clipping because it doesn't take partially
2157 visible lines into account. For example, it can be negative for
2158 partially visible lines at the top of a window. */
2159 if (!s
->row
->full_width_p
2160 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2161 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2163 r
.y
= max (0, s
->row
->y
);
2166 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2168 /* If drawing the cursor, don't let glyph draw outside its
2169 advertised boundaries. Cleartype does this under some circumstances. */
2170 if (s
->hl
== DRAW_CURSOR
)
2172 struct glyph
*glyph
= s
->first_glyph
;
2177 if (r
.width
>= s
->x
- r
.x
)
2178 r
.width
-= s
->x
- r
.x
;
2179 else /* R2L hscrolled row with cursor outside text area */
2183 r
.width
= min (r
.width
, glyph
->pixel_width
);
2185 /* If r.y is below window bottom, ensure that we still see a cursor. */
2186 height
= min (glyph
->ascent
+ glyph
->descent
,
2187 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2188 max_y
= window_text_bottom_y (s
->w
) - height
;
2189 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2190 if (s
->ybase
- glyph
->ascent
> max_y
)
2197 /* Don't draw cursor glyph taller than our actual glyph. */
2198 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2199 if (height
< r
.height
)
2201 max_y
= r
.y
+ r
.height
;
2202 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2203 r
.height
= min (max_y
- r
.y
, height
);
2210 XRectangle r_save
= r
;
2212 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2216 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2217 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2219 #ifdef CONVERT_FROM_XRECT
2220 CONVERT_FROM_XRECT (r
, *rects
);
2228 /* If we are processing overlapping and allowed to return
2229 multiple clipping rectangles, we exclude the row of the glyph
2230 string from the clipping rectangle. This is to avoid drawing
2231 the same text on the environment with anti-aliasing. */
2232 #ifdef CONVERT_FROM_XRECT
2235 XRectangle
*rs
= rects
;
2237 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2239 if (s
->for_overlaps
& OVERLAPS_PRED
)
2242 if (r
.y
+ r
.height
> row_y
)
2245 rs
[i
].height
= row_y
- r
.y
;
2251 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2254 if (r
.y
< row_y
+ s
->row
->visible_height
)
2256 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2258 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2259 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2268 #ifdef CONVERT_FROM_XRECT
2269 for (i
= 0; i
< n
; i
++)
2270 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2277 Return in *NR the clipping rectangle for glyph string S. */
2280 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2282 get_glyph_string_clip_rects (s
, nr
, 1);
2287 Return the position and height of the phys cursor in window W.
2288 Set w->phys_cursor_width to width of phys cursor.
2292 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2293 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2295 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2296 int x
, y
, wd
, h
, h0
, y0
;
2298 /* Compute the width of the rectangle to draw. If on a stretch
2299 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2300 rectangle as wide as the glyph, but use a canonical character
2302 wd
= glyph
->pixel_width
- 1;
2303 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2307 x
= w
->phys_cursor
.x
;
2314 if (glyph
->type
== STRETCH_GLYPH
2315 && !x_stretch_cursor_p
)
2316 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2317 w
->phys_cursor_width
= wd
;
2319 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2321 /* If y is below window bottom, ensure that we still see a cursor. */
2322 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2324 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2325 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2327 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2330 h
= max (h
- (y0
- y
) + 1, h0
);
2335 y0
= window_text_bottom_y (w
) - h0
;
2343 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2344 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2349 * Remember which glyph the mouse is over.
2353 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2357 struct glyph_row
*r
, *gr
, *end_row
;
2358 enum window_part part
;
2359 enum glyph_row_area area
;
2360 int x
, y
, width
, height
;
2362 /* Try to determine frame pixel position and size of the glyph under
2363 frame pixel coordinates X/Y on frame F. */
2365 if (window_resize_pixelwise
)
2370 else if (!f
->glyphs_initialized_p
2371 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2374 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2375 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2379 w
= XWINDOW (window
);
2380 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2381 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2383 x
= window_relative_x_coord (w
, part
, gx
);
2384 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2386 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2387 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2389 if (w
->pseudo_window_p
)
2392 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2398 case ON_LEFT_MARGIN
:
2399 area
= LEFT_MARGIN_AREA
;
2402 case ON_RIGHT_MARGIN
:
2403 area
= RIGHT_MARGIN_AREA
;
2406 case ON_HEADER_LINE
:
2408 gr
= (part
== ON_HEADER_LINE
2409 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2410 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2413 goto text_glyph_row_found
;
2420 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2421 if (r
->y
+ r
->height
> y
)
2427 text_glyph_row_found
:
2430 struct glyph
*g
= gr
->glyphs
[area
];
2431 struct glyph
*end
= g
+ gr
->used
[area
];
2433 height
= gr
->height
;
2434 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2435 if (gx
+ g
->pixel_width
> x
)
2440 if (g
->type
== IMAGE_GLYPH
)
2442 /* Don't remember when mouse is over image, as
2443 image may have hot-spots. */
2444 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2447 width
= g
->pixel_width
;
2451 /* Use nominal char spacing at end of line. */
2453 gx
+= (x
/ width
) * width
;
2456 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2458 gx
+= window_box_left_offset (w
, area
);
2459 /* Don't expand over the modeline to make sure the vertical
2460 drag cursor is shown early enough. */
2461 height
= min (height
,
2462 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2467 /* Use nominal line height at end of window. */
2468 gx
= (x
/ width
) * width
;
2470 gy
+= (y
/ height
) * height
;
2471 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2472 /* See comment above. */
2473 height
= min (height
,
2474 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2478 case ON_LEFT_FRINGE
:
2479 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2480 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2481 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2482 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2485 case ON_RIGHT_FRINGE
:
2486 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2487 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2488 : window_box_right_offset (w
, TEXT_AREA
));
2489 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2490 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2491 && !WINDOW_RIGHTMOST_P (w
))
2492 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2493 /* Make sure the vertical border can get her own glyph to the
2494 right of the one we build here. */
2495 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2497 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2499 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2503 case ON_VERTICAL_BORDER
:
2504 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2507 case ON_VERTICAL_SCROLL_BAR
:
2508 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2510 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2511 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2512 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2514 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2518 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2519 if (r
->y
+ r
->height
> y
)
2526 height
= gr
->height
;
2529 /* Use nominal line height at end of window. */
2531 gy
+= (y
/ height
) * height
;
2535 case ON_RIGHT_DIVIDER
:
2536 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2537 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2539 /* The bottom divider prevails. */
2540 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2543 case ON_BOTTOM_DIVIDER
:
2545 width
= WINDOW_PIXEL_WIDTH (w
);
2546 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2547 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2553 /* If there is no glyph under the mouse, then we divide the screen
2554 into a grid of the smallest glyph in the frame, and use that
2557 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2558 round down even for negative values. */
2564 gx
= (gx
/ width
) * width
;
2565 gy
= (gy
/ height
) * height
;
2571 gx
+= WINDOW_LEFT_EDGE_X (w
);
2572 gy
+= WINDOW_TOP_EDGE_Y (w
);
2575 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2577 /* Visible feedback for debugging. */
2580 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2581 f
->output_data
.x
->normal_gc
,
2582 gx
, gy
, width
, height
);
2588 #endif /* HAVE_WINDOW_SYSTEM */
2591 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2594 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2595 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2597 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2600 /***********************************************************************
2601 Lisp form evaluation
2602 ***********************************************************************/
2604 /* Error handler for safe_eval and safe_call. */
2607 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2609 add_to_log ("Error during redisplay: %S signaled %S",
2610 Flist (nargs
, args
), arg
);
2614 /* Call function FUNC with the rest of NARGS - 1 arguments
2615 following. Return the result, or nil if something went
2616 wrong. Prevent redisplay during the evaluation. */
2619 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2623 if (inhibit_eval_during_redisplay
)
2628 ptrdiff_t count
= SPECPDL_INDEX ();
2629 struct gcpro gcpro1
;
2630 Lisp_Object
*args
= alloca (nargs
* word_size
);
2633 for (i
= 1; i
< nargs
; i
++)
2634 args
[i
] = va_arg (ap
, Lisp_Object
);
2637 gcpro1
.nvars
= nargs
;
2638 specbind (Qinhibit_redisplay
, Qt
);
2640 specbind (Qinhibit_quit
, Qt
);
2641 /* Use Qt to ensure debugger does not run,
2642 so there is no possibility of wanting to redisplay. */
2643 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2646 val
= unbind_to (count
, val
);
2653 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2658 va_start (ap
, func
);
2659 retval
= safe__call (false, nargs
, func
, ap
);
2664 /* Call function FN with one argument ARG.
2665 Return the result, or nil if something went wrong. */
2668 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2670 return safe_call (2, fn
, arg
);
2674 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2680 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2685 static Lisp_Object Qeval
;
2688 safe_eval (Lisp_Object sexpr
)
2690 return safe__call1 (false, Qeval
, sexpr
);
2694 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2696 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2699 /* Call function FN with two arguments ARG1 and ARG2.
2700 Return the result, or nil if something went wrong. */
2703 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2705 return safe_call (3, fn
, arg1
, arg2
);
2710 /***********************************************************************
2712 ***********************************************************************/
2716 /* Define CHECK_IT to perform sanity checks on iterators.
2717 This is for debugging. It is too slow to do unconditionally. */
2720 check_it (struct it
*it
)
2722 if (it
->method
== GET_FROM_STRING
)
2724 eassert (STRINGP (it
->string
));
2725 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2729 eassert (IT_STRING_CHARPOS (*it
) < 0);
2730 if (it
->method
== GET_FROM_BUFFER
)
2732 /* Check that character and byte positions agree. */
2733 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2738 eassert (it
->current
.dpvec_index
>= 0);
2740 eassert (it
->current
.dpvec_index
< 0);
2743 #define CHECK_IT(IT) check_it ((IT))
2747 #define CHECK_IT(IT) (void) 0
2752 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2754 /* Check that the window end of window W is what we expect it
2755 to be---the last row in the current matrix displaying text. */
2758 check_window_end (struct window
*w
)
2760 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2762 struct glyph_row
*row
;
2763 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2765 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2766 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2770 #define CHECK_WINDOW_END(W) check_window_end ((W))
2774 #define CHECK_WINDOW_END(W) (void) 0
2776 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2778 /***********************************************************************
2779 Iterator initialization
2780 ***********************************************************************/
2782 /* Initialize IT for displaying current_buffer in window W, starting
2783 at character position CHARPOS. CHARPOS < 0 means that no buffer
2784 position is specified which is useful when the iterator is assigned
2785 a position later. BYTEPOS is the byte position corresponding to
2788 If ROW is not null, calls to produce_glyphs with IT as parameter
2789 will produce glyphs in that row.
2791 BASE_FACE_ID is the id of a base face to use. It must be one of
2792 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2793 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2794 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2796 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2797 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2798 will be initialized to use the corresponding mode line glyph row of
2799 the desired matrix of W. */
2802 init_iterator (struct it
*it
, struct window
*w
,
2803 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2804 struct glyph_row
*row
, enum face_id base_face_id
)
2806 enum face_id remapped_base_face_id
= base_face_id
;
2808 /* Some precondition checks. */
2809 eassert (w
!= NULL
&& it
!= NULL
);
2810 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2813 /* If face attributes have been changed since the last redisplay,
2814 free realized faces now because they depend on face definitions
2815 that might have changed. Don't free faces while there might be
2816 desired matrices pending which reference these faces. */
2817 if (face_change_count
&& !inhibit_free_realized_faces
)
2819 face_change_count
= 0;
2820 free_all_realized_faces (Qnil
);
2823 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2824 if (! NILP (Vface_remapping_alist
))
2825 remapped_base_face_id
2826 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2828 /* Use one of the mode line rows of W's desired matrix if
2832 if (base_face_id
== MODE_LINE_FACE_ID
2833 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2834 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2835 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2836 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2840 memset (it
, 0, sizeof *it
);
2841 it
->current
.overlay_string_index
= -1;
2842 it
->current
.dpvec_index
= -1;
2843 it
->base_face_id
= remapped_base_face_id
;
2845 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2846 it
->paragraph_embedding
= L2R
;
2847 it
->bidi_it
.string
.lstring
= Qnil
;
2848 it
->bidi_it
.string
.s
= NULL
;
2849 it
->bidi_it
.string
.bufpos
= 0;
2852 /* The window in which we iterate over current_buffer: */
2853 XSETWINDOW (it
->window
, w
);
2855 it
->f
= XFRAME (w
->frame
);
2859 /* Extra space between lines (on window systems only). */
2860 if (base_face_id
== DEFAULT_FACE_ID
2861 && FRAME_WINDOW_P (it
->f
))
2863 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2864 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2865 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2866 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2867 * FRAME_LINE_HEIGHT (it
->f
));
2868 else if (it
->f
->extra_line_spacing
> 0)
2869 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2870 it
->max_extra_line_spacing
= 0;
2873 /* If realized faces have been removed, e.g. because of face
2874 attribute changes of named faces, recompute them. When running
2875 in batch mode, the face cache of the initial frame is null. If
2876 we happen to get called, make a dummy face cache. */
2877 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2878 init_frame_faces (it
->f
);
2879 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2880 recompute_basic_faces (it
->f
);
2882 /* Current value of the `slice', `space-width', and 'height' properties. */
2883 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2884 it
->space_width
= Qnil
;
2885 it
->font_height
= Qnil
;
2886 it
->override_ascent
= -1;
2888 /* Are control characters displayed as `^C'? */
2889 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2891 /* -1 means everything between a CR and the following line end
2892 is invisible. >0 means lines indented more than this value are
2894 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2896 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2898 : (!NILP (BVAR (current_buffer
, selective_display
))
2900 it
->selective_display_ellipsis_p
2901 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2903 /* Display table to use. */
2904 it
->dp
= window_display_table (w
);
2906 /* Are multibyte characters enabled in current_buffer? */
2907 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2909 /* Get the position at which the redisplay_end_trigger hook should
2910 be run, if it is to be run at all. */
2911 if (MARKERP (w
->redisplay_end_trigger
)
2912 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2913 it
->redisplay_end_trigger_charpos
2914 = marker_position (w
->redisplay_end_trigger
);
2915 else if (INTEGERP (w
->redisplay_end_trigger
))
2916 it
->redisplay_end_trigger_charpos
2917 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2920 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2922 /* Are lines in the display truncated? */
2923 if (base_face_id
!= DEFAULT_FACE_ID
2925 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2926 && ((!NILP (Vtruncate_partial_width_windows
)
2927 && !INTEGERP (Vtruncate_partial_width_windows
))
2928 || (INTEGERP (Vtruncate_partial_width_windows
)
2929 /* PXW: Shall we do something about this? */
2930 && (WINDOW_TOTAL_COLS (it
->w
)
2931 < XINT (Vtruncate_partial_width_windows
))))))
2932 it
->line_wrap
= TRUNCATE
;
2933 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2934 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2935 ? WINDOW_WRAP
: WORD_WRAP
;
2937 it
->line_wrap
= TRUNCATE
;
2939 /* Get dimensions of truncation and continuation glyphs. These are
2940 displayed as fringe bitmaps under X, but we need them for such
2941 frames when the fringes are turned off. But leave the dimensions
2942 zero for tooltip frames, as these glyphs look ugly there and also
2943 sabotage calculations of tooltip dimensions in x-show-tip. */
2944 #ifdef HAVE_WINDOW_SYSTEM
2945 if (!(FRAME_WINDOW_P (it
->f
)
2946 && FRAMEP (tip_frame
)
2947 && it
->f
== XFRAME (tip_frame
)))
2950 if (it
->line_wrap
== TRUNCATE
)
2952 /* We will need the truncation glyph. */
2953 eassert (it
->glyph_row
== NULL
);
2954 produce_special_glyphs (it
, IT_TRUNCATION
);
2955 it
->truncation_pixel_width
= it
->pixel_width
;
2959 /* We will need the continuation glyph. */
2960 eassert (it
->glyph_row
== NULL
);
2961 produce_special_glyphs (it
, IT_CONTINUATION
);
2962 it
->continuation_pixel_width
= it
->pixel_width
;
2966 /* Reset these values to zero because the produce_special_glyphs
2967 above has changed them. */
2968 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2969 it
->phys_ascent
= it
->phys_descent
= 0;
2971 /* Set this after getting the dimensions of truncation and
2972 continuation glyphs, so that we don't produce glyphs when calling
2973 produce_special_glyphs, above. */
2974 it
->glyph_row
= row
;
2975 it
->area
= TEXT_AREA
;
2977 /* Get the dimensions of the display area. The display area
2978 consists of the visible window area plus a horizontally scrolled
2979 part to the left of the window. All x-values are relative to the
2980 start of this total display area. */
2981 if (base_face_id
!= DEFAULT_FACE_ID
)
2983 /* Mode lines, menu bar in terminal frames. */
2984 it
->first_visible_x
= 0;
2985 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2990 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2991 it
->last_visible_x
= (it
->first_visible_x
2992 + window_box_width (w
, TEXT_AREA
));
2994 /* If we truncate lines, leave room for the truncation glyph(s) at
2995 the right margin. Otherwise, leave room for the continuation
2996 glyph(s). Done only if the window has no fringes. Since we
2997 don't know at this point whether there will be any R2L lines in
2998 the window, we reserve space for truncation/continuation glyphs
2999 even if only one of the fringes is absent. */
3000 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
3001 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
3003 if (it
->line_wrap
== TRUNCATE
)
3004 it
->last_visible_x
-= it
->truncation_pixel_width
;
3006 it
->last_visible_x
-= it
->continuation_pixel_width
;
3009 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3010 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3013 /* Leave room for a border glyph. */
3014 if (!FRAME_WINDOW_P (it
->f
)
3015 && !WINDOW_RIGHTMOST_P (it
->w
))
3016 it
->last_visible_x
-= 1;
3018 it
->last_visible_y
= window_text_bottom_y (w
);
3020 /* For mode lines and alike, arrange for the first glyph having a
3021 left box line if the face specifies a box. */
3022 if (base_face_id
!= DEFAULT_FACE_ID
)
3026 it
->face_id
= remapped_base_face_id
;
3028 /* If we have a boxed mode line, make the first character appear
3029 with a left box line. */
3030 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3031 if (face
&& face
->box
!= FACE_NO_BOX
)
3032 it
->start_of_box_run_p
= true;
3035 /* If a buffer position was specified, set the iterator there,
3036 getting overlays and face properties from that position. */
3037 if (charpos
>= BUF_BEG (current_buffer
))
3039 it
->stop_charpos
= charpos
;
3040 it
->end_charpos
= ZV
;
3041 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3042 IT_CHARPOS (*it
) = charpos
;
3043 IT_BYTEPOS (*it
) = bytepos
;
3045 /* We will rely on `reseat' to set this up properly, via
3046 handle_face_prop. */
3047 it
->face_id
= it
->base_face_id
;
3049 it
->start
= it
->current
;
3050 /* Do we need to reorder bidirectional text? Not if this is a
3051 unibyte buffer: by definition, none of the single-byte
3052 characters are strong R2L, so no reordering is needed. And
3053 bidi.c doesn't support unibyte buffers anyway. Also, don't
3054 reorder while we are loading loadup.el, since the tables of
3055 character properties needed for reordering are not yet
3059 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3062 /* If we are to reorder bidirectional text, init the bidi
3066 /* Note the paragraph direction that this buffer wants to
3068 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3070 it
->paragraph_embedding
= L2R
;
3071 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3073 it
->paragraph_embedding
= R2L
;
3075 it
->paragraph_embedding
= NEUTRAL_DIR
;
3076 bidi_unshelve_cache (NULL
, 0);
3077 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3081 /* Compute faces etc. */
3082 reseat (it
, it
->current
.pos
, 1);
3089 /* Initialize IT for the display of window W with window start POS. */
3092 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3094 struct glyph_row
*row
;
3095 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3097 row
= w
->desired_matrix
->rows
+ first_vpos
;
3098 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3099 it
->first_vpos
= first_vpos
;
3101 /* Don't reseat to previous visible line start if current start
3102 position is in a string or image. */
3103 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3105 int start_at_line_beg_p
;
3106 int first_y
= it
->current_y
;
3108 /* If window start is not at a line start, skip forward to POS to
3109 get the correct continuation lines width. */
3110 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3111 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3112 if (!start_at_line_beg_p
)
3116 reseat_at_previous_visible_line_start (it
);
3117 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3119 new_x
= it
->current_x
+ it
->pixel_width
;
3121 /* If lines are continued, this line may end in the middle
3122 of a multi-glyph character (e.g. a control character
3123 displayed as \003, or in the middle of an overlay
3124 string). In this case move_it_to above will not have
3125 taken us to the start of the continuation line but to the
3126 end of the continued line. */
3127 if (it
->current_x
> 0
3128 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3129 && (/* And glyph doesn't fit on the line. */
3130 new_x
> it
->last_visible_x
3131 /* Or it fits exactly and we're on a window
3133 || (new_x
== it
->last_visible_x
3134 && FRAME_WINDOW_P (it
->f
)
3135 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3136 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3137 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3139 if ((it
->current
.dpvec_index
>= 0
3140 || it
->current
.overlay_string_index
>= 0)
3141 /* If we are on a newline from a display vector or
3142 overlay string, then we are already at the end of
3143 a screen line; no need to go to the next line in
3144 that case, as this line is not really continued.
3145 (If we do go to the next line, C-e will not DTRT.) */
3148 set_iterator_to_next (it
, 1);
3149 move_it_in_display_line_to (it
, -1, -1, 0);
3152 it
->continuation_lines_width
+= it
->current_x
;
3154 /* If the character at POS is displayed via a display
3155 vector, move_it_to above stops at the final glyph of
3156 IT->dpvec. To make the caller redisplay that character
3157 again (a.k.a. start at POS), we need to reset the
3158 dpvec_index to the beginning of IT->dpvec. */
3159 else if (it
->current
.dpvec_index
>= 0)
3160 it
->current
.dpvec_index
= 0;
3162 /* We're starting a new display line, not affected by the
3163 height of the continued line, so clear the appropriate
3164 fields in the iterator structure. */
3165 it
->max_ascent
= it
->max_descent
= 0;
3166 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3168 it
->current_y
= first_y
;
3170 it
->current_x
= it
->hpos
= 0;
3176 /* Return 1 if POS is a position in ellipses displayed for invisible
3177 text. W is the window we display, for text property lookup. */
3180 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3182 Lisp_Object prop
, window
;
3184 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3186 /* If POS specifies a position in a display vector, this might
3187 be for an ellipsis displayed for invisible text. We won't
3188 get the iterator set up for delivering that ellipsis unless
3189 we make sure that it gets aware of the invisible text. */
3190 if (pos
->dpvec_index
>= 0
3191 && pos
->overlay_string_index
< 0
3192 && CHARPOS (pos
->string_pos
) < 0
3194 && (XSETWINDOW (window
, w
),
3195 prop
= Fget_char_property (make_number (charpos
),
3196 Qinvisible
, window
),
3197 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3199 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3201 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3208 /* Initialize IT for stepping through current_buffer in window W,
3209 starting at position POS that includes overlay string and display
3210 vector/ control character translation position information. Value
3211 is zero if there are overlay strings with newlines at POS. */
3214 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3216 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3217 int i
, overlay_strings_with_newlines
= 0;
3219 /* If POS specifies a position in a display vector, this might
3220 be for an ellipsis displayed for invisible text. We won't
3221 get the iterator set up for delivering that ellipsis unless
3222 we make sure that it gets aware of the invisible text. */
3223 if (in_ellipses_for_invisible_text_p (pos
, w
))
3229 /* Keep in mind: the call to reseat in init_iterator skips invisible
3230 text, so we might end up at a position different from POS. This
3231 is only a problem when POS is a row start after a newline and an
3232 overlay starts there with an after-string, and the overlay has an
3233 invisible property. Since we don't skip invisible text in
3234 display_line and elsewhere immediately after consuming the
3235 newline before the row start, such a POS will not be in a string,
3236 but the call to init_iterator below will move us to the
3238 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3240 /* This only scans the current chunk -- it should scan all chunks.
3241 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3242 to 16 in 22.1 to make this a lesser problem. */
3243 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3245 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3246 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3248 while (s
< e
&& *s
!= '\n')
3253 overlay_strings_with_newlines
= 1;
3258 /* If position is within an overlay string, set up IT to the right
3260 if (pos
->overlay_string_index
>= 0)
3264 /* If the first overlay string happens to have a `display'
3265 property for an image, the iterator will be set up for that
3266 image, and we have to undo that setup first before we can
3267 correct the overlay string index. */
3268 if (it
->method
== GET_FROM_IMAGE
)
3271 /* We already have the first chunk of overlay strings in
3272 IT->overlay_strings. Load more until the one for
3273 pos->overlay_string_index is in IT->overlay_strings. */
3274 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3276 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3277 it
->current
.overlay_string_index
= 0;
3280 load_overlay_strings (it
, 0);
3281 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3285 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3286 relative_index
= (it
->current
.overlay_string_index
3287 % OVERLAY_STRING_CHUNK_SIZE
);
3288 it
->string
= it
->overlay_strings
[relative_index
];
3289 eassert (STRINGP (it
->string
));
3290 it
->current
.string_pos
= pos
->string_pos
;
3291 it
->method
= GET_FROM_STRING
;
3292 it
->end_charpos
= SCHARS (it
->string
);
3293 /* Set up the bidi iterator for this overlay string. */
3296 it
->bidi_it
.string
.lstring
= it
->string
;
3297 it
->bidi_it
.string
.s
= NULL
;
3298 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3299 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3300 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3301 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3302 it
->bidi_it
.w
= it
->w
;
3303 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3304 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3306 /* Synchronize the state of the bidi iterator with
3307 pos->string_pos. For any string position other than
3308 zero, this will be done automagically when we resume
3309 iteration over the string and get_visually_first_element
3310 is called. But if string_pos is zero, and the string is
3311 to be reordered for display, we need to resync manually,
3312 since it could be that the iteration state recorded in
3313 pos ended at string_pos of 0 moving backwards in string. */
3314 if (CHARPOS (pos
->string_pos
) == 0)
3316 get_visually_first_element (it
);
3317 if (IT_STRING_CHARPOS (*it
) != 0)
3320 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3321 bidi_move_to_visually_next (&it
->bidi_it
);
3322 } while (it
->bidi_it
.charpos
!= 0);
3324 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3325 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3329 if (CHARPOS (pos
->string_pos
) >= 0)
3331 /* Recorded position is not in an overlay string, but in another
3332 string. This can only be a string from a `display' property.
3333 IT should already be filled with that string. */
3334 it
->current
.string_pos
= pos
->string_pos
;
3335 eassert (STRINGP (it
->string
));
3337 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3338 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3341 /* Restore position in display vector translations, control
3342 character translations or ellipses. */
3343 if (pos
->dpvec_index
>= 0)
3345 if (it
->dpvec
== NULL
)
3346 get_next_display_element (it
);
3347 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3348 it
->current
.dpvec_index
= pos
->dpvec_index
;
3352 return !overlay_strings_with_newlines
;
3356 /* Initialize IT for stepping through current_buffer in window W
3357 starting at ROW->start. */
3360 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3362 init_from_display_pos (it
, w
, &row
->start
);
3363 it
->start
= row
->start
;
3364 it
->continuation_lines_width
= row
->continuation_lines_width
;
3369 /* Initialize IT for stepping through current_buffer in window W
3370 starting in the line following ROW, i.e. starting at ROW->end.
3371 Value is zero if there are overlay strings with newlines at ROW's
3375 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3379 if (init_from_display_pos (it
, w
, &row
->end
))
3381 if (row
->continued_p
)
3382 it
->continuation_lines_width
3383 = row
->continuation_lines_width
+ row
->pixel_width
;
3394 /***********************************************************************
3396 ***********************************************************************/
3398 /* Called when IT reaches IT->stop_charpos. Handle text property and
3399 overlay changes. Set IT->stop_charpos to the next position where
3403 handle_stop (struct it
*it
)
3405 enum prop_handled handled
;
3406 int handle_overlay_change_p
;
3410 it
->current
.dpvec_index
= -1;
3411 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3412 it
->ignore_overlay_strings_at_pos_p
= 0;
3415 /* Use face of preceding text for ellipsis (if invisible) */
3416 if (it
->selective_display_ellipsis_p
)
3417 it
->saved_face_id
= it
->face_id
;
3419 /* Here's the description of the semantics of, and the logic behind,
3420 the various HANDLED_* statuses:
3422 HANDLED_NORMALLY means the handler did its job, and the loop
3423 should proceed to calling the next handler in order.
3425 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3426 change in the properties and overlays at current position, so the
3427 loop should be restarted, to re-invoke the handlers that were
3428 already called. This happens when fontification-functions were
3429 called by handle_fontified_prop, and actually fontified
3430 something. Another case where HANDLED_RECOMPUTE_PROPS is
3431 returned is when we discover overlay strings that need to be
3432 displayed right away. The loop below will continue for as long
3433 as the status is HANDLED_RECOMPUTE_PROPS.
3435 HANDLED_RETURN means return immediately to the caller, to
3436 continue iteration without calling any further handlers. This is
3437 used when we need to act on some property right away, for example
3438 when we need to display the ellipsis or a replacing display
3439 property, such as display string or image.
3441 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3442 consumed, and the handler switched to the next overlay string.
3443 This signals the loop below to refrain from looking for more
3444 overlays before all the overlay strings of the current overlay
3447 Some of the handlers called by the loop push the iterator state
3448 onto the stack (see 'push_it'), and arrange for the iteration to
3449 continue with another object, such as an image, a display string,
3450 or an overlay string. In most such cases, it->stop_charpos is
3451 set to the first character of the string, so that when the
3452 iteration resumes, this function will immediately be called
3453 again, to examine the properties at the beginning of the string.
3455 When a display or overlay string is exhausted, the iterator state
3456 is popped (see 'pop_it'), and iteration continues with the
3457 previous object. Again, in many such cases this function is
3458 called again to find the next position where properties might
3463 handled
= HANDLED_NORMALLY
;
3465 /* Call text property handlers. */
3466 for (p
= it_props
; p
->handler
; ++p
)
3468 handled
= p
->handler (it
);
3470 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3472 else if (handled
== HANDLED_RETURN
)
3474 /* We still want to show before and after strings from
3475 overlays even if the actual buffer text is replaced. */
3476 if (!handle_overlay_change_p
3478 /* Don't call get_overlay_strings_1 if we already
3479 have overlay strings loaded, because doing so
3480 will load them again and push the iterator state
3481 onto the stack one more time, which is not
3482 expected by the rest of the code that processes
3484 || (it
->current
.overlay_string_index
< 0
3485 ? !get_overlay_strings_1 (it
, 0, 0)
3489 setup_for_ellipsis (it
, 0);
3490 /* When handling a display spec, we might load an
3491 empty string. In that case, discard it here. We
3492 used to discard it in handle_single_display_spec,
3493 but that causes get_overlay_strings_1, above, to
3494 ignore overlay strings that we must check. */
3495 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3499 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3503 it
->ignore_overlay_strings_at_pos_p
= true;
3504 it
->string_from_display_prop_p
= 0;
3505 it
->from_disp_prop_p
= 0;
3506 handle_overlay_change_p
= 0;
3508 handled
= HANDLED_RECOMPUTE_PROPS
;
3511 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3512 handle_overlay_change_p
= 0;
3515 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3517 /* Don't check for overlay strings below when set to deliver
3518 characters from a display vector. */
3519 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3520 handle_overlay_change_p
= 0;
3522 /* Handle overlay changes.
3523 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3524 if it finds overlays. */
3525 if (handle_overlay_change_p
)
3526 handled
= handle_overlay_change (it
);
3531 setup_for_ellipsis (it
, 0);
3535 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3537 /* Determine where to stop next. */
3538 if (handled
== HANDLED_NORMALLY
)
3539 compute_stop_pos (it
);
3543 /* Compute IT->stop_charpos from text property and overlay change
3544 information for IT's current position. */
3547 compute_stop_pos (struct it
*it
)
3549 register INTERVAL iv
, next_iv
;
3550 Lisp_Object object
, limit
, position
;
3551 ptrdiff_t charpos
, bytepos
;
3553 if (STRINGP (it
->string
))
3555 /* Strings are usually short, so don't limit the search for
3557 it
->stop_charpos
= it
->end_charpos
;
3558 object
= it
->string
;
3560 charpos
= IT_STRING_CHARPOS (*it
);
3561 bytepos
= IT_STRING_BYTEPOS (*it
);
3567 /* If end_charpos is out of range for some reason, such as a
3568 misbehaving display function, rationalize it (Bug#5984). */
3569 if (it
->end_charpos
> ZV
)
3570 it
->end_charpos
= ZV
;
3571 it
->stop_charpos
= it
->end_charpos
;
3573 /* If next overlay change is in front of the current stop pos
3574 (which is IT->end_charpos), stop there. Note: value of
3575 next_overlay_change is point-max if no overlay change
3577 charpos
= IT_CHARPOS (*it
);
3578 bytepos
= IT_BYTEPOS (*it
);
3579 pos
= next_overlay_change (charpos
);
3580 if (pos
< it
->stop_charpos
)
3581 it
->stop_charpos
= pos
;
3583 /* Set up variables for computing the stop position from text
3584 property changes. */
3585 XSETBUFFER (object
, current_buffer
);
3586 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3589 /* Get the interval containing IT's position. Value is a null
3590 interval if there isn't such an interval. */
3591 position
= make_number (charpos
);
3592 iv
= validate_interval_range (object
, &position
, &position
, 0);
3595 Lisp_Object values_here
[LAST_PROP_IDX
];
3598 /* Get properties here. */
3599 for (p
= it_props
; p
->handler
; ++p
)
3600 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3602 /* Look for an interval following iv that has different
3604 for (next_iv
= next_interval (iv
);
3607 || XFASTINT (limit
) > next_iv
->position
));
3608 next_iv
= next_interval (next_iv
))
3610 for (p
= it_props
; p
->handler
; ++p
)
3612 Lisp_Object new_value
;
3614 new_value
= textget (next_iv
->plist
, *p
->name
);
3615 if (!EQ (values_here
[p
->idx
], new_value
))
3625 if (INTEGERP (limit
)
3626 && next_iv
->position
>= XFASTINT (limit
))
3627 /* No text property change up to limit. */
3628 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3630 /* Text properties change in next_iv. */
3631 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3635 if (it
->cmp_it
.id
< 0)
3637 ptrdiff_t stoppos
= it
->end_charpos
;
3639 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3641 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3642 stoppos
, it
->string
);
3645 eassert (STRINGP (it
->string
)
3646 || (it
->stop_charpos
>= BEGV
3647 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3651 /* Return the position of the next overlay change after POS in
3652 current_buffer. Value is point-max if no overlay change
3653 follows. This is like `next-overlay-change' but doesn't use
3657 next_overlay_change (ptrdiff_t pos
)
3659 ptrdiff_t i
, noverlays
;
3661 Lisp_Object
*overlays
;
3663 /* Get all overlays at the given position. */
3664 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3666 /* If any of these overlays ends before endpos,
3667 use its ending point instead. */
3668 for (i
= 0; i
< noverlays
; ++i
)
3673 oend
= OVERLAY_END (overlays
[i
]);
3674 oendpos
= OVERLAY_POSITION (oend
);
3675 endpos
= min (endpos
, oendpos
);
3681 /* How many characters forward to search for a display property or
3682 display string. Searching too far forward makes the bidi display
3683 sluggish, especially in small windows. */
3684 #define MAX_DISP_SCAN 250
3686 /* Return the character position of a display string at or after
3687 position specified by POSITION. If no display string exists at or
3688 after POSITION, return ZV. A display string is either an overlay
3689 with `display' property whose value is a string, or a `display'
3690 text property whose value is a string. STRING is data about the
3691 string to iterate; if STRING->lstring is nil, we are iterating a
3692 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3693 on a GUI frame. DISP_PROP is set to zero if we searched
3694 MAX_DISP_SCAN characters forward without finding any display
3695 strings, non-zero otherwise. It is set to 2 if the display string
3696 uses any kind of `(space ...)' spec that will produce a stretch of
3697 white space in the text area. */
3699 compute_display_string_pos (struct text_pos
*position
,
3700 struct bidi_string_data
*string
,
3702 int frame_window_p
, int *disp_prop
)
3704 /* OBJECT = nil means current buffer. */
3705 Lisp_Object object
, object1
;
3706 Lisp_Object pos
, spec
, limpos
;
3707 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3708 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3709 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3710 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3712 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3713 struct text_pos tpos
;
3716 if (string
&& STRINGP (string
->lstring
))
3717 object1
= object
= string
->lstring
;
3718 else if (w
&& !string_p
)
3720 XSETWINDOW (object
, w
);
3724 object1
= object
= Qnil
;
3729 /* We don't support display properties whose values are strings
3730 that have display string properties. */
3731 || string
->from_disp_str
3732 /* C strings cannot have display properties. */
3733 || (string
->s
&& !STRINGP (object
)))
3739 /* If the character at CHARPOS is where the display string begins,
3741 pos
= make_number (charpos
);
3742 if (STRINGP (object
))
3743 bufpos
= string
->bufpos
;
3747 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3749 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3752 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3760 /* Look forward for the first character with a `display' property
3761 that will replace the underlying text when displayed. */
3762 limpos
= make_number (lim
);
3764 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3765 CHARPOS (tpos
) = XFASTINT (pos
);
3766 if (CHARPOS (tpos
) >= lim
)
3771 if (STRINGP (object
))
3772 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3774 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3775 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3776 if (!STRINGP (object
))
3777 bufpos
= CHARPOS (tpos
);
3778 } while (NILP (spec
)
3779 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3780 bufpos
, frame_window_p
)));
3784 return CHARPOS (tpos
);
3787 /* Return the character position of the end of the display string that
3788 started at CHARPOS. If there's no display string at CHARPOS,
3789 return -1. A display string is either an overlay with `display'
3790 property whose value is a string or a `display' text property whose
3791 value is a string. */
3793 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3795 /* OBJECT = nil means current buffer. */
3796 Lisp_Object object
=
3797 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3798 Lisp_Object pos
= make_number (charpos
);
3800 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3802 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3805 /* It could happen that the display property or overlay was removed
3806 since we found it in compute_display_string_pos above. One way
3807 this can happen is if JIT font-lock was called (through
3808 handle_fontified_prop), and jit-lock-functions remove text
3809 properties or overlays from the portion of buffer that includes
3810 CHARPOS. Muse mode is known to do that, for example. In this
3811 case, we return -1 to the caller, to signal that no display
3812 string is actually present at CHARPOS. See bidi_fetch_char for
3813 how this is handled.
3815 An alternative would be to never look for display properties past
3816 it->stop_charpos. But neither compute_display_string_pos nor
3817 bidi_fetch_char that calls it know or care where the next
3819 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3822 /* Look forward for the first character where the `display' property
3824 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3826 return XFASTINT (pos
);
3831 /***********************************************************************
3833 ***********************************************************************/
3835 /* Handle changes in the `fontified' property of the current buffer by
3836 calling hook functions from Qfontification_functions to fontify
3839 static enum prop_handled
3840 handle_fontified_prop (struct it
*it
)
3842 Lisp_Object prop
, pos
;
3843 enum prop_handled handled
= HANDLED_NORMALLY
;
3845 if (!NILP (Vmemory_full
))
3848 /* Get the value of the `fontified' property at IT's current buffer
3849 position. (The `fontified' property doesn't have a special
3850 meaning in strings.) If the value is nil, call functions from
3851 Qfontification_functions. */
3852 if (!STRINGP (it
->string
)
3854 && !NILP (Vfontification_functions
)
3855 && !NILP (Vrun_hooks
)
3856 && (pos
= make_number (IT_CHARPOS (*it
)),
3857 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3858 /* Ignore the special cased nil value always present at EOB since
3859 no amount of fontifying will be able to change it. */
3860 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3862 ptrdiff_t count
= SPECPDL_INDEX ();
3864 struct buffer
*obuf
= current_buffer
;
3865 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3866 bool old_clip_changed
= current_buffer
->clip_changed
;
3868 val
= Vfontification_functions
;
3869 specbind (Qfontification_functions
, Qnil
);
3871 eassert (it
->end_charpos
== ZV
);
3873 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3874 safe_call1 (val
, pos
);
3877 Lisp_Object fns
, fn
;
3878 struct gcpro gcpro1
, gcpro2
;
3883 for (; CONSP (val
); val
= XCDR (val
))
3889 /* A value of t indicates this hook has a local
3890 binding; it means to run the global binding too.
3891 In a global value, t should not occur. If it
3892 does, we must ignore it to avoid an endless
3894 for (fns
= Fdefault_value (Qfontification_functions
);
3900 safe_call1 (fn
, pos
);
3904 safe_call1 (fn
, pos
);
3910 unbind_to (count
, Qnil
);
3912 /* Fontification functions routinely call `save-restriction'.
3913 Normally, this tags clip_changed, which can confuse redisplay
3914 (see discussion in Bug#6671). Since we don't perform any
3915 special handling of fontification changes in the case where
3916 `save-restriction' isn't called, there's no point doing so in
3917 this case either. So, if the buffer's restrictions are
3918 actually left unchanged, reset clip_changed. */
3919 if (obuf
== current_buffer
)
3921 if (begv
== BEGV
&& zv
== ZV
)
3922 current_buffer
->clip_changed
= old_clip_changed
;
3924 /* There isn't much we can reasonably do to protect against
3925 misbehaving fontification, but here's a fig leaf. */
3926 else if (BUFFER_LIVE_P (obuf
))
3927 set_buffer_internal_1 (obuf
);
3929 /* The fontification code may have added/removed text.
3930 It could do even a lot worse, but let's at least protect against
3931 the most obvious case where only the text past `pos' gets changed',
3932 as is/was done in grep.el where some escapes sequences are turned
3933 into face properties (bug#7876). */
3934 it
->end_charpos
= ZV
;
3936 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3937 something. This avoids an endless loop if they failed to
3938 fontify the text for which reason ever. */
3939 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3940 handled
= HANDLED_RECOMPUTE_PROPS
;
3948 /***********************************************************************
3950 ***********************************************************************/
3952 /* Set up iterator IT from face properties at its current position.
3953 Called from handle_stop. */
3955 static enum prop_handled
3956 handle_face_prop (struct it
*it
)
3959 ptrdiff_t next_stop
;
3961 if (!STRINGP (it
->string
))
3964 = face_at_buffer_position (it
->w
,
3968 + TEXT_PROP_DISTANCE_LIMIT
),
3969 0, it
->base_face_id
);
3971 /* Is this a start of a run of characters with box face?
3972 Caveat: this can be called for a freshly initialized
3973 iterator; face_id is -1 in this case. We know that the new
3974 face will not change until limit, i.e. if the new face has a
3975 box, all characters up to limit will have one. But, as
3976 usual, we don't know whether limit is really the end. */
3977 if (new_face_id
!= it
->face_id
)
3979 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3980 /* If it->face_id is -1, old_face below will be NULL, see
3981 the definition of FACE_FROM_ID. This will happen if this
3982 is the initial call that gets the face. */
3983 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3985 /* If the value of face_id of the iterator is -1, we have to
3986 look in front of IT's position and see whether there is a
3987 face there that's different from new_face_id. */
3988 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3990 int prev_face_id
= face_before_it_pos (it
);
3992 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3995 /* If the new face has a box, but the old face does not,
3996 this is the start of a run of characters with box face,
3997 i.e. this character has a shadow on the left side. */
3998 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3999 && (old_face
== NULL
|| !old_face
->box
));
4000 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4008 Lisp_Object from_overlay
4009 = (it
->current
.overlay_string_index
>= 0
4010 ? it
->string_overlays
[it
->current
.overlay_string_index
4011 % OVERLAY_STRING_CHUNK_SIZE
]
4014 /* See if we got to this string directly or indirectly from
4015 an overlay property. That includes the before-string or
4016 after-string of an overlay, strings in display properties
4017 provided by an overlay, their text properties, etc.
4019 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4020 if (! NILP (from_overlay
))
4021 for (i
= it
->sp
- 1; i
>= 0; i
--)
4023 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4025 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4026 % OVERLAY_STRING_CHUNK_SIZE
];
4027 else if (! NILP (it
->stack
[i
].from_overlay
))
4028 from_overlay
= it
->stack
[i
].from_overlay
;
4030 if (!NILP (from_overlay
))
4034 if (! NILP (from_overlay
))
4036 bufpos
= IT_CHARPOS (*it
);
4037 /* For a string from an overlay, the base face depends
4038 only on text properties and ignores overlays. */
4040 = face_for_overlay_string (it
->w
,
4044 + TEXT_PROP_DISTANCE_LIMIT
),
4052 /* For strings from a `display' property, use the face at
4053 IT's current buffer position as the base face to merge
4054 with, so that overlay strings appear in the same face as
4055 surrounding text, unless they specify their own faces.
4056 For strings from wrap-prefix and line-prefix properties,
4057 use the default face, possibly remapped via
4058 Vface_remapping_alist. */
4059 /* Note that the fact that we use the face at _buffer_
4060 position means that a 'display' property on an overlay
4061 string will not inherit the face of that overlay string,
4062 but will instead revert to the face of buffer text
4063 covered by the overlay. This is visible, e.g., when the
4064 overlay specifies a box face, but neither the buffer nor
4065 the display string do. This sounds like a design bug,
4066 but Emacs always did that since v21.1, so changing that
4067 might be a big deal. */
4068 base_face_id
= it
->string_from_prefix_prop_p
4069 ? (!NILP (Vface_remapping_alist
)
4070 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4072 : underlying_face_id (it
);
4075 new_face_id
= face_at_string_position (it
->w
,
4077 IT_STRING_CHARPOS (*it
),
4082 /* Is this a start of a run of characters with box? Caveat:
4083 this can be called for a freshly allocated iterator; face_id
4084 is -1 is this case. We know that the new face will not
4085 change until the next check pos, i.e. if the new face has a
4086 box, all characters up to that position will have a
4087 box. But, as usual, we don't know whether that position
4088 is really the end. */
4089 if (new_face_id
!= it
->face_id
)
4091 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4092 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4094 /* If new face has a box but old face hasn't, this is the
4095 start of a run of characters with box, i.e. it has a
4096 shadow on the left side. */
4097 it
->start_of_box_run_p
4098 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4099 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4103 it
->face_id
= new_face_id
;
4104 return HANDLED_NORMALLY
;
4108 /* Return the ID of the face ``underlying'' IT's current position,
4109 which is in a string. If the iterator is associated with a
4110 buffer, return the face at IT's current buffer position.
4111 Otherwise, use the iterator's base_face_id. */
4114 underlying_face_id (struct it
*it
)
4116 int face_id
= it
->base_face_id
, i
;
4118 eassert (STRINGP (it
->string
));
4120 for (i
= it
->sp
- 1; i
>= 0; --i
)
4121 if (NILP (it
->stack
[i
].string
))
4122 face_id
= it
->stack
[i
].face_id
;
4128 /* Compute the face one character before or after the current position
4129 of IT, in the visual order. BEFORE_P non-zero means get the face
4130 in front (to the left in L2R paragraphs, to the right in R2L
4131 paragraphs) of IT's screen position. Value is the ID of the face. */
4134 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4137 ptrdiff_t next_check_charpos
;
4139 void *it_copy_data
= NULL
;
4141 eassert (it
->s
== NULL
);
4143 if (STRINGP (it
->string
))
4145 ptrdiff_t bufpos
, charpos
;
4148 /* No face change past the end of the string (for the case
4149 we are padding with spaces). No face change before the
4151 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4152 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4157 /* Set charpos to the position before or after IT's current
4158 position, in the logical order, which in the non-bidi
4159 case is the same as the visual order. */
4161 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4162 else if (it
->what
== IT_COMPOSITION
)
4163 /* For composition, we must check the character after the
4165 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4167 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4173 /* With bidi iteration, the character before the current
4174 in the visual order cannot be found by simple
4175 iteration, because "reverse" reordering is not
4176 supported. Instead, we need to use the move_it_*
4177 family of functions. */
4178 /* Ignore face changes before the first visible
4179 character on this display line. */
4180 if (it
->current_x
<= it
->first_visible_x
)
4182 SAVE_IT (it_copy
, *it
, it_copy_data
);
4183 /* Implementation note: Since move_it_in_display_line
4184 works in the iterator geometry, and thinks the first
4185 character is always the leftmost, even in R2L lines,
4186 we don't need to distinguish between the R2L and L2R
4188 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4189 it_copy
.current_x
- 1, MOVE_TO_X
);
4190 charpos
= IT_STRING_CHARPOS (it_copy
);
4191 RESTORE_IT (it
, it
, it_copy_data
);
4195 /* Set charpos to the string position of the character
4196 that comes after IT's current position in the visual
4198 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4202 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4204 charpos
= it_copy
.bidi_it
.charpos
;
4207 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4209 if (it
->current
.overlay_string_index
>= 0)
4210 bufpos
= IT_CHARPOS (*it
);
4214 base_face_id
= underlying_face_id (it
);
4216 /* Get the face for ASCII, or unibyte. */
4217 face_id
= face_at_string_position (it
->w
,
4221 &next_check_charpos
,
4224 /* Correct the face for charsets different from ASCII. Do it
4225 for the multibyte case only. The face returned above is
4226 suitable for unibyte text if IT->string is unibyte. */
4227 if (STRING_MULTIBYTE (it
->string
))
4229 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4230 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4232 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4234 c
= string_char_and_length (p
, &len
);
4235 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4240 struct text_pos pos
;
4242 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4243 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4246 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4247 pos
= it
->current
.pos
;
4252 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4255 if (it
->what
== IT_COMPOSITION
)
4257 /* For composition, we must check the position after
4259 pos
.charpos
+= it
->cmp_it
.nchars
;
4260 pos
.bytepos
+= it
->len
;
4263 INC_TEXT_POS (pos
, it
->multibyte_p
);
4270 /* With bidi iteration, the character before the current
4271 in the visual order cannot be found by simple
4272 iteration, because "reverse" reordering is not
4273 supported. Instead, we need to use the move_it_*
4274 family of functions. */
4275 /* Ignore face changes before the first visible
4276 character on this display line. */
4277 if (it
->current_x
<= it
->first_visible_x
)
4279 SAVE_IT (it_copy
, *it
, it_copy_data
);
4280 /* Implementation note: Since move_it_in_display_line
4281 works in the iterator geometry, and thinks the first
4282 character is always the leftmost, even in R2L lines,
4283 we don't need to distinguish between the R2L and L2R
4285 move_it_in_display_line (&it_copy
, ZV
,
4286 it_copy
.current_x
- 1, MOVE_TO_X
);
4287 pos
= it_copy
.current
.pos
;
4288 RESTORE_IT (it
, it
, it_copy_data
);
4292 /* Set charpos to the buffer position of the character
4293 that comes after IT's current position in the visual
4295 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4299 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4302 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4305 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4307 /* Determine face for CHARSET_ASCII, or unibyte. */
4308 face_id
= face_at_buffer_position (it
->w
,
4310 &next_check_charpos
,
4313 /* Correct the face for charsets different from ASCII. Do it
4314 for the multibyte case only. The face returned above is
4315 suitable for unibyte text if current_buffer is unibyte. */
4316 if (it
->multibyte_p
)
4318 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4319 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4320 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4329 /***********************************************************************
4331 ***********************************************************************/
4333 /* Set up iterator IT from invisible properties at its current
4334 position. Called from handle_stop. */
4336 static enum prop_handled
4337 handle_invisible_prop (struct it
*it
)
4339 enum prop_handled handled
= HANDLED_NORMALLY
;
4343 if (STRINGP (it
->string
))
4345 Lisp_Object end_charpos
, limit
, charpos
;
4347 /* Get the value of the invisible text property at the
4348 current position. Value will be nil if there is no such
4350 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4351 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4352 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4354 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4356 /* Record whether we have to display an ellipsis for the
4358 int display_ellipsis_p
= (invis_p
== 2);
4359 ptrdiff_t len
, endpos
;
4361 handled
= HANDLED_RECOMPUTE_PROPS
;
4363 /* Get the position at which the next visible text can be
4364 found in IT->string, if any. */
4365 endpos
= len
= SCHARS (it
->string
);
4366 XSETINT (limit
, len
);
4369 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4371 if (INTEGERP (end_charpos
))
4373 endpos
= XFASTINT (end_charpos
);
4374 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4375 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4377 display_ellipsis_p
= true;
4380 while (invis_p
&& endpos
< len
);
4382 if (display_ellipsis_p
)
4383 it
->ellipsis_p
= true;
4387 /* Text at END_CHARPOS is visible. Move IT there. */
4388 struct text_pos old
;
4391 old
= it
->current
.string_pos
;
4392 oldpos
= CHARPOS (old
);
4395 if (it
->bidi_it
.first_elt
4396 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4397 bidi_paragraph_init (it
->paragraph_embedding
,
4399 /* Bidi-iterate out of the invisible text. */
4402 bidi_move_to_visually_next (&it
->bidi_it
);
4404 while (oldpos
<= it
->bidi_it
.charpos
4405 && it
->bidi_it
.charpos
< endpos
);
4407 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4408 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4409 if (IT_CHARPOS (*it
) >= endpos
)
4410 it
->prev_stop
= endpos
;
4414 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4415 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4420 /* The rest of the string is invisible. If this is an
4421 overlay string, proceed with the next overlay string
4422 or whatever comes and return a character from there. */
4423 if (it
->current
.overlay_string_index
>= 0
4424 && !display_ellipsis_p
)
4426 next_overlay_string (it
);
4427 /* Don't check for overlay strings when we just
4428 finished processing them. */
4429 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4433 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4434 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4441 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4442 Lisp_Object pos
, overlay
;
4444 /* First of all, is there invisible text at this position? */
4445 tem
= start_charpos
= IT_CHARPOS (*it
);
4446 pos
= make_number (tem
);
4447 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4449 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4451 /* If we are on invisible text, skip over it. */
4452 if (invis_p
&& start_charpos
< it
->end_charpos
)
4454 /* Record whether we have to display an ellipsis for the
4456 int display_ellipsis_p
= invis_p
== 2;
4458 handled
= HANDLED_RECOMPUTE_PROPS
;
4460 /* Loop skipping over invisible text. The loop is left at
4461 ZV or with IT on the first char being visible again. */
4464 /* Try to skip some invisible text. Return value is the
4465 position reached which can be equal to where we start
4466 if there is nothing invisible there. This skips both
4467 over invisible text properties and overlays with
4468 invisible property. */
4469 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4471 /* If we skipped nothing at all we weren't at invisible
4472 text in the first place. If everything to the end of
4473 the buffer was skipped, end the loop. */
4474 if (newpos
== tem
|| newpos
>= ZV
)
4478 /* We skipped some characters but not necessarily
4479 all there are. Check if we ended up on visible
4480 text. Fget_char_property returns the property of
4481 the char before the given position, i.e. if we
4482 get invis_p = 0, this means that the char at
4483 newpos is visible. */
4484 pos
= make_number (newpos
);
4485 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4486 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4489 /* If we ended up on invisible text, proceed to
4490 skip starting with next_stop. */
4494 /* If there are adjacent invisible texts, don't lose the
4495 second one's ellipsis. */
4497 display_ellipsis_p
= true;
4501 /* The position newpos is now either ZV or on visible text. */
4504 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4506 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4508 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4510 /* If the invisible text ends on a newline or on a
4511 character after a newline, we can avoid the costly,
4512 character by character, bidi iteration to NEWPOS, and
4513 instead simply reseat the iterator there. That's
4514 because all bidi reordering information is tossed at
4515 the newline. This is a big win for modes that hide
4516 complete lines, like Outline, Org, etc. */
4517 if (on_newline
|| after_newline
)
4519 struct text_pos tpos
;
4520 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4522 SET_TEXT_POS (tpos
, newpos
, bpos
);
4523 reseat_1 (it
, tpos
, 0);
4524 /* If we reseat on a newline/ZV, we need to prep the
4525 bidi iterator for advancing to the next character
4526 after the newline/EOB, keeping the current paragraph
4527 direction (so that PRODUCE_GLYPHS does TRT wrt
4528 prepending/appending glyphs to a glyph row). */
4531 it
->bidi_it
.first_elt
= 0;
4532 it
->bidi_it
.paragraph_dir
= pdir
;
4533 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4534 it
->bidi_it
.nchars
= 1;
4535 it
->bidi_it
.ch_len
= 1;
4538 else /* Must use the slow method. */
4540 /* With bidi iteration, the region of invisible text
4541 could start and/or end in the middle of a
4542 non-base embedding level. Therefore, we need to
4543 skip invisible text using the bidi iterator,
4544 starting at IT's current position, until we find
4545 ourselves outside of the invisible text.
4546 Skipping invisible text _after_ bidi iteration
4547 avoids affecting the visual order of the
4548 displayed text when invisible properties are
4549 added or removed. */
4550 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4552 /* If we were `reseat'ed to a new paragraph,
4553 determine the paragraph base direction. We
4554 need to do it now because
4555 next_element_from_buffer may not have a
4556 chance to do it, if we are going to skip any
4557 text at the beginning, which resets the
4559 bidi_paragraph_init (it
->paragraph_embedding
,
4564 bidi_move_to_visually_next (&it
->bidi_it
);
4566 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4567 && it
->bidi_it
.charpos
< newpos
);
4568 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4569 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4570 /* If we overstepped NEWPOS, record its position in
4571 the iterator, so that we skip invisible text if
4572 later the bidi iteration lands us in the
4573 invisible region again. */
4574 if (IT_CHARPOS (*it
) >= newpos
)
4575 it
->prev_stop
= newpos
;
4580 IT_CHARPOS (*it
) = newpos
;
4581 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4584 /* If there are before-strings at the start of invisible
4585 text, and the text is invisible because of a text
4586 property, arrange to show before-strings because 20.x did
4587 it that way. (If the text is invisible because of an
4588 overlay property instead of a text property, this is
4589 already handled in the overlay code.) */
4591 && get_overlay_strings (it
, it
->stop_charpos
))
4593 handled
= HANDLED_RECOMPUTE_PROPS
;
4596 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4597 /* The call to get_overlay_strings above recomputes
4598 it->stop_charpos, but it only considers changes
4599 in properties and overlays beyond iterator's
4600 current position. This causes us to miss changes
4601 that happen exactly where the invisible property
4602 ended. So we play it safe here and force the
4603 iterator to check for potential stop positions
4604 immediately after the invisible text. Note that
4605 if get_overlay_strings returns non-zero, it
4606 normally also pushed the iterator stack, so we
4607 need to update the stop position in the slot
4608 below the current one. */
4609 it
->stack
[it
->sp
- 1].stop_charpos
4610 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4613 else if (display_ellipsis_p
)
4615 /* Make sure that the glyphs of the ellipsis will get
4616 correct `charpos' values. If we would not update
4617 it->position here, the glyphs would belong to the
4618 last visible character _before_ the invisible
4619 text, which confuses `set_cursor_from_row'.
4621 We use the last invisible position instead of the
4622 first because this way the cursor is always drawn on
4623 the first "." of the ellipsis, whenever PT is inside
4624 the invisible text. Otherwise the cursor would be
4625 placed _after_ the ellipsis when the point is after the
4626 first invisible character. */
4627 if (!STRINGP (it
->object
))
4629 it
->position
.charpos
= newpos
- 1;
4630 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4632 it
->ellipsis_p
= true;
4633 /* Let the ellipsis display before
4634 considering any properties of the following char.
4635 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4636 handled
= HANDLED_RETURN
;
4645 /* Make iterator IT return `...' next.
4646 Replaces LEN characters from buffer. */
4649 setup_for_ellipsis (struct it
*it
, int len
)
4651 /* Use the display table definition for `...'. Invalid glyphs
4652 will be handled by the method returning elements from dpvec. */
4653 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4655 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4656 it
->dpvec
= v
->contents
;
4657 it
->dpend
= v
->contents
+ v
->header
.size
;
4661 /* Default `...'. */
4662 it
->dpvec
= default_invis_vector
;
4663 it
->dpend
= default_invis_vector
+ 3;
4666 it
->dpvec_char_len
= len
;
4667 it
->current
.dpvec_index
= 0;
4668 it
->dpvec_face_id
= -1;
4670 /* Remember the current face id in case glyphs specify faces.
4671 IT's face is restored in set_iterator_to_next.
4672 saved_face_id was set to preceding char's face in handle_stop. */
4673 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4674 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4676 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4677 it
->ellipsis_p
= true;
4682 /***********************************************************************
4684 ***********************************************************************/
4686 /* Set up iterator IT from `display' property at its current position.
4687 Called from handle_stop.
4688 We return HANDLED_RETURN if some part of the display property
4689 overrides the display of the buffer text itself.
4690 Otherwise we return HANDLED_NORMALLY. */
4692 static enum prop_handled
4693 handle_display_prop (struct it
*it
)
4695 Lisp_Object propval
, object
, overlay
;
4696 struct text_pos
*position
;
4698 /* Nonzero if some property replaces the display of the text itself. */
4699 int display_replaced_p
= 0;
4701 if (STRINGP (it
->string
))
4703 object
= it
->string
;
4704 position
= &it
->current
.string_pos
;
4705 bufpos
= CHARPOS (it
->current
.pos
);
4709 XSETWINDOW (object
, it
->w
);
4710 position
= &it
->current
.pos
;
4711 bufpos
= CHARPOS (*position
);
4714 /* Reset those iterator values set from display property values. */
4715 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4716 it
->space_width
= Qnil
;
4717 it
->font_height
= Qnil
;
4720 /* We don't support recursive `display' properties, i.e. string
4721 values that have a string `display' property, that have a string
4722 `display' property etc. */
4723 if (!it
->string_from_display_prop_p
)
4724 it
->area
= TEXT_AREA
;
4726 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4727 Qdisplay
, object
, &overlay
);
4729 return HANDLED_NORMALLY
;
4730 /* Now OVERLAY is the overlay that gave us this property, or nil
4731 if it was a text property. */
4733 if (!STRINGP (it
->string
))
4734 object
= it
->w
->contents
;
4736 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4738 FRAME_WINDOW_P (it
->f
));
4740 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4743 /* Subroutine of handle_display_prop. Returns non-zero if the display
4744 specification in SPEC is a replacing specification, i.e. it would
4745 replace the text covered by `display' property with something else,
4746 such as an image or a display string. If SPEC includes any kind or
4747 `(space ...) specification, the value is 2; this is used by
4748 compute_display_string_pos, which see.
4750 See handle_single_display_spec for documentation of arguments.
4751 frame_window_p is non-zero if the window being redisplayed is on a
4752 GUI frame; this argument is used only if IT is NULL, see below.
4754 IT can be NULL, if this is called by the bidi reordering code
4755 through compute_display_string_pos, which see. In that case, this
4756 function only examines SPEC, but does not otherwise "handle" it, in
4757 the sense that it doesn't set up members of IT from the display
4760 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4761 Lisp_Object overlay
, struct text_pos
*position
,
4762 ptrdiff_t bufpos
, int frame_window_p
)
4764 int replacing_p
= 0;
4768 /* Simple specifications. */
4769 && !EQ (XCAR (spec
), Qimage
)
4770 && !EQ (XCAR (spec
), Qspace
)
4771 && !EQ (XCAR (spec
), Qwhen
)
4772 && !EQ (XCAR (spec
), Qslice
)
4773 && !EQ (XCAR (spec
), Qspace_width
)
4774 && !EQ (XCAR (spec
), Qheight
)
4775 && !EQ (XCAR (spec
), Qraise
)
4776 /* Marginal area specifications. */
4777 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4778 && !EQ (XCAR (spec
), Qleft_fringe
)
4779 && !EQ (XCAR (spec
), Qright_fringe
)
4780 && !NILP (XCAR (spec
)))
4782 for (; CONSP (spec
); spec
= XCDR (spec
))
4784 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4785 overlay
, position
, bufpos
,
4786 replacing_p
, frame_window_p
)))
4789 /* If some text in a string is replaced, `position' no
4790 longer points to the position of `object'. */
4791 if (!it
|| STRINGP (object
))
4796 else if (VECTORP (spec
))
4799 for (i
= 0; i
< ASIZE (spec
); ++i
)
4800 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4801 overlay
, position
, bufpos
,
4802 replacing_p
, frame_window_p
)))
4805 /* If some text in a string is replaced, `position' no
4806 longer points to the position of `object'. */
4807 if (!it
|| STRINGP (object
))
4813 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4814 position
, bufpos
, 0,
4822 /* Value is the position of the end of the `display' property starting
4823 at START_POS in OBJECT. */
4825 static struct text_pos
4826 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4829 struct text_pos end_pos
;
4831 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4832 Qdisplay
, object
, Qnil
);
4833 CHARPOS (end_pos
) = XFASTINT (end
);
4834 if (STRINGP (object
))
4835 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4837 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4843 /* Set up IT from a single `display' property specification SPEC. OBJECT
4844 is the object in which the `display' property was found. *POSITION
4845 is the position in OBJECT at which the `display' property was found.
4846 BUFPOS is the buffer position of OBJECT (different from POSITION if
4847 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4848 previously saw a display specification which already replaced text
4849 display with something else, for example an image; we ignore such
4850 properties after the first one has been processed.
4852 OVERLAY is the overlay this `display' property came from,
4853 or nil if it was a text property.
4855 If SPEC is a `space' or `image' specification, and in some other
4856 cases too, set *POSITION to the position where the `display'
4859 If IT is NULL, only examine the property specification in SPEC, but
4860 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4861 is intended to be displayed in a window on a GUI frame.
4863 Value is non-zero if something was found which replaces the display
4864 of buffer or string text. */
4867 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4868 Lisp_Object overlay
, struct text_pos
*position
,
4869 ptrdiff_t bufpos
, int display_replaced_p
,
4873 Lisp_Object location
, value
;
4874 struct text_pos start_pos
= *position
;
4877 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4878 If the result is non-nil, use VALUE instead of SPEC. */
4880 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4889 if (!NILP (form
) && !EQ (form
, Qt
))
4891 ptrdiff_t count
= SPECPDL_INDEX ();
4892 struct gcpro gcpro1
;
4894 /* Bind `object' to the object having the `display' property, a
4895 buffer or string. Bind `position' to the position in the
4896 object where the property was found, and `buffer-position'
4897 to the current position in the buffer. */
4900 XSETBUFFER (object
, current_buffer
);
4901 specbind (Qobject
, object
);
4902 specbind (Qposition
, make_number (CHARPOS (*position
)));
4903 specbind (Qbuffer_position
, make_number (bufpos
));
4905 form
= safe_eval (form
);
4907 unbind_to (count
, Qnil
);
4913 /* Handle `(height HEIGHT)' specifications. */
4915 && EQ (XCAR (spec
), Qheight
)
4916 && CONSP (XCDR (spec
)))
4920 if (!FRAME_WINDOW_P (it
->f
))
4923 it
->font_height
= XCAR (XCDR (spec
));
4924 if (!NILP (it
->font_height
))
4926 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4927 int new_height
= -1;
4929 if (CONSP (it
->font_height
)
4930 && (EQ (XCAR (it
->font_height
), Qplus
)
4931 || EQ (XCAR (it
->font_height
), Qminus
))
4932 && CONSP (XCDR (it
->font_height
))
4933 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4935 /* `(+ N)' or `(- N)' where N is an integer. */
4936 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4937 if (EQ (XCAR (it
->font_height
), Qplus
))
4939 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4941 else if (FUNCTIONP (it
->font_height
))
4943 /* Call function with current height as argument.
4944 Value is the new height. */
4946 height
= safe_call1 (it
->font_height
,
4947 face
->lface
[LFACE_HEIGHT_INDEX
]);
4948 if (NUMBERP (height
))
4949 new_height
= XFLOATINT (height
);
4951 else if (NUMBERP (it
->font_height
))
4953 /* Value is a multiple of the canonical char height. */
4956 f
= FACE_FROM_ID (it
->f
,
4957 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4958 new_height
= (XFLOATINT (it
->font_height
)
4959 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4963 /* Evaluate IT->font_height with `height' bound to the
4964 current specified height to get the new height. */
4965 ptrdiff_t count
= SPECPDL_INDEX ();
4967 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4968 value
= safe_eval (it
->font_height
);
4969 unbind_to (count
, Qnil
);
4971 if (NUMBERP (value
))
4972 new_height
= XFLOATINT (value
);
4976 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4983 /* Handle `(space-width WIDTH)'. */
4985 && EQ (XCAR (spec
), Qspace_width
)
4986 && CONSP (XCDR (spec
)))
4990 if (!FRAME_WINDOW_P (it
->f
))
4993 value
= XCAR (XCDR (spec
));
4994 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4995 it
->space_width
= value
;
5001 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5003 && EQ (XCAR (spec
), Qslice
))
5009 if (!FRAME_WINDOW_P (it
->f
))
5012 if (tem
= XCDR (spec
), CONSP (tem
))
5014 it
->slice
.x
= XCAR (tem
);
5015 if (tem
= XCDR (tem
), CONSP (tem
))
5017 it
->slice
.y
= XCAR (tem
);
5018 if (tem
= XCDR (tem
), CONSP (tem
))
5020 it
->slice
.width
= XCAR (tem
);
5021 if (tem
= XCDR (tem
), CONSP (tem
))
5022 it
->slice
.height
= XCAR (tem
);
5031 /* Handle `(raise FACTOR)'. */
5033 && EQ (XCAR (spec
), Qraise
)
5034 && CONSP (XCDR (spec
)))
5038 if (!FRAME_WINDOW_P (it
->f
))
5041 #ifdef HAVE_WINDOW_SYSTEM
5042 value
= XCAR (XCDR (spec
));
5043 if (NUMBERP (value
))
5045 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5046 it
->voffset
= - (XFLOATINT (value
)
5047 * (FONT_HEIGHT (face
->font
)));
5049 #endif /* HAVE_WINDOW_SYSTEM */
5055 /* Don't handle the other kinds of display specifications
5056 inside a string that we got from a `display' property. */
5057 if (it
&& it
->string_from_display_prop_p
)
5060 /* Characters having this form of property are not displayed, so
5061 we have to find the end of the property. */
5064 start_pos
= *position
;
5065 *position
= display_prop_end (it
, object
, start_pos
);
5069 /* Stop the scan at that end position--we assume that all
5070 text properties change there. */
5072 it
->stop_charpos
= position
->charpos
;
5074 /* Handle `(left-fringe BITMAP [FACE])'
5075 and `(right-fringe BITMAP [FACE])'. */
5077 && (EQ (XCAR (spec
), Qleft_fringe
)
5078 || EQ (XCAR (spec
), Qright_fringe
))
5079 && CONSP (XCDR (spec
)))
5085 if (!FRAME_WINDOW_P (it
->f
))
5086 /* If we return here, POSITION has been advanced
5087 across the text with this property. */
5089 /* Synchronize the bidi iterator with POSITION. This is
5090 needed because we are not going to push the iterator
5091 on behalf of this display property, so there will be
5092 no pop_it call to do this synchronization for us. */
5095 it
->position
= *position
;
5096 iterate_out_of_display_property (it
);
5097 *position
= it
->position
;
5102 else if (!frame_window_p
)
5105 #ifdef HAVE_WINDOW_SYSTEM
5106 value
= XCAR (XCDR (spec
));
5107 if (!SYMBOLP (value
)
5108 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5109 /* If we return here, POSITION has been advanced
5110 across the text with this property. */
5112 if (it
&& it
->bidi_p
)
5114 it
->position
= *position
;
5115 iterate_out_of_display_property (it
);
5116 *position
= it
->position
;
5123 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5125 if (CONSP (XCDR (XCDR (spec
))))
5127 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5128 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5134 /* Save current settings of IT so that we can restore them
5135 when we are finished with the glyph property value. */
5136 push_it (it
, position
);
5138 it
->area
= TEXT_AREA
;
5139 it
->what
= IT_IMAGE
;
5140 it
->image_id
= -1; /* no image */
5141 it
->position
= start_pos
;
5142 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5143 it
->method
= GET_FROM_IMAGE
;
5144 it
->from_overlay
= Qnil
;
5145 it
->face_id
= face_id
;
5146 it
->from_disp_prop_p
= true;
5148 /* Say that we haven't consumed the characters with
5149 `display' property yet. The call to pop_it in
5150 set_iterator_to_next will clean this up. */
5151 *position
= start_pos
;
5153 if (EQ (XCAR (spec
), Qleft_fringe
))
5155 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5156 it
->left_user_fringe_face_id
= face_id
;
5160 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5161 it
->right_user_fringe_face_id
= face_id
;
5164 #endif /* HAVE_WINDOW_SYSTEM */
5168 /* Prepare to handle `((margin left-margin) ...)',
5169 `((margin right-margin) ...)' and `((margin nil) ...)'
5170 prefixes for display specifications. */
5171 location
= Qunbound
;
5172 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5176 value
= XCDR (spec
);
5178 value
= XCAR (value
);
5181 if (EQ (XCAR (tem
), Qmargin
)
5182 && (tem
= XCDR (tem
),
5183 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5185 || EQ (tem
, Qleft_margin
)
5186 || EQ (tem
, Qright_margin
))))
5190 if (EQ (location
, Qunbound
))
5196 /* After this point, VALUE is the property after any
5197 margin prefix has been stripped. It must be a string,
5198 an image specification, or `(space ...)'.
5200 LOCATION specifies where to display: `left-margin',
5201 `right-margin' or nil. */
5203 valid_p
= (STRINGP (value
)
5204 #ifdef HAVE_WINDOW_SYSTEM
5205 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5206 && valid_image_p (value
))
5207 #endif /* not HAVE_WINDOW_SYSTEM */
5208 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5210 if (valid_p
&& !display_replaced_p
)
5216 /* Callers need to know whether the display spec is any kind
5217 of `(space ...)' spec that is about to affect text-area
5219 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5224 /* Save current settings of IT so that we can restore them
5225 when we are finished with the glyph property value. */
5226 push_it (it
, position
);
5227 it
->from_overlay
= overlay
;
5228 it
->from_disp_prop_p
= true;
5230 if (NILP (location
))
5231 it
->area
= TEXT_AREA
;
5232 else if (EQ (location
, Qleft_margin
))
5233 it
->area
= LEFT_MARGIN_AREA
;
5235 it
->area
= RIGHT_MARGIN_AREA
;
5237 if (STRINGP (value
))
5240 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5241 it
->current
.overlay_string_index
= -1;
5242 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5243 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5244 it
->method
= GET_FROM_STRING
;
5245 it
->stop_charpos
= 0;
5247 it
->base_level_stop
= 0;
5248 it
->string_from_display_prop_p
= true;
5249 /* Say that we haven't consumed the characters with
5250 `display' property yet. The call to pop_it in
5251 set_iterator_to_next will clean this up. */
5252 if (BUFFERP (object
))
5253 *position
= start_pos
;
5255 /* Force paragraph direction to be that of the parent
5256 object. If the parent object's paragraph direction is
5257 not yet determined, default to L2R. */
5258 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5259 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5261 it
->paragraph_embedding
= L2R
;
5263 /* Set up the bidi iterator for this display string. */
5266 it
->bidi_it
.string
.lstring
= it
->string
;
5267 it
->bidi_it
.string
.s
= NULL
;
5268 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5269 it
->bidi_it
.string
.bufpos
= bufpos
;
5270 it
->bidi_it
.string
.from_disp_str
= 1;
5271 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5272 it
->bidi_it
.w
= it
->w
;
5273 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5276 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5278 it
->method
= GET_FROM_STRETCH
;
5280 *position
= it
->position
= start_pos
;
5281 retval
= 1 + (it
->area
== TEXT_AREA
);
5283 #ifdef HAVE_WINDOW_SYSTEM
5286 it
->what
= IT_IMAGE
;
5287 it
->image_id
= lookup_image (it
->f
, value
);
5288 it
->position
= start_pos
;
5289 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5290 it
->method
= GET_FROM_IMAGE
;
5292 /* Say that we haven't consumed the characters with
5293 `display' property yet. The call to pop_it in
5294 set_iterator_to_next will clean this up. */
5295 *position
= start_pos
;
5297 #endif /* HAVE_WINDOW_SYSTEM */
5302 /* Invalid property or property not supported. Restore
5303 POSITION to what it was before. */
5304 *position
= start_pos
;
5308 /* Check if PROP is a display property value whose text should be
5309 treated as intangible. OVERLAY is the overlay from which PROP
5310 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5311 specify the buffer position covered by PROP. */
5314 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5315 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5317 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5318 struct text_pos position
;
5320 SET_TEXT_POS (position
, charpos
, bytepos
);
5321 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5322 &position
, charpos
, frame_window_p
);
5326 /* Return 1 if PROP is a display sub-property value containing STRING.
5328 Implementation note: this and the following function are really
5329 special cases of handle_display_spec and
5330 handle_single_display_spec, and should ideally use the same code.
5331 Until they do, these two pairs must be consistent and must be
5332 modified in sync. */
5335 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5337 if (EQ (string
, prop
))
5340 /* Skip over `when FORM'. */
5341 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5346 /* Actually, the condition following `when' should be eval'ed,
5347 like handle_single_display_spec does, and we should return
5348 zero if it evaluates to nil. However, this function is
5349 called only when the buffer was already displayed and some
5350 glyph in the glyph matrix was found to come from a display
5351 string. Therefore, the condition was already evaluated, and
5352 the result was non-nil, otherwise the display string wouldn't
5353 have been displayed and we would have never been called for
5354 this property. Thus, we can skip the evaluation and assume
5355 its result is non-nil. */
5360 /* Skip over `margin LOCATION'. */
5361 if (EQ (XCAR (prop
), Qmargin
))
5372 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5376 /* Return 1 if STRING appears in the `display' property PROP. */
5379 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5382 && !EQ (XCAR (prop
), Qwhen
)
5383 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5385 /* A list of sub-properties. */
5386 while (CONSP (prop
))
5388 if (single_display_spec_string_p (XCAR (prop
), string
))
5393 else if (VECTORP (prop
))
5395 /* A vector of sub-properties. */
5397 for (i
= 0; i
< ASIZE (prop
); ++i
)
5398 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5402 return single_display_spec_string_p (prop
, string
);
5407 /* Look for STRING in overlays and text properties in the current
5408 buffer, between character positions FROM and TO (excluding TO).
5409 BACK_P non-zero means look back (in this case, TO is supposed to be
5411 Value is the first character position where STRING was found, or
5412 zero if it wasn't found before hitting TO.
5414 This function may only use code that doesn't eval because it is
5415 called asynchronously from note_mouse_highlight. */
5418 string_buffer_position_lim (Lisp_Object string
,
5419 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5421 Lisp_Object limit
, prop
, pos
;
5424 pos
= make_number (max (from
, BEGV
));
5426 if (!back_p
) /* looking forward */
5428 limit
= make_number (min (to
, ZV
));
5429 while (!found
&& !EQ (pos
, limit
))
5431 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5432 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5435 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5439 else /* looking back */
5441 limit
= make_number (max (to
, BEGV
));
5442 while (!found
&& !EQ (pos
, limit
))
5444 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5445 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5448 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5453 return found
? XINT (pos
) : 0;
5456 /* Determine which buffer position in current buffer STRING comes from.
5457 AROUND_CHARPOS is an approximate position where it could come from.
5458 Value is the buffer position or 0 if it couldn't be determined.
5460 This function is necessary because we don't record buffer positions
5461 in glyphs generated from strings (to keep struct glyph small).
5462 This function may only use code that doesn't eval because it is
5463 called asynchronously from note_mouse_highlight. */
5466 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5468 const int MAX_DISTANCE
= 1000;
5469 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5470 around_charpos
+ MAX_DISTANCE
,
5474 found
= string_buffer_position_lim (string
, around_charpos
,
5475 around_charpos
- MAX_DISTANCE
, 1);
5481 /***********************************************************************
5482 `composition' property
5483 ***********************************************************************/
5485 /* Set up iterator IT from `composition' property at its current
5486 position. Called from handle_stop. */
5488 static enum prop_handled
5489 handle_composition_prop (struct it
*it
)
5491 Lisp_Object prop
, string
;
5492 ptrdiff_t pos
, pos_byte
, start
, end
;
5494 if (STRINGP (it
->string
))
5498 pos
= IT_STRING_CHARPOS (*it
);
5499 pos_byte
= IT_STRING_BYTEPOS (*it
);
5500 string
= it
->string
;
5501 s
= SDATA (string
) + pos_byte
;
5502 it
->c
= STRING_CHAR (s
);
5506 pos
= IT_CHARPOS (*it
);
5507 pos_byte
= IT_BYTEPOS (*it
);
5509 it
->c
= FETCH_CHAR (pos_byte
);
5512 /* If there's a valid composition and point is not inside of the
5513 composition (in the case that the composition is from the current
5514 buffer), draw a glyph composed from the composition components. */
5515 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5516 && composition_valid_p (start
, end
, prop
)
5517 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5520 /* As we can't handle this situation (perhaps font-lock added
5521 a new composition), we just return here hoping that next
5522 redisplay will detect this composition much earlier. */
5523 return HANDLED_NORMALLY
;
5526 if (STRINGP (it
->string
))
5527 pos_byte
= string_char_to_byte (it
->string
, start
);
5529 pos_byte
= CHAR_TO_BYTE (start
);
5531 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5534 if (it
->cmp_it
.id
>= 0)
5537 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5538 it
->cmp_it
.nglyphs
= -1;
5542 return HANDLED_NORMALLY
;
5547 /***********************************************************************
5549 ***********************************************************************/
5551 /* The following structure is used to record overlay strings for
5552 later sorting in load_overlay_strings. */
5554 struct overlay_entry
5556 Lisp_Object overlay
;
5563 /* Set up iterator IT from overlay strings at its current position.
5564 Called from handle_stop. */
5566 static enum prop_handled
5567 handle_overlay_change (struct it
*it
)
5569 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5570 return HANDLED_RECOMPUTE_PROPS
;
5572 return HANDLED_NORMALLY
;
5576 /* Set up the next overlay string for delivery by IT, if there is an
5577 overlay string to deliver. Called by set_iterator_to_next when the
5578 end of the current overlay string is reached. If there are more
5579 overlay strings to display, IT->string and
5580 IT->current.overlay_string_index are set appropriately here.
5581 Otherwise IT->string is set to nil. */
5584 next_overlay_string (struct it
*it
)
5586 ++it
->current
.overlay_string_index
;
5587 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5589 /* No more overlay strings. Restore IT's settings to what
5590 they were before overlay strings were processed, and
5591 continue to deliver from current_buffer. */
5593 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5596 || (NILP (it
->string
)
5597 && it
->method
== GET_FROM_BUFFER
5598 && it
->stop_charpos
>= BEGV
5599 && it
->stop_charpos
<= it
->end_charpos
));
5600 it
->current
.overlay_string_index
= -1;
5601 it
->n_overlay_strings
= 0;
5602 it
->overlay_strings_charpos
= -1;
5603 /* If there's an empty display string on the stack, pop the
5604 stack, to resync the bidi iterator with IT's position. Such
5605 empty strings are pushed onto the stack in
5606 get_overlay_strings_1. */
5607 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5610 /* If we're at the end of the buffer, record that we have
5611 processed the overlay strings there already, so that
5612 next_element_from_buffer doesn't try it again. */
5613 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5614 it
->overlay_strings_at_end_processed_p
= true;
5618 /* There are more overlay strings to process. If
5619 IT->current.overlay_string_index has advanced to a position
5620 where we must load IT->overlay_strings with more strings, do
5621 it. We must load at the IT->overlay_strings_charpos where
5622 IT->n_overlay_strings was originally computed; when invisible
5623 text is present, this might not be IT_CHARPOS (Bug#7016). */
5624 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5626 if (it
->current
.overlay_string_index
&& i
== 0)
5627 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5629 /* Initialize IT to deliver display elements from the overlay
5631 it
->string
= it
->overlay_strings
[i
];
5632 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5633 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5634 it
->method
= GET_FROM_STRING
;
5635 it
->stop_charpos
= 0;
5636 it
->end_charpos
= SCHARS (it
->string
);
5637 if (it
->cmp_it
.stop_pos
>= 0)
5638 it
->cmp_it
.stop_pos
= 0;
5640 it
->base_level_stop
= 0;
5642 /* Set up the bidi iterator for this overlay string. */
5645 it
->bidi_it
.string
.lstring
= it
->string
;
5646 it
->bidi_it
.string
.s
= NULL
;
5647 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5648 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5649 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5650 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5651 it
->bidi_it
.w
= it
->w
;
5652 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5660 /* Compare two overlay_entry structures E1 and E2. Used as a
5661 comparison function for qsort in load_overlay_strings. Overlay
5662 strings for the same position are sorted so that
5664 1. All after-strings come in front of before-strings, except
5665 when they come from the same overlay.
5667 2. Within after-strings, strings are sorted so that overlay strings
5668 from overlays with higher priorities come first.
5670 2. Within before-strings, strings are sorted so that overlay
5671 strings from overlays with higher priorities come last.
5673 Value is analogous to strcmp. */
5677 compare_overlay_entries (const void *e1
, const void *e2
)
5679 struct overlay_entry
const *entry1
= e1
;
5680 struct overlay_entry
const *entry2
= e2
;
5683 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5685 /* Let after-strings appear in front of before-strings if
5686 they come from different overlays. */
5687 if (EQ (entry1
->overlay
, entry2
->overlay
))
5688 result
= entry1
->after_string_p
? 1 : -1;
5690 result
= entry1
->after_string_p
? -1 : 1;
5692 else if (entry1
->priority
!= entry2
->priority
)
5694 if (entry1
->after_string_p
)
5695 /* After-strings sorted in order of decreasing priority. */
5696 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5698 /* Before-strings sorted in order of increasing priority. */
5699 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5708 /* Load the vector IT->overlay_strings with overlay strings from IT's
5709 current buffer position, or from CHARPOS if that is > 0. Set
5710 IT->n_overlays to the total number of overlay strings found.
5712 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5713 a time. On entry into load_overlay_strings,
5714 IT->current.overlay_string_index gives the number of overlay
5715 strings that have already been loaded by previous calls to this
5718 IT->add_overlay_start contains an additional overlay start
5719 position to consider for taking overlay strings from, if non-zero.
5720 This position comes into play when the overlay has an `invisible'
5721 property, and both before and after-strings. When we've skipped to
5722 the end of the overlay, because of its `invisible' property, we
5723 nevertheless want its before-string to appear.
5724 IT->add_overlay_start will contain the overlay start position
5727 Overlay strings are sorted so that after-string strings come in
5728 front of before-string strings. Within before and after-strings,
5729 strings are sorted by overlay priority. See also function
5730 compare_overlay_entries. */
5733 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5735 Lisp_Object overlay
, window
, str
, invisible
;
5736 struct Lisp_Overlay
*ov
;
5737 ptrdiff_t start
, end
;
5738 ptrdiff_t size
= 20;
5739 ptrdiff_t n
= 0, i
, j
;
5741 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5745 charpos
= IT_CHARPOS (*it
);
5747 /* Append the overlay string STRING of overlay OVERLAY to vector
5748 `entries' which has size `size' and currently contains `n'
5749 elements. AFTER_P non-zero means STRING is an after-string of
5751 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5754 Lisp_Object priority; \
5758 struct overlay_entry *old = entries; \
5759 SAFE_NALLOCA (entries, 2, size); \
5760 memcpy (entries, old, size * sizeof *entries); \
5764 entries[n].string = (STRING); \
5765 entries[n].overlay = (OVERLAY); \
5766 priority = Foverlay_get ((OVERLAY), Qpriority); \
5767 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5768 entries[n].after_string_p = (AFTER_P); \
5773 /* Process overlay before the overlay center. */
5774 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5776 XSETMISC (overlay
, ov
);
5777 eassert (OVERLAYP (overlay
));
5778 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5779 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5784 /* Skip this overlay if it doesn't start or end at IT's current
5786 if (end
!= charpos
&& start
!= charpos
)
5789 /* Skip this overlay if it doesn't apply to IT->w. */
5790 window
= Foverlay_get (overlay
, Qwindow
);
5791 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5794 /* If the text ``under'' the overlay is invisible, both before-
5795 and after-strings from this overlay are visible; start and
5796 end position are indistinguishable. */
5797 invisible
= Foverlay_get (overlay
, Qinvisible
);
5798 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5800 /* If overlay has a non-empty before-string, record it. */
5801 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5802 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5804 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5806 /* If overlay has a non-empty after-string, record it. */
5807 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5808 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5810 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5813 /* Process overlays after the overlay center. */
5814 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5816 XSETMISC (overlay
, ov
);
5817 eassert (OVERLAYP (overlay
));
5818 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5819 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5821 if (start
> charpos
)
5824 /* Skip this overlay if it doesn't start or end at IT's current
5826 if (end
!= charpos
&& start
!= charpos
)
5829 /* Skip this overlay if it doesn't apply to IT->w. */
5830 window
= Foverlay_get (overlay
, Qwindow
);
5831 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5834 /* If the text ``under'' the overlay is invisible, it has a zero
5835 dimension, and both before- and after-strings apply. */
5836 invisible
= Foverlay_get (overlay
, Qinvisible
);
5837 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5839 /* If overlay has a non-empty before-string, record it. */
5840 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5841 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5843 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5845 /* If overlay has a non-empty after-string, record it. */
5846 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5847 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5849 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5852 #undef RECORD_OVERLAY_STRING
5856 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5858 /* Record number of overlay strings, and where we computed it. */
5859 it
->n_overlay_strings
= n
;
5860 it
->overlay_strings_charpos
= charpos
;
5862 /* IT->current.overlay_string_index is the number of overlay strings
5863 that have already been consumed by IT. Copy some of the
5864 remaining overlay strings to IT->overlay_strings. */
5866 j
= it
->current
.overlay_string_index
;
5867 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5869 it
->overlay_strings
[i
] = entries
[j
].string
;
5870 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5878 /* Get the first chunk of overlay strings at IT's current buffer
5879 position, or at CHARPOS if that is > 0. Value is non-zero if at
5880 least one overlay string was found. */
5883 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5885 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5886 process. This fills IT->overlay_strings with strings, and sets
5887 IT->n_overlay_strings to the total number of strings to process.
5888 IT->pos.overlay_string_index has to be set temporarily to zero
5889 because load_overlay_strings needs this; it must be set to -1
5890 when no overlay strings are found because a zero value would
5891 indicate a position in the first overlay string. */
5892 it
->current
.overlay_string_index
= 0;
5893 load_overlay_strings (it
, charpos
);
5895 /* If we found overlay strings, set up IT to deliver display
5896 elements from the first one. Otherwise set up IT to deliver
5897 from current_buffer. */
5898 if (it
->n_overlay_strings
)
5900 /* Make sure we know settings in current_buffer, so that we can
5901 restore meaningful values when we're done with the overlay
5904 compute_stop_pos (it
);
5905 eassert (it
->face_id
>= 0);
5907 /* Save IT's settings. They are restored after all overlay
5908 strings have been processed. */
5909 eassert (!compute_stop_p
|| it
->sp
== 0);
5911 /* When called from handle_stop, there might be an empty display
5912 string loaded. In that case, don't bother saving it. But
5913 don't use this optimization with the bidi iterator, since we
5914 need the corresponding pop_it call to resync the bidi
5915 iterator's position with IT's position, after we are done
5916 with the overlay strings. (The corresponding call to pop_it
5917 in case of an empty display string is in
5918 next_overlay_string.) */
5920 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5923 /* Set up IT to deliver display elements from the first overlay
5925 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5926 it
->string
= it
->overlay_strings
[0];
5927 it
->from_overlay
= Qnil
;
5928 it
->stop_charpos
= 0;
5929 eassert (STRINGP (it
->string
));
5930 it
->end_charpos
= SCHARS (it
->string
);
5932 it
->base_level_stop
= 0;
5933 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5934 it
->method
= GET_FROM_STRING
;
5935 it
->from_disp_prop_p
= 0;
5937 /* Force paragraph direction to be that of the parent
5939 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5940 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5942 it
->paragraph_embedding
= L2R
;
5944 /* Set up the bidi iterator for this overlay string. */
5947 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5949 it
->bidi_it
.string
.lstring
= it
->string
;
5950 it
->bidi_it
.string
.s
= NULL
;
5951 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5952 it
->bidi_it
.string
.bufpos
= pos
;
5953 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5954 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5955 it
->bidi_it
.w
= it
->w
;
5956 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5961 it
->current
.overlay_string_index
= -1;
5966 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5969 it
->method
= GET_FROM_BUFFER
;
5971 (void) get_overlay_strings_1 (it
, charpos
, 1);
5975 /* Value is non-zero if we found at least one overlay string. */
5976 return STRINGP (it
->string
);
5981 /***********************************************************************
5982 Saving and restoring state
5983 ***********************************************************************/
5985 /* Save current settings of IT on IT->stack. Called, for example,
5986 before setting up IT for an overlay string, to be able to restore
5987 IT's settings to what they were after the overlay string has been
5988 processed. If POSITION is non-NULL, it is the position to save on
5989 the stack instead of IT->position. */
5992 push_it (struct it
*it
, struct text_pos
*position
)
5994 struct iterator_stack_entry
*p
;
5996 eassert (it
->sp
< IT_STACK_SIZE
);
5997 p
= it
->stack
+ it
->sp
;
5999 p
->stop_charpos
= it
->stop_charpos
;
6000 p
->prev_stop
= it
->prev_stop
;
6001 p
->base_level_stop
= it
->base_level_stop
;
6002 p
->cmp_it
= it
->cmp_it
;
6003 eassert (it
->face_id
>= 0);
6004 p
->face_id
= it
->face_id
;
6005 p
->string
= it
->string
;
6006 p
->method
= it
->method
;
6007 p
->from_overlay
= it
->from_overlay
;
6010 case GET_FROM_IMAGE
:
6011 p
->u
.image
.object
= it
->object
;
6012 p
->u
.image
.image_id
= it
->image_id
;
6013 p
->u
.image
.slice
= it
->slice
;
6015 case GET_FROM_STRETCH
:
6016 p
->u
.stretch
.object
= it
->object
;
6019 p
->position
= position
? *position
: it
->position
;
6020 p
->current
= it
->current
;
6021 p
->end_charpos
= it
->end_charpos
;
6022 p
->string_nchars
= it
->string_nchars
;
6024 p
->multibyte_p
= it
->multibyte_p
;
6025 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6026 p
->space_width
= it
->space_width
;
6027 p
->font_height
= it
->font_height
;
6028 p
->voffset
= it
->voffset
;
6029 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6030 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6031 p
->display_ellipsis_p
= 0;
6032 p
->line_wrap
= it
->line_wrap
;
6033 p
->bidi_p
= it
->bidi_p
;
6034 p
->paragraph_embedding
= it
->paragraph_embedding
;
6035 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6038 /* Save the state of the bidi iterator as well. */
6040 bidi_push_it (&it
->bidi_it
);
6044 iterate_out_of_display_property (struct it
*it
)
6046 int buffer_p
= !STRINGP (it
->string
);
6047 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6048 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6050 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6052 /* Maybe initialize paragraph direction. If we are at the beginning
6053 of a new paragraph, next_element_from_buffer may not have a
6054 chance to do that. */
6055 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6056 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6057 /* prev_stop can be zero, so check against BEGV as well. */
6058 while (it
->bidi_it
.charpos
>= bob
6059 && it
->prev_stop
<= it
->bidi_it
.charpos
6060 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6061 && it
->bidi_it
.charpos
< eob
)
6062 bidi_move_to_visually_next (&it
->bidi_it
);
6063 /* Record the stop_pos we just crossed, for when we cross it
6065 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6066 it
->prev_stop
= CHARPOS (it
->position
);
6067 /* If we ended up not where pop_it put us, resync IT's
6068 positional members with the bidi iterator. */
6069 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6070 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6072 it
->current
.pos
= it
->position
;
6074 it
->current
.string_pos
= it
->position
;
6077 /* Restore IT's settings from IT->stack. Called, for example, when no
6078 more overlay strings must be processed, and we return to delivering
6079 display elements from a buffer, or when the end of a string from a
6080 `display' property is reached and we return to delivering display
6081 elements from an overlay string, or from a buffer. */
6084 pop_it (struct it
*it
)
6086 struct iterator_stack_entry
*p
;
6087 int from_display_prop
= it
->from_disp_prop_p
;
6089 eassert (it
->sp
> 0);
6091 p
= it
->stack
+ it
->sp
;
6092 it
->stop_charpos
= p
->stop_charpos
;
6093 it
->prev_stop
= p
->prev_stop
;
6094 it
->base_level_stop
= p
->base_level_stop
;
6095 it
->cmp_it
= p
->cmp_it
;
6096 it
->face_id
= p
->face_id
;
6097 it
->current
= p
->current
;
6098 it
->position
= p
->position
;
6099 it
->string
= p
->string
;
6100 it
->from_overlay
= p
->from_overlay
;
6101 if (NILP (it
->string
))
6102 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6103 it
->method
= p
->method
;
6106 case GET_FROM_IMAGE
:
6107 it
->image_id
= p
->u
.image
.image_id
;
6108 it
->object
= p
->u
.image
.object
;
6109 it
->slice
= p
->u
.image
.slice
;
6111 case GET_FROM_STRETCH
:
6112 it
->object
= p
->u
.stretch
.object
;
6114 case GET_FROM_BUFFER
:
6115 it
->object
= it
->w
->contents
;
6117 case GET_FROM_STRING
:
6119 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6121 /* Restore the face_box_p flag, since it could have been
6122 overwritten by the face of the object that we just finished
6125 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6126 it
->object
= it
->string
;
6129 case GET_FROM_DISPLAY_VECTOR
:
6131 it
->method
= GET_FROM_C_STRING
;
6132 else if (STRINGP (it
->string
))
6133 it
->method
= GET_FROM_STRING
;
6136 it
->method
= GET_FROM_BUFFER
;
6137 it
->object
= it
->w
->contents
;
6140 it
->end_charpos
= p
->end_charpos
;
6141 it
->string_nchars
= p
->string_nchars
;
6143 it
->multibyte_p
= p
->multibyte_p
;
6144 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6145 it
->space_width
= p
->space_width
;
6146 it
->font_height
= p
->font_height
;
6147 it
->voffset
= p
->voffset
;
6148 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6149 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6150 it
->line_wrap
= p
->line_wrap
;
6151 it
->bidi_p
= p
->bidi_p
;
6152 it
->paragraph_embedding
= p
->paragraph_embedding
;
6153 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6156 bidi_pop_it (&it
->bidi_it
);
6157 /* Bidi-iterate until we get out of the portion of text, if any,
6158 covered by a `display' text property or by an overlay with
6159 `display' property. (We cannot just jump there, because the
6160 internal coherency of the bidi iterator state can not be
6161 preserved across such jumps.) We also must determine the
6162 paragraph base direction if the overlay we just processed is
6163 at the beginning of a new paragraph. */
6164 if (from_display_prop
6165 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6166 iterate_out_of_display_property (it
);
6168 eassert ((BUFFERP (it
->object
)
6169 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6170 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6171 || (STRINGP (it
->object
)
6172 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6173 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6174 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6180 /***********************************************************************
6182 ***********************************************************************/
6184 /* Set IT's current position to the previous line start. */
6187 back_to_previous_line_start (struct it
*it
)
6189 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6192 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6196 /* Move IT to the next line start.
6198 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6199 we skipped over part of the text (as opposed to moving the iterator
6200 continuously over the text). Otherwise, don't change the value
6203 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6204 iterator on the newline, if it was found.
6206 Newlines may come from buffer text, overlay strings, or strings
6207 displayed via the `display' property. That's the reason we can't
6208 simply use find_newline_no_quit.
6210 Note that this function may not skip over invisible text that is so
6211 because of text properties and immediately follows a newline. If
6212 it would, function reseat_at_next_visible_line_start, when called
6213 from set_iterator_to_next, would effectively make invisible
6214 characters following a newline part of the wrong glyph row, which
6215 leads to wrong cursor motion. */
6218 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6219 struct bidi_it
*bidi_it_prev
)
6221 ptrdiff_t old_selective
;
6222 int newline_found_p
, n
;
6223 const int MAX_NEWLINE_DISTANCE
= 500;
6225 /* If already on a newline, just consume it to avoid unintended
6226 skipping over invisible text below. */
6227 if (it
->what
== IT_CHARACTER
6229 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6231 if (it
->bidi_p
&& bidi_it_prev
)
6232 *bidi_it_prev
= it
->bidi_it
;
6233 set_iterator_to_next (it
, 0);
6238 /* Don't handle selective display in the following. It's (a)
6239 unnecessary because it's done by the caller, and (b) leads to an
6240 infinite recursion because next_element_from_ellipsis indirectly
6241 calls this function. */
6242 old_selective
= it
->selective
;
6245 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6246 from buffer text. */
6247 for (n
= newline_found_p
= 0;
6248 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6249 n
+= STRINGP (it
->string
) ? 0 : 1)
6251 if (!get_next_display_element (it
))
6253 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6254 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6255 *bidi_it_prev
= it
->bidi_it
;
6256 set_iterator_to_next (it
, 0);
6259 /* If we didn't find a newline near enough, see if we can use a
6261 if (!newline_found_p
)
6263 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6264 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6268 eassert (!STRINGP (it
->string
));
6270 /* If there isn't any `display' property in sight, and no
6271 overlays, we can just use the position of the newline in
6273 if (it
->stop_charpos
>= limit
6274 || ((pos
= Fnext_single_property_change (make_number (start
),
6276 make_number (limit
)),
6278 && next_overlay_change (start
) == ZV
))
6282 IT_CHARPOS (*it
) = limit
;
6283 IT_BYTEPOS (*it
) = bytepos
;
6287 struct bidi_it bprev
;
6289 /* Help bidi.c avoid expensive searches for display
6290 properties and overlays, by telling it that there are
6291 none up to `limit'. */
6292 if (it
->bidi_it
.disp_pos
< limit
)
6294 it
->bidi_it
.disp_pos
= limit
;
6295 it
->bidi_it
.disp_prop
= 0;
6298 bprev
= it
->bidi_it
;
6299 bidi_move_to_visually_next (&it
->bidi_it
);
6300 } while (it
->bidi_it
.charpos
!= limit
);
6301 IT_CHARPOS (*it
) = limit
;
6302 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6304 *bidi_it_prev
= bprev
;
6306 *skipped_p
= newline_found_p
= true;
6310 while (get_next_display_element (it
)
6311 && !newline_found_p
)
6313 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6314 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6315 *bidi_it_prev
= it
->bidi_it
;
6316 set_iterator_to_next (it
, 0);
6321 it
->selective
= old_selective
;
6322 return newline_found_p
;
6326 /* Set IT's current position to the previous visible line start. Skip
6327 invisible text that is so either due to text properties or due to
6328 selective display. Caution: this does not change IT->current_x and
6332 back_to_previous_visible_line_start (struct it
*it
)
6334 while (IT_CHARPOS (*it
) > BEGV
)
6336 back_to_previous_line_start (it
);
6338 if (IT_CHARPOS (*it
) <= BEGV
)
6341 /* If selective > 0, then lines indented more than its value are
6343 if (it
->selective
> 0
6344 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6348 /* Check the newline before point for invisibility. */
6351 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6352 Qinvisible
, it
->window
);
6353 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6357 if (IT_CHARPOS (*it
) <= BEGV
)
6362 void *it2data
= NULL
;
6365 Lisp_Object val
, overlay
;
6367 SAVE_IT (it2
, *it
, it2data
);
6369 /* If newline is part of a composition, continue from start of composition */
6370 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6371 && beg
< IT_CHARPOS (*it
))
6374 /* If newline is replaced by a display property, find start of overlay
6375 or interval and continue search from that point. */
6376 pos
= --IT_CHARPOS (it2
);
6379 bidi_unshelve_cache (NULL
, 0);
6380 it2
.string_from_display_prop_p
= 0;
6381 it2
.from_disp_prop_p
= 0;
6382 if (handle_display_prop (&it2
) == HANDLED_RETURN
6383 && !NILP (val
= get_char_property_and_overlay
6384 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6385 && (OVERLAYP (overlay
)
6386 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6387 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6389 RESTORE_IT (it
, it
, it2data
);
6393 /* Newline is not replaced by anything -- so we are done. */
6394 RESTORE_IT (it
, it
, it2data
);
6400 IT_CHARPOS (*it
) = beg
;
6401 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6405 it
->continuation_lines_width
= 0;
6407 eassert (IT_CHARPOS (*it
) >= BEGV
);
6408 eassert (IT_CHARPOS (*it
) == BEGV
6409 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6414 /* Reseat iterator IT at the previous visible line start. Skip
6415 invisible text that is so either due to text properties or due to
6416 selective display. At the end, update IT's overlay information,
6417 face information etc. */
6420 reseat_at_previous_visible_line_start (struct it
*it
)
6422 back_to_previous_visible_line_start (it
);
6423 reseat (it
, it
->current
.pos
, 1);
6428 /* Reseat iterator IT on the next visible line start in the current
6429 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6430 preceding the line start. Skip over invisible text that is so
6431 because of selective display. Compute faces, overlays etc at the
6432 new position. Note that this function does not skip over text that
6433 is invisible because of text properties. */
6436 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6438 int newline_found_p
, skipped_p
= 0;
6439 struct bidi_it bidi_it_prev
;
6441 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6443 /* Skip over lines that are invisible because they are indented
6444 more than the value of IT->selective. */
6445 if (it
->selective
> 0)
6446 while (IT_CHARPOS (*it
) < ZV
6447 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6450 eassert (IT_BYTEPOS (*it
) == BEGV
6451 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6453 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6456 /* Position on the newline if that's what's requested. */
6457 if (on_newline_p
&& newline_found_p
)
6459 if (STRINGP (it
->string
))
6461 if (IT_STRING_CHARPOS (*it
) > 0)
6465 --IT_STRING_CHARPOS (*it
);
6466 --IT_STRING_BYTEPOS (*it
);
6470 /* We need to restore the bidi iterator to the state
6471 it had on the newline, and resync the IT's
6472 position with that. */
6473 it
->bidi_it
= bidi_it_prev
;
6474 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6475 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6479 else if (IT_CHARPOS (*it
) > BEGV
)
6488 /* We need to restore the bidi iterator to the state it
6489 had on the newline and resync IT with that. */
6490 it
->bidi_it
= bidi_it_prev
;
6491 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6492 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6494 reseat (it
, it
->current
.pos
, 0);
6498 reseat (it
, it
->current
.pos
, 0);
6505 /***********************************************************************
6506 Changing an iterator's position
6507 ***********************************************************************/
6509 /* Change IT's current position to POS in current_buffer. If FORCE_P
6510 is non-zero, always check for text properties at the new position.
6511 Otherwise, text properties are only looked up if POS >=
6512 IT->check_charpos of a property. */
6515 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6517 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6519 reseat_1 (it
, pos
, 0);
6521 /* Determine where to check text properties. Avoid doing it
6522 where possible because text property lookup is very expensive. */
6524 || CHARPOS (pos
) > it
->stop_charpos
6525 || CHARPOS (pos
) < original_pos
)
6529 /* For bidi iteration, we need to prime prev_stop and
6530 base_level_stop with our best estimations. */
6531 /* Implementation note: Of course, POS is not necessarily a
6532 stop position, so assigning prev_pos to it is a lie; we
6533 should have called compute_stop_backwards. However, if
6534 the current buffer does not include any R2L characters,
6535 that call would be a waste of cycles, because the
6536 iterator will never move back, and thus never cross this
6537 "fake" stop position. So we delay that backward search
6538 until the time we really need it, in next_element_from_buffer. */
6539 if (CHARPOS (pos
) != it
->prev_stop
)
6540 it
->prev_stop
= CHARPOS (pos
);
6541 if (CHARPOS (pos
) < it
->base_level_stop
)
6542 it
->base_level_stop
= 0; /* meaning it's unknown */
6548 it
->prev_stop
= it
->base_level_stop
= 0;
6557 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6558 IT->stop_pos to POS, also. */
6561 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6563 /* Don't call this function when scanning a C string. */
6564 eassert (it
->s
== NULL
);
6566 /* POS must be a reasonable value. */
6567 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6569 it
->current
.pos
= it
->position
= pos
;
6570 it
->end_charpos
= ZV
;
6572 it
->current
.dpvec_index
= -1;
6573 it
->current
.overlay_string_index
= -1;
6574 IT_STRING_CHARPOS (*it
) = -1;
6575 IT_STRING_BYTEPOS (*it
) = -1;
6577 it
->method
= GET_FROM_BUFFER
;
6578 it
->object
= it
->w
->contents
;
6579 it
->area
= TEXT_AREA
;
6580 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6582 it
->string_from_display_prop_p
= 0;
6583 it
->string_from_prefix_prop_p
= 0;
6585 it
->from_disp_prop_p
= 0;
6586 it
->face_before_selective_p
= 0;
6589 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6591 bidi_unshelve_cache (NULL
, 0);
6592 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6593 it
->bidi_it
.string
.s
= NULL
;
6594 it
->bidi_it
.string
.lstring
= Qnil
;
6595 it
->bidi_it
.string
.bufpos
= 0;
6596 it
->bidi_it
.string
.from_disp_str
= 0;
6597 it
->bidi_it
.string
.unibyte
= 0;
6598 it
->bidi_it
.w
= it
->w
;
6603 it
->stop_charpos
= CHARPOS (pos
);
6604 it
->base_level_stop
= CHARPOS (pos
);
6606 /* This make the information stored in it->cmp_it invalidate. */
6611 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6612 If S is non-null, it is a C string to iterate over. Otherwise,
6613 STRING gives a Lisp string to iterate over.
6615 If PRECISION > 0, don't return more then PRECISION number of
6616 characters from the string.
6618 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6619 characters have been returned. FIELD_WIDTH < 0 means an infinite
6622 MULTIBYTE = 0 means disable processing of multibyte characters,
6623 MULTIBYTE > 0 means enable it,
6624 MULTIBYTE < 0 means use IT->multibyte_p.
6626 IT must be initialized via a prior call to init_iterator before
6627 calling this function. */
6630 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6631 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6634 /* No text property checks performed by default, but see below. */
6635 it
->stop_charpos
= -1;
6637 /* Set iterator position and end position. */
6638 memset (&it
->current
, 0, sizeof it
->current
);
6639 it
->current
.overlay_string_index
= -1;
6640 it
->current
.dpvec_index
= -1;
6641 eassert (charpos
>= 0);
6643 /* If STRING is specified, use its multibyteness, otherwise use the
6644 setting of MULTIBYTE, if specified. */
6646 it
->multibyte_p
= multibyte
> 0;
6648 /* Bidirectional reordering of strings is controlled by the default
6649 value of bidi-display-reordering. Don't try to reorder while
6650 loading loadup.el, as the necessary character property tables are
6651 not yet available. */
6654 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6658 eassert (STRINGP (string
));
6659 it
->string
= string
;
6661 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6662 it
->method
= GET_FROM_STRING
;
6663 it
->current
.string_pos
= string_pos (charpos
, string
);
6667 it
->bidi_it
.string
.lstring
= string
;
6668 it
->bidi_it
.string
.s
= NULL
;
6669 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6670 it
->bidi_it
.string
.bufpos
= 0;
6671 it
->bidi_it
.string
.from_disp_str
= 0;
6672 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6673 it
->bidi_it
.w
= it
->w
;
6674 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6675 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6680 it
->s
= (const unsigned char *) s
;
6683 /* Note that we use IT->current.pos, not it->current.string_pos,
6684 for displaying C strings. */
6685 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6686 if (it
->multibyte_p
)
6688 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6689 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6693 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6694 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6699 it
->bidi_it
.string
.lstring
= Qnil
;
6700 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6701 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6702 it
->bidi_it
.string
.bufpos
= 0;
6703 it
->bidi_it
.string
.from_disp_str
= 0;
6704 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6705 it
->bidi_it
.w
= it
->w
;
6706 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6709 it
->method
= GET_FROM_C_STRING
;
6712 /* PRECISION > 0 means don't return more than PRECISION characters
6714 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6716 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6718 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6721 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6722 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6723 FIELD_WIDTH < 0 means infinite field width. This is useful for
6724 padding with `-' at the end of a mode line. */
6725 if (field_width
< 0)
6726 field_width
= INFINITY
;
6727 /* Implementation note: We deliberately don't enlarge
6728 it->bidi_it.string.schars here to fit it->end_charpos, because
6729 the bidi iterator cannot produce characters out of thin air. */
6730 if (field_width
> it
->end_charpos
- charpos
)
6731 it
->end_charpos
= charpos
+ field_width
;
6733 /* Use the standard display table for displaying strings. */
6734 if (DISP_TABLE_P (Vstandard_display_table
))
6735 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6737 it
->stop_charpos
= charpos
;
6738 it
->prev_stop
= charpos
;
6739 it
->base_level_stop
= 0;
6742 it
->bidi_it
.first_elt
= 1;
6743 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6744 it
->bidi_it
.disp_pos
= -1;
6746 if (s
== NULL
&& it
->multibyte_p
)
6748 ptrdiff_t endpos
= SCHARS (it
->string
);
6749 if (endpos
> it
->end_charpos
)
6750 endpos
= it
->end_charpos
;
6751 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6759 /***********************************************************************
6761 ***********************************************************************/
6763 /* Map enum it_method value to corresponding next_element_from_* function. */
6765 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6767 next_element_from_buffer
,
6768 next_element_from_display_vector
,
6769 next_element_from_string
,
6770 next_element_from_c_string
,
6771 next_element_from_image
,
6772 next_element_from_stretch
6775 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6778 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6779 (possibly with the following characters). */
6781 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6782 ((IT)->cmp_it.id >= 0 \
6783 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6784 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6785 END_CHARPOS, (IT)->w, \
6786 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6790 /* Lookup the char-table Vglyphless_char_display for character C (-1
6791 if we want information for no-font case), and return the display
6792 method symbol. By side-effect, update it->what and
6793 it->glyphless_method. This function is called from
6794 get_next_display_element for each character element, and from
6795 x_produce_glyphs when no suitable font was found. */
6798 lookup_glyphless_char_display (int c
, struct it
*it
)
6800 Lisp_Object glyphless_method
= Qnil
;
6802 if (CHAR_TABLE_P (Vglyphless_char_display
)
6803 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6807 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6808 if (CONSP (glyphless_method
))
6809 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6810 ? XCAR (glyphless_method
)
6811 : XCDR (glyphless_method
);
6814 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6818 if (NILP (glyphless_method
))
6821 /* The default is to display the character by a proper font. */
6823 /* The default for the no-font case is to display an empty box. */
6824 glyphless_method
= Qempty_box
;
6826 if (EQ (glyphless_method
, Qzero_width
))
6829 return glyphless_method
;
6830 /* This method can't be used for the no-font case. */
6831 glyphless_method
= Qempty_box
;
6833 if (EQ (glyphless_method
, Qthin_space
))
6834 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6835 else if (EQ (glyphless_method
, Qempty_box
))
6836 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6837 else if (EQ (glyphless_method
, Qhex_code
))
6838 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6839 else if (STRINGP (glyphless_method
))
6840 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6843 /* Invalid value. We use the default method. */
6844 glyphless_method
= Qnil
;
6847 it
->what
= IT_GLYPHLESS
;
6848 return glyphless_method
;
6851 /* Merge escape glyph face and cache the result. */
6853 static struct frame
*last_escape_glyph_frame
= NULL
;
6854 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6855 static int last_escape_glyph_merged_face_id
= 0;
6858 merge_escape_glyph_face (struct it
*it
)
6862 if (it
->f
== last_escape_glyph_frame
6863 && it
->face_id
== last_escape_glyph_face_id
)
6864 face_id
= last_escape_glyph_merged_face_id
;
6867 /* Merge the `escape-glyph' face into the current face. */
6868 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6869 last_escape_glyph_frame
= it
->f
;
6870 last_escape_glyph_face_id
= it
->face_id
;
6871 last_escape_glyph_merged_face_id
= face_id
;
6876 /* Likewise for glyphless glyph face. */
6878 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6879 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6880 static int last_glyphless_glyph_merged_face_id
= 0;
6883 merge_glyphless_glyph_face (struct it
*it
)
6887 if (it
->f
== last_glyphless_glyph_frame
6888 && it
->face_id
== last_glyphless_glyph_face_id
)
6889 face_id
= last_glyphless_glyph_merged_face_id
;
6892 /* Merge the `glyphless-char' face into the current face. */
6893 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6894 last_glyphless_glyph_frame
= it
->f
;
6895 last_glyphless_glyph_face_id
= it
->face_id
;
6896 last_glyphless_glyph_merged_face_id
= face_id
;
6901 /* Load IT's display element fields with information about the next
6902 display element from the current position of IT. Value is zero if
6903 end of buffer (or C string) is reached. */
6906 get_next_display_element (struct it
*it
)
6908 /* Non-zero means that we found a display element. Zero means that
6909 we hit the end of what we iterate over. Performance note: the
6910 function pointer `method' used here turns out to be faster than
6911 using a sequence of if-statements. */
6915 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6917 if (it
->what
== IT_CHARACTER
)
6919 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6920 and only if (a) the resolved directionality of that character
6922 /* FIXME: Do we need an exception for characters from display
6924 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6925 it
->c
= bidi_mirror_char (it
->c
);
6926 /* Map via display table or translate control characters.
6927 IT->c, IT->len etc. have been set to the next character by
6928 the function call above. If we have a display table, and it
6929 contains an entry for IT->c, translate it. Don't do this if
6930 IT->c itself comes from a display table, otherwise we could
6931 end up in an infinite recursion. (An alternative could be to
6932 count the recursion depth of this function and signal an
6933 error when a certain maximum depth is reached.) Is it worth
6935 if (success_p
&& it
->dpvec
== NULL
)
6938 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6939 int nonascii_space_p
= 0;
6940 int nonascii_hyphen_p
= 0;
6941 int c
= it
->c
; /* This is the character to display. */
6943 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6945 eassert (SINGLE_BYTE_CHAR_P (c
));
6946 if (unibyte_display_via_language_environment
)
6948 c
= DECODE_CHAR (unibyte
, c
);
6950 c
= BYTE8_TO_CHAR (it
->c
);
6953 c
= BYTE8_TO_CHAR (it
->c
);
6957 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6960 struct Lisp_Vector
*v
= XVECTOR (dv
);
6962 /* Return the first character from the display table
6963 entry, if not empty. If empty, don't display the
6964 current character. */
6967 it
->dpvec_char_len
= it
->len
;
6968 it
->dpvec
= v
->contents
;
6969 it
->dpend
= v
->contents
+ v
->header
.size
;
6970 it
->current
.dpvec_index
= 0;
6971 it
->dpvec_face_id
= -1;
6972 it
->saved_face_id
= it
->face_id
;
6973 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6978 set_iterator_to_next (it
, 0);
6983 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6985 if (it
->what
== IT_GLYPHLESS
)
6987 /* Don't display this character. */
6988 set_iterator_to_next (it
, 0);
6992 /* If `nobreak-char-display' is non-nil, we display
6993 non-ASCII spaces and hyphens specially. */
6994 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6997 nonascii_space_p
= true;
6998 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6999 nonascii_hyphen_p
= true;
7002 /* Translate control characters into `\003' or `^C' form.
7003 Control characters coming from a display table entry are
7004 currently not translated because we use IT->dpvec to hold
7005 the translation. This could easily be changed but I
7006 don't believe that it is worth doing.
7008 The characters handled by `nobreak-char-display' must be
7011 Non-printable characters and raw-byte characters are also
7012 translated to octal form. */
7013 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7014 ? (it
->area
!= TEXT_AREA
7015 /* In mode line, treat \n, \t like other crl chars. */
7018 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7019 || (c
!= '\n' && c
!= '\t'))
7021 || nonascii_hyphen_p
7023 || ! CHAR_PRINTABLE_P (c
))))
7025 /* C is a control character, non-ASCII space/hyphen,
7026 raw-byte, or a non-printable character which must be
7027 displayed either as '\003' or as `^C' where the '\\'
7028 and '^' can be defined in the display table. Fill
7029 IT->ctl_chars with glyphs for what we have to
7030 display. Then, set IT->dpvec to these glyphs. */
7037 /* Handle control characters with ^. */
7039 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7043 g
= '^'; /* default glyph for Control */
7044 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7046 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7048 g
= GLYPH_CODE_CHAR (gc
);
7049 lface_id
= GLYPH_CODE_FACE (gc
);
7053 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7054 : merge_escape_glyph_face (it
));
7056 XSETINT (it
->ctl_chars
[0], g
);
7057 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7059 goto display_control
;
7062 /* Handle non-ascii space in the mode where it only gets
7065 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7067 /* Merge `nobreak-space' into the current face. */
7068 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7070 XSETINT (it
->ctl_chars
[0], ' ');
7072 goto display_control
;
7075 /* Handle sequences that start with the "escape glyph". */
7077 /* the default escape glyph is \. */
7078 escape_glyph
= '\\';
7081 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7083 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7084 lface_id
= GLYPH_CODE_FACE (gc
);
7088 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7089 : merge_escape_glyph_face (it
));
7091 /* Draw non-ASCII hyphen with just highlighting: */
7093 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7095 XSETINT (it
->ctl_chars
[0], '-');
7097 goto display_control
;
7100 /* Draw non-ASCII space/hyphen with escape glyph: */
7102 if (nonascii_space_p
|| nonascii_hyphen_p
)
7104 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7105 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7107 goto display_control
;
7114 if (CHAR_BYTE8_P (c
))
7115 /* Display \200 instead of \17777600. */
7116 c
= CHAR_TO_BYTE8 (c
);
7117 len
= sprintf (str
, "%03o", c
);
7119 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7120 for (i
= 0; i
< len
; i
++)
7121 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7126 /* Set up IT->dpvec and return first character from it. */
7127 it
->dpvec_char_len
= it
->len
;
7128 it
->dpvec
= it
->ctl_chars
;
7129 it
->dpend
= it
->dpvec
+ ctl_len
;
7130 it
->current
.dpvec_index
= 0;
7131 it
->dpvec_face_id
= face_id
;
7132 it
->saved_face_id
= it
->face_id
;
7133 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7137 it
->char_to_display
= c
;
7141 it
->char_to_display
= it
->c
;
7145 #ifdef HAVE_WINDOW_SYSTEM
7146 /* Adjust face id for a multibyte character. There are no multibyte
7147 character in unibyte text. */
7148 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7151 && FRAME_WINDOW_P (it
->f
))
7153 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7155 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7157 /* Automatic composition with glyph-string. */
7158 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7160 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7164 ptrdiff_t pos
= (it
->s
? -1
7165 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7166 : IT_CHARPOS (*it
));
7169 if (it
->what
== IT_CHARACTER
)
7170 c
= it
->char_to_display
;
7173 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7177 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7178 /* TAB in a composition means display glyphs with
7179 padding space on the left or right. */
7180 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7183 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7186 #endif /* HAVE_WINDOW_SYSTEM */
7189 /* Is this character the last one of a run of characters with
7190 box? If yes, set IT->end_of_box_run_p to 1. */
7194 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7196 int face_id
= underlying_face_id (it
);
7197 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7201 if (face
->box
== FACE_NO_BOX
)
7203 /* If the box comes from face properties in a
7204 display string, check faces in that string. */
7205 int string_face_id
= face_after_it_pos (it
);
7206 it
->end_of_box_run_p
7207 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7210 /* Otherwise, the box comes from the underlying face.
7211 If this is the last string character displayed, check
7212 the next buffer location. */
7213 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7214 /* n_overlay_strings is unreliable unless
7215 overlay_string_index is non-negative. */
7216 && ((it
->current
.overlay_string_index
>= 0
7217 && (it
->current
.overlay_string_index
7218 == it
->n_overlay_strings
- 1))
7219 /* A string from display property. */
7220 || it
->from_disp_prop_p
))
7224 struct text_pos pos
= it
->current
.pos
;
7226 /* For a string from a display property, the next
7227 buffer position is stored in the 'position'
7228 member of the iteration stack slot below the
7229 current one, see handle_single_display_spec. By
7230 contrast, it->current.pos was is not yet updated
7231 to point to that buffer position; that will
7232 happen in pop_it, after we finish displaying the
7233 current string. Note that we already checked
7234 above that it->sp is positive, so subtracting one
7236 if (it
->from_disp_prop_p
)
7237 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7239 INC_TEXT_POS (pos
, it
->multibyte_p
);
7241 if (CHARPOS (pos
) >= ZV
)
7242 it
->end_of_box_run_p
= true;
7245 next_face_id
= face_at_buffer_position
7246 (it
->w
, CHARPOS (pos
), &ignore
,
7247 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7248 it
->end_of_box_run_p
7249 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7255 /* next_element_from_display_vector sets this flag according to
7256 faces of the display vector glyphs, see there. */
7257 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7259 int face_id
= face_after_it_pos (it
);
7260 it
->end_of_box_run_p
7261 = (face_id
!= it
->face_id
7262 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7265 /* If we reached the end of the object we've been iterating (e.g., a
7266 display string or an overlay string), and there's something on
7267 IT->stack, proceed with what's on the stack. It doesn't make
7268 sense to return zero if there's unprocessed stuff on the stack,
7269 because otherwise that stuff will never be displayed. */
7270 if (!success_p
&& it
->sp
> 0)
7272 set_iterator_to_next (it
, 0);
7273 success_p
= get_next_display_element (it
);
7276 /* Value is 0 if end of buffer or string reached. */
7281 /* Move IT to the next display element.
7283 RESEAT_P non-zero means if called on a newline in buffer text,
7284 skip to the next visible line start.
7286 Functions get_next_display_element and set_iterator_to_next are
7287 separate because I find this arrangement easier to handle than a
7288 get_next_display_element function that also increments IT's
7289 position. The way it is we can first look at an iterator's current
7290 display element, decide whether it fits on a line, and if it does,
7291 increment the iterator position. The other way around we probably
7292 would either need a flag indicating whether the iterator has to be
7293 incremented the next time, or we would have to implement a
7294 decrement position function which would not be easy to write. */
7297 set_iterator_to_next (struct it
*it
, int reseat_p
)
7299 /* Reset flags indicating start and end of a sequence of characters
7300 with box. Reset them at the start of this function because
7301 moving the iterator to a new position might set them. */
7302 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7306 case GET_FROM_BUFFER
:
7307 /* The current display element of IT is a character from
7308 current_buffer. Advance in the buffer, and maybe skip over
7309 invisible lines that are so because of selective display. */
7310 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7311 reseat_at_next_visible_line_start (it
, 0);
7312 else if (it
->cmp_it
.id
>= 0)
7314 /* We are currently getting glyphs from a composition. */
7319 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7320 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7321 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7323 it
->cmp_it
.from
= it
->cmp_it
.to
;
7328 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7330 it
->end_charpos
, Qnil
);
7333 else if (! it
->cmp_it
.reversed_p
)
7335 /* Composition created while scanning forward. */
7336 /* Update IT's char/byte positions to point to the first
7337 character of the next grapheme cluster, or to the
7338 character visually after the current composition. */
7339 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7340 bidi_move_to_visually_next (&it
->bidi_it
);
7341 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7342 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7344 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7346 /* Proceed to the next grapheme cluster. */
7347 it
->cmp_it
.from
= it
->cmp_it
.to
;
7351 /* No more grapheme clusters in this composition.
7352 Find the next stop position. */
7353 ptrdiff_t stop
= it
->end_charpos
;
7354 if (it
->bidi_it
.scan_dir
< 0)
7355 /* Now we are scanning backward and don't know
7358 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7359 IT_BYTEPOS (*it
), stop
, Qnil
);
7364 /* Composition created while scanning backward. */
7365 /* Update IT's char/byte positions to point to the last
7366 character of the previous grapheme cluster, or the
7367 character visually after the current composition. */
7368 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7369 bidi_move_to_visually_next (&it
->bidi_it
);
7370 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7371 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7372 if (it
->cmp_it
.from
> 0)
7374 /* Proceed to the previous grapheme cluster. */
7375 it
->cmp_it
.to
= it
->cmp_it
.from
;
7379 /* No more grapheme clusters in this composition.
7380 Find the next stop position. */
7381 ptrdiff_t stop
= it
->end_charpos
;
7382 if (it
->bidi_it
.scan_dir
< 0)
7383 /* Now we are scanning backward and don't know
7386 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7387 IT_BYTEPOS (*it
), stop
, Qnil
);
7393 eassert (it
->len
!= 0);
7397 IT_BYTEPOS (*it
) += it
->len
;
7398 IT_CHARPOS (*it
) += 1;
7402 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7403 /* If this is a new paragraph, determine its base
7404 direction (a.k.a. its base embedding level). */
7405 if (it
->bidi_it
.new_paragraph
)
7406 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7407 bidi_move_to_visually_next (&it
->bidi_it
);
7408 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7409 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7410 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7412 /* As the scan direction was changed, we must
7413 re-compute the stop position for composition. */
7414 ptrdiff_t stop
= it
->end_charpos
;
7415 if (it
->bidi_it
.scan_dir
< 0)
7417 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7418 IT_BYTEPOS (*it
), stop
, Qnil
);
7421 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7425 case GET_FROM_C_STRING
:
7426 /* Current display element of IT is from a C string. */
7428 /* If the string position is beyond string's end, it means
7429 next_element_from_c_string is padding the string with
7430 blanks, in which case we bypass the bidi iterator,
7431 because it cannot deal with such virtual characters. */
7432 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7434 IT_BYTEPOS (*it
) += it
->len
;
7435 IT_CHARPOS (*it
) += 1;
7439 bidi_move_to_visually_next (&it
->bidi_it
);
7440 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7441 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7445 case GET_FROM_DISPLAY_VECTOR
:
7446 /* Current display element of IT is from a display table entry.
7447 Advance in the display table definition. Reset it to null if
7448 end reached, and continue with characters from buffers/
7450 ++it
->current
.dpvec_index
;
7452 /* Restore face of the iterator to what they were before the
7453 display vector entry (these entries may contain faces). */
7454 it
->face_id
= it
->saved_face_id
;
7456 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7458 int recheck_faces
= it
->ellipsis_p
;
7461 it
->method
= GET_FROM_C_STRING
;
7462 else if (STRINGP (it
->string
))
7463 it
->method
= GET_FROM_STRING
;
7466 it
->method
= GET_FROM_BUFFER
;
7467 it
->object
= it
->w
->contents
;
7471 it
->current
.dpvec_index
= -1;
7473 /* Skip over characters which were displayed via IT->dpvec. */
7474 if (it
->dpvec_char_len
< 0)
7475 reseat_at_next_visible_line_start (it
, 1);
7476 else if (it
->dpvec_char_len
> 0)
7478 if (it
->method
== GET_FROM_STRING
7479 && it
->current
.overlay_string_index
>= 0
7480 && it
->n_overlay_strings
> 0)
7481 it
->ignore_overlay_strings_at_pos_p
= true;
7482 it
->len
= it
->dpvec_char_len
;
7483 set_iterator_to_next (it
, reseat_p
);
7486 /* Maybe recheck faces after display vector. */
7488 it
->stop_charpos
= IT_CHARPOS (*it
);
7492 case GET_FROM_STRING
:
7493 /* Current display element is a character from a Lisp string. */
7494 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7495 /* Don't advance past string end. These conditions are true
7496 when set_iterator_to_next is called at the end of
7497 get_next_display_element, in which case the Lisp string is
7498 already exhausted, and all we want is pop the iterator
7500 if (it
->current
.overlay_string_index
>= 0)
7502 /* This is an overlay string, so there's no padding with
7503 spaces, and the number of characters in the string is
7504 where the string ends. */
7505 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7506 goto consider_string_end
;
7510 /* Not an overlay string. There could be padding, so test
7511 against it->end_charpos. */
7512 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7513 goto consider_string_end
;
7515 if (it
->cmp_it
.id
>= 0)
7521 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7522 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7523 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7524 it
->cmp_it
.from
= it
->cmp_it
.to
;
7528 composition_compute_stop_pos (&it
->cmp_it
,
7529 IT_STRING_CHARPOS (*it
),
7530 IT_STRING_BYTEPOS (*it
),
7531 it
->end_charpos
, it
->string
);
7534 else if (! it
->cmp_it
.reversed_p
)
7536 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7537 bidi_move_to_visually_next (&it
->bidi_it
);
7538 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7539 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7541 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7542 it
->cmp_it
.from
= it
->cmp_it
.to
;
7545 ptrdiff_t stop
= it
->end_charpos
;
7546 if (it
->bidi_it
.scan_dir
< 0)
7548 composition_compute_stop_pos (&it
->cmp_it
,
7549 IT_STRING_CHARPOS (*it
),
7550 IT_STRING_BYTEPOS (*it
), stop
,
7556 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7557 bidi_move_to_visually_next (&it
->bidi_it
);
7558 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7559 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7560 if (it
->cmp_it
.from
> 0)
7561 it
->cmp_it
.to
= it
->cmp_it
.from
;
7564 ptrdiff_t stop
= it
->end_charpos
;
7565 if (it
->bidi_it
.scan_dir
< 0)
7567 composition_compute_stop_pos (&it
->cmp_it
,
7568 IT_STRING_CHARPOS (*it
),
7569 IT_STRING_BYTEPOS (*it
), stop
,
7577 /* If the string position is beyond string's end, it
7578 means next_element_from_string is padding the string
7579 with blanks, in which case we bypass the bidi
7580 iterator, because it cannot deal with such virtual
7582 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7584 IT_STRING_BYTEPOS (*it
) += it
->len
;
7585 IT_STRING_CHARPOS (*it
) += 1;
7589 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7591 bidi_move_to_visually_next (&it
->bidi_it
);
7592 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7593 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7594 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7596 ptrdiff_t stop
= it
->end_charpos
;
7598 if (it
->bidi_it
.scan_dir
< 0)
7600 composition_compute_stop_pos (&it
->cmp_it
,
7601 IT_STRING_CHARPOS (*it
),
7602 IT_STRING_BYTEPOS (*it
), stop
,
7608 consider_string_end
:
7610 if (it
->current
.overlay_string_index
>= 0)
7612 /* IT->string is an overlay string. Advance to the
7613 next, if there is one. */
7614 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7617 next_overlay_string (it
);
7619 setup_for_ellipsis (it
, 0);
7624 /* IT->string is not an overlay string. If we reached
7625 its end, and there is something on IT->stack, proceed
7626 with what is on the stack. This can be either another
7627 string, this time an overlay string, or a buffer. */
7628 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7632 if (it
->method
== GET_FROM_STRING
)
7633 goto consider_string_end
;
7638 case GET_FROM_IMAGE
:
7639 case GET_FROM_STRETCH
:
7640 /* The position etc with which we have to proceed are on
7641 the stack. The position may be at the end of a string,
7642 if the `display' property takes up the whole string. */
7643 eassert (it
->sp
> 0);
7645 if (it
->method
== GET_FROM_STRING
)
7646 goto consider_string_end
;
7650 /* There are no other methods defined, so this should be a bug. */
7654 eassert (it
->method
!= GET_FROM_STRING
7655 || (STRINGP (it
->string
)
7656 && IT_STRING_CHARPOS (*it
) >= 0));
7659 /* Load IT's display element fields with information about the next
7660 display element which comes from a display table entry or from the
7661 result of translating a control character to one of the forms `^C'
7664 IT->dpvec holds the glyphs to return as characters.
7665 IT->saved_face_id holds the face id before the display vector--it
7666 is restored into IT->face_id in set_iterator_to_next. */
7669 next_element_from_display_vector (struct it
*it
)
7672 int prev_face_id
= it
->face_id
;
7676 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7678 it
->face_id
= it
->saved_face_id
;
7680 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7681 That seemed totally bogus - so I changed it... */
7682 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7684 if (GLYPH_CODE_P (gc
))
7686 struct face
*this_face
, *prev_face
, *next_face
;
7688 it
->c
= GLYPH_CODE_CHAR (gc
);
7689 it
->len
= CHAR_BYTES (it
->c
);
7691 /* The entry may contain a face id to use. Such a face id is
7692 the id of a Lisp face, not a realized face. A face id of
7693 zero means no face is specified. */
7694 if (it
->dpvec_face_id
>= 0)
7695 it
->face_id
= it
->dpvec_face_id
;
7698 int lface_id
= GLYPH_CODE_FACE (gc
);
7700 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7704 /* Glyphs in the display vector could have the box face, so we
7705 need to set the related flags in the iterator, as
7707 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7708 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7710 /* Is this character the first character of a box-face run? */
7711 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7713 || prev_face
->box
== FACE_NO_BOX
));
7715 /* For the last character of the box-face run, we need to look
7716 either at the next glyph from the display vector, or at the
7717 face we saw before the display vector. */
7718 next_face_id
= it
->saved_face_id
;
7719 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7721 if (it
->dpvec_face_id
>= 0)
7722 next_face_id
= it
->dpvec_face_id
;
7726 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7729 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7733 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7734 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7736 || next_face
->box
== FACE_NO_BOX
));
7737 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7740 /* Display table entry is invalid. Return a space. */
7741 it
->c
= ' ', it
->len
= 1;
7743 /* Don't change position and object of the iterator here. They are
7744 still the values of the character that had this display table
7745 entry or was translated, and that's what we want. */
7746 it
->what
= IT_CHARACTER
;
7750 /* Get the first element of string/buffer in the visual order, after
7751 being reseated to a new position in a string or a buffer. */
7753 get_visually_first_element (struct it
*it
)
7755 int string_p
= STRINGP (it
->string
) || it
->s
;
7756 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7757 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7759 if (STRINGP (it
->string
))
7761 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7762 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7766 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7767 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7770 if (it
->bidi_it
.charpos
== eob
)
7772 /* Nothing to do, but reset the FIRST_ELT flag, like
7773 bidi_paragraph_init does, because we are not going to
7775 it
->bidi_it
.first_elt
= 0;
7777 else if (it
->bidi_it
.charpos
== bob
7779 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7780 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7782 /* If we are at the beginning of a line/string, we can produce
7783 the next element right away. */
7784 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7785 bidi_move_to_visually_next (&it
->bidi_it
);
7789 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7791 /* We need to prime the bidi iterator starting at the line's or
7792 string's beginning, before we will be able to produce the
7795 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7797 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7798 IT_BYTEPOS (*it
), -1,
7799 &it
->bidi_it
.bytepos
);
7800 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7803 /* Now return to buffer/string position where we were asked
7804 to get the next display element, and produce that. */
7805 bidi_move_to_visually_next (&it
->bidi_it
);
7807 while (it
->bidi_it
.bytepos
!= orig_bytepos
7808 && it
->bidi_it
.charpos
< eob
);
7811 /* Adjust IT's position information to where we ended up. */
7812 if (STRINGP (it
->string
))
7814 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7815 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7819 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7820 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7823 if (STRINGP (it
->string
) || !it
->s
)
7825 ptrdiff_t stop
, charpos
, bytepos
;
7827 if (STRINGP (it
->string
))
7830 stop
= SCHARS (it
->string
);
7831 if (stop
> it
->end_charpos
)
7832 stop
= it
->end_charpos
;
7833 charpos
= IT_STRING_CHARPOS (*it
);
7834 bytepos
= IT_STRING_BYTEPOS (*it
);
7838 stop
= it
->end_charpos
;
7839 charpos
= IT_CHARPOS (*it
);
7840 bytepos
= IT_BYTEPOS (*it
);
7842 if (it
->bidi_it
.scan_dir
< 0)
7844 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7849 /* Load IT with the next display element from Lisp string IT->string.
7850 IT->current.string_pos is the current position within the string.
7851 If IT->current.overlay_string_index >= 0, the Lisp string is an
7855 next_element_from_string (struct it
*it
)
7857 struct text_pos position
;
7859 eassert (STRINGP (it
->string
));
7860 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7861 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7862 position
= it
->current
.string_pos
;
7864 /* With bidi reordering, the character to display might not be the
7865 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7866 that we were reseat()ed to a new string, whose paragraph
7867 direction is not known. */
7868 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7870 get_visually_first_element (it
);
7871 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7874 /* Time to check for invisible text? */
7875 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7877 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7880 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7881 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7883 /* With bidi non-linear iteration, we could find
7884 ourselves far beyond the last computed stop_charpos,
7885 with several other stop positions in between that we
7886 missed. Scan them all now, in buffer's logical
7887 order, until we find and handle the last stop_charpos
7888 that precedes our current position. */
7889 handle_stop_backwards (it
, it
->stop_charpos
);
7890 return GET_NEXT_DISPLAY_ELEMENT (it
);
7896 /* Take note of the stop position we just moved
7897 across, for when we will move back across it. */
7898 it
->prev_stop
= it
->stop_charpos
;
7899 /* If we are at base paragraph embedding level, take
7900 note of the last stop position seen at this
7902 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7903 it
->base_level_stop
= it
->stop_charpos
;
7907 /* Since a handler may have changed IT->method, we must
7909 return GET_NEXT_DISPLAY_ELEMENT (it
);
7913 /* If we are before prev_stop, we may have overstepped
7914 on our way backwards a stop_pos, and if so, we need
7915 to handle that stop_pos. */
7916 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7917 /* We can sometimes back up for reasons that have nothing
7918 to do with bidi reordering. E.g., compositions. The
7919 code below is only needed when we are above the base
7920 embedding level, so test for that explicitly. */
7921 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7923 /* If we lost track of base_level_stop, we have no better
7924 place for handle_stop_backwards to start from than string
7925 beginning. This happens, e.g., when we were reseated to
7926 the previous screenful of text by vertical-motion. */
7927 if (it
->base_level_stop
<= 0
7928 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7929 it
->base_level_stop
= 0;
7930 handle_stop_backwards (it
, it
->base_level_stop
);
7931 return GET_NEXT_DISPLAY_ELEMENT (it
);
7935 if (it
->current
.overlay_string_index
>= 0)
7937 /* Get the next character from an overlay string. In overlay
7938 strings, there is no field width or padding with spaces to
7940 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7945 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7946 IT_STRING_BYTEPOS (*it
),
7947 it
->bidi_it
.scan_dir
< 0
7949 : SCHARS (it
->string
))
7950 && next_element_from_composition (it
))
7954 else if (STRING_MULTIBYTE (it
->string
))
7956 const unsigned char *s
= (SDATA (it
->string
)
7957 + IT_STRING_BYTEPOS (*it
));
7958 it
->c
= string_char_and_length (s
, &it
->len
);
7962 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7968 /* Get the next character from a Lisp string that is not an
7969 overlay string. Such strings come from the mode line, for
7970 example. We may have to pad with spaces, or truncate the
7971 string. See also next_element_from_c_string. */
7972 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7977 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7979 /* Pad with spaces. */
7980 it
->c
= ' ', it
->len
= 1;
7981 CHARPOS (position
) = BYTEPOS (position
) = -1;
7983 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7984 IT_STRING_BYTEPOS (*it
),
7985 it
->bidi_it
.scan_dir
< 0
7987 : it
->string_nchars
)
7988 && next_element_from_composition (it
))
7992 else if (STRING_MULTIBYTE (it
->string
))
7994 const unsigned char *s
= (SDATA (it
->string
)
7995 + IT_STRING_BYTEPOS (*it
));
7996 it
->c
= string_char_and_length (s
, &it
->len
);
8000 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8005 /* Record what we have and where it came from. */
8006 it
->what
= IT_CHARACTER
;
8007 it
->object
= it
->string
;
8008 it
->position
= position
;
8013 /* Load IT with next display element from C string IT->s.
8014 IT->string_nchars is the maximum number of characters to return
8015 from the string. IT->end_charpos may be greater than
8016 IT->string_nchars when this function is called, in which case we
8017 may have to return padding spaces. Value is zero if end of string
8018 reached, including padding spaces. */
8021 next_element_from_c_string (struct it
*it
)
8023 bool success_p
= true;
8026 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8027 it
->what
= IT_CHARACTER
;
8028 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8031 /* With bidi reordering, the character to display might not be the
8032 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8033 we were reseated to a new string, whose paragraph direction is
8035 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8036 get_visually_first_element (it
);
8038 /* IT's position can be greater than IT->string_nchars in case a
8039 field width or precision has been specified when the iterator was
8041 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8043 /* End of the game. */
8047 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8049 /* Pad with spaces. */
8050 it
->c
= ' ', it
->len
= 1;
8051 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8053 else if (it
->multibyte_p
)
8054 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8056 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8062 /* Set up IT to return characters from an ellipsis, if appropriate.
8063 The definition of the ellipsis glyphs may come from a display table
8064 entry. This function fills IT with the first glyph from the
8065 ellipsis if an ellipsis is to be displayed. */
8068 next_element_from_ellipsis (struct it
*it
)
8070 if (it
->selective_display_ellipsis_p
)
8071 setup_for_ellipsis (it
, it
->len
);
8074 /* The face at the current position may be different from the
8075 face we find after the invisible text. Remember what it
8076 was in IT->saved_face_id, and signal that it's there by
8077 setting face_before_selective_p. */
8078 it
->saved_face_id
= it
->face_id
;
8079 it
->method
= GET_FROM_BUFFER
;
8080 it
->object
= it
->w
->contents
;
8081 reseat_at_next_visible_line_start (it
, 1);
8082 it
->face_before_selective_p
= true;
8085 return GET_NEXT_DISPLAY_ELEMENT (it
);
8089 /* Deliver an image display element. The iterator IT is already
8090 filled with image information (done in handle_display_prop). Value
8095 next_element_from_image (struct it
*it
)
8097 it
->what
= IT_IMAGE
;
8098 it
->ignore_overlay_strings_at_pos_p
= 0;
8103 /* Fill iterator IT with next display element from a stretch glyph
8104 property. IT->object is the value of the text property. Value is
8108 next_element_from_stretch (struct it
*it
)
8110 it
->what
= IT_STRETCH
;
8114 /* Scan backwards from IT's current position until we find a stop
8115 position, or until BEGV. This is called when we find ourself
8116 before both the last known prev_stop and base_level_stop while
8117 reordering bidirectional text. */
8120 compute_stop_pos_backwards (struct it
*it
)
8122 const int SCAN_BACK_LIMIT
= 1000;
8123 struct text_pos pos
;
8124 struct display_pos save_current
= it
->current
;
8125 struct text_pos save_position
= it
->position
;
8126 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8127 ptrdiff_t where_we_are
= charpos
;
8128 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8129 ptrdiff_t save_end_pos
= it
->end_charpos
;
8131 eassert (NILP (it
->string
) && !it
->s
);
8132 eassert (it
->bidi_p
);
8136 it
->end_charpos
= min (charpos
+ 1, ZV
);
8137 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8138 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8139 reseat_1 (it
, pos
, 0);
8140 compute_stop_pos (it
);
8141 /* We must advance forward, right? */
8142 if (it
->stop_charpos
<= charpos
)
8145 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8147 if (it
->stop_charpos
<= where_we_are
)
8148 it
->prev_stop
= it
->stop_charpos
;
8150 it
->prev_stop
= BEGV
;
8152 it
->current
= save_current
;
8153 it
->position
= save_position
;
8154 it
->stop_charpos
= save_stop_pos
;
8155 it
->end_charpos
= save_end_pos
;
8158 /* Scan forward from CHARPOS in the current buffer/string, until we
8159 find a stop position > current IT's position. Then handle the stop
8160 position before that. This is called when we bump into a stop
8161 position while reordering bidirectional text. CHARPOS should be
8162 the last previously processed stop_pos (or BEGV/0, if none were
8163 processed yet) whose position is less that IT's current
8167 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8169 int bufp
= !STRINGP (it
->string
);
8170 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8171 struct display_pos save_current
= it
->current
;
8172 struct text_pos save_position
= it
->position
;
8173 struct text_pos pos1
;
8174 ptrdiff_t next_stop
;
8176 /* Scan in strict logical order. */
8177 eassert (it
->bidi_p
);
8181 it
->prev_stop
= charpos
;
8184 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8185 reseat_1 (it
, pos1
, 0);
8188 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8189 compute_stop_pos (it
);
8190 /* We must advance forward, right? */
8191 if (it
->stop_charpos
<= it
->prev_stop
)
8193 charpos
= it
->stop_charpos
;
8195 while (charpos
<= where_we_are
);
8198 it
->current
= save_current
;
8199 it
->position
= save_position
;
8200 next_stop
= it
->stop_charpos
;
8201 it
->stop_charpos
= it
->prev_stop
;
8203 it
->stop_charpos
= next_stop
;
8206 /* Load IT with the next display element from current_buffer. Value
8207 is zero if end of buffer reached. IT->stop_charpos is the next
8208 position at which to stop and check for text properties or buffer
8212 next_element_from_buffer (struct it
*it
)
8214 bool success_p
= true;
8216 eassert (IT_CHARPOS (*it
) >= BEGV
);
8217 eassert (NILP (it
->string
) && !it
->s
);
8218 eassert (!it
->bidi_p
8219 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8220 && it
->bidi_it
.string
.s
== NULL
));
8222 /* With bidi reordering, the character to display might not be the
8223 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8224 we were reseat()ed to a new buffer position, which is potentially
8225 a different paragraph. */
8226 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8228 get_visually_first_element (it
);
8229 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8232 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8234 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8236 int overlay_strings_follow_p
;
8238 /* End of the game, except when overlay strings follow that
8239 haven't been returned yet. */
8240 if (it
->overlay_strings_at_end_processed_p
)
8241 overlay_strings_follow_p
= 0;
8244 it
->overlay_strings_at_end_processed_p
= true;
8245 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8248 if (overlay_strings_follow_p
)
8249 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8253 it
->position
= it
->current
.pos
;
8257 else if (!(!it
->bidi_p
8258 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8259 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8261 /* With bidi non-linear iteration, we could find ourselves
8262 far beyond the last computed stop_charpos, with several
8263 other stop positions in between that we missed. Scan
8264 them all now, in buffer's logical order, until we find
8265 and handle the last stop_charpos that precedes our
8266 current position. */
8267 handle_stop_backwards (it
, it
->stop_charpos
);
8268 return GET_NEXT_DISPLAY_ELEMENT (it
);
8274 /* Take note of the stop position we just moved across,
8275 for when we will move back across it. */
8276 it
->prev_stop
= it
->stop_charpos
;
8277 /* If we are at base paragraph embedding level, take
8278 note of the last stop position seen at this
8280 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8281 it
->base_level_stop
= it
->stop_charpos
;
8284 return GET_NEXT_DISPLAY_ELEMENT (it
);
8288 /* If we are before prev_stop, we may have overstepped on
8289 our way backwards a stop_pos, and if so, we need to
8290 handle that stop_pos. */
8291 && IT_CHARPOS (*it
) < it
->prev_stop
8292 /* We can sometimes back up for reasons that have nothing
8293 to do with bidi reordering. E.g., compositions. The
8294 code below is only needed when we are above the base
8295 embedding level, so test for that explicitly. */
8296 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8298 if (it
->base_level_stop
<= 0
8299 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8301 /* If we lost track of base_level_stop, we need to find
8302 prev_stop by looking backwards. This happens, e.g., when
8303 we were reseated to the previous screenful of text by
8305 it
->base_level_stop
= BEGV
;
8306 compute_stop_pos_backwards (it
);
8307 handle_stop_backwards (it
, it
->prev_stop
);
8310 handle_stop_backwards (it
, it
->base_level_stop
);
8311 return GET_NEXT_DISPLAY_ELEMENT (it
);
8315 /* No face changes, overlays etc. in sight, so just return a
8316 character from current_buffer. */
8320 /* Maybe run the redisplay end trigger hook. Performance note:
8321 This doesn't seem to cost measurable time. */
8322 if (it
->redisplay_end_trigger_charpos
8324 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8325 run_redisplay_end_trigger_hook (it
);
8327 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8328 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8330 && next_element_from_composition (it
))
8335 /* Get the next character, maybe multibyte. */
8336 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8337 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8338 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8340 it
->c
= *p
, it
->len
= 1;
8342 /* Record what we have and where it came from. */
8343 it
->what
= IT_CHARACTER
;
8344 it
->object
= it
->w
->contents
;
8345 it
->position
= it
->current
.pos
;
8347 /* Normally we return the character found above, except when we
8348 really want to return an ellipsis for selective display. */
8353 /* A value of selective > 0 means hide lines indented more
8354 than that number of columns. */
8355 if (it
->selective
> 0
8356 && IT_CHARPOS (*it
) + 1 < ZV
8357 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8358 IT_BYTEPOS (*it
) + 1,
8361 success_p
= next_element_from_ellipsis (it
);
8362 it
->dpvec_char_len
= -1;
8365 else if (it
->c
== '\r' && it
->selective
== -1)
8367 /* A value of selective == -1 means that everything from the
8368 CR to the end of the line is invisible, with maybe an
8369 ellipsis displayed for it. */
8370 success_p
= next_element_from_ellipsis (it
);
8371 it
->dpvec_char_len
= -1;
8376 /* Value is zero if end of buffer reached. */
8377 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8382 /* Run the redisplay end trigger hook for IT. */
8385 run_redisplay_end_trigger_hook (struct it
*it
)
8387 Lisp_Object args
[3];
8389 /* IT->glyph_row should be non-null, i.e. we should be actually
8390 displaying something, or otherwise we should not run the hook. */
8391 eassert (it
->glyph_row
);
8393 /* Set up hook arguments. */
8394 args
[0] = Qredisplay_end_trigger_functions
;
8395 args
[1] = it
->window
;
8396 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8397 it
->redisplay_end_trigger_charpos
= 0;
8399 /* Since we are *trying* to run these functions, don't try to run
8400 them again, even if they get an error. */
8401 wset_redisplay_end_trigger (it
->w
, Qnil
);
8402 Frun_hook_with_args (3, args
);
8404 /* Notice if it changed the face of the character we are on. */
8405 handle_face_prop (it
);
8409 /* Deliver a composition display element. Unlike the other
8410 next_element_from_XXX, this function is not registered in the array
8411 get_next_element[]. It is called from next_element_from_buffer and
8412 next_element_from_string when necessary. */
8415 next_element_from_composition (struct it
*it
)
8417 it
->what
= IT_COMPOSITION
;
8418 it
->len
= it
->cmp_it
.nbytes
;
8419 if (STRINGP (it
->string
))
8423 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8424 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8427 it
->position
= it
->current
.string_pos
;
8428 it
->object
= it
->string
;
8429 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8430 IT_STRING_BYTEPOS (*it
), it
->string
);
8436 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8437 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8440 if (it
->bidi_it
.new_paragraph
)
8441 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8442 /* Resync the bidi iterator with IT's new position.
8443 FIXME: this doesn't support bidirectional text. */
8444 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8445 bidi_move_to_visually_next (&it
->bidi_it
);
8449 it
->position
= it
->current
.pos
;
8450 it
->object
= it
->w
->contents
;
8451 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8452 IT_BYTEPOS (*it
), Qnil
);
8459 /***********************************************************************
8460 Moving an iterator without producing glyphs
8461 ***********************************************************************/
8463 /* Check if iterator is at a position corresponding to a valid buffer
8464 position after some move_it_ call. */
8466 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8467 ((it)->method == GET_FROM_STRING \
8468 ? IT_STRING_CHARPOS (*it) == 0 \
8472 /* Move iterator IT to a specified buffer or X position within one
8473 line on the display without producing glyphs.
8475 OP should be a bit mask including some or all of these bits:
8476 MOVE_TO_X: Stop upon reaching x-position TO_X.
8477 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8478 Regardless of OP's value, stop upon reaching the end of the display line.
8480 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8481 This means, in particular, that TO_X includes window's horizontal
8484 The return value has several possible values that
8485 say what condition caused the scan to stop:
8487 MOVE_POS_MATCH_OR_ZV
8488 - when TO_POS or ZV was reached.
8491 -when TO_X was reached before TO_POS or ZV were reached.
8494 - when we reached the end of the display area and the line must
8498 - when we reached the end of the display area and the line is
8502 - when we stopped at a line end, i.e. a newline or a CR and selective
8505 static enum move_it_result
8506 move_it_in_display_line_to (struct it
*it
,
8507 ptrdiff_t to_charpos
, int to_x
,
8508 enum move_operation_enum op
)
8510 enum move_it_result result
= MOVE_UNDEFINED
;
8511 struct glyph_row
*saved_glyph_row
;
8512 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8513 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8514 void *ppos_data
= NULL
;
8516 enum it_method prev_method
= it
->method
;
8517 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8518 int saw_smaller_pos
= prev_pos
< to_charpos
;
8520 /* Don't produce glyphs in produce_glyphs. */
8521 saved_glyph_row
= it
->glyph_row
;
8522 it
->glyph_row
= NULL
;
8524 /* Use wrap_it to save a copy of IT wherever a word wrap could
8525 occur. Use atpos_it to save a copy of IT at the desired buffer
8526 position, if found, so that we can scan ahead and check if the
8527 word later overshoots the window edge. Use atx_it similarly, for
8533 /* Use ppos_it under bidi reordering to save a copy of IT for the
8534 initial position. We restore that position in IT when we have
8535 scanned the entire display line without finding a match for
8536 TO_CHARPOS and all the character positions are greater than
8537 TO_CHARPOS. We then restart the scan from the initial position,
8538 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8539 the closest to TO_CHARPOS. */
8542 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8544 SAVE_IT (ppos_it
, *it
, ppos_data
);
8545 closest_pos
= IT_CHARPOS (*it
);
8551 #define BUFFER_POS_REACHED_P() \
8552 ((op & MOVE_TO_POS) != 0 \
8553 && BUFFERP (it->object) \
8554 && (IT_CHARPOS (*it) == to_charpos \
8556 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8557 && IT_CHARPOS (*it) > to_charpos) \
8558 || (it->what == IT_COMPOSITION \
8559 && ((IT_CHARPOS (*it) > to_charpos \
8560 && to_charpos >= it->cmp_it.charpos) \
8561 || (IT_CHARPOS (*it) < to_charpos \
8562 && to_charpos <= it->cmp_it.charpos)))) \
8563 && (it->method == GET_FROM_BUFFER \
8564 || (it->method == GET_FROM_DISPLAY_VECTOR \
8565 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8567 /* If there's a line-/wrap-prefix, handle it. */
8568 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8569 && it
->current_y
< it
->last_visible_y
)
8570 handle_line_prefix (it
);
8572 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8573 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8577 int x
, i
, ascent
= 0, descent
= 0;
8579 /* Utility macro to reset an iterator with x, ascent, and descent. */
8580 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8581 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8582 (IT)->max_descent = descent)
8584 /* Stop if we move beyond TO_CHARPOS (after an image or a
8585 display string or stretch glyph). */
8586 if ((op
& MOVE_TO_POS
) != 0
8587 && BUFFERP (it
->object
)
8588 && it
->method
== GET_FROM_BUFFER
8590 /* When the iterator is at base embedding level, we
8591 are guaranteed that characters are delivered for
8592 display in strictly increasing order of their
8593 buffer positions. */
8594 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8595 && IT_CHARPOS (*it
) > to_charpos
)
8597 && (prev_method
== GET_FROM_IMAGE
8598 || prev_method
== GET_FROM_STRETCH
8599 || prev_method
== GET_FROM_STRING
)
8600 /* Passed TO_CHARPOS from left to right. */
8601 && ((prev_pos
< to_charpos
8602 && IT_CHARPOS (*it
) > to_charpos
)
8603 /* Passed TO_CHARPOS from right to left. */
8604 || (prev_pos
> to_charpos
8605 && IT_CHARPOS (*it
) < to_charpos
)))))
8607 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8609 result
= MOVE_POS_MATCH_OR_ZV
;
8612 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8613 /* If wrap_it is valid, the current position might be in a
8614 word that is wrapped. So, save the iterator in
8615 atpos_it and continue to see if wrapping happens. */
8616 SAVE_IT (atpos_it
, *it
, atpos_data
);
8619 /* Stop when ZV reached.
8620 We used to stop here when TO_CHARPOS reached as well, but that is
8621 too soon if this glyph does not fit on this line. So we handle it
8622 explicitly below. */
8623 if (!get_next_display_element (it
))
8625 result
= MOVE_POS_MATCH_OR_ZV
;
8629 if (it
->line_wrap
== TRUNCATE
)
8631 if (BUFFER_POS_REACHED_P ())
8633 result
= MOVE_POS_MATCH_OR_ZV
;
8639 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8641 if (IT_DISPLAYING_WHITESPACE (it
))
8645 /* We have reached a glyph that follows one or more
8646 whitespace characters. If the position is
8647 already found, we are done. */
8648 if (atpos_it
.sp
>= 0)
8650 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8651 result
= MOVE_POS_MATCH_OR_ZV
;
8656 RESTORE_IT (it
, &atx_it
, atx_data
);
8657 result
= MOVE_X_REACHED
;
8660 /* Otherwise, we can wrap here. */
8661 SAVE_IT (wrap_it
, *it
, wrap_data
);
8667 /* Remember the line height for the current line, in case
8668 the next element doesn't fit on the line. */
8669 ascent
= it
->max_ascent
;
8670 descent
= it
->max_descent
;
8672 /* The call to produce_glyphs will get the metrics of the
8673 display element IT is loaded with. Record the x-position
8674 before this display element, in case it doesn't fit on the
8678 PRODUCE_GLYPHS (it
);
8680 if (it
->area
!= TEXT_AREA
)
8682 prev_method
= it
->method
;
8683 if (it
->method
== GET_FROM_BUFFER
)
8684 prev_pos
= IT_CHARPOS (*it
);
8685 set_iterator_to_next (it
, 1);
8686 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8687 SET_TEXT_POS (this_line_min_pos
,
8688 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8690 && (op
& MOVE_TO_POS
)
8691 && IT_CHARPOS (*it
) > to_charpos
8692 && IT_CHARPOS (*it
) < closest_pos
)
8693 closest_pos
= IT_CHARPOS (*it
);
8697 /* The number of glyphs we get back in IT->nglyphs will normally
8698 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8699 character on a terminal frame, or (iii) a line end. For the
8700 second case, IT->nglyphs - 1 padding glyphs will be present.
8701 (On X frames, there is only one glyph produced for a
8702 composite character.)
8704 The behavior implemented below means, for continuation lines,
8705 that as many spaces of a TAB as fit on the current line are
8706 displayed there. For terminal frames, as many glyphs of a
8707 multi-glyph character are displayed in the current line, too.
8708 This is what the old redisplay code did, and we keep it that
8709 way. Under X, the whole shape of a complex character must
8710 fit on the line or it will be completely displayed in the
8713 Note that both for tabs and padding glyphs, all glyphs have
8717 /* More than one glyph or glyph doesn't fit on line. All
8718 glyphs have the same width. */
8719 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8721 int x_before_this_char
= x
;
8722 int hpos_before_this_char
= it
->hpos
;
8724 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8726 new_x
= x
+ single_glyph_width
;
8728 /* We want to leave anything reaching TO_X to the caller. */
8729 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8731 if (BUFFER_POS_REACHED_P ())
8733 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8734 goto buffer_pos_reached
;
8735 if (atpos_it
.sp
< 0)
8737 SAVE_IT (atpos_it
, *it
, atpos_data
);
8738 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8743 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8746 result
= MOVE_X_REACHED
;
8751 SAVE_IT (atx_it
, *it
, atx_data
);
8752 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8757 if (/* Lines are continued. */
8758 it
->line_wrap
!= TRUNCATE
8759 && (/* And glyph doesn't fit on the line. */
8760 new_x
> it
->last_visible_x
8761 /* Or it fits exactly and we're on a window
8763 || (new_x
== it
->last_visible_x
8764 && FRAME_WINDOW_P (it
->f
)
8765 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8766 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8767 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8769 if (/* IT->hpos == 0 means the very first glyph
8770 doesn't fit on the line, e.g. a wide image. */
8772 || (new_x
== it
->last_visible_x
8773 && FRAME_WINDOW_P (it
->f
)
8774 /* When word-wrap is ON and we have a valid
8775 wrap point, we don't allow the last glyph
8776 to "just barely fit" on the line. */
8777 && (it
->line_wrap
!= WORD_WRAP
8778 || wrap_it
.sp
< 0)))
8781 it
->current_x
= new_x
;
8783 /* The character's last glyph just barely fits
8785 if (i
== it
->nglyphs
- 1)
8787 /* If this is the destination position,
8788 return a position *before* it in this row,
8789 now that we know it fits in this row. */
8790 if (BUFFER_POS_REACHED_P ())
8792 if (it
->line_wrap
!= WORD_WRAP
8795 it
->hpos
= hpos_before_this_char
;
8796 it
->current_x
= x_before_this_char
;
8797 result
= MOVE_POS_MATCH_OR_ZV
;
8800 if (it
->line_wrap
== WORD_WRAP
8803 SAVE_IT (atpos_it
, *it
, atpos_data
);
8804 atpos_it
.current_x
= x_before_this_char
;
8805 atpos_it
.hpos
= hpos_before_this_char
;
8809 prev_method
= it
->method
;
8810 if (it
->method
== GET_FROM_BUFFER
)
8811 prev_pos
= IT_CHARPOS (*it
);
8812 set_iterator_to_next (it
, 1);
8813 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8814 SET_TEXT_POS (this_line_min_pos
,
8815 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8816 /* On graphical terminals, newlines may
8817 "overflow" into the fringe if
8818 overflow-newline-into-fringe is non-nil.
8819 On text terminals, and on graphical
8820 terminals with no right margin, newlines
8821 may overflow into the last glyph on the
8823 if (!FRAME_WINDOW_P (it
->f
)
8825 && it
->bidi_it
.paragraph_dir
== R2L
)
8826 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8827 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8828 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8830 if (!get_next_display_element (it
))
8832 result
= MOVE_POS_MATCH_OR_ZV
;
8835 if (BUFFER_POS_REACHED_P ())
8837 if (ITERATOR_AT_END_OF_LINE_P (it
))
8838 result
= MOVE_POS_MATCH_OR_ZV
;
8840 result
= MOVE_LINE_CONTINUED
;
8843 if (ITERATOR_AT_END_OF_LINE_P (it
)
8844 && (it
->line_wrap
!= WORD_WRAP
8847 result
= MOVE_NEWLINE_OR_CR
;
8854 IT_RESET_X_ASCENT_DESCENT (it
);
8856 if (wrap_it
.sp
>= 0)
8858 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8863 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8865 result
= MOVE_LINE_CONTINUED
;
8869 if (BUFFER_POS_REACHED_P ())
8871 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8872 goto buffer_pos_reached
;
8873 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8875 SAVE_IT (atpos_it
, *it
, atpos_data
);
8876 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8880 if (new_x
> it
->first_visible_x
)
8882 /* Glyph is visible. Increment number of glyphs that
8883 would be displayed. */
8888 if (result
!= MOVE_UNDEFINED
)
8891 else if (BUFFER_POS_REACHED_P ())
8894 IT_RESET_X_ASCENT_DESCENT (it
);
8895 result
= MOVE_POS_MATCH_OR_ZV
;
8898 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8900 /* Stop when TO_X specified and reached. This check is
8901 necessary here because of lines consisting of a line end,
8902 only. The line end will not produce any glyphs and we
8903 would never get MOVE_X_REACHED. */
8904 eassert (it
->nglyphs
== 0);
8905 result
= MOVE_X_REACHED
;
8909 /* Is this a line end? If yes, we're done. */
8910 if (ITERATOR_AT_END_OF_LINE_P (it
))
8912 /* If we are past TO_CHARPOS, but never saw any character
8913 positions smaller than TO_CHARPOS, return
8914 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8916 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8918 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8920 if (closest_pos
< ZV
)
8922 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8923 /* Don't recurse if closest_pos is equal to
8924 to_charpos, since we have just tried that. */
8925 if (closest_pos
!= to_charpos
)
8926 move_it_in_display_line_to (it
, closest_pos
, -1,
8928 result
= MOVE_POS_MATCH_OR_ZV
;
8931 goto buffer_pos_reached
;
8933 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8934 && IT_CHARPOS (*it
) > to_charpos
)
8935 goto buffer_pos_reached
;
8937 result
= MOVE_NEWLINE_OR_CR
;
8940 result
= MOVE_NEWLINE_OR_CR
;
8944 prev_method
= it
->method
;
8945 if (it
->method
== GET_FROM_BUFFER
)
8946 prev_pos
= IT_CHARPOS (*it
);
8947 /* The current display element has been consumed. Advance
8949 set_iterator_to_next (it
, 1);
8950 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8951 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8952 if (IT_CHARPOS (*it
) < to_charpos
)
8953 saw_smaller_pos
= 1;
8955 && (op
& MOVE_TO_POS
)
8956 && IT_CHARPOS (*it
) >= to_charpos
8957 && IT_CHARPOS (*it
) < closest_pos
)
8958 closest_pos
= IT_CHARPOS (*it
);
8960 /* Stop if lines are truncated and IT's current x-position is
8961 past the right edge of the window now. */
8962 if (it
->line_wrap
== TRUNCATE
8963 && it
->current_x
>= it
->last_visible_x
)
8965 if (!FRAME_WINDOW_P (it
->f
)
8966 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8967 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8968 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8969 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8973 if ((at_eob_p
= !get_next_display_element (it
))
8974 || BUFFER_POS_REACHED_P ()
8975 /* If we are past TO_CHARPOS, but never saw any
8976 character positions smaller than TO_CHARPOS,
8977 return MOVE_POS_MATCH_OR_ZV, like the
8978 unidirectional display did. */
8979 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8981 && IT_CHARPOS (*it
) > to_charpos
))
8984 && !BUFFER_POS_REACHED_P ()
8985 && !at_eob_p
&& closest_pos
< ZV
)
8987 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8988 if (closest_pos
!= to_charpos
)
8989 move_it_in_display_line_to (it
, closest_pos
, -1,
8992 result
= MOVE_POS_MATCH_OR_ZV
;
8995 if (ITERATOR_AT_END_OF_LINE_P (it
))
8997 result
= MOVE_NEWLINE_OR_CR
;
9001 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9003 && IT_CHARPOS (*it
) > to_charpos
)
9005 if (closest_pos
< ZV
)
9007 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9008 if (closest_pos
!= to_charpos
)
9009 move_it_in_display_line_to (it
, closest_pos
, -1,
9012 result
= MOVE_POS_MATCH_OR_ZV
;
9015 result
= MOVE_LINE_TRUNCATED
;
9018 #undef IT_RESET_X_ASCENT_DESCENT
9021 #undef BUFFER_POS_REACHED_P
9023 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9024 restore the saved iterator. */
9025 if (atpos_it
.sp
>= 0)
9026 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9027 else if (atx_it
.sp
>= 0)
9028 RESTORE_IT (it
, &atx_it
, atx_data
);
9033 bidi_unshelve_cache (atpos_data
, 1);
9035 bidi_unshelve_cache (atx_data
, 1);
9037 bidi_unshelve_cache (wrap_data
, 1);
9039 bidi_unshelve_cache (ppos_data
, 1);
9041 /* Restore the iterator settings altered at the beginning of this
9043 it
->glyph_row
= saved_glyph_row
;
9047 /* For external use. */
9049 move_it_in_display_line (struct it
*it
,
9050 ptrdiff_t to_charpos
, int to_x
,
9051 enum move_operation_enum op
)
9053 if (it
->line_wrap
== WORD_WRAP
9054 && (op
& MOVE_TO_X
))
9057 void *save_data
= NULL
;
9060 SAVE_IT (save_it
, *it
, save_data
);
9061 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9062 /* When word-wrap is on, TO_X may lie past the end
9063 of a wrapped line. Then it->current is the
9064 character on the next line, so backtrack to the
9065 space before the wrap point. */
9066 if (skip
== MOVE_LINE_CONTINUED
)
9068 int prev_x
= max (it
->current_x
- 1, 0);
9069 RESTORE_IT (it
, &save_it
, save_data
);
9070 move_it_in_display_line_to
9071 (it
, -1, prev_x
, MOVE_TO_X
);
9074 bidi_unshelve_cache (save_data
, 1);
9077 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9081 /* Move IT forward until it satisfies one or more of the criteria in
9082 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9084 OP is a bit-mask that specifies where to stop, and in particular,
9085 which of those four position arguments makes a difference. See the
9086 description of enum move_operation_enum.
9088 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9089 screen line, this function will set IT to the next position that is
9090 displayed to the right of TO_CHARPOS on the screen.
9092 Return the maximum pixel length of any line scanned but never more
9093 than it.last_visible_x. */
9096 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9098 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9099 int line_height
, line_start_x
= 0, reached
= 0;
9100 int max_current_x
= 0;
9101 void *backup_data
= NULL
;
9105 if (op
& MOVE_TO_VPOS
)
9107 /* If no TO_CHARPOS and no TO_X specified, stop at the
9108 start of the line TO_VPOS. */
9109 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9111 if (it
->vpos
== to_vpos
)
9117 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9121 /* TO_VPOS >= 0 means stop at TO_X in the line at
9122 TO_VPOS, or at TO_POS, whichever comes first. */
9123 if (it
->vpos
== to_vpos
)
9129 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9131 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9136 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9138 /* We have reached TO_X but not in the line we want. */
9139 skip
= move_it_in_display_line_to (it
, to_charpos
,
9141 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9149 else if (op
& MOVE_TO_Y
)
9151 struct it it_backup
;
9153 if (it
->line_wrap
== WORD_WRAP
)
9154 SAVE_IT (it_backup
, *it
, backup_data
);
9156 /* TO_Y specified means stop at TO_X in the line containing
9157 TO_Y---or at TO_CHARPOS if this is reached first. The
9158 problem is that we can't really tell whether the line
9159 contains TO_Y before we have completely scanned it, and
9160 this may skip past TO_X. What we do is to first scan to
9163 If TO_X is not specified, use a TO_X of zero. The reason
9164 is to make the outcome of this function more predictable.
9165 If we didn't use TO_X == 0, we would stop at the end of
9166 the line which is probably not what a caller would expect
9168 skip
= move_it_in_display_line_to
9169 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9170 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9172 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9173 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9175 else if (skip
== MOVE_X_REACHED
)
9177 /* If TO_X was reached, we want to know whether TO_Y is
9178 in the line. We know this is the case if the already
9179 scanned glyphs make the line tall enough. Otherwise,
9180 we must check by scanning the rest of the line. */
9181 line_height
= it
->max_ascent
+ it
->max_descent
;
9182 if (to_y
>= it
->current_y
9183 && to_y
< it
->current_y
+ line_height
)
9188 SAVE_IT (it_backup
, *it
, backup_data
);
9189 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9190 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9192 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9193 line_height
= it
->max_ascent
+ it
->max_descent
;
9194 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9196 if (to_y
>= it
->current_y
9197 && to_y
< it
->current_y
+ line_height
)
9199 /* If TO_Y is in this line and TO_X was reached
9200 above, we scanned too far. We have to restore
9201 IT's settings to the ones before skipping. But
9202 keep the more accurate values of max_ascent and
9203 max_descent we've found while skipping the rest
9204 of the line, for the sake of callers, such as
9205 pos_visible_p, that need to know the line
9207 int max_ascent
= it
->max_ascent
;
9208 int max_descent
= it
->max_descent
;
9210 RESTORE_IT (it
, &it_backup
, backup_data
);
9211 it
->max_ascent
= max_ascent
;
9212 it
->max_descent
= max_descent
;
9218 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9224 /* Check whether TO_Y is in this line. */
9225 line_height
= it
->max_ascent
+ it
->max_descent
;
9226 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9228 if (to_y
>= it
->current_y
9229 && to_y
< it
->current_y
+ line_height
)
9231 if (to_y
> it
->current_y
)
9232 max_current_x
= max (it
->current_x
, max_current_x
);
9234 /* When word-wrap is on, TO_X may lie past the end
9235 of a wrapped line. Then it->current is the
9236 character on the next line, so backtrack to the
9237 space before the wrap point. */
9238 if (skip
== MOVE_LINE_CONTINUED
9239 && it
->line_wrap
== WORD_WRAP
)
9241 int prev_x
= max (it
->current_x
- 1, 0);
9242 RESTORE_IT (it
, &it_backup
, backup_data
);
9243 skip
= move_it_in_display_line_to
9244 (it
, -1, prev_x
, MOVE_TO_X
);
9253 max_current_x
= max (it
->current_x
, max_current_x
);
9257 else if (BUFFERP (it
->object
)
9258 && (it
->method
== GET_FROM_BUFFER
9259 || it
->method
== GET_FROM_STRETCH
)
9260 && IT_CHARPOS (*it
) >= to_charpos
9261 /* Under bidi iteration, a call to set_iterator_to_next
9262 can scan far beyond to_charpos if the initial
9263 portion of the next line needs to be reordered. In
9264 that case, give move_it_in_display_line_to another
9267 && it
->bidi_it
.scan_dir
== -1))
9268 skip
= MOVE_POS_MATCH_OR_ZV
;
9270 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9274 case MOVE_POS_MATCH_OR_ZV
:
9275 max_current_x
= max (it
->current_x
, max_current_x
);
9279 case MOVE_NEWLINE_OR_CR
:
9280 max_current_x
= max (it
->current_x
, max_current_x
);
9281 set_iterator_to_next (it
, 1);
9282 it
->continuation_lines_width
= 0;
9285 case MOVE_LINE_TRUNCATED
:
9286 max_current_x
= it
->last_visible_x
;
9287 it
->continuation_lines_width
= 0;
9288 reseat_at_next_visible_line_start (it
, 0);
9289 if ((op
& MOVE_TO_POS
) != 0
9290 && IT_CHARPOS (*it
) > to_charpos
)
9297 case MOVE_LINE_CONTINUED
:
9298 max_current_x
= it
->last_visible_x
;
9299 /* For continued lines ending in a tab, some of the glyphs
9300 associated with the tab are displayed on the current
9301 line. Since it->current_x does not include these glyphs,
9302 we use it->last_visible_x instead. */
9305 it
->continuation_lines_width
+= it
->last_visible_x
;
9306 /* When moving by vpos, ensure that the iterator really
9307 advances to the next line (bug#847, bug#969). Fixme:
9308 do we need to do this in other circumstances? */
9309 if (it
->current_x
!= it
->last_visible_x
9310 && (op
& MOVE_TO_VPOS
)
9311 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9313 line_start_x
= it
->current_x
+ it
->pixel_width
9314 - it
->last_visible_x
;
9315 if (FRAME_WINDOW_P (it
->f
))
9317 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9318 struct font
*face_font
= face
->font
;
9320 /* When display_line produces a continued line
9321 that ends in a TAB, it skips a tab stop that
9322 is closer than the font's space character
9323 width (see x_produce_glyphs where it produces
9324 the stretch glyph which represents a TAB).
9325 We need to reproduce the same logic here. */
9326 eassert (face_font
);
9329 if (line_start_x
< face_font
->space_width
)
9331 += it
->tab_width
* face_font
->space_width
;
9334 set_iterator_to_next (it
, 0);
9338 it
->continuation_lines_width
+= it
->current_x
;
9345 /* Reset/increment for the next run. */
9346 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9347 it
->current_x
= line_start_x
;
9350 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9352 last_height
= it
->max_ascent
+ it
->max_descent
;
9353 it
->max_ascent
= it
->max_descent
= 0;
9358 /* On text terminals, we may stop at the end of a line in the middle
9359 of a multi-character glyph. If the glyph itself is continued,
9360 i.e. it is actually displayed on the next line, don't treat this
9361 stopping point as valid; move to the next line instead (unless
9362 that brings us offscreen). */
9363 if (!FRAME_WINDOW_P (it
->f
)
9365 && IT_CHARPOS (*it
) == to_charpos
9366 && it
->what
== IT_CHARACTER
9368 && it
->line_wrap
== WINDOW_WRAP
9369 && it
->current_x
== it
->last_visible_x
- 1
9372 && it
->vpos
< it
->w
->window_end_vpos
)
9374 it
->continuation_lines_width
+= it
->current_x
;
9375 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9376 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9378 last_height
= it
->max_ascent
+ it
->max_descent
;
9382 bidi_unshelve_cache (backup_data
, 1);
9384 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9386 return max_current_x
;
9390 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9392 If DY > 0, move IT backward at least that many pixels. DY = 0
9393 means move IT backward to the preceding line start or BEGV. This
9394 function may move over more than DY pixels if IT->current_y - DY
9395 ends up in the middle of a line; in this case IT->current_y will be
9396 set to the top of the line moved to. */
9399 move_it_vertically_backward (struct it
*it
, int dy
)
9403 void *it2data
= NULL
, *it3data
= NULL
;
9404 ptrdiff_t start_pos
;
9406 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9407 ptrdiff_t pos_limit
;
9412 start_pos
= IT_CHARPOS (*it
);
9414 /* Estimate how many newlines we must move back. */
9415 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9416 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9419 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9421 /* Set the iterator's position that many lines back. But don't go
9422 back more than NLINES full screen lines -- this wins a day with
9423 buffers which have very long lines. */
9424 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9425 back_to_previous_visible_line_start (it
);
9427 /* Reseat the iterator here. When moving backward, we don't want
9428 reseat to skip forward over invisible text, set up the iterator
9429 to deliver from overlay strings at the new position etc. So,
9430 use reseat_1 here. */
9431 reseat_1 (it
, it
->current
.pos
, 1);
9433 /* We are now surely at a line start. */
9434 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9435 reordering is in effect. */
9436 it
->continuation_lines_width
= 0;
9438 /* Move forward and see what y-distance we moved. First move to the
9439 start of the next line so that we get its height. We need this
9440 height to be able to tell whether we reached the specified
9442 SAVE_IT (it2
, *it
, it2data
);
9443 it2
.max_ascent
= it2
.max_descent
= 0;
9446 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9447 MOVE_TO_POS
| MOVE_TO_VPOS
);
9449 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9450 /* If we are in a display string which starts at START_POS,
9451 and that display string includes a newline, and we are
9452 right after that newline (i.e. at the beginning of a
9453 display line), exit the loop, because otherwise we will
9454 infloop, since move_it_to will see that it is already at
9455 START_POS and will not move. */
9456 || (it2
.method
== GET_FROM_STRING
9457 && IT_CHARPOS (it2
) == start_pos
9458 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9459 eassert (IT_CHARPOS (*it
) >= BEGV
);
9460 SAVE_IT (it3
, it2
, it3data
);
9462 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9463 eassert (IT_CHARPOS (*it
) >= BEGV
);
9464 /* H is the actual vertical distance from the position in *IT
9465 and the starting position. */
9466 h
= it2
.current_y
- it
->current_y
;
9467 /* NLINES is the distance in number of lines. */
9468 nlines
= it2
.vpos
- it
->vpos
;
9470 /* Correct IT's y and vpos position
9471 so that they are relative to the starting point. */
9477 /* DY == 0 means move to the start of the screen line. The
9478 value of nlines is > 0 if continuation lines were involved,
9479 or if the original IT position was at start of a line. */
9480 RESTORE_IT (it
, it
, it2data
);
9482 move_it_by_lines (it
, nlines
);
9483 /* The above code moves us to some position NLINES down,
9484 usually to its first glyph (leftmost in an L2R line), but
9485 that's not necessarily the start of the line, under bidi
9486 reordering. We want to get to the character position
9487 that is immediately after the newline of the previous
9490 && !it
->continuation_lines_width
9491 && !STRINGP (it
->string
)
9492 && IT_CHARPOS (*it
) > BEGV
9493 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9495 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9498 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9499 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9501 bidi_unshelve_cache (it3data
, 1);
9505 /* The y-position we try to reach, relative to *IT.
9506 Note that H has been subtracted in front of the if-statement. */
9507 int target_y
= it
->current_y
+ h
- dy
;
9508 int y0
= it3
.current_y
;
9512 RESTORE_IT (&it3
, &it3
, it3data
);
9513 y1
= line_bottom_y (&it3
);
9514 line_height
= y1
- y0
;
9515 RESTORE_IT (it
, it
, it2data
);
9516 /* If we did not reach target_y, try to move further backward if
9517 we can. If we moved too far backward, try to move forward. */
9518 if (target_y
< it
->current_y
9519 /* This is heuristic. In a window that's 3 lines high, with
9520 a line height of 13 pixels each, recentering with point
9521 on the bottom line will try to move -39/2 = 19 pixels
9522 backward. Try to avoid moving into the first line. */
9523 && (it
->current_y
- target_y
9524 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9525 && IT_CHARPOS (*it
) > BEGV
)
9527 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9528 target_y
- it
->current_y
));
9529 dy
= it
->current_y
- target_y
;
9530 goto move_further_back
;
9532 else if (target_y
>= it
->current_y
+ line_height
9533 && IT_CHARPOS (*it
) < ZV
)
9535 /* Should move forward by at least one line, maybe more.
9537 Note: Calling move_it_by_lines can be expensive on
9538 terminal frames, where compute_motion is used (via
9539 vmotion) to do the job, when there are very long lines
9540 and truncate-lines is nil. That's the reason for
9541 treating terminal frames specially here. */
9543 if (!FRAME_WINDOW_P (it
->f
))
9544 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9549 move_it_by_lines (it
, 1);
9551 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9558 /* Move IT by a specified amount of pixel lines DY. DY negative means
9559 move backwards. DY = 0 means move to start of screen line. At the
9560 end, IT will be on the start of a screen line. */
9563 move_it_vertically (struct it
*it
, int dy
)
9566 move_it_vertically_backward (it
, -dy
);
9569 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9570 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9571 MOVE_TO_POS
| MOVE_TO_Y
);
9572 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9574 /* If buffer ends in ZV without a newline, move to the start of
9575 the line to satisfy the post-condition. */
9576 if (IT_CHARPOS (*it
) == ZV
9578 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9579 move_it_by_lines (it
, 0);
9584 /* Move iterator IT past the end of the text line it is in. */
9587 move_it_past_eol (struct it
*it
)
9589 enum move_it_result rc
;
9591 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9592 if (rc
== MOVE_NEWLINE_OR_CR
)
9593 set_iterator_to_next (it
, 0);
9597 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9598 negative means move up. DVPOS == 0 means move to the start of the
9601 Optimization idea: If we would know that IT->f doesn't use
9602 a face with proportional font, we could be faster for
9603 truncate-lines nil. */
9606 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9609 /* The commented-out optimization uses vmotion on terminals. This
9610 gives bad results, because elements like it->what, on which
9611 callers such as pos_visible_p rely, aren't updated. */
9612 /* struct position pos;
9613 if (!FRAME_WINDOW_P (it->f))
9615 struct text_pos textpos;
9617 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9618 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9619 reseat (it, textpos, 1);
9620 it->vpos += pos.vpos;
9621 it->current_y += pos.vpos;
9627 /* DVPOS == 0 means move to the start of the screen line. */
9628 move_it_vertically_backward (it
, 0);
9629 /* Let next call to line_bottom_y calculate real line height. */
9634 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9635 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9637 /* Only move to the next buffer position if we ended up in a
9638 string from display property, not in an overlay string
9639 (before-string or after-string). That is because the
9640 latter don't conceal the underlying buffer position, so
9641 we can ask to move the iterator to the exact position we
9642 are interested in. Note that, even if we are already at
9643 IT_CHARPOS (*it), the call below is not a no-op, as it
9644 will detect that we are at the end of the string, pop the
9645 iterator, and compute it->current_x and it->hpos
9647 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9648 -1, -1, -1, MOVE_TO_POS
);
9654 void *it2data
= NULL
;
9655 ptrdiff_t start_charpos
, i
;
9657 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9658 bool hit_pos_limit
= false;
9659 ptrdiff_t pos_limit
;
9661 /* Start at the beginning of the screen line containing IT's
9662 position. This may actually move vertically backwards,
9663 in case of overlays, so adjust dvpos accordingly. */
9665 move_it_vertically_backward (it
, 0);
9668 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9669 screen lines, and reseat the iterator there. */
9670 start_charpos
= IT_CHARPOS (*it
);
9671 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9674 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9676 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9677 back_to_previous_visible_line_start (it
);
9678 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9679 hit_pos_limit
= true;
9680 reseat (it
, it
->current
.pos
, 1);
9682 /* Move further back if we end up in a string or an image. */
9683 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9685 /* First try to move to start of display line. */
9687 move_it_vertically_backward (it
, 0);
9689 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9691 /* If start of line is still in string or image,
9692 move further back. */
9693 back_to_previous_visible_line_start (it
);
9694 reseat (it
, it
->current
.pos
, 1);
9698 it
->current_x
= it
->hpos
= 0;
9700 /* Above call may have moved too far if continuation lines
9701 are involved. Scan forward and see if it did. */
9702 SAVE_IT (it2
, *it
, it2data
);
9703 it2
.vpos
= it2
.current_y
= 0;
9704 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9705 it
->vpos
-= it2
.vpos
;
9706 it
->current_y
-= it2
.current_y
;
9707 it
->current_x
= it
->hpos
= 0;
9709 /* If we moved too far back, move IT some lines forward. */
9710 if (it2
.vpos
> -dvpos
)
9712 int delta
= it2
.vpos
+ dvpos
;
9714 RESTORE_IT (&it2
, &it2
, it2data
);
9715 SAVE_IT (it2
, *it
, it2data
);
9716 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9717 /* Move back again if we got too far ahead. */
9718 if (IT_CHARPOS (*it
) >= start_charpos
)
9719 RESTORE_IT (it
, &it2
, it2data
);
9721 bidi_unshelve_cache (it2data
, 1);
9723 else if (hit_pos_limit
&& pos_limit
> BEGV
9724 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9726 /* If we hit the limit, but still didn't make it far enough
9727 back, that means there's a display string with a newline
9728 covering a large chunk of text, and that caused
9729 back_to_previous_visible_line_start try to go too far.
9730 Punish those who commit such atrocities by going back
9731 until we've reached DVPOS, after lifting the limit, which
9732 could make it slow for very long lines. "If it hurts,
9735 RESTORE_IT (it
, it
, it2data
);
9736 for (i
= -dvpos
; i
> 0; --i
)
9738 back_to_previous_visible_line_start (it
);
9743 RESTORE_IT (it
, it
, it2data
);
9747 /* Return true if IT points into the middle of a display vector. */
9750 in_display_vector_p (struct it
*it
)
9752 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9753 && it
->current
.dpvec_index
> 0
9754 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9757 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9758 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9759 WINDOW must be a live window and defaults to the selected one. The
9760 return value is a cons of the maximum pixel-width of any text line and
9761 the maximum pixel-height of all text lines.
9763 The optional argument FROM, if non-nil, specifies the first text
9764 position and defaults to the minimum accessible position of the buffer.
9765 If FROM is t, use the minimum accessible position that is not a newline
9766 character. TO, if non-nil, specifies the last text position and
9767 defaults to the maximum accessible position of the buffer. If TO is t,
9768 use the maximum accessible position that is not a newline character.
9770 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9771 width that can be returned. X-LIMIT nil or omitted, means to use the
9772 pixel-width of WINDOW's body; use this if you do not intend to change
9773 the width of WINDOW. Use the maximum width WINDOW may assume if you
9774 intend to change WINDOW's width. In any case, text whose x-coordinate
9775 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9776 can take some time, it's always a good idea to make this argument as
9777 small as possible; in particular, if the buffer contains long lines that
9778 shall be truncated anyway.
9780 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9781 height that can be returned. Text lines whose y-coordinate is beyond
9782 Y-LIMIT are ignored. Since calculating the text height of a large
9783 buffer can take some time, it makes sense to specify this argument if
9784 the size of the buffer is unknown.
9786 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9787 include the height of the mode- or header-line of WINDOW in the return
9788 value. If it is either the symbol `mode-line' or `header-line', include
9789 only the height of that line, if present, in the return value. If t,
9790 include the height of both, if present, in the return value. */)
9791 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9792 Lisp_Object mode_and_header_line
)
9794 struct window
*w
= decode_live_window (window
);
9798 struct buffer
*old_buffer
= NULL
;
9799 ptrdiff_t start
, end
, pos
;
9800 struct text_pos startp
;
9801 void *itdata
= NULL
;
9802 int c
, max_y
= -1, x
= 0, y
= 0;
9808 if (b
!= current_buffer
)
9810 old_buffer
= current_buffer
;
9811 set_buffer_internal (b
);
9816 else if (EQ (from
, Qt
))
9819 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9820 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9822 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9827 CHECK_NUMBER_COERCE_MARKER (from
);
9828 start
= min (max (XINT (from
), BEGV
), ZV
);
9833 else if (EQ (to
, Qt
))
9836 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9837 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9839 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9844 CHECK_NUMBER_COERCE_MARKER (to
);
9845 end
= max (start
, min (XINT (to
), ZV
));
9848 if (!NILP (y_limit
))
9850 CHECK_NUMBER (y_limit
);
9851 max_y
= min (XINT (y_limit
), INT_MAX
);
9854 itdata
= bidi_shelve_cache ();
9855 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9856 start_display (&it
, w
, startp
);
9859 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9862 CHECK_NUMBER (x_limit
);
9863 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9864 /* Actually, we never want move_it_to stop at to_x. But to make
9865 sure that move_it_in_display_line_to always moves far enough,
9866 we set it to INT_MAX and specify MOVE_TO_X. */
9867 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9868 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9871 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9873 if (!EQ (mode_and_header_line
, Qheader_line
)
9874 && !EQ (mode_and_header_line
, Qt
))
9875 /* Do not count the header-line which was counted automatically by
9877 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9879 if (EQ (mode_and_header_line
, Qmode_line
)
9880 || EQ (mode_and_header_line
, Qt
))
9881 /* Do count the mode-line which is not included automatically by
9883 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9885 bidi_unshelve_cache (itdata
, 0);
9888 set_buffer_internal (old_buffer
);
9890 return Fcons (make_number (x
), make_number (y
));
9893 /***********************************************************************
9895 ***********************************************************************/
9898 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9902 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9904 Lisp_Object args
[3];
9905 Lisp_Object msg
, fmt
;
9908 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9912 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9914 args
[0] = fmt
= build_string (format
);
9917 msg
= Fformat (3, args
);
9919 len
= SBYTES (msg
) + 1;
9920 buffer
= SAFE_ALLOCA (len
);
9921 memcpy (buffer
, SDATA (msg
), len
);
9923 message_dolog (buffer
, len
- 1, 1, 0);
9930 /* Output a newline in the *Messages* buffer if "needs" one. */
9933 message_log_maybe_newline (void)
9935 if (message_log_need_newline
)
9936 message_dolog ("", 0, 1, 0);
9940 /* Add a string M of length NBYTES to the message log, optionally
9941 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9942 true, means interpret the contents of M as multibyte. This
9943 function calls low-level routines in order to bypass text property
9944 hooks, etc. which might not be safe to run.
9946 This may GC (insert may run before/after change hooks),
9947 so the buffer M must NOT point to a Lisp string. */
9950 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9952 const unsigned char *msg
= (const unsigned char *) m
;
9954 if (!NILP (Vmemory_full
))
9957 if (!NILP (Vmessage_log_max
))
9959 struct buffer
*oldbuf
;
9960 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9961 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9962 ptrdiff_t point_at_end
= 0;
9963 ptrdiff_t zv_at_end
= 0;
9964 Lisp_Object old_deactivate_mark
;
9965 struct gcpro gcpro1
;
9967 old_deactivate_mark
= Vdeactivate_mark
;
9968 oldbuf
= current_buffer
;
9970 /* Ensure the Messages buffer exists, and switch to it.
9971 If we created it, set the major-mode. */
9974 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9976 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9979 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9980 call0 (intern ("messages-buffer-mode"));
9983 bset_undo_list (current_buffer
, Qt
);
9984 bset_cache_long_scans (current_buffer
, Qnil
);
9986 oldpoint
= message_dolog_marker1
;
9987 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9988 oldbegv
= message_dolog_marker2
;
9989 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9990 oldzv
= message_dolog_marker3
;
9991 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9992 GCPRO1 (old_deactivate_mark
);
10000 BEGV_BYTE
= BEG_BYTE
;
10003 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10005 /* Insert the string--maybe converting multibyte to single byte
10006 or vice versa, so that all the text fits the buffer. */
10008 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10014 /* Convert a multibyte string to single-byte
10015 for the *Message* buffer. */
10016 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10018 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10019 work
[0] = CHAR_TO_BYTE8 (c
);
10020 insert_1_both (work
, 1, 1, 1, 0, 0);
10023 else if (! multibyte
10024 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10028 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10029 /* Convert a single-byte string to multibyte
10030 for the *Message* buffer. */
10031 for (i
= 0; i
< nbytes
; i
++)
10034 MAKE_CHAR_MULTIBYTE (c
);
10035 char_bytes
= CHAR_STRING (c
, str
);
10036 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10040 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10044 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10047 insert_1_both ("\n", 1, 1, 1, 0, 0);
10049 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10051 this_bol_byte
= PT_BYTE
;
10053 /* See if this line duplicates the previous one.
10054 If so, combine duplicates. */
10055 if (this_bol
> BEG
)
10057 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10059 prev_bol_byte
= PT_BYTE
;
10061 dups
= message_log_check_duplicate (prev_bol_byte
,
10065 del_range_both (prev_bol
, prev_bol_byte
,
10066 this_bol
, this_bol_byte
, 0);
10069 char dupstr
[sizeof " [ times]"
10070 + INT_STRLEN_BOUND (printmax_t
)];
10072 /* If you change this format, don't forget to also
10073 change message_log_check_duplicate. */
10074 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10075 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10076 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10081 /* If we have more than the desired maximum number of lines
10082 in the *Messages* buffer now, delete the oldest ones.
10083 This is safe because we don't have undo in this buffer. */
10085 if (NATNUMP (Vmessage_log_max
))
10087 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10088 -XFASTINT (Vmessage_log_max
) - 1, 0);
10089 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10092 BEGV
= marker_position (oldbegv
);
10093 BEGV_BYTE
= marker_byte_position (oldbegv
);
10102 ZV
= marker_position (oldzv
);
10103 ZV_BYTE
= marker_byte_position (oldzv
);
10107 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10109 /* We can't do Fgoto_char (oldpoint) because it will run some
10111 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10112 marker_byte_position (oldpoint
));
10115 unchain_marker (XMARKER (oldpoint
));
10116 unchain_marker (XMARKER (oldbegv
));
10117 unchain_marker (XMARKER (oldzv
));
10119 /* We called insert_1_both above with its 5th argument (PREPARE)
10120 zero, which prevents insert_1_both from calling
10121 prepare_to_modify_buffer, which in turns prevents us from
10122 incrementing windows_or_buffers_changed even if *Messages* is
10123 shown in some window. So we must manually set
10124 windows_or_buffers_changed here to make up for that. */
10125 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10126 bset_redisplay (current_buffer
);
10128 set_buffer_internal (oldbuf
);
10130 message_log_need_newline
= !nlflag
;
10131 Vdeactivate_mark
= old_deactivate_mark
;
10136 /* We are at the end of the buffer after just having inserted a newline.
10137 (Note: We depend on the fact we won't be crossing the gap.)
10138 Check to see if the most recent message looks a lot like the previous one.
10139 Return 0 if different, 1 if the new one should just replace it, or a
10140 value N > 1 if we should also append " [N times]". */
10143 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10146 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10148 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10149 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10151 for (i
= 0; i
< len
; i
++)
10153 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10155 if (p1
[i
] != p2
[i
])
10161 if (*p1
++ == ' ' && *p1
++ == '[')
10164 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10165 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10172 /* Display an echo area message M with a specified length of NBYTES
10173 bytes. The string may include null characters. If M is not a
10174 string, clear out any existing message, and let the mini-buffer
10177 This function cancels echoing. */
10180 message3 (Lisp_Object m
)
10182 struct gcpro gcpro1
;
10185 clear_message (true, true);
10188 /* First flush out any partial line written with print. */
10189 message_log_maybe_newline ();
10192 ptrdiff_t nbytes
= SBYTES (m
);
10193 bool multibyte
= STRING_MULTIBYTE (m
);
10195 char *buffer
= SAFE_ALLOCA (nbytes
);
10196 memcpy (buffer
, SDATA (m
), nbytes
);
10197 message_dolog (buffer
, nbytes
, 1, multibyte
);
10200 message3_nolog (m
);
10206 /* The non-logging version of message3.
10207 This does not cancel echoing, because it is used for echoing.
10208 Perhaps we need to make a separate function for echoing
10209 and make this cancel echoing. */
10212 message3_nolog (Lisp_Object m
)
10214 struct frame
*sf
= SELECTED_FRAME ();
10216 if (FRAME_INITIAL_P (sf
))
10218 if (noninteractive_need_newline
)
10219 putc ('\n', stderr
);
10220 noninteractive_need_newline
= 0;
10223 Lisp_Object s
= ENCODE_SYSTEM (m
);
10225 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10227 if (cursor_in_echo_area
== 0)
10228 fprintf (stderr
, "\n");
10231 /* Error messages get reported properly by cmd_error, so this must be just an
10232 informative message; if the frame hasn't really been initialized yet, just
10234 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10236 /* Get the frame containing the mini-buffer
10237 that the selected frame is using. */
10238 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10239 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10240 struct frame
*f
= XFRAME (frame
);
10242 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10243 Fmake_frame_visible (frame
);
10245 if (STRINGP (m
) && SCHARS (m
) > 0)
10248 if (minibuffer_auto_raise
)
10249 Fraise_frame (frame
);
10250 /* Assume we are not echoing.
10251 (If we are, echo_now will override this.) */
10252 echo_message_buffer
= Qnil
;
10255 clear_message (true, true);
10257 do_pending_window_change (0);
10258 echo_area_display (1);
10259 do_pending_window_change (0);
10260 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10261 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10266 /* Display a null-terminated echo area message M. If M is 0, clear
10267 out any existing message, and let the mini-buffer text show through.
10269 The buffer M must continue to exist until after the echo area gets
10270 cleared or some other message gets displayed there. Do not pass
10271 text that is stored in a Lisp string. Do not pass text in a buffer
10272 that was alloca'd. */
10275 message1 (const char *m
)
10277 message3 (m
? build_unibyte_string (m
) : Qnil
);
10281 /* The non-logging counterpart of message1. */
10284 message1_nolog (const char *m
)
10286 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10289 /* Display a message M which contains a single %s
10290 which gets replaced with STRING. */
10293 message_with_string (const char *m
, Lisp_Object string
, int log
)
10295 CHECK_STRING (string
);
10297 if (noninteractive
)
10301 /* ENCODE_SYSTEM below can GC and/or relocate the
10302 Lisp data, so make sure we don't use it here. */
10303 eassert (relocatable_string_data_p (m
) != 1);
10305 if (noninteractive_need_newline
)
10306 putc ('\n', stderr
);
10307 noninteractive_need_newline
= 0;
10308 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10309 if (!cursor_in_echo_area
)
10310 fprintf (stderr
, "\n");
10314 else if (INTERACTIVE
)
10316 /* The frame whose minibuffer we're going to display the message on.
10317 It may be larger than the selected frame, so we need
10318 to use its buffer, not the selected frame's buffer. */
10319 Lisp_Object mini_window
;
10320 struct frame
*f
, *sf
= SELECTED_FRAME ();
10322 /* Get the frame containing the minibuffer
10323 that the selected frame is using. */
10324 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10325 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10327 /* Error messages get reported properly by cmd_error, so this must be
10328 just an informative message; if the frame hasn't really been
10329 initialized yet, just toss it. */
10330 if (f
->glyphs_initialized_p
)
10332 Lisp_Object args
[2], msg
;
10333 struct gcpro gcpro1
, gcpro2
;
10335 args
[0] = build_string (m
);
10336 args
[1] = msg
= string
;
10337 GCPRO2 (args
[0], msg
);
10340 msg
= Fformat (2, args
);
10345 message3_nolog (msg
);
10349 /* Print should start at the beginning of the message
10350 buffer next time. */
10351 message_buf_print
= 0;
10357 /* Dump an informative message to the minibuf. If M is 0, clear out
10358 any existing message, and let the mini-buffer text show through. */
10361 vmessage (const char *m
, va_list ap
)
10363 if (noninteractive
)
10367 if (noninteractive_need_newline
)
10368 putc ('\n', stderr
);
10369 noninteractive_need_newline
= 0;
10370 vfprintf (stderr
, m
, ap
);
10371 if (cursor_in_echo_area
== 0)
10372 fprintf (stderr
, "\n");
10376 else if (INTERACTIVE
)
10378 /* The frame whose mini-buffer we're going to display the message
10379 on. It may be larger than the selected frame, so we need to
10380 use its buffer, not the selected frame's buffer. */
10381 Lisp_Object mini_window
;
10382 struct frame
*f
, *sf
= SELECTED_FRAME ();
10384 /* Get the frame containing the mini-buffer
10385 that the selected frame is using. */
10386 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10387 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10389 /* Error messages get reported properly by cmd_error, so this must be
10390 just an informative message; if the frame hasn't really been
10391 initialized yet, just toss it. */
10392 if (f
->glyphs_initialized_p
)
10397 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10398 char *message_buf
= alloca (maxsize
+ 1);
10400 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10402 message3 (make_string (message_buf
, len
));
10407 /* Print should start at the beginning of the message
10408 buffer next time. */
10409 message_buf_print
= 0;
10415 message (const char *m
, ...)
10425 /* The non-logging version of message. */
10428 message_nolog (const char *m
, ...)
10430 Lisp_Object old_log_max
;
10433 old_log_max
= Vmessage_log_max
;
10434 Vmessage_log_max
= Qnil
;
10436 Vmessage_log_max
= old_log_max
;
10442 /* Display the current message in the current mini-buffer. This is
10443 only called from error handlers in process.c, and is not time
10447 update_echo_area (void)
10449 if (!NILP (echo_area_buffer
[0]))
10451 Lisp_Object string
;
10452 string
= Fcurrent_message ();
10458 /* Make sure echo area buffers in `echo_buffers' are live.
10459 If they aren't, make new ones. */
10462 ensure_echo_area_buffers (void)
10466 for (i
= 0; i
< 2; ++i
)
10467 if (!BUFFERP (echo_buffer
[i
])
10468 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10471 Lisp_Object old_buffer
;
10474 old_buffer
= echo_buffer
[i
];
10475 echo_buffer
[i
] = Fget_buffer_create
10476 (make_formatted_string (name
, " *Echo Area %d*", i
));
10477 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10478 /* to force word wrap in echo area -
10479 it was decided to postpone this*/
10480 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10482 for (j
= 0; j
< 2; ++j
)
10483 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10484 echo_area_buffer
[j
] = echo_buffer
[i
];
10489 /* Call FN with args A1..A2 with either the current or last displayed
10490 echo_area_buffer as current buffer.
10492 WHICH zero means use the current message buffer
10493 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10494 from echo_buffer[] and clear it.
10496 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10497 suitable buffer from echo_buffer[] and clear it.
10499 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10500 that the current message becomes the last displayed one, make
10501 choose a suitable buffer for echo_area_buffer[0], and clear it.
10503 Value is what FN returns. */
10506 with_echo_area_buffer (struct window
*w
, int which
,
10507 int (*fn
) (ptrdiff_t, Lisp_Object
),
10508 ptrdiff_t a1
, Lisp_Object a2
)
10510 Lisp_Object buffer
;
10511 int this_one
, the_other
, clear_buffer_p
, rc
;
10512 ptrdiff_t count
= SPECPDL_INDEX ();
10514 /* If buffers aren't live, make new ones. */
10515 ensure_echo_area_buffers ();
10517 clear_buffer_p
= 0;
10520 this_one
= 0, the_other
= 1;
10521 else if (which
> 0)
10522 this_one
= 1, the_other
= 0;
10525 this_one
= 0, the_other
= 1;
10526 clear_buffer_p
= true;
10528 /* We need a fresh one in case the current echo buffer equals
10529 the one containing the last displayed echo area message. */
10530 if (!NILP (echo_area_buffer
[this_one
])
10531 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10532 echo_area_buffer
[this_one
] = Qnil
;
10535 /* Choose a suitable buffer from echo_buffer[] is we don't
10537 if (NILP (echo_area_buffer
[this_one
]))
10539 echo_area_buffer
[this_one
]
10540 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10541 ? echo_buffer
[the_other
]
10542 : echo_buffer
[this_one
]);
10543 clear_buffer_p
= true;
10546 buffer
= echo_area_buffer
[this_one
];
10548 /* Don't get confused by reusing the buffer used for echoing
10549 for a different purpose. */
10550 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10553 record_unwind_protect (unwind_with_echo_area_buffer
,
10554 with_echo_area_buffer_unwind_data (w
));
10556 /* Make the echo area buffer current. Note that for display
10557 purposes, it is not necessary that the displayed window's buffer
10558 == current_buffer, except for text property lookup. So, let's
10559 only set that buffer temporarily here without doing a full
10560 Fset_window_buffer. We must also change w->pointm, though,
10561 because otherwise an assertions in unshow_buffer fails, and Emacs
10563 set_buffer_internal_1 (XBUFFER (buffer
));
10566 wset_buffer (w
, buffer
);
10567 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10568 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10571 bset_undo_list (current_buffer
, Qt
);
10572 bset_read_only (current_buffer
, Qnil
);
10573 specbind (Qinhibit_read_only
, Qt
);
10574 specbind (Qinhibit_modification_hooks
, Qt
);
10576 if (clear_buffer_p
&& Z
> BEG
)
10577 del_range (BEG
, Z
);
10579 eassert (BEGV
>= BEG
);
10580 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10584 eassert (BEGV
>= BEG
);
10585 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10587 unbind_to (count
, Qnil
);
10592 /* Save state that should be preserved around the call to the function
10593 FN called in with_echo_area_buffer. */
10596 with_echo_area_buffer_unwind_data (struct window
*w
)
10599 Lisp_Object vector
, tmp
;
10601 /* Reduce consing by keeping one vector in
10602 Vwith_echo_area_save_vector. */
10603 vector
= Vwith_echo_area_save_vector
;
10604 Vwith_echo_area_save_vector
= Qnil
;
10607 vector
= Fmake_vector (make_number (11), Qnil
);
10609 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10610 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10611 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10615 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10616 ASET (vector
, i
, w
->contents
); ++i
;
10617 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10618 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10619 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10620 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10621 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10622 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10627 for (; i
< end
; ++i
)
10628 ASET (vector
, i
, Qnil
);
10631 eassert (i
== ASIZE (vector
));
10636 /* Restore global state from VECTOR which was created by
10637 with_echo_area_buffer_unwind_data. */
10640 unwind_with_echo_area_buffer (Lisp_Object vector
)
10642 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10643 Vdeactivate_mark
= AREF (vector
, 1);
10644 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10646 if (WINDOWP (AREF (vector
, 3)))
10649 Lisp_Object buffer
;
10651 w
= XWINDOW (AREF (vector
, 3));
10652 buffer
= AREF (vector
, 4);
10654 wset_buffer (w
, buffer
);
10655 set_marker_both (w
->pointm
, buffer
,
10656 XFASTINT (AREF (vector
, 5)),
10657 XFASTINT (AREF (vector
, 6)));
10658 set_marker_both (w
->old_pointm
, buffer
,
10659 XFASTINT (AREF (vector
, 7)),
10660 XFASTINT (AREF (vector
, 8)));
10661 set_marker_both (w
->start
, buffer
,
10662 XFASTINT (AREF (vector
, 9)),
10663 XFASTINT (AREF (vector
, 10)));
10666 Vwith_echo_area_save_vector
= vector
;
10670 /* Set up the echo area for use by print functions. MULTIBYTE_P
10671 non-zero means we will print multibyte. */
10674 setup_echo_area_for_printing (int multibyte_p
)
10676 /* If we can't find an echo area any more, exit. */
10677 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10678 Fkill_emacs (Qnil
);
10680 ensure_echo_area_buffers ();
10682 if (!message_buf_print
)
10684 /* A message has been output since the last time we printed.
10685 Choose a fresh echo area buffer. */
10686 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10687 echo_area_buffer
[0] = echo_buffer
[1];
10689 echo_area_buffer
[0] = echo_buffer
[0];
10691 /* Switch to that buffer and clear it. */
10692 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10693 bset_truncate_lines (current_buffer
, Qnil
);
10697 ptrdiff_t count
= SPECPDL_INDEX ();
10698 specbind (Qinhibit_read_only
, Qt
);
10699 /* Note that undo recording is always disabled. */
10700 del_range (BEG
, Z
);
10701 unbind_to (count
, Qnil
);
10703 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10705 /* Set up the buffer for the multibyteness we need. */
10707 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10708 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10710 /* Raise the frame containing the echo area. */
10711 if (minibuffer_auto_raise
)
10713 struct frame
*sf
= SELECTED_FRAME ();
10714 Lisp_Object mini_window
;
10715 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10716 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10719 message_log_maybe_newline ();
10720 message_buf_print
= 1;
10724 if (NILP (echo_area_buffer
[0]))
10726 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10727 echo_area_buffer
[0] = echo_buffer
[1];
10729 echo_area_buffer
[0] = echo_buffer
[0];
10732 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10734 /* Someone switched buffers between print requests. */
10735 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10736 bset_truncate_lines (current_buffer
, Qnil
);
10742 /* Display an echo area message in window W. Value is non-zero if W's
10743 height is changed. If display_last_displayed_message_p is
10744 non-zero, display the message that was last displayed, otherwise
10745 display the current message. */
10748 display_echo_area (struct window
*w
)
10750 int i
, no_message_p
, window_height_changed_p
;
10752 /* Temporarily disable garbage collections while displaying the echo
10753 area. This is done because a GC can print a message itself.
10754 That message would modify the echo area buffer's contents while a
10755 redisplay of the buffer is going on, and seriously confuse
10757 ptrdiff_t count
= inhibit_garbage_collection ();
10759 /* If there is no message, we must call display_echo_area_1
10760 nevertheless because it resizes the window. But we will have to
10761 reset the echo_area_buffer in question to nil at the end because
10762 with_echo_area_buffer will sets it to an empty buffer. */
10763 i
= display_last_displayed_message_p
? 1 : 0;
10764 no_message_p
= NILP (echo_area_buffer
[i
]);
10766 window_height_changed_p
10767 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10768 display_echo_area_1
,
10769 (intptr_t) w
, Qnil
);
10772 echo_area_buffer
[i
] = Qnil
;
10774 unbind_to (count
, Qnil
);
10775 return window_height_changed_p
;
10779 /* Helper for display_echo_area. Display the current buffer which
10780 contains the current echo area message in window W, a mini-window,
10781 a pointer to which is passed in A1. A2..A4 are currently not used.
10782 Change the height of W so that all of the message is displayed.
10783 Value is non-zero if height of W was changed. */
10786 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10789 struct window
*w
= (struct window
*) i1
;
10790 Lisp_Object window
;
10791 struct text_pos start
;
10792 int window_height_changed_p
= 0;
10794 /* Do this before displaying, so that we have a large enough glyph
10795 matrix for the display. If we can't get enough space for the
10796 whole text, display the last N lines. That works by setting w->start. */
10797 window_height_changed_p
= resize_mini_window (w
, 0);
10799 /* Use the starting position chosen by resize_mini_window. */
10800 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10803 clear_glyph_matrix (w
->desired_matrix
);
10804 XSETWINDOW (window
, w
);
10805 try_window (window
, start
, 0);
10807 return window_height_changed_p
;
10811 /* Resize the echo area window to exactly the size needed for the
10812 currently displayed message, if there is one. If a mini-buffer
10813 is active, don't shrink it. */
10816 resize_echo_area_exactly (void)
10818 if (BUFFERP (echo_area_buffer
[0])
10819 && WINDOWP (echo_area_window
))
10821 struct window
*w
= XWINDOW (echo_area_window
);
10822 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10823 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10824 (intptr_t) w
, resize_exactly
);
10827 windows_or_buffers_changed
= 42;
10828 update_mode_lines
= 30;
10829 redisplay_internal ();
10835 /* Callback function for with_echo_area_buffer, when used from
10836 resize_echo_area_exactly. A1 contains a pointer to the window to
10837 resize, EXACTLY non-nil means resize the mini-window exactly to the
10838 size of the text displayed. A3 and A4 are not used. Value is what
10839 resize_mini_window returns. */
10842 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10845 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10849 /* Resize mini-window W to fit the size of its contents. EXACT_P
10850 means size the window exactly to the size needed. Otherwise, it's
10851 only enlarged until W's buffer is empty.
10853 Set W->start to the right place to begin display. If the whole
10854 contents fit, start at the beginning. Otherwise, start so as
10855 to make the end of the contents appear. This is particularly
10856 important for y-or-n-p, but seems desirable generally.
10858 Value is non-zero if the window height has been changed. */
10861 resize_mini_window (struct window
*w
, int exact_p
)
10863 struct frame
*f
= XFRAME (w
->frame
);
10864 int window_height_changed_p
= 0;
10866 eassert (MINI_WINDOW_P (w
));
10868 /* By default, start display at the beginning. */
10869 set_marker_both (w
->start
, w
->contents
,
10870 BUF_BEGV (XBUFFER (w
->contents
)),
10871 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10873 /* Don't resize windows while redisplaying a window; it would
10874 confuse redisplay functions when the size of the window they are
10875 displaying changes from under them. Such a resizing can happen,
10876 for instance, when which-func prints a long message while
10877 we are running fontification-functions. We're running these
10878 functions with safe_call which binds inhibit-redisplay to t. */
10879 if (!NILP (Vinhibit_redisplay
))
10882 /* Nil means don't try to resize. */
10883 if (NILP (Vresize_mini_windows
)
10884 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10887 if (!FRAME_MINIBUF_ONLY_P (f
))
10890 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10891 + WINDOW_PIXEL_HEIGHT (w
));
10892 int unit
= FRAME_LINE_HEIGHT (f
);
10893 int height
, max_height
;
10894 struct text_pos start
;
10895 struct buffer
*old_current_buffer
= NULL
;
10897 if (current_buffer
!= XBUFFER (w
->contents
))
10899 old_current_buffer
= current_buffer
;
10900 set_buffer_internal (XBUFFER (w
->contents
));
10903 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10905 /* Compute the max. number of lines specified by the user. */
10906 if (FLOATP (Vmax_mini_window_height
))
10907 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10908 else if (INTEGERP (Vmax_mini_window_height
))
10909 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10911 max_height
= total_height
/ 4;
10913 /* Correct that max. height if it's bogus. */
10914 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10916 /* Find out the height of the text in the window. */
10917 if (it
.line_wrap
== TRUNCATE
)
10922 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10923 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10924 height
= it
.current_y
+ last_height
;
10926 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10927 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10930 /* Compute a suitable window start. */
10931 if (height
> max_height
)
10933 height
= (max_height
/ unit
) * unit
;
10934 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10935 move_it_vertically_backward (&it
, height
- unit
);
10936 start
= it
.current
.pos
;
10939 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10940 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10942 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10944 /* Let it grow only, until we display an empty message, in which
10945 case the window shrinks again. */
10946 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10948 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10950 FRAME_WINDOWS_FROZEN (f
) = 1;
10951 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10952 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10954 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10955 && (exact_p
|| BEGV
== ZV
))
10957 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10959 FRAME_WINDOWS_FROZEN (f
) = 0;
10960 shrink_mini_window (w
, 1);
10961 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10966 /* Always resize to exact size needed. */
10967 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10969 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10971 FRAME_WINDOWS_FROZEN (f
) = 1;
10972 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10973 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10975 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10977 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10979 FRAME_WINDOWS_FROZEN (f
) = 0;
10980 shrink_mini_window (w
, 1);
10984 FRAME_WINDOWS_FROZEN (f
) = 1;
10985 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10988 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10992 if (old_current_buffer
)
10993 set_buffer_internal (old_current_buffer
);
10996 return window_height_changed_p
;
11000 /* Value is the current message, a string, or nil if there is no
11001 current message. */
11004 current_message (void)
11008 if (!BUFFERP (echo_area_buffer
[0]))
11012 with_echo_area_buffer (0, 0, current_message_1
,
11013 (intptr_t) &msg
, Qnil
);
11015 echo_area_buffer
[0] = Qnil
;
11023 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11026 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11029 *msg
= make_buffer_string (BEG
, Z
, 1);
11036 /* Push the current message on Vmessage_stack for later restoration
11037 by restore_message. Value is non-zero if the current message isn't
11038 empty. This is a relatively infrequent operation, so it's not
11039 worth optimizing. */
11042 push_message (void)
11044 Lisp_Object msg
= current_message ();
11045 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11046 return STRINGP (msg
);
11050 /* Restore message display from the top of Vmessage_stack. */
11053 restore_message (void)
11055 eassert (CONSP (Vmessage_stack
));
11056 message3_nolog (XCAR (Vmessage_stack
));
11060 /* Handler for unwind-protect calling pop_message. */
11063 pop_message_unwind (void)
11065 /* Pop the top-most entry off Vmessage_stack. */
11066 eassert (CONSP (Vmessage_stack
));
11067 Vmessage_stack
= XCDR (Vmessage_stack
);
11071 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11072 exits. If the stack is not empty, we have a missing pop_message
11076 check_message_stack (void)
11078 if (!NILP (Vmessage_stack
))
11083 /* Truncate to NCHARS what will be displayed in the echo area the next
11084 time we display it---but don't redisplay it now. */
11087 truncate_echo_area (ptrdiff_t nchars
)
11090 echo_area_buffer
[0] = Qnil
;
11091 else if (!noninteractive
11093 && !NILP (echo_area_buffer
[0]))
11095 struct frame
*sf
= SELECTED_FRAME ();
11096 /* Error messages get reported properly by cmd_error, so this must be
11097 just an informative message; if the frame hasn't really been
11098 initialized yet, just toss it. */
11099 if (sf
->glyphs_initialized_p
)
11100 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11105 /* Helper function for truncate_echo_area. Truncate the current
11106 message to at most NCHARS characters. */
11109 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11111 if (BEG
+ nchars
< Z
)
11112 del_range (BEG
+ nchars
, Z
);
11114 echo_area_buffer
[0] = Qnil
;
11118 /* Set the current message to STRING. */
11121 set_message (Lisp_Object string
)
11123 eassert (STRINGP (string
));
11125 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11127 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11128 message_buf_print
= 0;
11129 help_echo_showing_p
= 0;
11131 if (STRINGP (Vdebug_on_message
)
11132 && STRINGP (string
)
11133 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11134 call_debugger (list2 (Qerror
, string
));
11138 /* Helper function for set_message. First argument is ignored and second
11139 argument has the same meaning as for set_message.
11140 This function is called with the echo area buffer being current. */
11143 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11145 eassert (STRINGP (string
));
11147 /* Change multibyteness of the echo buffer appropriately. */
11148 if (message_enable_multibyte
11149 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11150 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11152 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11153 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11154 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11156 /* Insert new message at BEG. */
11157 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11159 /* This function takes care of single/multibyte conversion.
11160 We just have to ensure that the echo area buffer has the right
11161 setting of enable_multibyte_characters. */
11162 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11168 /* Clear messages. CURRENT_P non-zero means clear the current
11169 message. LAST_DISPLAYED_P non-zero means clear the message
11173 clear_message (bool current_p
, bool last_displayed_p
)
11177 echo_area_buffer
[0] = Qnil
;
11178 message_cleared_p
= true;
11181 if (last_displayed_p
)
11182 echo_area_buffer
[1] = Qnil
;
11184 message_buf_print
= 0;
11187 /* Clear garbaged frames.
11189 This function is used where the old redisplay called
11190 redraw_garbaged_frames which in turn called redraw_frame which in
11191 turn called clear_frame. The call to clear_frame was a source of
11192 flickering. I believe a clear_frame is not necessary. It should
11193 suffice in the new redisplay to invalidate all current matrices,
11194 and ensure a complete redisplay of all windows. */
11197 clear_garbaged_frames (void)
11199 if (frame_garbaged
)
11201 Lisp_Object tail
, frame
;
11203 FOR_EACH_FRAME (tail
, frame
)
11205 struct frame
*f
= XFRAME (frame
);
11207 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11212 clear_current_matrices (f
);
11213 fset_redisplay (f
);
11214 f
->garbaged
= false;
11215 f
->resized_p
= false;
11219 frame_garbaged
= false;
11224 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11225 is non-zero update selected_frame. Value is non-zero if the
11226 mini-windows height has been changed. */
11229 echo_area_display (int update_frame_p
)
11231 Lisp_Object mini_window
;
11234 int window_height_changed_p
= 0;
11235 struct frame
*sf
= SELECTED_FRAME ();
11237 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11238 w
= XWINDOW (mini_window
);
11239 f
= XFRAME (WINDOW_FRAME (w
));
11241 /* Don't display if frame is invisible or not yet initialized. */
11242 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11245 #ifdef HAVE_WINDOW_SYSTEM
11246 /* When Emacs starts, selected_frame may be the initial terminal
11247 frame. If we let this through, a message would be displayed on
11249 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11251 #endif /* HAVE_WINDOW_SYSTEM */
11253 /* Redraw garbaged frames. */
11254 clear_garbaged_frames ();
11256 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11258 echo_area_window
= mini_window
;
11259 window_height_changed_p
= display_echo_area (w
);
11260 w
->must_be_updated_p
= true;
11262 /* Update the display, unless called from redisplay_internal.
11263 Also don't update the screen during redisplay itself. The
11264 update will happen at the end of redisplay, and an update
11265 here could cause confusion. */
11266 if (update_frame_p
&& !redisplaying_p
)
11270 /* If the display update has been interrupted by pending
11271 input, update mode lines in the frame. Due to the
11272 pending input, it might have been that redisplay hasn't
11273 been called, so that mode lines above the echo area are
11274 garbaged. This looks odd, so we prevent it here. */
11275 if (!display_completed
)
11276 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11278 if (window_height_changed_p
11279 /* Don't do this if Emacs is shutting down. Redisplay
11280 needs to run hooks. */
11281 && !NILP (Vrun_hooks
))
11283 /* Must update other windows. Likewise as in other
11284 cases, don't let this update be interrupted by
11286 ptrdiff_t count
= SPECPDL_INDEX ();
11287 specbind (Qredisplay_dont_pause
, Qt
);
11288 windows_or_buffers_changed
= 44;
11289 redisplay_internal ();
11290 unbind_to (count
, Qnil
);
11292 else if (FRAME_WINDOW_P (f
) && n
== 0)
11294 /* Window configuration is the same as before.
11295 Can do with a display update of the echo area,
11296 unless we displayed some mode lines. */
11297 update_single_window (w
, 1);
11301 update_frame (f
, 1, 1);
11303 /* If cursor is in the echo area, make sure that the next
11304 redisplay displays the minibuffer, so that the cursor will
11305 be replaced with what the minibuffer wants. */
11306 if (cursor_in_echo_area
)
11307 wset_redisplay (XWINDOW (mini_window
));
11310 else if (!EQ (mini_window
, selected_window
))
11311 wset_redisplay (XWINDOW (mini_window
));
11313 /* Last displayed message is now the current message. */
11314 echo_area_buffer
[1] = echo_area_buffer
[0];
11315 /* Inform read_char that we're not echoing. */
11316 echo_message_buffer
= Qnil
;
11318 /* Prevent redisplay optimization in redisplay_internal by resetting
11319 this_line_start_pos. This is done because the mini-buffer now
11320 displays the message instead of its buffer text. */
11321 if (EQ (mini_window
, selected_window
))
11322 CHARPOS (this_line_start_pos
) = 0;
11324 return window_height_changed_p
;
11327 /* Nonzero if W's buffer was changed but not saved. */
11330 window_buffer_changed (struct window
*w
)
11332 struct buffer
*b
= XBUFFER (w
->contents
);
11334 eassert (BUFFER_LIVE_P (b
));
11336 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11339 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11342 mode_line_update_needed (struct window
*w
)
11344 return (w
->column_number_displayed
!= -1
11345 && !(PT
== w
->last_point
&& !window_outdated (w
))
11346 && (w
->column_number_displayed
!= current_column ()));
11349 /* Nonzero if window start of W is frozen and may not be changed during
11353 window_frozen_p (struct window
*w
)
11355 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11357 Lisp_Object window
;
11359 XSETWINDOW (window
, w
);
11360 if (MINI_WINDOW_P (w
))
11362 else if (EQ (window
, selected_window
))
11364 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11365 && EQ (window
, Vminibuf_scroll_window
))
11366 /* This special window can't be frozen too. */
11374 /***********************************************************************
11375 Mode Lines and Frame Titles
11376 ***********************************************************************/
11378 /* A buffer for constructing non-propertized mode-line strings and
11379 frame titles in it; allocated from the heap in init_xdisp and
11380 resized as needed in store_mode_line_noprop_char. */
11382 static char *mode_line_noprop_buf
;
11384 /* The buffer's end, and a current output position in it. */
11386 static char *mode_line_noprop_buf_end
;
11387 static char *mode_line_noprop_ptr
;
11389 #define MODE_LINE_NOPROP_LEN(start) \
11390 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11393 MODE_LINE_DISPLAY
= 0,
11397 } mode_line_target
;
11399 /* Alist that caches the results of :propertize.
11400 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11401 static Lisp_Object mode_line_proptrans_alist
;
11403 /* List of strings making up the mode-line. */
11404 static Lisp_Object mode_line_string_list
;
11406 /* Base face property when building propertized mode line string. */
11407 static Lisp_Object mode_line_string_face
;
11408 static Lisp_Object mode_line_string_face_prop
;
11411 /* Unwind data for mode line strings */
11413 static Lisp_Object Vmode_line_unwind_vector
;
11416 format_mode_line_unwind_data (struct frame
*target_frame
,
11417 struct buffer
*obuf
,
11419 int save_proptrans
)
11421 Lisp_Object vector
, tmp
;
11423 /* Reduce consing by keeping one vector in
11424 Vwith_echo_area_save_vector. */
11425 vector
= Vmode_line_unwind_vector
;
11426 Vmode_line_unwind_vector
= Qnil
;
11429 vector
= Fmake_vector (make_number (10), Qnil
);
11431 ASET (vector
, 0, make_number (mode_line_target
));
11432 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11433 ASET (vector
, 2, mode_line_string_list
);
11434 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11435 ASET (vector
, 4, mode_line_string_face
);
11436 ASET (vector
, 5, mode_line_string_face_prop
);
11439 XSETBUFFER (tmp
, obuf
);
11442 ASET (vector
, 6, tmp
);
11443 ASET (vector
, 7, owin
);
11446 /* Similarly to `with-selected-window', if the operation selects
11447 a window on another frame, we must restore that frame's
11448 selected window, and (for a tty) the top-frame. */
11449 ASET (vector
, 8, target_frame
->selected_window
);
11450 if (FRAME_TERMCAP_P (target_frame
))
11451 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11458 unwind_format_mode_line (Lisp_Object vector
)
11460 Lisp_Object old_window
= AREF (vector
, 7);
11461 Lisp_Object target_frame_window
= AREF (vector
, 8);
11462 Lisp_Object old_top_frame
= AREF (vector
, 9);
11464 mode_line_target
= XINT (AREF (vector
, 0));
11465 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11466 mode_line_string_list
= AREF (vector
, 2);
11467 if (! EQ (AREF (vector
, 3), Qt
))
11468 mode_line_proptrans_alist
= AREF (vector
, 3);
11469 mode_line_string_face
= AREF (vector
, 4);
11470 mode_line_string_face_prop
= AREF (vector
, 5);
11472 /* Select window before buffer, since it may change the buffer. */
11473 if (!NILP (old_window
))
11475 /* If the operation that we are unwinding had selected a window
11476 on a different frame, reset its frame-selected-window. For a
11477 text terminal, reset its top-frame if necessary. */
11478 if (!NILP (target_frame_window
))
11481 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11483 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11484 Fselect_window (target_frame_window
, Qt
);
11486 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11487 Fselect_frame (old_top_frame
, Qt
);
11490 Fselect_window (old_window
, Qt
);
11493 if (!NILP (AREF (vector
, 6)))
11495 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11496 ASET (vector
, 6, Qnil
);
11499 Vmode_line_unwind_vector
= vector
;
11503 /* Store a single character C for the frame title in mode_line_noprop_buf.
11504 Re-allocate mode_line_noprop_buf if necessary. */
11507 store_mode_line_noprop_char (char c
)
11509 /* If output position has reached the end of the allocated buffer,
11510 increase the buffer's size. */
11511 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11513 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11514 ptrdiff_t size
= len
;
11515 mode_line_noprop_buf
=
11516 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11517 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11518 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11521 *mode_line_noprop_ptr
++ = c
;
11525 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11526 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11527 characters that yield more columns than PRECISION; PRECISION <= 0
11528 means copy the whole string. Pad with spaces until FIELD_WIDTH
11529 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11530 pad. Called from display_mode_element when it is used to build a
11534 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11536 const unsigned char *str
= (const unsigned char *) string
;
11538 ptrdiff_t dummy
, nbytes
;
11540 /* Copy at most PRECISION chars from STR. */
11541 nbytes
= strlen (string
);
11542 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11544 store_mode_line_noprop_char (*str
++);
11546 /* Fill up with spaces until FIELD_WIDTH reached. */
11547 while (field_width
> 0
11548 && n
< field_width
)
11550 store_mode_line_noprop_char (' ');
11557 /***********************************************************************
11559 ***********************************************************************/
11561 #ifdef HAVE_WINDOW_SYSTEM
11563 /* Set the title of FRAME, if it has changed. The title format is
11564 Vicon_title_format if FRAME is iconified, otherwise it is
11565 frame_title_format. */
11568 x_consider_frame_title (Lisp_Object frame
)
11570 struct frame
*f
= XFRAME (frame
);
11572 if (FRAME_WINDOW_P (f
)
11573 || FRAME_MINIBUF_ONLY_P (f
)
11574 || f
->explicit_name
)
11576 /* Do we have more than one visible frame on this X display? */
11577 Lisp_Object tail
, other_frame
, fmt
;
11578 ptrdiff_t title_start
;
11582 ptrdiff_t count
= SPECPDL_INDEX ();
11584 FOR_EACH_FRAME (tail
, other_frame
)
11586 struct frame
*tf
= XFRAME (other_frame
);
11589 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11590 && !FRAME_MINIBUF_ONLY_P (tf
)
11591 && !EQ (other_frame
, tip_frame
)
11592 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11596 /* Set global variable indicating that multiple frames exist. */
11597 multiple_frames
= CONSP (tail
);
11599 /* Switch to the buffer of selected window of the frame. Set up
11600 mode_line_target so that display_mode_element will output into
11601 mode_line_noprop_buf; then display the title. */
11602 record_unwind_protect (unwind_format_mode_line
,
11603 format_mode_line_unwind_data
11604 (f
, current_buffer
, selected_window
, 0));
11606 Fselect_window (f
->selected_window
, Qt
);
11607 set_buffer_internal_1
11608 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11609 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11611 mode_line_target
= MODE_LINE_TITLE
;
11612 title_start
= MODE_LINE_NOPROP_LEN (0);
11613 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11614 NULL
, DEFAULT_FACE_ID
);
11615 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11616 len
= MODE_LINE_NOPROP_LEN (title_start
);
11617 title
= mode_line_noprop_buf
+ title_start
;
11618 unbind_to (count
, Qnil
);
11620 /* Set the title only if it's changed. This avoids consing in
11621 the common case where it hasn't. (If it turns out that we've
11622 already wasted too much time by walking through the list with
11623 display_mode_element, then we might need to optimize at a
11624 higher level than this.) */
11625 if (! STRINGP (f
->name
)
11626 || SBYTES (f
->name
) != len
11627 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11628 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11632 #endif /* not HAVE_WINDOW_SYSTEM */
11635 /***********************************************************************
11637 ***********************************************************************/
11639 /* Non-zero if we will not redisplay all visible windows. */
11640 #define REDISPLAY_SOME_P() \
11641 ((windows_or_buffers_changed == 0 \
11642 || windows_or_buffers_changed == REDISPLAY_SOME) \
11643 && (update_mode_lines == 0 \
11644 || update_mode_lines == REDISPLAY_SOME))
11646 /* Prepare for redisplay by updating menu-bar item lists when
11647 appropriate. This can call eval. */
11650 prepare_menu_bars (void)
11652 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11653 bool some_windows
= REDISPLAY_SOME_P ();
11654 struct gcpro gcpro1
, gcpro2
;
11655 Lisp_Object tooltip_frame
;
11657 #ifdef HAVE_WINDOW_SYSTEM
11658 tooltip_frame
= tip_frame
;
11660 tooltip_frame
= Qnil
;
11663 if (FUNCTIONP (Vpre_redisplay_function
))
11665 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11666 if (all_windows
&& some_windows
)
11668 Lisp_Object ws
= window_list ();
11669 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11671 Lisp_Object
this = XCAR (ws
);
11672 struct window
*w
= XWINDOW (this);
11674 || XFRAME (w
->frame
)->redisplay
11675 || XBUFFER (w
->contents
)->text
->redisplay
)
11677 windows
= Fcons (this, windows
);
11681 safe__call1 (true, Vpre_redisplay_function
, windows
);
11684 /* Update all frame titles based on their buffer names, etc. We do
11685 this before the menu bars so that the buffer-menu will show the
11686 up-to-date frame titles. */
11687 #ifdef HAVE_WINDOW_SYSTEM
11690 Lisp_Object tail
, frame
;
11692 FOR_EACH_FRAME (tail
, frame
)
11694 struct frame
*f
= XFRAME (frame
);
11695 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11699 && !XBUFFER (w
->contents
)->text
->redisplay
)
11702 if (!EQ (frame
, tooltip_frame
)
11703 && (FRAME_ICONIFIED_P (f
)
11704 || FRAME_VISIBLE_P (f
) == 1
11705 /* Exclude TTY frames that are obscured because they
11706 are not the top frame on their console. This is
11707 because x_consider_frame_title actually switches
11708 to the frame, which for TTY frames means it is
11709 marked as garbaged, and will be completely
11710 redrawn on the next redisplay cycle. This causes
11711 TTY frames to be completely redrawn, when there
11712 are more than one of them, even though nothing
11713 should be changed on display. */
11714 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11715 x_consider_frame_title (frame
);
11718 #endif /* HAVE_WINDOW_SYSTEM */
11720 /* Update the menu bar item lists, if appropriate. This has to be
11721 done before any actual redisplay or generation of display lines. */
11725 Lisp_Object tail
, frame
;
11726 ptrdiff_t count
= SPECPDL_INDEX ();
11727 /* 1 means that update_menu_bar has run its hooks
11728 so any further calls to update_menu_bar shouldn't do so again. */
11729 int menu_bar_hooks_run
= 0;
11731 record_unwind_save_match_data ();
11733 FOR_EACH_FRAME (tail
, frame
)
11735 struct frame
*f
= XFRAME (frame
);
11736 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11738 /* Ignore tooltip frame. */
11739 if (EQ (frame
, tooltip_frame
))
11745 && !XBUFFER (w
->contents
)->text
->redisplay
)
11748 /* If a window on this frame changed size, report that to
11749 the user and clear the size-change flag. */
11750 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11752 Lisp_Object functions
;
11754 /* Clear flag first in case we get an error below. */
11755 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11756 functions
= Vwindow_size_change_functions
;
11757 GCPRO2 (tail
, functions
);
11759 while (CONSP (functions
))
11761 if (!EQ (XCAR (functions
), Qt
))
11762 call1 (XCAR (functions
), frame
);
11763 functions
= XCDR (functions
);
11769 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11770 #ifdef HAVE_WINDOW_SYSTEM
11771 update_tool_bar (f
, 0);
11774 if (windows_or_buffers_changed
11777 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11782 unbind_to (count
, Qnil
);
11786 struct frame
*sf
= SELECTED_FRAME ();
11787 update_menu_bar (sf
, 1, 0);
11788 #ifdef HAVE_WINDOW_SYSTEM
11789 update_tool_bar (sf
, 1);
11795 /* Update the menu bar item list for frame F. This has to be done
11796 before we start to fill in any display lines, because it can call
11799 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11801 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11802 already ran the menu bar hooks for this redisplay, so there
11803 is no need to run them again. The return value is the
11804 updated value of this flag, to pass to the next call. */
11807 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11809 Lisp_Object window
;
11810 register struct window
*w
;
11812 /* If called recursively during a menu update, do nothing. This can
11813 happen when, for instance, an activate-menubar-hook causes a
11815 if (inhibit_menubar_update
)
11818 window
= FRAME_SELECTED_WINDOW (f
);
11819 w
= XWINDOW (window
);
11821 if (FRAME_WINDOW_P (f
)
11823 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11824 || defined (HAVE_NS) || defined (USE_GTK)
11825 FRAME_EXTERNAL_MENU_BAR (f
)
11827 FRAME_MENU_BAR_LINES (f
) > 0
11829 : FRAME_MENU_BAR_LINES (f
) > 0)
11831 /* If the user has switched buffers or windows, we need to
11832 recompute to reflect the new bindings. But we'll
11833 recompute when update_mode_lines is set too; that means
11834 that people can use force-mode-line-update to request
11835 that the menu bar be recomputed. The adverse effect on
11836 the rest of the redisplay algorithm is about the same as
11837 windows_or_buffers_changed anyway. */
11838 if (windows_or_buffers_changed
11839 /* This used to test w->update_mode_line, but we believe
11840 there is no need to recompute the menu in that case. */
11841 || update_mode_lines
11842 || window_buffer_changed (w
))
11844 struct buffer
*prev
= current_buffer
;
11845 ptrdiff_t count
= SPECPDL_INDEX ();
11847 specbind (Qinhibit_menubar_update
, Qt
);
11849 set_buffer_internal_1 (XBUFFER (w
->contents
));
11850 if (save_match_data
)
11851 record_unwind_save_match_data ();
11852 if (NILP (Voverriding_local_map_menu_flag
))
11854 specbind (Qoverriding_terminal_local_map
, Qnil
);
11855 specbind (Qoverriding_local_map
, Qnil
);
11860 /* Run the Lucid hook. */
11861 safe_run_hooks (Qactivate_menubar_hook
);
11863 /* If it has changed current-menubar from previous value,
11864 really recompute the menu-bar from the value. */
11865 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11866 call0 (Qrecompute_lucid_menubar
);
11868 safe_run_hooks (Qmenu_bar_update_hook
);
11873 XSETFRAME (Vmenu_updating_frame
, f
);
11874 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11876 /* Redisplay the menu bar in case we changed it. */
11877 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11878 || defined (HAVE_NS) || defined (USE_GTK)
11879 if (FRAME_WINDOW_P (f
))
11881 #if defined (HAVE_NS)
11882 /* All frames on Mac OS share the same menubar. So only
11883 the selected frame should be allowed to set it. */
11884 if (f
== SELECTED_FRAME ())
11886 set_frame_menubar (f
, 0, 0);
11889 /* On a terminal screen, the menu bar is an ordinary screen
11890 line, and this makes it get updated. */
11891 w
->update_mode_line
= 1;
11892 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11893 /* In the non-toolkit version, the menu bar is an ordinary screen
11894 line, and this makes it get updated. */
11895 w
->update_mode_line
= 1;
11896 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11898 unbind_to (count
, Qnil
);
11899 set_buffer_internal_1 (prev
);
11906 /***********************************************************************
11908 ***********************************************************************/
11910 #ifdef HAVE_WINDOW_SYSTEM
11912 /* Select `frame' temporarily without running all the code in
11914 FIXME: Maybe do_switch_frame should be trimmed down similarly
11915 when `norecord' is set. */
11917 fast_set_selected_frame (Lisp_Object frame
)
11919 if (!EQ (selected_frame
, frame
))
11921 selected_frame
= frame
;
11922 selected_window
= XFRAME (frame
)->selected_window
;
11926 /* Update the tool-bar item list for frame F. This has to be done
11927 before we start to fill in any display lines. Called from
11928 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11929 and restore it here. */
11932 update_tool_bar (struct frame
*f
, int save_match_data
)
11934 #if defined (USE_GTK) || defined (HAVE_NS)
11935 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11937 int do_update
= (WINDOWP (f
->tool_bar_window
)
11938 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11943 Lisp_Object window
;
11946 window
= FRAME_SELECTED_WINDOW (f
);
11947 w
= XWINDOW (window
);
11949 /* If the user has switched buffers or windows, we need to
11950 recompute to reflect the new bindings. But we'll
11951 recompute when update_mode_lines is set too; that means
11952 that people can use force-mode-line-update to request
11953 that the menu bar be recomputed. The adverse effect on
11954 the rest of the redisplay algorithm is about the same as
11955 windows_or_buffers_changed anyway. */
11956 if (windows_or_buffers_changed
11957 || w
->update_mode_line
11958 || update_mode_lines
11959 || window_buffer_changed (w
))
11961 struct buffer
*prev
= current_buffer
;
11962 ptrdiff_t count
= SPECPDL_INDEX ();
11963 Lisp_Object frame
, new_tool_bar
;
11964 int new_n_tool_bar
;
11965 struct gcpro gcpro1
;
11967 /* Set current_buffer to the buffer of the selected
11968 window of the frame, so that we get the right local
11970 set_buffer_internal_1 (XBUFFER (w
->contents
));
11972 /* Save match data, if we must. */
11973 if (save_match_data
)
11974 record_unwind_save_match_data ();
11976 /* Make sure that we don't accidentally use bogus keymaps. */
11977 if (NILP (Voverriding_local_map_menu_flag
))
11979 specbind (Qoverriding_terminal_local_map
, Qnil
);
11980 specbind (Qoverriding_local_map
, Qnil
);
11983 GCPRO1 (new_tool_bar
);
11985 /* We must temporarily set the selected frame to this frame
11986 before calling tool_bar_items, because the calculation of
11987 the tool-bar keymap uses the selected frame (see
11988 `tool-bar-make-keymap' in tool-bar.el). */
11989 eassert (EQ (selected_window
,
11990 /* Since we only explicitly preserve selected_frame,
11991 check that selected_window would be redundant. */
11992 XFRAME (selected_frame
)->selected_window
));
11993 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11994 XSETFRAME (frame
, f
);
11995 fast_set_selected_frame (frame
);
11997 /* Build desired tool-bar items from keymaps. */
11999 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12002 /* Redisplay the tool-bar if we changed it. */
12003 if (new_n_tool_bar
!= f
->n_tool_bar_items
12004 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12006 /* Redisplay that happens asynchronously due to an expose event
12007 may access f->tool_bar_items. Make sure we update both
12008 variables within BLOCK_INPUT so no such event interrupts. */
12010 fset_tool_bar_items (f
, new_tool_bar
);
12011 f
->n_tool_bar_items
= new_n_tool_bar
;
12012 w
->update_mode_line
= 1;
12018 unbind_to (count
, Qnil
);
12019 set_buffer_internal_1 (prev
);
12024 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12026 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12027 F's desired tool-bar contents. F->tool_bar_items must have
12028 been set up previously by calling prepare_menu_bars. */
12031 build_desired_tool_bar_string (struct frame
*f
)
12033 int i
, size
, size_needed
;
12034 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12035 Lisp_Object image
, plist
, props
;
12037 image
= plist
= props
= Qnil
;
12038 GCPRO3 (image
, plist
, props
);
12040 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12041 Otherwise, make a new string. */
12043 /* The size of the string we might be able to reuse. */
12044 size
= (STRINGP (f
->desired_tool_bar_string
)
12045 ? SCHARS (f
->desired_tool_bar_string
)
12048 /* We need one space in the string for each image. */
12049 size_needed
= f
->n_tool_bar_items
;
12051 /* Reuse f->desired_tool_bar_string, if possible. */
12052 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12053 fset_desired_tool_bar_string
12054 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12057 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12058 Fremove_text_properties (make_number (0), make_number (size
),
12059 props
, f
->desired_tool_bar_string
);
12062 /* Put a `display' property on the string for the images to display,
12063 put a `menu_item' property on tool-bar items with a value that
12064 is the index of the item in F's tool-bar item vector. */
12065 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12067 #define PROP(IDX) \
12068 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12070 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12071 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12072 int hmargin
, vmargin
, relief
, idx
, end
;
12074 /* If image is a vector, choose the image according to the
12076 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12077 if (VECTORP (image
))
12081 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12082 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12085 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12086 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12088 eassert (ASIZE (image
) >= idx
);
12089 image
= AREF (image
, idx
);
12094 /* Ignore invalid image specifications. */
12095 if (!valid_image_p (image
))
12098 /* Display the tool-bar button pressed, or depressed. */
12099 plist
= Fcopy_sequence (XCDR (image
));
12101 /* Compute margin and relief to draw. */
12102 relief
= (tool_bar_button_relief
>= 0
12103 ? tool_bar_button_relief
12104 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12105 hmargin
= vmargin
= relief
;
12107 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12108 INT_MAX
- max (hmargin
, vmargin
)))
12110 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12111 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12113 else if (CONSP (Vtool_bar_button_margin
))
12115 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12116 INT_MAX
- hmargin
))
12117 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12119 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12120 INT_MAX
- vmargin
))
12121 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12124 if (auto_raise_tool_bar_buttons_p
)
12126 /* Add a `:relief' property to the image spec if the item is
12130 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12137 /* If image is selected, display it pressed, i.e. with a
12138 negative relief. If it's not selected, display it with a
12140 plist
= Fplist_put (plist
, QCrelief
,
12142 ? make_number (-relief
)
12143 : make_number (relief
)));
12148 /* Put a margin around the image. */
12149 if (hmargin
|| vmargin
)
12151 if (hmargin
== vmargin
)
12152 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12154 plist
= Fplist_put (plist
, QCmargin
,
12155 Fcons (make_number (hmargin
),
12156 make_number (vmargin
)));
12159 /* If button is not enabled, and we don't have special images
12160 for the disabled state, make the image appear disabled by
12161 applying an appropriate algorithm to it. */
12162 if (!enabled_p
&& idx
< 0)
12163 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12165 /* Put a `display' text property on the string for the image to
12166 display. Put a `menu-item' property on the string that gives
12167 the start of this item's properties in the tool-bar items
12169 image
= Fcons (Qimage
, plist
);
12170 props
= list4 (Qdisplay
, image
,
12171 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12173 /* Let the last image hide all remaining spaces in the tool bar
12174 string. The string can be longer than needed when we reuse a
12175 previous string. */
12176 if (i
+ 1 == f
->n_tool_bar_items
)
12177 end
= SCHARS (f
->desired_tool_bar_string
);
12180 Fadd_text_properties (make_number (i
), make_number (end
),
12181 props
, f
->desired_tool_bar_string
);
12189 /* Display one line of the tool-bar of frame IT->f.
12191 HEIGHT specifies the desired height of the tool-bar line.
12192 If the actual height of the glyph row is less than HEIGHT, the
12193 row's height is increased to HEIGHT, and the icons are centered
12194 vertically in the new height.
12196 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12197 count a final empty row in case the tool-bar width exactly matches
12202 display_tool_bar_line (struct it
*it
, int height
)
12204 struct glyph_row
*row
= it
->glyph_row
;
12205 int max_x
= it
->last_visible_x
;
12206 struct glyph
*last
;
12208 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12209 clear_glyph_row (row
);
12210 row
->enabled_p
= true;
12211 row
->y
= it
->current_y
;
12213 /* Note that this isn't made use of if the face hasn't a box,
12214 so there's no need to check the face here. */
12215 it
->start_of_box_run_p
= 1;
12217 while (it
->current_x
< max_x
)
12219 int x
, n_glyphs_before
, i
, nglyphs
;
12220 struct it it_before
;
12222 /* Get the next display element. */
12223 if (!get_next_display_element (it
))
12225 /* Don't count empty row if we are counting needed tool-bar lines. */
12226 if (height
< 0 && !it
->hpos
)
12231 /* Produce glyphs. */
12232 n_glyphs_before
= row
->used
[TEXT_AREA
];
12235 PRODUCE_GLYPHS (it
);
12237 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12239 x
= it_before
.current_x
;
12240 while (i
< nglyphs
)
12242 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12244 if (x
+ glyph
->pixel_width
> max_x
)
12246 /* Glyph doesn't fit on line. Backtrack. */
12247 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12249 /* If this is the only glyph on this line, it will never fit on the
12250 tool-bar, so skip it. But ensure there is at least one glyph,
12251 so we don't accidentally disable the tool-bar. */
12252 if (n_glyphs_before
== 0
12253 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12259 x
+= glyph
->pixel_width
;
12263 /* Stop at line end. */
12264 if (ITERATOR_AT_END_OF_LINE_P (it
))
12267 set_iterator_to_next (it
, 1);
12272 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12274 /* Use default face for the border below the tool bar.
12276 FIXME: When auto-resize-tool-bars is grow-only, there is
12277 no additional border below the possibly empty tool-bar lines.
12278 So to make the extra empty lines look "normal", we have to
12279 use the tool-bar face for the border too. */
12280 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12281 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12282 it
->face_id
= DEFAULT_FACE_ID
;
12284 extend_face_to_end_of_line (it
);
12285 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12286 last
->right_box_line_p
= 1;
12287 if (last
== row
->glyphs
[TEXT_AREA
])
12288 last
->left_box_line_p
= 1;
12290 /* Make line the desired height and center it vertically. */
12291 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12293 /* Don't add more than one line height. */
12294 height
%= FRAME_LINE_HEIGHT (it
->f
);
12295 it
->max_ascent
+= height
/ 2;
12296 it
->max_descent
+= (height
+ 1) / 2;
12299 compute_line_metrics (it
);
12301 /* If line is empty, make it occupy the rest of the tool-bar. */
12302 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12304 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12305 row
->visible_height
= row
->height
;
12306 row
->ascent
= row
->phys_ascent
= 0;
12307 row
->extra_line_spacing
= 0;
12310 row
->full_width_p
= 1;
12311 row
->continued_p
= 0;
12312 row
->truncated_on_left_p
= 0;
12313 row
->truncated_on_right_p
= 0;
12315 it
->current_x
= it
->hpos
= 0;
12316 it
->current_y
+= row
->height
;
12322 /* Value is the number of pixels needed to make all tool-bar items of
12323 frame F visible. The actual number of glyph rows needed is
12324 returned in *N_ROWS if non-NULL. */
12326 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12328 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12330 /* tool_bar_height is called from redisplay_tool_bar after building
12331 the desired matrix, so use (unused) mode-line row as temporary row to
12332 avoid destroying the first tool-bar row. */
12333 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12335 /* Initialize an iterator for iteration over
12336 F->desired_tool_bar_string in the tool-bar window of frame F. */
12337 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12338 temp_row
->reversed_p
= false;
12339 it
.first_visible_x
= 0;
12340 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12341 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12342 it
.paragraph_embedding
= L2R
;
12344 while (!ITERATOR_AT_END_P (&it
))
12346 clear_glyph_row (temp_row
);
12347 it
.glyph_row
= temp_row
;
12348 display_tool_bar_line (&it
, -1);
12350 clear_glyph_row (temp_row
);
12352 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12354 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12357 return it
.current_y
;
12359 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12362 #endif /* !USE_GTK && !HAVE_NS */
12364 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12366 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12367 If FRAME is nil or omitted, use the selected frame. Optional argument
12368 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12369 (Lisp_Object frame
, Lisp_Object pixelwise
)
12373 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12374 struct frame
*f
= decode_any_frame (frame
);
12376 if (WINDOWP (f
->tool_bar_window
)
12377 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12379 update_tool_bar (f
, 1);
12380 if (f
->n_tool_bar_items
)
12382 build_desired_tool_bar_string (f
);
12383 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12388 return make_number (height
);
12392 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12393 height should be changed. */
12395 redisplay_tool_bar (struct frame
*f
)
12397 #if defined (USE_GTK) || defined (HAVE_NS)
12399 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12400 update_frame_tool_bar (f
);
12403 #else /* !USE_GTK && !HAVE_NS */
12407 struct glyph_row
*row
;
12409 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12410 do anything. This means you must start with tool-bar-lines
12411 non-zero to get the auto-sizing effect. Or in other words, you
12412 can turn off tool-bars by specifying tool-bar-lines zero. */
12413 if (!WINDOWP (f
->tool_bar_window
)
12414 || (w
= XWINDOW (f
->tool_bar_window
),
12415 WINDOW_TOTAL_LINES (w
) == 0))
12418 /* Set up an iterator for the tool-bar window. */
12419 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12420 it
.first_visible_x
= 0;
12421 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12422 row
= it
.glyph_row
;
12423 row
->reversed_p
= false;
12425 /* Build a string that represents the contents of the tool-bar. */
12426 build_desired_tool_bar_string (f
);
12427 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12428 /* FIXME: This should be controlled by a user option. But it
12429 doesn't make sense to have an R2L tool bar if the menu bar cannot
12430 be drawn also R2L, and making the menu bar R2L is tricky due
12431 toolkit-specific code that implements it. If an R2L tool bar is
12432 ever supported, display_tool_bar_line should also be augmented to
12433 call unproduce_glyphs like display_line and display_string
12435 it
.paragraph_embedding
= L2R
;
12437 if (f
->n_tool_bar_rows
== 0)
12439 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12441 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12443 x_change_tool_bar_height (f
, new_height
);
12444 /* Always do that now. */
12445 clear_glyph_matrix (w
->desired_matrix
);
12446 f
->fonts_changed
= 1;
12451 /* Display as many lines as needed to display all tool-bar items. */
12453 if (f
->n_tool_bar_rows
> 0)
12455 int border
, rows
, height
, extra
;
12457 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12458 border
= XINT (Vtool_bar_border
);
12459 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12460 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12461 else if (EQ (Vtool_bar_border
, Qborder_width
))
12462 border
= f
->border_width
;
12468 rows
= f
->n_tool_bar_rows
;
12469 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12470 extra
= it
.last_visible_y
- border
- height
* rows
;
12472 while (it
.current_y
< it
.last_visible_y
)
12475 if (extra
> 0 && rows
-- > 0)
12477 h
= (extra
+ rows
- 1) / rows
;
12480 display_tool_bar_line (&it
, height
+ h
);
12485 while (it
.current_y
< it
.last_visible_y
)
12486 display_tool_bar_line (&it
, 0);
12489 /* It doesn't make much sense to try scrolling in the tool-bar
12490 window, so don't do it. */
12491 w
->desired_matrix
->no_scrolling_p
= 1;
12492 w
->must_be_updated_p
= 1;
12494 if (!NILP (Vauto_resize_tool_bars
))
12496 int change_height_p
= 0;
12498 /* If we couldn't display everything, change the tool-bar's
12499 height if there is room for more. */
12500 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12501 change_height_p
= 1;
12503 /* We subtract 1 because display_tool_bar_line advances the
12504 glyph_row pointer before returning to its caller. We want to
12505 examine the last glyph row produced by
12506 display_tool_bar_line. */
12507 row
= it
.glyph_row
- 1;
12509 /* If there are blank lines at the end, except for a partially
12510 visible blank line at the end that is smaller than
12511 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12512 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12513 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12514 change_height_p
= 1;
12516 /* If row displays tool-bar items, but is partially visible,
12517 change the tool-bar's height. */
12518 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12519 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12520 change_height_p
= 1;
12522 /* Resize windows as needed by changing the `tool-bar-lines'
12523 frame parameter. */
12524 if (change_height_p
)
12527 int new_height
= tool_bar_height (f
, &nrows
, 1);
12529 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12530 && !f
->minimize_tool_bar_window_p
)
12531 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12532 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12533 f
->minimize_tool_bar_window_p
= 0;
12535 if (change_height_p
)
12537 x_change_tool_bar_height (f
, new_height
);
12538 clear_glyph_matrix (w
->desired_matrix
);
12539 f
->n_tool_bar_rows
= nrows
;
12540 f
->fonts_changed
= 1;
12547 f
->minimize_tool_bar_window_p
= 0;
12550 #endif /* USE_GTK || HAVE_NS */
12553 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12555 /* Get information about the tool-bar item which is displayed in GLYPH
12556 on frame F. Return in *PROP_IDX the index where tool-bar item
12557 properties start in F->tool_bar_items. Value is zero if
12558 GLYPH doesn't display a tool-bar item. */
12561 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12567 /* This function can be called asynchronously, which means we must
12568 exclude any possibility that Fget_text_property signals an
12570 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12571 charpos
= max (0, charpos
);
12573 /* Get the text property `menu-item' at pos. The value of that
12574 property is the start index of this item's properties in
12575 F->tool_bar_items. */
12576 prop
= Fget_text_property (make_number (charpos
),
12577 Qmenu_item
, f
->current_tool_bar_string
);
12578 if (INTEGERP (prop
))
12580 *prop_idx
= XINT (prop
);
12590 /* Get information about the tool-bar item at position X/Y on frame F.
12591 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12592 the current matrix of the tool-bar window of F, or NULL if not
12593 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12594 item in F->tool_bar_items. Value is
12596 -1 if X/Y is not on a tool-bar item
12597 0 if X/Y is on the same item that was highlighted before.
12601 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12602 int *hpos
, int *vpos
, int *prop_idx
)
12604 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12605 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12608 /* Find the glyph under X/Y. */
12609 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12610 if (*glyph
== NULL
)
12613 /* Get the start of this tool-bar item's properties in
12614 f->tool_bar_items. */
12615 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12618 /* Is mouse on the highlighted item? */
12619 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12620 && *vpos
>= hlinfo
->mouse_face_beg_row
12621 && *vpos
<= hlinfo
->mouse_face_end_row
12622 && (*vpos
> hlinfo
->mouse_face_beg_row
12623 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12624 && (*vpos
< hlinfo
->mouse_face_end_row
12625 || *hpos
< hlinfo
->mouse_face_end_col
12626 || hlinfo
->mouse_face_past_end
))
12634 Handle mouse button event on the tool-bar of frame F, at
12635 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12636 0 for button release. MODIFIERS is event modifiers for button
12640 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12643 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12644 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12645 int hpos
, vpos
, prop_idx
;
12646 struct glyph
*glyph
;
12647 Lisp_Object enabled_p
;
12650 /* If not on the highlighted tool-bar item, and mouse-highlight is
12651 non-nil, return. This is so we generate the tool-bar button
12652 click only when the mouse button is released on the same item as
12653 where it was pressed. However, when mouse-highlight is disabled,
12654 generate the click when the button is released regardless of the
12655 highlight, since tool-bar items are not highlighted in that
12657 frame_to_window_pixel_xy (w
, &x
, &y
);
12658 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12660 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12663 /* When mouse-highlight is off, generate the click for the item
12664 where the button was pressed, disregarding where it was
12666 if (NILP (Vmouse_highlight
) && !down_p
)
12667 prop_idx
= f
->last_tool_bar_item
;
12669 /* If item is disabled, do nothing. */
12670 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12671 if (NILP (enabled_p
))
12676 /* Show item in pressed state. */
12677 if (!NILP (Vmouse_highlight
))
12678 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12679 f
->last_tool_bar_item
= prop_idx
;
12683 Lisp_Object key
, frame
;
12684 struct input_event event
;
12685 EVENT_INIT (event
);
12687 /* Show item in released state. */
12688 if (!NILP (Vmouse_highlight
))
12689 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12691 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12693 XSETFRAME (frame
, f
);
12694 event
.kind
= TOOL_BAR_EVENT
;
12695 event
.frame_or_window
= frame
;
12697 kbd_buffer_store_event (&event
);
12699 event
.kind
= TOOL_BAR_EVENT
;
12700 event
.frame_or_window
= frame
;
12702 event
.modifiers
= modifiers
;
12703 kbd_buffer_store_event (&event
);
12704 f
->last_tool_bar_item
= -1;
12709 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12710 tool-bar window-relative coordinates X/Y. Called from
12711 note_mouse_highlight. */
12714 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12716 Lisp_Object window
= f
->tool_bar_window
;
12717 struct window
*w
= XWINDOW (window
);
12718 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12719 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12721 struct glyph
*glyph
;
12722 struct glyph_row
*row
;
12724 Lisp_Object enabled_p
;
12726 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12727 int mouse_down_p
, rc
;
12729 /* Function note_mouse_highlight is called with negative X/Y
12730 values when mouse moves outside of the frame. */
12731 if (x
<= 0 || y
<= 0)
12733 clear_mouse_face (hlinfo
);
12737 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12740 /* Not on tool-bar item. */
12741 clear_mouse_face (hlinfo
);
12745 /* On same tool-bar item as before. */
12746 goto set_help_echo
;
12748 clear_mouse_face (hlinfo
);
12750 /* Mouse is down, but on different tool-bar item? */
12751 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12752 && f
== dpyinfo
->last_mouse_frame
);
12754 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12757 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12759 /* If tool-bar item is not enabled, don't highlight it. */
12760 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12761 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12763 /* Compute the x-position of the glyph. In front and past the
12764 image is a space. We include this in the highlighted area. */
12765 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12766 for (i
= x
= 0; i
< hpos
; ++i
)
12767 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12769 /* Record this as the current active region. */
12770 hlinfo
->mouse_face_beg_col
= hpos
;
12771 hlinfo
->mouse_face_beg_row
= vpos
;
12772 hlinfo
->mouse_face_beg_x
= x
;
12773 hlinfo
->mouse_face_past_end
= 0;
12775 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12776 hlinfo
->mouse_face_end_row
= vpos
;
12777 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12778 hlinfo
->mouse_face_window
= window
;
12779 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12781 /* Display it as active. */
12782 show_mouse_face (hlinfo
, draw
);
12787 /* Set help_echo_string to a help string to display for this tool-bar item.
12788 XTread_socket does the rest. */
12789 help_echo_object
= help_echo_window
= Qnil
;
12790 help_echo_pos
= -1;
12791 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12792 if (NILP (help_echo_string
))
12793 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12796 #endif /* !USE_GTK && !HAVE_NS */
12798 #endif /* HAVE_WINDOW_SYSTEM */
12802 /************************************************************************
12803 Horizontal scrolling
12804 ************************************************************************/
12806 static int hscroll_window_tree (Lisp_Object
);
12807 static int hscroll_windows (Lisp_Object
);
12809 /* For all leaf windows in the window tree rooted at WINDOW, set their
12810 hscroll value so that PT is (i) visible in the window, and (ii) so
12811 that it is not within a certain margin at the window's left and
12812 right border. Value is non-zero if any window's hscroll has been
12816 hscroll_window_tree (Lisp_Object window
)
12818 int hscrolled_p
= 0;
12819 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12820 int hscroll_step_abs
= 0;
12821 double hscroll_step_rel
= 0;
12823 if (hscroll_relative_p
)
12825 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12826 if (hscroll_step_rel
< 0)
12828 hscroll_relative_p
= 0;
12829 hscroll_step_abs
= 0;
12832 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12834 hscroll_step_abs
= XINT (Vhscroll_step
);
12835 if (hscroll_step_abs
< 0)
12836 hscroll_step_abs
= 0;
12839 hscroll_step_abs
= 0;
12841 while (WINDOWP (window
))
12843 struct window
*w
= XWINDOW (window
);
12845 if (WINDOWP (w
->contents
))
12846 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12847 else if (w
->cursor
.vpos
>= 0)
12850 int text_area_width
;
12851 struct glyph_row
*cursor_row
;
12852 struct glyph_row
*bottom_row
;
12855 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12856 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12857 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12859 cursor_row
= bottom_row
- 1;
12861 if (!cursor_row
->enabled_p
)
12863 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12864 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12865 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12867 cursor_row
= bottom_row
- 1;
12869 row_r2l_p
= cursor_row
->reversed_p
;
12871 text_area_width
= window_box_width (w
, TEXT_AREA
);
12873 /* Scroll when cursor is inside this scroll margin. */
12874 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12876 /* If the position of this window's point has explicitly
12877 changed, no more suspend auto hscrolling. */
12878 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12879 w
->suspend_auto_hscroll
= 0;
12881 /* Remember window point. */
12882 Fset_marker (w
->old_pointm
,
12883 ((w
== XWINDOW (selected_window
))
12884 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12885 : Fmarker_position (w
->pointm
)),
12888 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12889 && w
->suspend_auto_hscroll
== 0
12890 /* In some pathological cases, like restoring a window
12891 configuration into a frame that is much smaller than
12892 the one from which the configuration was saved, we
12893 get glyph rows whose start and end have zero buffer
12894 positions, which we cannot handle below. Just skip
12896 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12897 /* For left-to-right rows, hscroll when cursor is either
12898 (i) inside the right hscroll margin, or (ii) if it is
12899 inside the left margin and the window is already
12902 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12903 || (cursor_row
->enabled_p
12904 && cursor_row
->truncated_on_right_p
12905 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12906 /* For right-to-left rows, the logic is similar,
12907 except that rules for scrolling to left and right
12908 are reversed. E.g., if cursor.x <= h_margin, we
12909 need to hscroll "to the right" unconditionally,
12910 and that will scroll the screen to the left so as
12911 to reveal the next portion of the row. */
12913 && ((cursor_row
->enabled_p
12914 /* FIXME: It is confusing to set the
12915 truncated_on_right_p flag when R2L rows
12916 are actually truncated on the left. */
12917 && cursor_row
->truncated_on_right_p
12918 && w
->cursor
.x
<= h_margin
)
12920 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12924 struct buffer
*saved_current_buffer
;
12928 /* Find point in a display of infinite width. */
12929 saved_current_buffer
= current_buffer
;
12930 current_buffer
= XBUFFER (w
->contents
);
12932 if (w
== XWINDOW (selected_window
))
12935 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12937 /* Move iterator to pt starting at cursor_row->start in
12938 a line with infinite width. */
12939 init_to_row_start (&it
, w
, cursor_row
);
12940 it
.last_visible_x
= INFINITY
;
12941 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12942 current_buffer
= saved_current_buffer
;
12944 /* Position cursor in window. */
12945 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12946 hscroll
= max (0, (it
.current_x
12947 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12948 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12949 : (text_area_width
/ 2))))
12950 / FRAME_COLUMN_WIDTH (it
.f
);
12951 else if ((!row_r2l_p
12952 && w
->cursor
.x
>= text_area_width
- h_margin
)
12953 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12955 if (hscroll_relative_p
)
12956 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12959 wanted_x
= text_area_width
12960 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12963 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12967 if (hscroll_relative_p
)
12968 wanted_x
= text_area_width
* hscroll_step_rel
12971 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12974 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12976 hscroll
= max (hscroll
, w
->min_hscroll
);
12978 /* Don't prevent redisplay optimizations if hscroll
12979 hasn't changed, as it will unnecessarily slow down
12981 if (w
->hscroll
!= hscroll
)
12983 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12984 w
->hscroll
= hscroll
;
12993 /* Value is non-zero if hscroll of any leaf window has been changed. */
12994 return hscrolled_p
;
12998 /* Set hscroll so that cursor is visible and not inside horizontal
12999 scroll margins for all windows in the tree rooted at WINDOW. See
13000 also hscroll_window_tree above. Value is non-zero if any window's
13001 hscroll has been changed. If it has, desired matrices on the frame
13002 of WINDOW are cleared. */
13005 hscroll_windows (Lisp_Object window
)
13007 int hscrolled_p
= hscroll_window_tree (window
);
13009 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13010 return hscrolled_p
;
13015 /************************************************************************
13017 ************************************************************************/
13019 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13020 to a non-zero value. This is sometimes handy to have in a debugger
13025 /* First and last unchanged row for try_window_id. */
13027 static int debug_first_unchanged_at_end_vpos
;
13028 static int debug_last_unchanged_at_beg_vpos
;
13030 /* Delta vpos and y. */
13032 static int debug_dvpos
, debug_dy
;
13034 /* Delta in characters and bytes for try_window_id. */
13036 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13038 /* Values of window_end_pos and window_end_vpos at the end of
13041 static ptrdiff_t debug_end_vpos
;
13043 /* Append a string to W->desired_matrix->method. FMT is a printf
13044 format string. If trace_redisplay_p is true also printf the
13045 resulting string to stderr. */
13047 static void debug_method_add (struct window
*, char const *, ...)
13048 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13051 debug_method_add (struct window
*w
, char const *fmt
, ...)
13054 char *method
= w
->desired_matrix
->method
;
13055 int len
= strlen (method
);
13056 int size
= sizeof w
->desired_matrix
->method
;
13057 int remaining
= size
- len
- 1;
13060 if (len
&& remaining
)
13063 --remaining
, ++len
;
13066 va_start (ap
, fmt
);
13067 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13070 if (trace_redisplay_p
)
13071 fprintf (stderr
, "%p (%s): %s\n",
13073 ((BUFFERP (w
->contents
)
13074 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13075 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13080 #endif /* GLYPH_DEBUG */
13083 /* Value is non-zero if all changes in window W, which displays
13084 current_buffer, are in the text between START and END. START is a
13085 buffer position, END is given as a distance from Z. Used in
13086 redisplay_internal for display optimization. */
13089 text_outside_line_unchanged_p (struct window
*w
,
13090 ptrdiff_t start
, ptrdiff_t end
)
13092 int unchanged_p
= 1;
13094 /* If text or overlays have changed, see where. */
13095 if (window_outdated (w
))
13097 /* Gap in the line? */
13098 if (GPT
< start
|| Z
- GPT
< end
)
13101 /* Changes start in front of the line, or end after it? */
13103 && (BEG_UNCHANGED
< start
- 1
13104 || END_UNCHANGED
< end
))
13107 /* If selective display, can't optimize if changes start at the
13108 beginning of the line. */
13110 && INTEGERP (BVAR (current_buffer
, selective_display
))
13111 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13112 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13115 /* If there are overlays at the start or end of the line, these
13116 may have overlay strings with newlines in them. A change at
13117 START, for instance, may actually concern the display of such
13118 overlay strings as well, and they are displayed on different
13119 lines. So, quickly rule out this case. (For the future, it
13120 might be desirable to implement something more telling than
13121 just BEG/END_UNCHANGED.) */
13124 if (BEG
+ BEG_UNCHANGED
== start
13125 && overlay_touches_p (start
))
13127 if (END_UNCHANGED
== end
13128 && overlay_touches_p (Z
- end
))
13132 /* Under bidi reordering, adding or deleting a character in the
13133 beginning of a paragraph, before the first strong directional
13134 character, can change the base direction of the paragraph (unless
13135 the buffer specifies a fixed paragraph direction), which will
13136 require to redisplay the whole paragraph. It might be worthwhile
13137 to find the paragraph limits and widen the range of redisplayed
13138 lines to that, but for now just give up this optimization. */
13139 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13140 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13144 return unchanged_p
;
13148 /* Do a frame update, taking possible shortcuts into account. This is
13149 the main external entry point for redisplay.
13151 If the last redisplay displayed an echo area message and that message
13152 is no longer requested, we clear the echo area or bring back the
13153 mini-buffer if that is in use. */
13158 redisplay_internal ();
13163 overlay_arrow_string_or_property (Lisp_Object var
)
13167 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13170 return Voverlay_arrow_string
;
13173 /* Return 1 if there are any overlay-arrows in current_buffer. */
13175 overlay_arrow_in_current_buffer_p (void)
13179 for (vlist
= Voverlay_arrow_variable_list
;
13181 vlist
= XCDR (vlist
))
13183 Lisp_Object var
= XCAR (vlist
);
13186 if (!SYMBOLP (var
))
13188 val
= find_symbol_value (var
);
13190 && current_buffer
== XMARKER (val
)->buffer
)
13197 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13201 overlay_arrows_changed_p (void)
13205 for (vlist
= Voverlay_arrow_variable_list
;
13207 vlist
= XCDR (vlist
))
13209 Lisp_Object var
= XCAR (vlist
);
13210 Lisp_Object val
, pstr
;
13212 if (!SYMBOLP (var
))
13214 val
= find_symbol_value (var
);
13215 if (!MARKERP (val
))
13217 if (! EQ (COERCE_MARKER (val
),
13218 Fget (var
, Qlast_arrow_position
))
13219 || ! (pstr
= overlay_arrow_string_or_property (var
),
13220 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13226 /* Mark overlay arrows to be updated on next redisplay. */
13229 update_overlay_arrows (int up_to_date
)
13233 for (vlist
= Voverlay_arrow_variable_list
;
13235 vlist
= XCDR (vlist
))
13237 Lisp_Object var
= XCAR (vlist
);
13239 if (!SYMBOLP (var
))
13242 if (up_to_date
> 0)
13244 Lisp_Object val
= find_symbol_value (var
);
13245 Fput (var
, Qlast_arrow_position
,
13246 COERCE_MARKER (val
));
13247 Fput (var
, Qlast_arrow_string
,
13248 overlay_arrow_string_or_property (var
));
13250 else if (up_to_date
< 0
13251 || !NILP (Fget (var
, Qlast_arrow_position
)))
13253 Fput (var
, Qlast_arrow_position
, Qt
);
13254 Fput (var
, Qlast_arrow_string
, Qt
);
13260 /* Return overlay arrow string to display at row.
13261 Return integer (bitmap number) for arrow bitmap in left fringe.
13262 Return nil if no overlay arrow. */
13265 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13269 for (vlist
= Voverlay_arrow_variable_list
;
13271 vlist
= XCDR (vlist
))
13273 Lisp_Object var
= XCAR (vlist
);
13276 if (!SYMBOLP (var
))
13279 val
= find_symbol_value (var
);
13282 && current_buffer
== XMARKER (val
)->buffer
13283 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13285 if (FRAME_WINDOW_P (it
->f
)
13286 /* FIXME: if ROW->reversed_p is set, this should test
13287 the right fringe, not the left one. */
13288 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13290 #ifdef HAVE_WINDOW_SYSTEM
13291 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13294 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13295 return make_number (fringe_bitmap
);
13298 return make_number (-1); /* Use default arrow bitmap. */
13300 return overlay_arrow_string_or_property (var
);
13307 /* Return 1 if point moved out of or into a composition. Otherwise
13308 return 0. PREV_BUF and PREV_PT are the last point buffer and
13309 position. BUF and PT are the current point buffer and position. */
13312 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13313 struct buffer
*buf
, ptrdiff_t pt
)
13315 ptrdiff_t start
, end
;
13317 Lisp_Object buffer
;
13319 XSETBUFFER (buffer
, buf
);
13320 /* Check a composition at the last point if point moved within the
13322 if (prev_buf
== buf
)
13325 /* Point didn't move. */
13328 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13329 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13330 && composition_valid_p (start
, end
, prop
)
13331 && start
< prev_pt
&& end
> prev_pt
)
13332 /* The last point was within the composition. Return 1 iff
13333 point moved out of the composition. */
13334 return (pt
<= start
|| pt
>= end
);
13337 /* Check a composition at the current point. */
13338 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13339 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13340 && composition_valid_p (start
, end
, prop
)
13341 && start
< pt
&& end
> pt
);
13344 /* Reconsider the clip changes of buffer which is displayed in W. */
13347 reconsider_clip_changes (struct window
*w
)
13349 struct buffer
*b
= XBUFFER (w
->contents
);
13351 if (b
->clip_changed
13352 && w
->window_end_valid
13353 && w
->current_matrix
->buffer
== b
13354 && w
->current_matrix
->zv
== BUF_ZV (b
)
13355 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13356 b
->clip_changed
= 0;
13358 /* If display wasn't paused, and W is not a tool bar window, see if
13359 point has been moved into or out of a composition. In that case,
13360 we set b->clip_changed to 1 to force updating the screen. If
13361 b->clip_changed has already been set to 1, we can skip this
13363 if (!b
->clip_changed
&& w
->window_end_valid
)
13365 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13366 ? PT
: marker_position (w
->pointm
));
13368 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13369 && check_point_in_composition (w
->current_matrix
->buffer
,
13370 w
->last_point
, b
, pt
))
13371 b
->clip_changed
= 1;
13376 propagate_buffer_redisplay (void)
13377 { /* Resetting b->text->redisplay is problematic!
13378 We can't just reset it in the case that some window that displays
13379 it has not been redisplayed; and such a window can stay
13380 unredisplayed for a long time if it's currently invisible.
13381 But we do want to reset it at the end of redisplay otherwise
13382 its displayed windows will keep being redisplayed over and over
13384 So we copy all b->text->redisplay flags up to their windows here,
13385 such that mark_window_display_accurate can safely reset
13386 b->text->redisplay. */
13387 Lisp_Object ws
= window_list ();
13388 for (; CONSP (ws
); ws
= XCDR (ws
))
13390 struct window
*thisw
= XWINDOW (XCAR (ws
));
13391 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13392 if (thisb
->text
->redisplay
)
13393 thisw
->redisplay
= true;
13397 #define STOP_POLLING \
13398 do { if (! polling_stopped_here) stop_polling (); \
13399 polling_stopped_here = 1; } while (0)
13401 #define RESUME_POLLING \
13402 do { if (polling_stopped_here) start_polling (); \
13403 polling_stopped_here = 0; } while (0)
13406 /* Perhaps in the future avoid recentering windows if it
13407 is not necessary; currently that causes some problems. */
13410 redisplay_internal (void)
13412 struct window
*w
= XWINDOW (selected_window
);
13416 bool must_finish
= 0, match_p
;
13417 struct text_pos tlbufpos
, tlendpos
;
13418 int number_of_visible_frames
;
13421 int polling_stopped_here
= 0;
13422 Lisp_Object tail
, frame
;
13424 /* True means redisplay has to consider all windows on all
13425 frames. False, only selected_window is considered. */
13426 bool consider_all_windows_p
;
13428 /* True means redisplay has to redisplay the miniwindow. */
13429 bool update_miniwindow_p
= false;
13431 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13433 /* No redisplay if running in batch mode or frame is not yet fully
13434 initialized, or redisplay is explicitly turned off by setting
13435 Vinhibit_redisplay. */
13436 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13437 || !NILP (Vinhibit_redisplay
))
13440 /* Don't examine these until after testing Vinhibit_redisplay.
13441 When Emacs is shutting down, perhaps because its connection to
13442 X has dropped, we should not look at them at all. */
13443 fr
= XFRAME (w
->frame
);
13444 sf
= SELECTED_FRAME ();
13446 if (!fr
->glyphs_initialized_p
)
13449 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13450 if (popup_activated ())
13454 /* I don't think this happens but let's be paranoid. */
13455 if (redisplaying_p
)
13458 /* Record a function that clears redisplaying_p
13459 when we leave this function. */
13460 count
= SPECPDL_INDEX ();
13461 record_unwind_protect_void (unwind_redisplay
);
13462 redisplaying_p
= 1;
13463 specbind (Qinhibit_free_realized_faces
, Qnil
);
13465 /* Record this function, so it appears on the profiler's backtraces. */
13466 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13468 FOR_EACH_FRAME (tail
, frame
)
13469 XFRAME (frame
)->already_hscrolled_p
= 0;
13472 /* Remember the currently selected window. */
13476 last_escape_glyph_frame
= NULL
;
13477 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13478 last_glyphless_glyph_frame
= NULL
;
13479 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13481 /* If face_change_count is non-zero, init_iterator will free all
13482 realized faces, which includes the faces referenced from current
13483 matrices. So, we can't reuse current matrices in this case. */
13484 if (face_change_count
)
13485 windows_or_buffers_changed
= 47;
13487 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13488 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13490 /* Since frames on a single ASCII terminal share the same
13491 display area, displaying a different frame means redisplay
13492 the whole thing. */
13493 SET_FRAME_GARBAGED (sf
);
13495 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13497 FRAME_TTY (sf
)->previous_frame
= sf
;
13500 /* Set the visible flags for all frames. Do this before checking for
13501 resized or garbaged frames; they want to know if their frames are
13502 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13503 number_of_visible_frames
= 0;
13505 FOR_EACH_FRAME (tail
, frame
)
13507 struct frame
*f
= XFRAME (frame
);
13509 if (FRAME_VISIBLE_P (f
))
13511 ++number_of_visible_frames
;
13512 /* Adjust matrices for visible frames only. */
13513 if (f
->fonts_changed
)
13515 adjust_frame_glyphs (f
);
13516 f
->fonts_changed
= 0;
13518 /* If cursor type has been changed on the frame
13519 other than selected, consider all frames. */
13520 if (f
!= sf
&& f
->cursor_type_changed
)
13521 update_mode_lines
= 31;
13523 clear_desired_matrices (f
);
13526 /* Notice any pending interrupt request to change frame size. */
13527 do_pending_window_change (1);
13529 /* do_pending_window_change could change the selected_window due to
13530 frame resizing which makes the selected window too small. */
13531 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13534 /* Clear frames marked as garbaged. */
13535 clear_garbaged_frames ();
13537 /* Build menubar and tool-bar items. */
13538 if (NILP (Vmemory_full
))
13539 prepare_menu_bars ();
13541 reconsider_clip_changes (w
);
13543 /* In most cases selected window displays current buffer. */
13544 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13547 /* Detect case that we need to write or remove a star in the mode line. */
13548 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13549 w
->update_mode_line
= 1;
13551 if (mode_line_update_needed (w
))
13552 w
->update_mode_line
= 1;
13555 /* Normally the message* functions will have already displayed and
13556 updated the echo area, but the frame may have been trashed, or
13557 the update may have been preempted, so display the echo area
13558 again here. Checking message_cleared_p captures the case that
13559 the echo area should be cleared. */
13560 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13561 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13562 || (message_cleared_p
13563 && minibuf_level
== 0
13564 /* If the mini-window is currently selected, this means the
13565 echo-area doesn't show through. */
13566 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13568 int window_height_changed_p
= echo_area_display (0);
13570 if (message_cleared_p
)
13571 update_miniwindow_p
= true;
13575 /* If we don't display the current message, don't clear the
13576 message_cleared_p flag, because, if we did, we wouldn't clear
13577 the echo area in the next redisplay which doesn't preserve
13579 if (!display_last_displayed_message_p
)
13580 message_cleared_p
= 0;
13582 if (window_height_changed_p
)
13584 windows_or_buffers_changed
= 50;
13586 /* If window configuration was changed, frames may have been
13587 marked garbaged. Clear them or we will experience
13588 surprises wrt scrolling. */
13589 clear_garbaged_frames ();
13592 else if (EQ (selected_window
, minibuf_window
)
13593 && (current_buffer
->clip_changed
|| window_outdated (w
))
13594 && resize_mini_window (w
, 0))
13596 /* Resized active mini-window to fit the size of what it is
13597 showing if its contents might have changed. */
13600 /* If window configuration was changed, frames may have been
13601 marked garbaged. Clear them or we will experience
13602 surprises wrt scrolling. */
13603 clear_garbaged_frames ();
13606 if (windows_or_buffers_changed
&& !update_mode_lines
)
13607 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13608 only the windows's contents needs to be refreshed, or whether the
13609 mode-lines also need a refresh. */
13610 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13611 ? REDISPLAY_SOME
: 32);
13613 /* If specs for an arrow have changed, do thorough redisplay
13614 to ensure we remove any arrow that should no longer exist. */
13615 if (overlay_arrows_changed_p ())
13616 /* Apparently, this is the only case where we update other windows,
13617 without updating other mode-lines. */
13618 windows_or_buffers_changed
= 49;
13620 consider_all_windows_p
= (update_mode_lines
13621 || windows_or_buffers_changed
);
13623 #define AINC(a,i) \
13624 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13625 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13627 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13628 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13630 /* Optimize the case that only the line containing the cursor in the
13631 selected window has changed. Variables starting with this_ are
13632 set in display_line and record information about the line
13633 containing the cursor. */
13634 tlbufpos
= this_line_start_pos
;
13635 tlendpos
= this_line_end_pos
;
13636 if (!consider_all_windows_p
13637 && CHARPOS (tlbufpos
) > 0
13638 && !w
->update_mode_line
13639 && !current_buffer
->clip_changed
13640 && !current_buffer
->prevent_redisplay_optimizations_p
13641 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13642 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13643 && !XFRAME (w
->frame
)->cursor_type_changed
13644 /* Make sure recorded data applies to current buffer, etc. */
13645 && this_line_buffer
== current_buffer
13648 && !w
->optional_new_start
13649 /* Point must be on the line that we have info recorded about. */
13650 && PT
>= CHARPOS (tlbufpos
)
13651 && PT
<= Z
- CHARPOS (tlendpos
)
13652 /* All text outside that line, including its final newline,
13653 must be unchanged. */
13654 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13655 CHARPOS (tlendpos
)))
13657 if (CHARPOS (tlbufpos
) > BEGV
13658 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13659 && (CHARPOS (tlbufpos
) == ZV
13660 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13661 /* Former continuation line has disappeared by becoming empty. */
13663 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13665 /* We have to handle the case of continuation around a
13666 wide-column character (see the comment in indent.c around
13669 For instance, in the following case:
13671 -------- Insert --------
13672 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13673 J_I_ ==> J_I_ `^^' are cursors.
13677 As we have to redraw the line above, we cannot use this
13681 int line_height_before
= this_line_pixel_height
;
13683 /* Note that start_display will handle the case that the
13684 line starting at tlbufpos is a continuation line. */
13685 start_display (&it
, w
, tlbufpos
);
13687 /* Implementation note: It this still necessary? */
13688 if (it
.current_x
!= this_line_start_x
)
13691 TRACE ((stderr
, "trying display optimization 1\n"));
13692 w
->cursor
.vpos
= -1;
13693 overlay_arrow_seen
= 0;
13694 it
.vpos
= this_line_vpos
;
13695 it
.current_y
= this_line_y
;
13696 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13697 display_line (&it
);
13699 /* If line contains point, is not continued,
13700 and ends at same distance from eob as before, we win. */
13701 if (w
->cursor
.vpos
>= 0
13702 /* Line is not continued, otherwise this_line_start_pos
13703 would have been set to 0 in display_line. */
13704 && CHARPOS (this_line_start_pos
)
13705 /* Line ends as before. */
13706 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13707 /* Line has same height as before. Otherwise other lines
13708 would have to be shifted up or down. */
13709 && this_line_pixel_height
== line_height_before
)
13711 /* If this is not the window's last line, we must adjust
13712 the charstarts of the lines below. */
13713 if (it
.current_y
< it
.last_visible_y
)
13715 struct glyph_row
*row
13716 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13717 ptrdiff_t delta
, delta_bytes
;
13719 /* We used to distinguish between two cases here,
13720 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13721 when the line ends in a newline or the end of the
13722 buffer's accessible portion. But both cases did
13723 the same, so they were collapsed. */
13725 - CHARPOS (tlendpos
)
13726 - MATRIX_ROW_START_CHARPOS (row
));
13727 delta_bytes
= (Z_BYTE
13728 - BYTEPOS (tlendpos
)
13729 - MATRIX_ROW_START_BYTEPOS (row
));
13731 increment_matrix_positions (w
->current_matrix
,
13732 this_line_vpos
+ 1,
13733 w
->current_matrix
->nrows
,
13734 delta
, delta_bytes
);
13737 /* If this row displays text now but previously didn't,
13738 or vice versa, w->window_end_vpos may have to be
13740 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13742 if (w
->window_end_vpos
< this_line_vpos
)
13743 w
->window_end_vpos
= this_line_vpos
;
13745 else if (w
->window_end_vpos
== this_line_vpos
13746 && this_line_vpos
> 0)
13747 w
->window_end_vpos
= this_line_vpos
- 1;
13748 w
->window_end_valid
= 0;
13750 /* Update hint: No need to try to scroll in update_window. */
13751 w
->desired_matrix
->no_scrolling_p
= 1;
13754 *w
->desired_matrix
->method
= 0;
13755 debug_method_add (w
, "optimization 1");
13757 #ifdef HAVE_WINDOW_SYSTEM
13758 update_window_fringes (w
, 0);
13765 else if (/* Cursor position hasn't changed. */
13766 PT
== w
->last_point
13767 /* Make sure the cursor was last displayed
13768 in this window. Otherwise we have to reposition it. */
13770 /* PXW: Must be converted to pixels, probably. */
13771 && 0 <= w
->cursor
.vpos
13772 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13776 do_pending_window_change (1);
13777 /* If selected_window changed, redisplay again. */
13778 if (WINDOWP (selected_window
)
13779 && (w
= XWINDOW (selected_window
)) != sw
)
13782 /* We used to always goto end_of_redisplay here, but this
13783 isn't enough if we have a blinking cursor. */
13784 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13785 goto end_of_redisplay
;
13789 /* If highlighting the region, or if the cursor is in the echo area,
13790 then we can't just move the cursor. */
13791 else if (NILP (Vshow_trailing_whitespace
)
13792 && !cursor_in_echo_area
)
13795 struct glyph_row
*row
;
13797 /* Skip from tlbufpos to PT and see where it is. Note that
13798 PT may be in invisible text. If so, we will end at the
13799 next visible position. */
13800 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13801 NULL
, DEFAULT_FACE_ID
);
13802 it
.current_x
= this_line_start_x
;
13803 it
.current_y
= this_line_y
;
13804 it
.vpos
= this_line_vpos
;
13806 /* The call to move_it_to stops in front of PT, but
13807 moves over before-strings. */
13808 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13810 if (it
.vpos
== this_line_vpos
13811 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13814 eassert (this_line_vpos
== it
.vpos
);
13815 eassert (this_line_y
== it
.current_y
);
13816 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13818 *w
->desired_matrix
->method
= 0;
13819 debug_method_add (w
, "optimization 3");
13828 /* Text changed drastically or point moved off of line. */
13829 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13832 CHARPOS (this_line_start_pos
) = 0;
13833 ++clear_face_cache_count
;
13834 #ifdef HAVE_WINDOW_SYSTEM
13835 ++clear_image_cache_count
;
13838 /* Build desired matrices, and update the display. If
13839 consider_all_windows_p is non-zero, do it for all windows on all
13840 frames. Otherwise do it for selected_window, only. */
13842 if (consider_all_windows_p
)
13844 FOR_EACH_FRAME (tail
, frame
)
13845 XFRAME (frame
)->updated_p
= 0;
13847 propagate_buffer_redisplay ();
13849 FOR_EACH_FRAME (tail
, frame
)
13851 struct frame
*f
= XFRAME (frame
);
13853 /* We don't have to do anything for unselected terminal
13855 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13856 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13861 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13864 /* Only GC scrollbars when we redisplay the whole frame. */
13865 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13866 /* Mark all the scroll bars to be removed; we'll redeem
13867 the ones we want when we redisplay their windows. */
13868 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13869 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13871 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13872 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13873 /* Remember that the invisible frames need to be redisplayed next
13874 time they're visible. */
13875 else if (!REDISPLAY_SOME_P ())
13876 f
->redisplay
= true;
13878 /* The X error handler may have deleted that frame. */
13879 if (!FRAME_LIVE_P (f
))
13882 /* Any scroll bars which redisplay_windows should have
13883 nuked should now go away. */
13884 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13885 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13887 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13889 /* If fonts changed on visible frame, display again. */
13890 if (f
->fonts_changed
)
13892 adjust_frame_glyphs (f
);
13893 f
->fonts_changed
= 0;
13897 /* See if we have to hscroll. */
13898 if (!f
->already_hscrolled_p
)
13900 f
->already_hscrolled_p
= 1;
13901 if (hscroll_windows (f
->root_window
))
13905 /* Prevent various kinds of signals during display
13906 update. stdio is not robust about handling
13907 signals, which can cause an apparent I/O error. */
13908 if (interrupt_input
)
13909 unrequest_sigio ();
13912 pending
|= update_frame (f
, 0, 0);
13913 f
->cursor_type_changed
= 0;
13919 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13923 /* Do the mark_window_display_accurate after all windows have
13924 been redisplayed because this call resets flags in buffers
13925 which are needed for proper redisplay. */
13926 FOR_EACH_FRAME (tail
, frame
)
13928 struct frame
*f
= XFRAME (frame
);
13931 f
->redisplay
= false;
13932 mark_window_display_accurate (f
->root_window
, 1);
13933 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13934 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13939 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13941 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13942 struct frame
*mini_frame
;
13944 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13945 /* Use list_of_error, not Qerror, so that
13946 we catch only errors and don't run the debugger. */
13947 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13949 redisplay_window_error
);
13950 if (update_miniwindow_p
)
13951 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13953 redisplay_window_error
);
13955 /* Compare desired and current matrices, perform output. */
13958 /* If fonts changed, display again. */
13959 if (sf
->fonts_changed
)
13962 /* Prevent various kinds of signals during display update.
13963 stdio is not robust about handling signals,
13964 which can cause an apparent I/O error. */
13965 if (interrupt_input
)
13966 unrequest_sigio ();
13969 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13971 if (hscroll_windows (selected_window
))
13974 XWINDOW (selected_window
)->must_be_updated_p
= true;
13975 pending
= update_frame (sf
, 0, 0);
13976 sf
->cursor_type_changed
= 0;
13979 /* We may have called echo_area_display at the top of this
13980 function. If the echo area is on another frame, that may
13981 have put text on a frame other than the selected one, so the
13982 above call to update_frame would not have caught it. Catch
13984 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13985 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13987 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13989 XWINDOW (mini_window
)->must_be_updated_p
= true;
13990 pending
|= update_frame (mini_frame
, 0, 0);
13991 mini_frame
->cursor_type_changed
= 0;
13992 if (!pending
&& hscroll_windows (mini_window
))
13997 /* If display was paused because of pending input, make sure we do a
13998 thorough update the next time. */
14001 /* Prevent the optimization at the beginning of
14002 redisplay_internal that tries a single-line update of the
14003 line containing the cursor in the selected window. */
14004 CHARPOS (this_line_start_pos
) = 0;
14006 /* Let the overlay arrow be updated the next time. */
14007 update_overlay_arrows (0);
14009 /* If we pause after scrolling, some rows in the current
14010 matrices of some windows are not valid. */
14011 if (!WINDOW_FULL_WIDTH_P (w
)
14012 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14013 update_mode_lines
= 36;
14017 if (!consider_all_windows_p
)
14019 /* This has already been done above if
14020 consider_all_windows_p is set. */
14021 if (XBUFFER (w
->contents
)->text
->redisplay
14022 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14023 /* This can happen if b->text->redisplay was set during
14025 propagate_buffer_redisplay ();
14026 mark_window_display_accurate_1 (w
, 1);
14028 /* Say overlay arrows are up to date. */
14029 update_overlay_arrows (1);
14031 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14032 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14035 update_mode_lines
= 0;
14036 windows_or_buffers_changed
= 0;
14039 /* Start SIGIO interrupts coming again. Having them off during the
14040 code above makes it less likely one will discard output, but not
14041 impossible, since there might be stuff in the system buffer here.
14042 But it is much hairier to try to do anything about that. */
14043 if (interrupt_input
)
14047 /* If a frame has become visible which was not before, redisplay
14048 again, so that we display it. Expose events for such a frame
14049 (which it gets when becoming visible) don't call the parts of
14050 redisplay constructing glyphs, so simply exposing a frame won't
14051 display anything in this case. So, we have to display these
14052 frames here explicitly. */
14057 FOR_EACH_FRAME (tail
, frame
)
14059 if (XFRAME (frame
)->visible
)
14063 if (new_count
!= number_of_visible_frames
)
14064 windows_or_buffers_changed
= 52;
14067 /* Change frame size now if a change is pending. */
14068 do_pending_window_change (1);
14070 /* If we just did a pending size change, or have additional
14071 visible frames, or selected_window changed, redisplay again. */
14072 if ((windows_or_buffers_changed
&& !pending
)
14073 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14076 /* Clear the face and image caches.
14078 We used to do this only if consider_all_windows_p. But the cache
14079 needs to be cleared if a timer creates images in the current
14080 buffer (e.g. the test case in Bug#6230). */
14082 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14084 clear_face_cache (0);
14085 clear_face_cache_count
= 0;
14088 #ifdef HAVE_WINDOW_SYSTEM
14089 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14091 clear_image_caches (Qnil
);
14092 clear_image_cache_count
= 0;
14094 #endif /* HAVE_WINDOW_SYSTEM */
14097 if (interrupt_input
&& interrupts_deferred
)
14100 unbind_to (count
, Qnil
);
14105 /* Redisplay, but leave alone any recent echo area message unless
14106 another message has been requested in its place.
14108 This is useful in situations where you need to redisplay but no
14109 user action has occurred, making it inappropriate for the message
14110 area to be cleared. See tracking_off and
14111 wait_reading_process_output for examples of these situations.
14113 FROM_WHERE is an integer saying from where this function was
14114 called. This is useful for debugging. */
14117 redisplay_preserve_echo_area (int from_where
)
14119 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14121 if (!NILP (echo_area_buffer
[1]))
14123 /* We have a previously displayed message, but no current
14124 message. Redisplay the previous message. */
14125 display_last_displayed_message_p
= 1;
14126 redisplay_internal ();
14127 display_last_displayed_message_p
= 0;
14130 redisplay_internal ();
14132 flush_frame (SELECTED_FRAME ());
14136 /* Function registered with record_unwind_protect in redisplay_internal. */
14139 unwind_redisplay (void)
14141 redisplaying_p
= 0;
14145 /* Mark the display of leaf window W as accurate or inaccurate.
14146 If ACCURATE_P is non-zero mark display of W as accurate. If
14147 ACCURATE_P is zero, arrange for W to be redisplayed the next
14148 time redisplay_internal is called. */
14151 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14153 struct buffer
*b
= XBUFFER (w
->contents
);
14155 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14156 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14157 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14161 b
->clip_changed
= false;
14162 b
->prevent_redisplay_optimizations_p
= false;
14163 eassert (buffer_window_count (b
) > 0);
14164 /* Resetting b->text->redisplay is problematic!
14165 In order to make it safer to do it here, redisplay_internal must
14166 have copied all b->text->redisplay to their respective windows. */
14167 b
->text
->redisplay
= false;
14169 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14170 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14171 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14172 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14174 w
->current_matrix
->buffer
= b
;
14175 w
->current_matrix
->begv
= BUF_BEGV (b
);
14176 w
->current_matrix
->zv
= BUF_ZV (b
);
14178 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14179 w
->last_cursor_off_p
= w
->cursor_off_p
;
14181 if (w
== XWINDOW (selected_window
))
14182 w
->last_point
= BUF_PT (b
);
14184 w
->last_point
= marker_position (w
->pointm
);
14186 w
->window_end_valid
= true;
14187 w
->update_mode_line
= false;
14190 w
->redisplay
= !accurate_p
;
14194 /* Mark the display of windows in the window tree rooted at WINDOW as
14195 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14196 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14197 be redisplayed the next time redisplay_internal is called. */
14200 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14204 for (; !NILP (window
); window
= w
->next
)
14206 w
= XWINDOW (window
);
14207 if (WINDOWP (w
->contents
))
14208 mark_window_display_accurate (w
->contents
, accurate_p
);
14210 mark_window_display_accurate_1 (w
, accurate_p
);
14214 update_overlay_arrows (1);
14216 /* Force a thorough redisplay the next time by setting
14217 last_arrow_position and last_arrow_string to t, which is
14218 unequal to any useful value of Voverlay_arrow_... */
14219 update_overlay_arrows (-1);
14223 /* Return value in display table DP (Lisp_Char_Table *) for character
14224 C. Since a display table doesn't have any parent, we don't have to
14225 follow parent. Do not call this function directly but use the
14226 macro DISP_CHAR_VECTOR. */
14229 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14233 if (ASCII_CHAR_P (c
))
14236 if (SUB_CHAR_TABLE_P (val
))
14237 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14243 XSETCHAR_TABLE (table
, dp
);
14244 val
= char_table_ref (table
, c
);
14253 /***********************************************************************
14255 ***********************************************************************/
14257 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14260 redisplay_windows (Lisp_Object window
)
14262 while (!NILP (window
))
14264 struct window
*w
= XWINDOW (window
);
14266 if (WINDOWP (w
->contents
))
14267 redisplay_windows (w
->contents
);
14268 else if (BUFFERP (w
->contents
))
14270 displayed_buffer
= XBUFFER (w
->contents
);
14271 /* Use list_of_error, not Qerror, so that
14272 we catch only errors and don't run the debugger. */
14273 internal_condition_case_1 (redisplay_window_0
, window
,
14275 redisplay_window_error
);
14283 redisplay_window_error (Lisp_Object ignore
)
14285 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14290 redisplay_window_0 (Lisp_Object window
)
14292 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14293 redisplay_window (window
, false);
14298 redisplay_window_1 (Lisp_Object window
)
14300 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14301 redisplay_window (window
, true);
14306 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14307 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14308 which positions recorded in ROW differ from current buffer
14311 Return 0 if cursor is not on this row, 1 otherwise. */
14314 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14315 struct glyph_matrix
*matrix
,
14316 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14319 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14320 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14321 struct glyph
*cursor
= NULL
;
14322 /* The last known character position in row. */
14323 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14325 ptrdiff_t pt_old
= PT
- delta
;
14326 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14327 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14328 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14329 /* A glyph beyond the edge of TEXT_AREA which we should never
14331 struct glyph
*glyphs_end
= end
;
14332 /* Non-zero means we've found a match for cursor position, but that
14333 glyph has the avoid_cursor_p flag set. */
14334 int match_with_avoid_cursor
= 0;
14335 /* Non-zero means we've seen at least one glyph that came from a
14337 int string_seen
= 0;
14338 /* Largest and smallest buffer positions seen so far during scan of
14340 ptrdiff_t bpos_max
= pos_before
;
14341 ptrdiff_t bpos_min
= pos_after
;
14342 /* Last buffer position covered by an overlay string with an integer
14343 `cursor' property. */
14344 ptrdiff_t bpos_covered
= 0;
14345 /* Non-zero means the display string on which to display the cursor
14346 comes from a text property, not from an overlay. */
14347 int string_from_text_prop
= 0;
14349 /* Don't even try doing anything if called for a mode-line or
14350 header-line row, since the rest of the code isn't prepared to
14351 deal with such calamities. */
14352 eassert (!row
->mode_line_p
);
14353 if (row
->mode_line_p
)
14356 /* Skip over glyphs not having an object at the start and the end of
14357 the row. These are special glyphs like truncation marks on
14358 terminal frames. */
14359 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14361 if (!row
->reversed_p
)
14364 && INTEGERP (glyph
->object
)
14365 && glyph
->charpos
< 0)
14367 x
+= glyph
->pixel_width
;
14371 && INTEGERP ((end
- 1)->object
)
14372 /* CHARPOS is zero for blanks and stretch glyphs
14373 inserted by extend_face_to_end_of_line. */
14374 && (end
- 1)->charpos
<= 0)
14376 glyph_before
= glyph
- 1;
14383 /* If the glyph row is reversed, we need to process it from back
14384 to front, so swap the edge pointers. */
14385 glyphs_end
= end
= glyph
- 1;
14386 glyph
+= row
->used
[TEXT_AREA
] - 1;
14388 while (glyph
> end
+ 1
14389 && INTEGERP (glyph
->object
)
14390 && glyph
->charpos
< 0)
14393 x
-= glyph
->pixel_width
;
14395 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14397 /* By default, in reversed rows we put the cursor on the
14398 rightmost (first in the reading order) glyph. */
14399 for (g
= end
+ 1; g
< glyph
; g
++)
14400 x
+= g
->pixel_width
;
14402 && INTEGERP ((end
+ 1)->object
)
14403 && (end
+ 1)->charpos
<= 0)
14405 glyph_before
= glyph
+ 1;
14409 else if (row
->reversed_p
)
14411 /* In R2L rows that don't display text, put the cursor on the
14412 rightmost glyph. Case in point: an empty last line that is
14413 part of an R2L paragraph. */
14415 /* Avoid placing the cursor on the last glyph of the row, where
14416 on terminal frames we hold the vertical border between
14417 adjacent windows. */
14418 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14419 && !WINDOW_RIGHTMOST_P (w
)
14420 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14422 x
= -1; /* will be computed below, at label compute_x */
14425 /* Step 1: Try to find the glyph whose character position
14426 corresponds to point. If that's not possible, find 2 glyphs
14427 whose character positions are the closest to point, one before
14428 point, the other after it. */
14429 if (!row
->reversed_p
)
14430 while (/* not marched to end of glyph row */
14432 /* glyph was not inserted by redisplay for internal purposes */
14433 && !INTEGERP (glyph
->object
))
14435 if (BUFFERP (glyph
->object
))
14437 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14439 if (glyph
->charpos
> bpos_max
)
14440 bpos_max
= glyph
->charpos
;
14441 if (glyph
->charpos
< bpos_min
)
14442 bpos_min
= glyph
->charpos
;
14443 if (!glyph
->avoid_cursor_p
)
14445 /* If we hit point, we've found the glyph on which to
14446 display the cursor. */
14449 match_with_avoid_cursor
= 0;
14452 /* See if we've found a better approximation to
14453 POS_BEFORE or to POS_AFTER. */
14454 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14456 pos_before
= glyph
->charpos
;
14457 glyph_before
= glyph
;
14459 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14461 pos_after
= glyph
->charpos
;
14462 glyph_after
= glyph
;
14465 else if (dpos
== 0)
14466 match_with_avoid_cursor
= 1;
14468 else if (STRINGP (glyph
->object
))
14470 Lisp_Object chprop
;
14471 ptrdiff_t glyph_pos
= glyph
->charpos
;
14473 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14475 if (!NILP (chprop
))
14477 /* If the string came from a `display' text property,
14478 look up the buffer position of that property and
14479 use that position to update bpos_max, as if we
14480 actually saw such a position in one of the row's
14481 glyphs. This helps with supporting integer values
14482 of `cursor' property on the display string in
14483 situations where most or all of the row's buffer
14484 text is completely covered by display properties,
14485 so that no glyph with valid buffer positions is
14486 ever seen in the row. */
14487 ptrdiff_t prop_pos
=
14488 string_buffer_position_lim (glyph
->object
, pos_before
,
14491 if (prop_pos
>= pos_before
)
14492 bpos_max
= prop_pos
;
14494 if (INTEGERP (chprop
))
14496 bpos_covered
= bpos_max
+ XINT (chprop
);
14497 /* If the `cursor' property covers buffer positions up
14498 to and including point, we should display cursor on
14499 this glyph. Note that, if a `cursor' property on one
14500 of the string's characters has an integer value, we
14501 will break out of the loop below _before_ we get to
14502 the position match above. IOW, integer values of
14503 the `cursor' property override the "exact match for
14504 point" strategy of positioning the cursor. */
14505 /* Implementation note: bpos_max == pt_old when, e.g.,
14506 we are in an empty line, where bpos_max is set to
14507 MATRIX_ROW_START_CHARPOS, see above. */
14508 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14517 x
+= glyph
->pixel_width
;
14520 else if (glyph
> end
) /* row is reversed */
14521 while (!INTEGERP (glyph
->object
))
14523 if (BUFFERP (glyph
->object
))
14525 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14527 if (glyph
->charpos
> bpos_max
)
14528 bpos_max
= glyph
->charpos
;
14529 if (glyph
->charpos
< bpos_min
)
14530 bpos_min
= glyph
->charpos
;
14531 if (!glyph
->avoid_cursor_p
)
14535 match_with_avoid_cursor
= 0;
14538 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14540 pos_before
= glyph
->charpos
;
14541 glyph_before
= glyph
;
14543 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14545 pos_after
= glyph
->charpos
;
14546 glyph_after
= glyph
;
14549 else if (dpos
== 0)
14550 match_with_avoid_cursor
= 1;
14552 else if (STRINGP (glyph
->object
))
14554 Lisp_Object chprop
;
14555 ptrdiff_t glyph_pos
= glyph
->charpos
;
14557 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14559 if (!NILP (chprop
))
14561 ptrdiff_t prop_pos
=
14562 string_buffer_position_lim (glyph
->object
, pos_before
,
14565 if (prop_pos
>= pos_before
)
14566 bpos_max
= prop_pos
;
14568 if (INTEGERP (chprop
))
14570 bpos_covered
= bpos_max
+ XINT (chprop
);
14571 /* If the `cursor' property covers buffer positions up
14572 to and including point, we should display cursor on
14574 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14583 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14585 x
--; /* can't use any pixel_width */
14588 x
-= glyph
->pixel_width
;
14591 /* Step 2: If we didn't find an exact match for point, we need to
14592 look for a proper place to put the cursor among glyphs between
14593 GLYPH_BEFORE and GLYPH_AFTER. */
14594 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14595 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14596 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14598 /* An empty line has a single glyph whose OBJECT is zero and
14599 whose CHARPOS is the position of a newline on that line.
14600 Note that on a TTY, there are more glyphs after that, which
14601 were produced by extend_face_to_end_of_line, but their
14602 CHARPOS is zero or negative. */
14604 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14605 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14606 /* On a TTY, continued and truncated rows also have a glyph at
14607 their end whose OBJECT is zero and whose CHARPOS is
14608 positive (the continuation and truncation glyphs), but such
14609 rows are obviously not "empty". */
14610 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14612 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14614 ptrdiff_t ellipsis_pos
;
14616 /* Scan back over the ellipsis glyphs. */
14617 if (!row
->reversed_p
)
14619 ellipsis_pos
= (glyph
- 1)->charpos
;
14620 while (glyph
> row
->glyphs
[TEXT_AREA
]
14621 && (glyph
- 1)->charpos
== ellipsis_pos
)
14622 glyph
--, x
-= glyph
->pixel_width
;
14623 /* That loop always goes one position too far, including
14624 the glyph before the ellipsis. So scan forward over
14626 x
+= glyph
->pixel_width
;
14629 else /* row is reversed */
14631 ellipsis_pos
= (glyph
+ 1)->charpos
;
14632 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14633 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14634 glyph
++, x
+= glyph
->pixel_width
;
14635 x
-= glyph
->pixel_width
;
14639 else if (match_with_avoid_cursor
)
14641 cursor
= glyph_after
;
14644 else if (string_seen
)
14646 int incr
= row
->reversed_p
? -1 : +1;
14648 /* Need to find the glyph that came out of a string which is
14649 present at point. That glyph is somewhere between
14650 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14651 positioned between POS_BEFORE and POS_AFTER in the
14653 struct glyph
*start
, *stop
;
14654 ptrdiff_t pos
= pos_before
;
14658 /* If the row ends in a newline from a display string,
14659 reordering could have moved the glyphs belonging to the
14660 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14661 in this case we extend the search to the last glyph in
14662 the row that was not inserted by redisplay. */
14663 if (row
->ends_in_newline_from_string_p
)
14666 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14669 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14670 correspond to POS_BEFORE and POS_AFTER, respectively. We
14671 need START and STOP in the order that corresponds to the
14672 row's direction as given by its reversed_p flag. If the
14673 directionality of characters between POS_BEFORE and
14674 POS_AFTER is the opposite of the row's base direction,
14675 these characters will have been reordered for display,
14676 and we need to reverse START and STOP. */
14677 if (!row
->reversed_p
)
14679 start
= min (glyph_before
, glyph_after
);
14680 stop
= max (glyph_before
, glyph_after
);
14684 start
= max (glyph_before
, glyph_after
);
14685 stop
= min (glyph_before
, glyph_after
);
14687 for (glyph
= start
+ incr
;
14688 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14691 /* Any glyphs that come from the buffer are here because
14692 of bidi reordering. Skip them, and only pay
14693 attention to glyphs that came from some string. */
14694 if (STRINGP (glyph
->object
))
14698 /* If the display property covers the newline, we
14699 need to search for it one position farther. */
14700 ptrdiff_t lim
= pos_after
14701 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14703 string_from_text_prop
= 0;
14704 str
= glyph
->object
;
14705 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14706 if (tem
== 0 /* from overlay */
14709 /* If the string from which this glyph came is
14710 found in the buffer at point, or at position
14711 that is closer to point than pos_after, then
14712 we've found the glyph we've been looking for.
14713 If it comes from an overlay (tem == 0), and
14714 it has the `cursor' property on one of its
14715 glyphs, record that glyph as a candidate for
14716 displaying the cursor. (As in the
14717 unidirectional version, we will display the
14718 cursor on the last candidate we find.) */
14721 || (tem
- pt_old
> 0 && tem
< pos_after
))
14723 /* The glyphs from this string could have
14724 been reordered. Find the one with the
14725 smallest string position. Or there could
14726 be a character in the string with the
14727 `cursor' property, which means display
14728 cursor on that character's glyph. */
14729 ptrdiff_t strpos
= glyph
->charpos
;
14734 string_from_text_prop
= 1;
14737 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14738 && EQ (glyph
->object
, str
);
14742 ptrdiff_t gpos
= glyph
->charpos
;
14744 cprop
= Fget_char_property (make_number (gpos
),
14752 if (tem
&& glyph
->charpos
< strpos
)
14754 strpos
= glyph
->charpos
;
14760 || (tem
- pt_old
> 0 && tem
< pos_after
))
14764 pos
= tem
+ 1; /* don't find previous instances */
14766 /* This string is not what we want; skip all of the
14767 glyphs that came from it. */
14768 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14769 && EQ (glyph
->object
, str
))
14776 /* If we reached the end of the line, and END was from a string,
14777 the cursor is not on this line. */
14779 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14780 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14781 && STRINGP (end
->object
)
14782 && row
->continued_p
)
14785 /* A truncated row may not include PT among its character positions.
14786 Setting the cursor inside the scroll margin will trigger
14787 recalculation of hscroll in hscroll_window_tree. But if a
14788 display string covers point, defer to the string-handling
14789 code below to figure this out. */
14790 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14792 cursor
= glyph_before
;
14795 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14796 /* Zero-width characters produce no glyphs. */
14798 && (row
->reversed_p
14799 ? glyph_after
> glyphs_end
14800 : glyph_after
< glyphs_end
)))
14802 cursor
= glyph_after
;
14808 if (cursor
!= NULL
)
14810 else if (glyph
== glyphs_end
14811 && pos_before
== pos_after
14812 && STRINGP ((row
->reversed_p
14813 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14814 : row
->glyphs
[TEXT_AREA
])->object
))
14816 /* If all the glyphs of this row came from strings, put the
14817 cursor on the first glyph of the row. This avoids having the
14818 cursor outside of the text area in this very rare and hard
14822 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14823 : row
->glyphs
[TEXT_AREA
];
14829 /* Need to compute x that corresponds to GLYPH. */
14830 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14832 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14834 x
+= g
->pixel_width
;
14838 /* ROW could be part of a continued line, which, under bidi
14839 reordering, might have other rows whose start and end charpos
14840 occlude point. Only set w->cursor if we found a better
14841 approximation to the cursor position than we have from previously
14842 examined candidate rows belonging to the same continued line. */
14843 if (/* We already have a candidate row. */
14844 w
->cursor
.vpos
>= 0
14845 /* That candidate is not the row we are processing. */
14846 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14847 /* Make sure cursor.vpos specifies a row whose start and end
14848 charpos occlude point, and it is valid candidate for being a
14849 cursor-row. This is because some callers of this function
14850 leave cursor.vpos at the row where the cursor was displayed
14851 during the last redisplay cycle. */
14852 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14853 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14854 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14857 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14859 /* Don't consider glyphs that are outside TEXT_AREA. */
14860 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14862 /* Keep the candidate whose buffer position is the closest to
14863 point or has the `cursor' property. */
14864 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14865 w
->cursor
.hpos
>= 0
14866 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14867 && ((BUFFERP (g1
->object
)
14868 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14869 || (BUFFERP (glyph
->object
)
14870 && eabs (g1
->charpos
- pt_old
)
14871 < eabs (glyph
->charpos
- pt_old
))))
14872 /* Previous candidate is a glyph from a string that has
14873 a non-nil `cursor' property. */
14874 || (STRINGP (g1
->object
)
14875 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14876 Qcursor
, g1
->object
))
14877 /* Previous candidate is from the same display
14878 string as this one, and the display string
14879 came from a text property. */
14880 || (EQ (g1
->object
, glyph
->object
)
14881 && string_from_text_prop
)
14882 /* this candidate is from newline and its
14883 position is not an exact match */
14884 || (INTEGERP (glyph
->object
)
14885 && glyph
->charpos
!= pt_old
)))))
14887 /* If this candidate gives an exact match, use that. */
14888 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14889 /* If this candidate is a glyph created for the
14890 terminating newline of a line, and point is on that
14891 newline, it wins because it's an exact match. */
14892 || (!row
->continued_p
14893 && INTEGERP (glyph
->object
)
14894 && glyph
->charpos
== 0
14895 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14896 /* Otherwise, keep the candidate that comes from a row
14897 spanning less buffer positions. This may win when one or
14898 both candidate positions are on glyphs that came from
14899 display strings, for which we cannot compare buffer
14901 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14902 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14903 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14906 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14908 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14909 w
->cursor
.y
= row
->y
+ dy
;
14911 if (w
== XWINDOW (selected_window
))
14913 if (!row
->continued_p
14914 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14917 this_line_buffer
= XBUFFER (w
->contents
);
14919 CHARPOS (this_line_start_pos
)
14920 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14921 BYTEPOS (this_line_start_pos
)
14922 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14924 CHARPOS (this_line_end_pos
)
14925 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14926 BYTEPOS (this_line_end_pos
)
14927 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14929 this_line_y
= w
->cursor
.y
;
14930 this_line_pixel_height
= row
->height
;
14931 this_line_vpos
= w
->cursor
.vpos
;
14932 this_line_start_x
= row
->x
;
14935 CHARPOS (this_line_start_pos
) = 0;
14942 /* Run window scroll functions, if any, for WINDOW with new window
14943 start STARTP. Sets the window start of WINDOW to that position.
14945 We assume that the window's buffer is really current. */
14947 static struct text_pos
14948 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14950 struct window
*w
= XWINDOW (window
);
14951 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14953 eassert (current_buffer
== XBUFFER (w
->contents
));
14955 if (!NILP (Vwindow_scroll_functions
))
14957 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14958 make_number (CHARPOS (startp
)));
14959 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14960 /* In case the hook functions switch buffers. */
14961 set_buffer_internal (XBUFFER (w
->contents
));
14968 /* Make sure the line containing the cursor is fully visible.
14969 A value of 1 means there is nothing to be done.
14970 (Either the line is fully visible, or it cannot be made so,
14971 or we cannot tell.)
14973 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14974 is higher than window.
14976 A value of 0 means the caller should do scrolling
14977 as if point had gone off the screen. */
14980 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14982 struct glyph_matrix
*matrix
;
14983 struct glyph_row
*row
;
14986 if (!make_cursor_line_fully_visible_p
)
14989 /* It's not always possible to find the cursor, e.g, when a window
14990 is full of overlay strings. Don't do anything in that case. */
14991 if (w
->cursor
.vpos
< 0)
14994 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14995 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14997 /* If the cursor row is not partially visible, there's nothing to do. */
14998 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15001 /* If the row the cursor is in is taller than the window's height,
15002 it's not clear what to do, so do nothing. */
15003 window_height
= window_box_height (w
);
15004 if (row
->height
>= window_height
)
15006 if (!force_p
|| MINI_WINDOW_P (w
)
15007 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15014 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15015 non-zero means only WINDOW is redisplayed in redisplay_internal.
15016 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15017 in redisplay_window to bring a partially visible line into view in
15018 the case that only the cursor has moved.
15020 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15021 last screen line's vertical height extends past the end of the screen.
15025 1 if scrolling succeeded
15027 0 if scrolling didn't find point.
15029 -1 if new fonts have been loaded so that we must interrupt
15030 redisplay, adjust glyph matrices, and try again. */
15036 SCROLLING_NEED_LARGER_MATRICES
15039 /* If scroll-conservatively is more than this, never recenter.
15041 If you change this, don't forget to update the doc string of
15042 `scroll-conservatively' and the Emacs manual. */
15043 #define SCROLL_LIMIT 100
15046 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15047 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15048 int temp_scroll_step
, int last_line_misfit
)
15050 struct window
*w
= XWINDOW (window
);
15051 struct frame
*f
= XFRAME (w
->frame
);
15052 struct text_pos pos
, startp
;
15054 int this_scroll_margin
, scroll_max
, rc
, height
;
15055 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15056 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15057 Lisp_Object aggressive
;
15058 /* We will never try scrolling more than this number of lines. */
15059 int scroll_limit
= SCROLL_LIMIT
;
15060 int frame_line_height
= default_line_pixel_height (w
);
15061 int window_total_lines
15062 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15065 debug_method_add (w
, "try_scrolling");
15068 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15070 /* Compute scroll margin height in pixels. We scroll when point is
15071 within this distance from the top or bottom of the window. */
15072 if (scroll_margin
> 0)
15073 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15074 * frame_line_height
;
15076 this_scroll_margin
= 0;
15078 /* Force arg_scroll_conservatively to have a reasonable value, to
15079 avoid scrolling too far away with slow move_it_* functions. Note
15080 that the user can supply scroll-conservatively equal to
15081 `most-positive-fixnum', which can be larger than INT_MAX. */
15082 if (arg_scroll_conservatively
> scroll_limit
)
15084 arg_scroll_conservatively
= scroll_limit
+ 1;
15085 scroll_max
= scroll_limit
* frame_line_height
;
15087 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15088 /* Compute how much we should try to scroll maximally to bring
15089 point into view. */
15090 scroll_max
= (max (scroll_step
,
15091 max (arg_scroll_conservatively
, temp_scroll_step
))
15092 * frame_line_height
);
15093 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15094 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15095 /* We're trying to scroll because of aggressive scrolling but no
15096 scroll_step is set. Choose an arbitrary one. */
15097 scroll_max
= 10 * frame_line_height
;
15103 /* Decide whether to scroll down. */
15104 if (PT
> CHARPOS (startp
))
15106 int scroll_margin_y
;
15108 /* Compute the pixel ypos of the scroll margin, then move IT to
15109 either that ypos or PT, whichever comes first. */
15110 start_display (&it
, w
, startp
);
15111 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15112 - frame_line_height
* extra_scroll_margin_lines
;
15113 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15114 (MOVE_TO_POS
| MOVE_TO_Y
));
15116 if (PT
> CHARPOS (it
.current
.pos
))
15118 int y0
= line_bottom_y (&it
);
15119 /* Compute how many pixels below window bottom to stop searching
15120 for PT. This avoids costly search for PT that is far away if
15121 the user limited scrolling by a small number of lines, but
15122 always finds PT if scroll_conservatively is set to a large
15123 number, such as most-positive-fixnum. */
15124 int slack
= max (scroll_max
, 10 * frame_line_height
);
15125 int y_to_move
= it
.last_visible_y
+ slack
;
15127 /* Compute the distance from the scroll margin to PT or to
15128 the scroll limit, whichever comes first. This should
15129 include the height of the cursor line, to make that line
15131 move_it_to (&it
, PT
, -1, y_to_move
,
15132 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15133 dy
= line_bottom_y (&it
) - y0
;
15135 if (dy
> scroll_max
)
15136 return SCROLLING_FAILED
;
15145 /* Point is in or below the bottom scroll margin, so move the
15146 window start down. If scrolling conservatively, move it just
15147 enough down to make point visible. If scroll_step is set,
15148 move it down by scroll_step. */
15149 if (arg_scroll_conservatively
)
15151 = min (max (dy
, frame_line_height
),
15152 frame_line_height
* arg_scroll_conservatively
);
15153 else if (scroll_step
|| temp_scroll_step
)
15154 amount_to_scroll
= scroll_max
;
15157 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15158 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15159 if (NUMBERP (aggressive
))
15161 double float_amount
= XFLOATINT (aggressive
) * height
;
15162 int aggressive_scroll
= float_amount
;
15163 if (aggressive_scroll
== 0 && float_amount
> 0)
15164 aggressive_scroll
= 1;
15165 /* Don't let point enter the scroll margin near top of
15166 the window. This could happen if the value of
15167 scroll_up_aggressively is too large and there are
15168 non-zero margins, because scroll_up_aggressively
15169 means put point that fraction of window height
15170 _from_the_bottom_margin_. */
15171 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15172 aggressive_scroll
= height
- 2*this_scroll_margin
;
15173 amount_to_scroll
= dy
+ aggressive_scroll
;
15177 if (amount_to_scroll
<= 0)
15178 return SCROLLING_FAILED
;
15180 start_display (&it
, w
, startp
);
15181 if (arg_scroll_conservatively
<= scroll_limit
)
15182 move_it_vertically (&it
, amount_to_scroll
);
15185 /* Extra precision for users who set scroll-conservatively
15186 to a large number: make sure the amount we scroll
15187 the window start is never less than amount_to_scroll,
15188 which was computed as distance from window bottom to
15189 point. This matters when lines at window top and lines
15190 below window bottom have different height. */
15192 void *it1data
= NULL
;
15193 /* We use a temporary it1 because line_bottom_y can modify
15194 its argument, if it moves one line down; see there. */
15197 SAVE_IT (it1
, it
, it1data
);
15198 start_y
= line_bottom_y (&it1
);
15200 RESTORE_IT (&it
, &it
, it1data
);
15201 move_it_by_lines (&it
, 1);
15202 SAVE_IT (it1
, it
, it1data
);
15203 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15206 /* If STARTP is unchanged, move it down another screen line. */
15207 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15208 move_it_by_lines (&it
, 1);
15209 startp
= it
.current
.pos
;
15213 struct text_pos scroll_margin_pos
= startp
;
15216 /* See if point is inside the scroll margin at the top of the
15218 if (this_scroll_margin
)
15222 start_display (&it
, w
, startp
);
15223 y_start
= it
.current_y
;
15224 move_it_vertically (&it
, this_scroll_margin
);
15225 scroll_margin_pos
= it
.current
.pos
;
15226 /* If we didn't move enough before hitting ZV, request
15227 additional amount of scroll, to move point out of the
15229 if (IT_CHARPOS (it
) == ZV
15230 && it
.current_y
- y_start
< this_scroll_margin
)
15231 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15234 if (PT
< CHARPOS (scroll_margin_pos
))
15236 /* Point is in the scroll margin at the top of the window or
15237 above what is displayed in the window. */
15240 /* Compute the vertical distance from PT to the scroll
15241 margin position. Move as far as scroll_max allows, or
15242 one screenful, or 10 screen lines, whichever is largest.
15243 Give up if distance is greater than scroll_max or if we
15244 didn't reach the scroll margin position. */
15245 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15246 start_display (&it
, w
, pos
);
15248 y_to_move
= max (it
.last_visible_y
,
15249 max (scroll_max
, 10 * frame_line_height
));
15250 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15252 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15253 dy
= it
.current_y
- y0
;
15254 if (dy
> scroll_max
15255 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15256 return SCROLLING_FAILED
;
15258 /* Additional scroll for when ZV was too close to point. */
15261 /* Compute new window start. */
15262 start_display (&it
, w
, startp
);
15264 if (arg_scroll_conservatively
)
15265 amount_to_scroll
= max (dy
, frame_line_height
*
15266 max (scroll_step
, temp_scroll_step
));
15267 else if (scroll_step
|| temp_scroll_step
)
15268 amount_to_scroll
= scroll_max
;
15271 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15272 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15273 if (NUMBERP (aggressive
))
15275 double float_amount
= XFLOATINT (aggressive
) * height
;
15276 int aggressive_scroll
= float_amount
;
15277 if (aggressive_scroll
== 0 && float_amount
> 0)
15278 aggressive_scroll
= 1;
15279 /* Don't let point enter the scroll margin near
15280 bottom of the window, if the value of
15281 scroll_down_aggressively happens to be too
15283 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15284 aggressive_scroll
= height
- 2*this_scroll_margin
;
15285 amount_to_scroll
= dy
+ aggressive_scroll
;
15289 if (amount_to_scroll
<= 0)
15290 return SCROLLING_FAILED
;
15292 move_it_vertically_backward (&it
, amount_to_scroll
);
15293 startp
= it
.current
.pos
;
15297 /* Run window scroll functions. */
15298 startp
= run_window_scroll_functions (window
, startp
);
15300 /* Display the window. Give up if new fonts are loaded, or if point
15302 if (!try_window (window
, startp
, 0))
15303 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15304 else if (w
->cursor
.vpos
< 0)
15306 clear_glyph_matrix (w
->desired_matrix
);
15307 rc
= SCROLLING_FAILED
;
15311 /* Maybe forget recorded base line for line number display. */
15312 if (!just_this_one_p
15313 || current_buffer
->clip_changed
15314 || BEG_UNCHANGED
< CHARPOS (startp
))
15315 w
->base_line_number
= 0;
15317 /* If cursor ends up on a partially visible line,
15318 treat that as being off the bottom of the screen. */
15319 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15320 /* It's possible that the cursor is on the first line of the
15321 buffer, which is partially obscured due to a vscroll
15322 (Bug#7537). In that case, avoid looping forever. */
15323 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15325 clear_glyph_matrix (w
->desired_matrix
);
15326 ++extra_scroll_margin_lines
;
15329 rc
= SCROLLING_SUCCESS
;
15336 /* Compute a suitable window start for window W if display of W starts
15337 on a continuation line. Value is non-zero if a new window start
15340 The new window start will be computed, based on W's width, starting
15341 from the start of the continued line. It is the start of the
15342 screen line with the minimum distance from the old start W->start. */
15345 compute_window_start_on_continuation_line (struct window
*w
)
15347 struct text_pos pos
, start_pos
;
15348 int window_start_changed_p
= 0;
15350 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15352 /* If window start is on a continuation line... Window start may be
15353 < BEGV in case there's invisible text at the start of the
15354 buffer (M-x rmail, for example). */
15355 if (CHARPOS (start_pos
) > BEGV
15356 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15359 struct glyph_row
*row
;
15361 /* Handle the case that the window start is out of range. */
15362 if (CHARPOS (start_pos
) < BEGV
)
15363 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15364 else if (CHARPOS (start_pos
) > ZV
)
15365 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15367 /* Find the start of the continued line. This should be fast
15368 because find_newline is fast (newline cache). */
15369 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15370 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15371 row
, DEFAULT_FACE_ID
);
15372 reseat_at_previous_visible_line_start (&it
);
15374 /* If the line start is "too far" away from the window start,
15375 say it takes too much time to compute a new window start. */
15376 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15377 /* PXW: Do we need upper bounds here? */
15378 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15380 int min_distance
, distance
;
15382 /* Move forward by display lines to find the new window
15383 start. If window width was enlarged, the new start can
15384 be expected to be > the old start. If window width was
15385 decreased, the new window start will be < the old start.
15386 So, we're looking for the display line start with the
15387 minimum distance from the old window start. */
15388 pos
= it
.current
.pos
;
15389 min_distance
= INFINITY
;
15390 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15391 distance
< min_distance
)
15393 min_distance
= distance
;
15394 pos
= it
.current
.pos
;
15395 if (it
.line_wrap
== WORD_WRAP
)
15397 /* Under WORD_WRAP, move_it_by_lines is likely to
15398 overshoot and stop not at the first, but the
15399 second character from the left margin. So in
15400 that case, we need a more tight control on the X
15401 coordinate of the iterator than move_it_by_lines
15402 promises in its contract. The method is to first
15403 go to the last (rightmost) visible character of a
15404 line, then move to the leftmost character on the
15405 next line in a separate call. */
15406 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15407 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15408 move_it_to (&it
, ZV
, 0,
15409 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15410 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15413 move_it_by_lines (&it
, 1);
15416 /* Set the window start there. */
15417 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15418 window_start_changed_p
= 1;
15422 return window_start_changed_p
;
15426 /* Try cursor movement in case text has not changed in window WINDOW,
15427 with window start STARTP. Value is
15429 CURSOR_MOVEMENT_SUCCESS if successful
15431 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15433 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15434 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15435 we want to scroll as if scroll-step were set to 1. See the code.
15437 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15438 which case we have to abort this redisplay, and adjust matrices
15443 CURSOR_MOVEMENT_SUCCESS
,
15444 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15445 CURSOR_MOVEMENT_MUST_SCROLL
,
15446 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15450 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15452 struct window
*w
= XWINDOW (window
);
15453 struct frame
*f
= XFRAME (w
->frame
);
15454 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15457 if (inhibit_try_cursor_movement
)
15461 /* Previously, there was a check for Lisp integer in the
15462 if-statement below. Now, this field is converted to
15463 ptrdiff_t, thus zero means invalid position in a buffer. */
15464 eassert (w
->last_point
> 0);
15465 /* Likewise there was a check whether window_end_vpos is nil or larger
15466 than the window. Now window_end_vpos is int and so never nil, but
15467 let's leave eassert to check whether it fits in the window. */
15468 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15470 /* Handle case where text has not changed, only point, and it has
15471 not moved off the frame. */
15472 if (/* Point may be in this window. */
15473 PT
>= CHARPOS (startp
)
15474 /* Selective display hasn't changed. */
15475 && !current_buffer
->clip_changed
15476 /* Function force-mode-line-update is used to force a thorough
15477 redisplay. It sets either windows_or_buffers_changed or
15478 update_mode_lines. So don't take a shortcut here for these
15480 && !update_mode_lines
15481 && !windows_or_buffers_changed
15482 && !f
->cursor_type_changed
15483 && NILP (Vshow_trailing_whitespace
)
15484 /* This code is not used for mini-buffer for the sake of the case
15485 of redisplaying to replace an echo area message; since in
15486 that case the mini-buffer contents per se are usually
15487 unchanged. This code is of no real use in the mini-buffer
15488 since the handling of this_line_start_pos, etc., in redisplay
15489 handles the same cases. */
15490 && !EQ (window
, minibuf_window
)
15491 && (FRAME_WINDOW_P (f
)
15492 || !overlay_arrow_in_current_buffer_p ()))
15494 int this_scroll_margin
, top_scroll_margin
;
15495 struct glyph_row
*row
= NULL
;
15496 int frame_line_height
= default_line_pixel_height (w
);
15497 int window_total_lines
15498 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15501 debug_method_add (w
, "cursor movement");
15504 /* Scroll if point within this distance from the top or bottom
15505 of the window. This is a pixel value. */
15506 if (scroll_margin
> 0)
15508 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15509 this_scroll_margin
*= frame_line_height
;
15512 this_scroll_margin
= 0;
15514 top_scroll_margin
= this_scroll_margin
;
15515 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15516 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15518 /* Start with the row the cursor was displayed during the last
15519 not paused redisplay. Give up if that row is not valid. */
15520 if (w
->last_cursor_vpos
< 0
15521 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15522 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15525 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15526 if (row
->mode_line_p
)
15528 if (!row
->enabled_p
)
15529 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15532 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15534 int scroll_p
= 0, must_scroll
= 0;
15535 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15537 if (PT
> w
->last_point
)
15539 /* Point has moved forward. */
15540 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15541 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15543 eassert (row
->enabled_p
);
15547 /* If the end position of a row equals the start
15548 position of the next row, and PT is at that position,
15549 we would rather display cursor in the next line. */
15550 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15551 && MATRIX_ROW_END_CHARPOS (row
) == PT
15552 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15553 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15554 && !cursor_row_p (row
))
15557 /* If within the scroll margin, scroll. Note that
15558 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15559 the next line would be drawn, and that
15560 this_scroll_margin can be zero. */
15561 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15562 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15563 /* Line is completely visible last line in window
15564 and PT is to be set in the next line. */
15565 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15566 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15567 && !row
->ends_at_zv_p
15568 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15571 else if (PT
< w
->last_point
)
15573 /* Cursor has to be moved backward. Note that PT >=
15574 CHARPOS (startp) because of the outer if-statement. */
15575 while (!row
->mode_line_p
15576 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15577 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15578 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15579 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15580 row
> w
->current_matrix
->rows
15581 && (row
-1)->ends_in_newline_from_string_p
))))
15582 && (row
->y
> top_scroll_margin
15583 || CHARPOS (startp
) == BEGV
))
15585 eassert (row
->enabled_p
);
15589 /* Consider the following case: Window starts at BEGV,
15590 there is invisible, intangible text at BEGV, so that
15591 display starts at some point START > BEGV. It can
15592 happen that we are called with PT somewhere between
15593 BEGV and START. Try to handle that case. */
15594 if (row
< w
->current_matrix
->rows
15595 || row
->mode_line_p
)
15597 row
= w
->current_matrix
->rows
;
15598 if (row
->mode_line_p
)
15602 /* Due to newlines in overlay strings, we may have to
15603 skip forward over overlay strings. */
15604 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15605 && MATRIX_ROW_END_CHARPOS (row
) == PT
15606 && !cursor_row_p (row
))
15609 /* If within the scroll margin, scroll. */
15610 if (row
->y
< top_scroll_margin
15611 && CHARPOS (startp
) != BEGV
)
15616 /* Cursor did not move. So don't scroll even if cursor line
15617 is partially visible, as it was so before. */
15618 rc
= CURSOR_MOVEMENT_SUCCESS
;
15621 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15622 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15624 /* if PT is not in the glyph row, give up. */
15625 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15628 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15629 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15631 struct glyph_row
*row1
;
15633 /* If rows are bidi-reordered and point moved, back up
15634 until we find a row that does not belong to a
15635 continuation line. This is because we must consider
15636 all rows of a continued line as candidates for the
15637 new cursor positioning, since row start and end
15638 positions change non-linearly with vertical position
15640 /* FIXME: Revisit this when glyph ``spilling'' in
15641 continuation lines' rows is implemented for
15642 bidi-reordered rows. */
15643 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15644 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15647 /* If we hit the beginning of the displayed portion
15648 without finding the first row of a continued
15652 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15655 eassert (row
->enabled_p
);
15660 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15661 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15662 /* Make sure this isn't a header line by any chance, since
15663 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15664 && !row
->mode_line_p
15665 && make_cursor_line_fully_visible_p
)
15667 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15668 && !row
->ends_at_zv_p
15669 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15670 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15671 else if (row
->height
> window_box_height (w
))
15673 /* If we end up in a partially visible line, let's
15674 make it fully visible, except when it's taller
15675 than the window, in which case we can't do much
15678 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15682 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15683 if (!cursor_row_fully_visible_p (w
, 0, 1))
15684 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15686 rc
= CURSOR_MOVEMENT_SUCCESS
;
15690 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15691 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15692 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15694 /* With bidi-reordered rows, there could be more than
15695 one candidate row whose start and end positions
15696 occlude point. We need to let set_cursor_from_row
15697 find the best candidate. */
15698 /* FIXME: Revisit this when glyph ``spilling'' in
15699 continuation lines' rows is implemented for
15700 bidi-reordered rows. */
15705 int at_zv_p
= 0, exact_match_p
= 0;
15707 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15708 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15709 && cursor_row_p (row
))
15710 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15712 /* As soon as we've found the exact match for point,
15713 or the first suitable row whose ends_at_zv_p flag
15714 is set, we are done. */
15717 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15718 w
->cursor
.vpos
)->ends_at_zv_p
;
15720 && w
->cursor
.hpos
>= 0
15721 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15724 struct glyph_row
*candidate
=
15725 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15727 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15728 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15731 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15732 || (INTEGERP (g
->object
)
15733 && (g
->charpos
== PT
15734 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15736 if (at_zv_p
|| exact_match_p
)
15738 rc
= CURSOR_MOVEMENT_SUCCESS
;
15742 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15746 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15747 || row
->continued_p
)
15748 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15749 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15750 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15751 /* If we didn't find any candidate rows, or exited the
15752 loop before all the candidates were examined, signal
15753 to the caller that this method failed. */
15754 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15756 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15757 && !row
->continued_p
))
15758 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15760 rc
= CURSOR_MOVEMENT_SUCCESS
;
15766 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15768 rc
= CURSOR_MOVEMENT_SUCCESS
;
15773 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15774 && MATRIX_ROW_START_CHARPOS (row
) == PT
15775 && cursor_row_p (row
));
15785 set_vertical_scroll_bar (struct window
*w
)
15787 ptrdiff_t start
, end
, whole
;
15789 /* Calculate the start and end positions for the current window.
15790 At some point, it would be nice to choose between scrollbars
15791 which reflect the whole buffer size, with special markers
15792 indicating narrowing, and scrollbars which reflect only the
15795 Note that mini-buffers sometimes aren't displaying any text. */
15796 if (!MINI_WINDOW_P (w
)
15797 || (w
== XWINDOW (minibuf_window
)
15798 && NILP (echo_area_buffer
[0])))
15800 struct buffer
*buf
= XBUFFER (w
->contents
);
15801 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15802 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15803 /* I don't think this is guaranteed to be right. For the
15804 moment, we'll pretend it is. */
15805 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15809 if (whole
< (end
- start
))
15810 whole
= end
- start
;
15813 start
= end
= whole
= 0;
15815 /* Indicate what this scroll bar ought to be displaying now. */
15816 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15817 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15818 (w
, end
- start
, whole
, start
);
15823 set_horizontal_scroll_bar (struct window
*w
)
15825 int start
, end
, whole
, portion
;
15827 if (!MINI_WINDOW_P (w
)
15828 || (w
== XWINDOW (minibuf_window
)
15829 && NILP (echo_area_buffer
[0])))
15831 struct buffer
*b
= XBUFFER (w
->contents
);
15832 struct buffer
*old_buffer
= NULL
;
15834 struct text_pos startp
;
15836 if (b
!= current_buffer
)
15838 old_buffer
= current_buffer
;
15839 set_buffer_internal (b
);
15842 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15843 start_display (&it
, w
, startp
);
15844 it
.last_visible_x
= INT_MAX
;
15845 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15846 MOVE_TO_X
| MOVE_TO_Y
);
15847 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15848 window_box_height (w), -1,
15849 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15851 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15852 end
= start
+ window_box_width (w
, TEXT_AREA
);
15853 portion
= end
- start
;
15854 /* After enlarging a horizontally scrolled window such that it
15855 gets at least as wide as the text it contains, make sure that
15856 the thumb doesn't fill the entire scroll bar so we can still
15857 drag it back to see the entire text. */
15858 whole
= max (whole
, end
);
15864 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15865 if (EQ (pdir
, Qright_to_left
))
15867 start
= whole
- end
;
15868 end
= start
+ portion
;
15873 set_buffer_internal (old_buffer
);
15876 start
= end
= whole
= portion
= 0;
15878 w
->hscroll_whole
= whole
;
15880 /* Indicate what this scroll bar ought to be displaying now. */
15881 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15882 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15883 (w
, portion
, whole
, start
);
15887 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15888 selected_window is redisplayed.
15890 We can return without actually redisplaying the window if fonts has been
15891 changed on window's frame. In that case, redisplay_internal will retry.
15893 As one of the important parts of redisplaying a window, we need to
15894 decide whether the previous window-start position (stored in the
15895 window's w->start marker position) is still valid, and if it isn't,
15896 recompute it. Some details about that:
15898 . The previous window-start could be in a continuation line, in
15899 which case we need to recompute it when the window width
15900 changes. See compute_window_start_on_continuation_line and its
15903 . The text that changed since last redisplay could include the
15904 previous window-start position. In that case, we try to salvage
15905 what we can from the current glyph matrix by calling
15906 try_scrolling, which see.
15908 . Some Emacs command could force us to use a specific window-start
15909 position by setting the window's force_start flag, or gently
15910 propose doing that by setting the window's optional_new_start
15911 flag. In these cases, we try using the specified start point if
15912 that succeeds (i.e. the window desired matrix is successfully
15913 recomputed, and point location is within the window). In case
15914 of optional_new_start, we first check if the specified start
15915 position is feasible, i.e. if it will allow point to be
15916 displayed in the window. If using the specified start point
15917 fails, e.g., if new fonts are needed to be loaded, we abort the
15918 redisplay cycle and leave it up to the next cycle to figure out
15921 . Note that the window's force_start flag is sometimes set by
15922 redisplay itself, when it decides that the previous window start
15923 point is fine and should be kept. Search for "goto force_start"
15924 below to see the details. Like the values of window-start
15925 specified outside of redisplay, these internally-deduced values
15926 are tested for feasibility, and ignored if found to be
15929 . Note that the function try_window, used to completely redisplay
15930 a window, accepts the window's start point as its argument.
15931 This is used several times in the redisplay code to control
15932 where the window start will be, according to user options such
15933 as scroll-conservatively, and also to ensure the screen line
15934 showing point will be fully (as opposed to partially) visible on
15938 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15940 struct window
*w
= XWINDOW (window
);
15941 struct frame
*f
= XFRAME (w
->frame
);
15942 struct buffer
*buffer
= XBUFFER (w
->contents
);
15943 struct buffer
*old
= current_buffer
;
15944 struct text_pos lpoint
, opoint
, startp
;
15945 int update_mode_line
;
15948 /* Record it now because it's overwritten. */
15949 bool current_matrix_up_to_date_p
= false;
15950 bool used_current_matrix_p
= false;
15951 /* This is less strict than current_matrix_up_to_date_p.
15952 It indicates that the buffer contents and narrowing are unchanged. */
15953 bool buffer_unchanged_p
= false;
15954 int temp_scroll_step
= 0;
15955 ptrdiff_t count
= SPECPDL_INDEX ();
15957 int centering_position
= -1;
15958 int last_line_misfit
= 0;
15959 ptrdiff_t beg_unchanged
, end_unchanged
;
15960 int frame_line_height
;
15962 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15966 *w
->desired_matrix
->method
= 0;
15969 if (!just_this_one_p
15970 && REDISPLAY_SOME_P ()
15973 && !buffer
->text
->redisplay
15974 && BUF_PT (buffer
) == w
->last_point
)
15977 /* Make sure that both W's markers are valid. */
15978 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15979 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15981 /* We come here again if we need to run window-text-change-functions
15984 reconsider_clip_changes (w
);
15985 frame_line_height
= default_line_pixel_height (w
);
15987 /* Has the mode line to be updated? */
15988 update_mode_line
= (w
->update_mode_line
15989 || update_mode_lines
15990 || buffer
->clip_changed
15991 || buffer
->prevent_redisplay_optimizations_p
);
15993 if (!just_this_one_p
)
15994 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15995 cleverly elsewhere. */
15996 w
->must_be_updated_p
= true;
15998 if (MINI_WINDOW_P (w
))
16000 if (w
== XWINDOW (echo_area_window
)
16001 && !NILP (echo_area_buffer
[0]))
16003 if (update_mode_line
)
16004 /* We may have to update a tty frame's menu bar or a
16005 tool-bar. Example `M-x C-h C-h C-g'. */
16006 goto finish_menu_bars
;
16008 /* We've already displayed the echo area glyphs in this window. */
16009 goto finish_scroll_bars
;
16011 else if ((w
!= XWINDOW (minibuf_window
)
16012 || minibuf_level
== 0)
16013 /* When buffer is nonempty, redisplay window normally. */
16014 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16015 /* Quail displays non-mini buffers in minibuffer window.
16016 In that case, redisplay the window normally. */
16017 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16019 /* W is a mini-buffer window, but it's not active, so clear
16021 int yb
= window_text_bottom_y (w
);
16022 struct glyph_row
*row
;
16025 for (y
= 0, row
= w
->desired_matrix
->rows
;
16027 y
+= row
->height
, ++row
)
16028 blank_row (w
, row
, y
);
16029 goto finish_scroll_bars
;
16032 clear_glyph_matrix (w
->desired_matrix
);
16035 /* Otherwise set up data on this window; select its buffer and point
16037 /* Really select the buffer, for the sake of buffer-local
16039 set_buffer_internal_1 (XBUFFER (w
->contents
));
16041 current_matrix_up_to_date_p
16042 = (w
->window_end_valid
16043 && !current_buffer
->clip_changed
16044 && !current_buffer
->prevent_redisplay_optimizations_p
16045 && !window_outdated (w
));
16047 /* Run the window-text-change-functions
16048 if it is possible that the text on the screen has changed
16049 (either due to modification of the text, or any other reason). */
16050 if (!current_matrix_up_to_date_p
16051 && !NILP (Vwindow_text_change_functions
))
16053 safe_run_hooks (Qwindow_text_change_functions
);
16057 beg_unchanged
= BEG_UNCHANGED
;
16058 end_unchanged
= END_UNCHANGED
;
16060 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16062 specbind (Qinhibit_point_motion_hooks
, Qt
);
16065 = (w
->window_end_valid
16066 && !current_buffer
->clip_changed
16067 && !window_outdated (w
));
16069 /* When windows_or_buffers_changed is non-zero, we can't rely
16070 on the window end being valid, so set it to zero there. */
16071 if (windows_or_buffers_changed
)
16073 /* If window starts on a continuation line, maybe adjust the
16074 window start in case the window's width changed. */
16075 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16076 compute_window_start_on_continuation_line (w
);
16078 w
->window_end_valid
= false;
16079 /* If so, we also can't rely on current matrix
16080 and should not fool try_cursor_movement below. */
16081 current_matrix_up_to_date_p
= false;
16084 /* Some sanity checks. */
16085 CHECK_WINDOW_END (w
);
16086 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16088 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16091 if (mode_line_update_needed (w
))
16092 update_mode_line
= 1;
16094 /* Point refers normally to the selected window. For any other
16095 window, set up appropriate value. */
16096 if (!EQ (window
, selected_window
))
16098 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16099 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16104 new_pt_byte
= BEGV_BYTE
;
16105 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16107 else if (new_pt
> (ZV
- 1))
16110 new_pt_byte
= ZV_BYTE
;
16111 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16114 /* We don't use SET_PT so that the point-motion hooks don't run. */
16115 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16118 /* If any of the character widths specified in the display table
16119 have changed, invalidate the width run cache. It's true that
16120 this may be a bit late to catch such changes, but the rest of
16121 redisplay goes (non-fatally) haywire when the display table is
16122 changed, so why should we worry about doing any better? */
16123 if (current_buffer
->width_run_cache
16124 || (current_buffer
->base_buffer
16125 && current_buffer
->base_buffer
->width_run_cache
))
16127 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16129 if (! disptab_matches_widthtab
16130 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16132 struct buffer
*buf
= current_buffer
;
16134 if (buf
->base_buffer
)
16135 buf
= buf
->base_buffer
;
16136 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16137 recompute_width_table (current_buffer
, disptab
);
16141 /* If window-start is screwed up, choose a new one. */
16142 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16145 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16147 /* If someone specified a new starting point but did not insist,
16148 check whether it can be used. */
16149 if (w
->optional_new_start
16150 && CHARPOS (startp
) >= BEGV
16151 && CHARPOS (startp
) <= ZV
)
16153 w
->optional_new_start
= 0;
16154 start_display (&it
, w
, startp
);
16155 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16156 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16157 if (IT_CHARPOS (it
) == PT
)
16158 w
->force_start
= 1;
16159 /* IT may overshoot PT if text at PT is invisible. */
16160 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16161 w
->force_start
= 1;
16166 /* Handle case where place to start displaying has been specified,
16167 unless the specified location is outside the accessible range. */
16168 if (w
->force_start
|| window_frozen_p (w
))
16170 /* We set this later on if we have to adjust point. */
16173 w
->force_start
= 0;
16175 w
->window_end_valid
= 0;
16177 /* Forget any recorded base line for line number display. */
16178 if (!buffer_unchanged_p
)
16179 w
->base_line_number
= 0;
16181 /* Redisplay the mode line. Select the buffer properly for that.
16182 Also, run the hook window-scroll-functions
16183 because we have scrolled. */
16184 /* Note, we do this after clearing force_start because
16185 if there's an error, it is better to forget about force_start
16186 than to get into an infinite loop calling the hook functions
16187 and having them get more errors. */
16188 if (!update_mode_line
16189 || ! NILP (Vwindow_scroll_functions
))
16191 update_mode_line
= 1;
16192 w
->update_mode_line
= 1;
16193 startp
= run_window_scroll_functions (window
, startp
);
16196 if (CHARPOS (startp
) < BEGV
)
16197 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16198 else if (CHARPOS (startp
) > ZV
)
16199 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16201 /* Redisplay, then check if cursor has been set during the
16202 redisplay. Give up if new fonts were loaded. */
16203 /* We used to issue a CHECK_MARGINS argument to try_window here,
16204 but this causes scrolling to fail when point begins inside
16205 the scroll margin (bug#148) -- cyd */
16206 if (!try_window (window
, startp
, 0))
16208 w
->force_start
= 1;
16209 clear_glyph_matrix (w
->desired_matrix
);
16210 goto need_larger_matrices
;
16213 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16215 /* If point does not appear, try to move point so it does
16216 appear. The desired matrix has been built above, so we
16217 can use it here. */
16218 new_vpos
= window_box_height (w
) / 2;
16221 if (!cursor_row_fully_visible_p (w
, 0, 0))
16223 /* Point does appear, but on a line partly visible at end of window.
16224 Move it back to a fully-visible line. */
16225 new_vpos
= window_box_height (w
);
16226 /* But if window_box_height suggests a Y coordinate that is
16227 not less than we already have, that line will clearly not
16228 be fully visible, so give up and scroll the display.
16229 This can happen when the default face uses a font whose
16230 dimensions are different from the frame's default
16232 if (new_vpos
>= w
->cursor
.y
)
16234 w
->cursor
.vpos
= -1;
16235 clear_glyph_matrix (w
->desired_matrix
);
16236 goto try_to_scroll
;
16239 else if (w
->cursor
.vpos
>= 0)
16241 /* Some people insist on not letting point enter the scroll
16242 margin, even though this part handles windows that didn't
16244 int window_total_lines
16245 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16246 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16247 int pixel_margin
= margin
* frame_line_height
;
16248 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16250 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16251 below, which finds the row to move point to, advances by
16252 the Y coordinate of the _next_ row, see the definition of
16253 MATRIX_ROW_BOTTOM_Y. */
16254 if (w
->cursor
.vpos
< margin
+ header_line
)
16256 w
->cursor
.vpos
= -1;
16257 clear_glyph_matrix (w
->desired_matrix
);
16258 goto try_to_scroll
;
16262 int window_height
= window_box_height (w
);
16265 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16266 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16268 w
->cursor
.vpos
= -1;
16269 clear_glyph_matrix (w
->desired_matrix
);
16270 goto try_to_scroll
;
16275 /* If we need to move point for either of the above reasons,
16276 now actually do it. */
16279 struct glyph_row
*row
;
16281 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16282 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16285 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16286 MATRIX_ROW_START_BYTEPOS (row
));
16288 if (w
!= XWINDOW (selected_window
))
16289 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16290 else if (current_buffer
== old
)
16291 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16293 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16295 /* If we are highlighting the region, then we just changed
16296 the region, so redisplay to show it. */
16297 /* FIXME: We need to (re)run pre-redisplay-function! */
16298 /* if (markpos_of_region () >= 0)
16300 clear_glyph_matrix (w->desired_matrix);
16301 if (!try_window (window, startp, 0))
16302 goto need_larger_matrices;
16308 debug_method_add (w
, "forced window start");
16313 /* Handle case where text has not changed, only point, and it has
16314 not moved off the frame, and we are not retrying after hscroll.
16315 (current_matrix_up_to_date_p is nonzero when retrying.) */
16316 if (current_matrix_up_to_date_p
16317 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16318 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16322 case CURSOR_MOVEMENT_SUCCESS
:
16323 used_current_matrix_p
= 1;
16326 case CURSOR_MOVEMENT_MUST_SCROLL
:
16327 goto try_to_scroll
;
16333 /* If current starting point was originally the beginning of a line
16334 but no longer is, find a new starting point. */
16335 else if (w
->start_at_line_beg
16336 && !(CHARPOS (startp
) <= BEGV
16337 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16340 debug_method_add (w
, "recenter 1");
16345 /* Try scrolling with try_window_id. Value is > 0 if update has
16346 been done, it is -1 if we know that the same window start will
16347 not work. It is 0 if unsuccessful for some other reason. */
16348 else if ((tem
= try_window_id (w
)) != 0)
16351 debug_method_add (w
, "try_window_id %d", tem
);
16354 if (f
->fonts_changed
)
16355 goto need_larger_matrices
;
16359 /* Otherwise try_window_id has returned -1 which means that we
16360 don't want the alternative below this comment to execute. */
16362 else if (CHARPOS (startp
) >= BEGV
16363 && CHARPOS (startp
) <= ZV
16364 && PT
>= CHARPOS (startp
)
16365 && (CHARPOS (startp
) < ZV
16366 /* Avoid starting at end of buffer. */
16367 || CHARPOS (startp
) == BEGV
16368 || !window_outdated (w
)))
16370 int d1
, d2
, d3
, d4
, d5
, d6
;
16372 /* If first window line is a continuation line, and window start
16373 is inside the modified region, but the first change is before
16374 current window start, we must select a new window start.
16376 However, if this is the result of a down-mouse event (e.g. by
16377 extending the mouse-drag-overlay), we don't want to select a
16378 new window start, since that would change the position under
16379 the mouse, resulting in an unwanted mouse-movement rather
16380 than a simple mouse-click. */
16381 if (!w
->start_at_line_beg
16382 && NILP (do_mouse_tracking
)
16383 && CHARPOS (startp
) > BEGV
16384 && CHARPOS (startp
) > BEG
+ beg_unchanged
16385 && CHARPOS (startp
) <= Z
- end_unchanged
16386 /* Even if w->start_at_line_beg is nil, a new window may
16387 start at a line_beg, since that's how set_buffer_window
16388 sets it. So, we need to check the return value of
16389 compute_window_start_on_continuation_line. (See also
16391 && XMARKER (w
->start
)->buffer
== current_buffer
16392 && compute_window_start_on_continuation_line (w
)
16393 /* It doesn't make sense to force the window start like we
16394 do at label force_start if it is already known that point
16395 will not be visible in the resulting window, because
16396 doing so will move point from its correct position
16397 instead of scrolling the window to bring point into view.
16399 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16401 w
->force_start
= 1;
16402 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16407 debug_method_add (w
, "same window start");
16410 /* Try to redisplay starting at same place as before.
16411 If point has not moved off frame, accept the results. */
16412 if (!current_matrix_up_to_date_p
16413 /* Don't use try_window_reusing_current_matrix in this case
16414 because a window scroll function can have changed the
16416 || !NILP (Vwindow_scroll_functions
)
16417 || MINI_WINDOW_P (w
)
16418 || !(used_current_matrix_p
16419 = try_window_reusing_current_matrix (w
)))
16421 IF_DEBUG (debug_method_add (w
, "1"));
16422 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16423 /* -1 means we need to scroll.
16424 0 means we need new matrices, but fonts_changed
16425 is set in that case, so we will detect it below. */
16426 goto try_to_scroll
;
16429 if (f
->fonts_changed
)
16430 goto need_larger_matrices
;
16432 if (w
->cursor
.vpos
>= 0)
16434 if (!just_this_one_p
16435 || current_buffer
->clip_changed
16436 || BEG_UNCHANGED
< CHARPOS (startp
))
16437 /* Forget any recorded base line for line number display. */
16438 w
->base_line_number
= 0;
16440 if (!cursor_row_fully_visible_p (w
, 1, 0))
16442 clear_glyph_matrix (w
->desired_matrix
);
16443 last_line_misfit
= 1;
16445 /* Drop through and scroll. */
16450 clear_glyph_matrix (w
->desired_matrix
);
16455 /* Redisplay the mode line. Select the buffer properly for that. */
16456 if (!update_mode_line
)
16458 update_mode_line
= 1;
16459 w
->update_mode_line
= 1;
16462 /* Try to scroll by specified few lines. */
16463 if ((scroll_conservatively
16464 || emacs_scroll_step
16465 || temp_scroll_step
16466 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16467 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16468 && CHARPOS (startp
) >= BEGV
16469 && CHARPOS (startp
) <= ZV
)
16471 /* The function returns -1 if new fonts were loaded, 1 if
16472 successful, 0 if not successful. */
16473 int ss
= try_scrolling (window
, just_this_one_p
,
16474 scroll_conservatively
,
16476 temp_scroll_step
, last_line_misfit
);
16479 case SCROLLING_SUCCESS
:
16482 case SCROLLING_NEED_LARGER_MATRICES
:
16483 goto need_larger_matrices
;
16485 case SCROLLING_FAILED
:
16493 /* Finally, just choose a place to start which positions point
16494 according to user preferences. */
16499 debug_method_add (w
, "recenter");
16502 /* Forget any previously recorded base line for line number display. */
16503 if (!buffer_unchanged_p
)
16504 w
->base_line_number
= 0;
16506 /* Determine the window start relative to point. */
16507 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16508 it
.current_y
= it
.last_visible_y
;
16509 if (centering_position
< 0)
16511 int window_total_lines
16512 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16515 ? min (scroll_margin
, window_total_lines
/ 4)
16517 ptrdiff_t margin_pos
= CHARPOS (startp
);
16518 Lisp_Object aggressive
;
16521 /* If there is a scroll margin at the top of the window, find
16522 its character position. */
16524 /* Cannot call start_display if startp is not in the
16525 accessible region of the buffer. This can happen when we
16526 have just switched to a different buffer and/or changed
16527 its restriction. In that case, startp is initialized to
16528 the character position 1 (BEGV) because we did not yet
16529 have chance to display the buffer even once. */
16530 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16533 void *it1data
= NULL
;
16535 SAVE_IT (it1
, it
, it1data
);
16536 start_display (&it1
, w
, startp
);
16537 move_it_vertically (&it1
, margin
* frame_line_height
);
16538 margin_pos
= IT_CHARPOS (it1
);
16539 RESTORE_IT (&it
, &it
, it1data
);
16541 scrolling_up
= PT
> margin_pos
;
16544 ? BVAR (current_buffer
, scroll_up_aggressively
)
16545 : BVAR (current_buffer
, scroll_down_aggressively
);
16547 if (!MINI_WINDOW_P (w
)
16548 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16552 /* Setting scroll-conservatively overrides
16553 scroll-*-aggressively. */
16554 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16556 double float_amount
= XFLOATINT (aggressive
);
16558 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16559 if (pt_offset
== 0 && float_amount
> 0)
16561 if (pt_offset
&& margin
> 0)
16564 /* Compute how much to move the window start backward from
16565 point so that point will be displayed where the user
16569 centering_position
= it
.last_visible_y
;
16571 centering_position
-= pt_offset
;
16572 centering_position
-=
16573 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16574 + WINDOW_HEADER_LINE_HEIGHT (w
);
16575 /* Don't let point enter the scroll margin near top of
16577 if (centering_position
< margin
* frame_line_height
)
16578 centering_position
= margin
* frame_line_height
;
16581 centering_position
= margin
* frame_line_height
+ pt_offset
;
16584 /* Set the window start half the height of the window backward
16586 centering_position
= window_box_height (w
) / 2;
16588 move_it_vertically_backward (&it
, centering_position
);
16590 eassert (IT_CHARPOS (it
) >= BEGV
);
16592 /* The function move_it_vertically_backward may move over more
16593 than the specified y-distance. If it->w is small, e.g. a
16594 mini-buffer window, we may end up in front of the window's
16595 display area. Start displaying at the start of the line
16596 containing PT in this case. */
16597 if (it
.current_y
<= 0)
16599 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16600 move_it_vertically_backward (&it
, 0);
16604 it
.current_x
= it
.hpos
= 0;
16606 /* Set the window start position here explicitly, to avoid an
16607 infinite loop in case the functions in window-scroll-functions
16609 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16611 /* Run scroll hooks. */
16612 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16614 /* Redisplay the window. */
16615 if (!current_matrix_up_to_date_p
16616 || windows_or_buffers_changed
16617 || f
->cursor_type_changed
16618 /* Don't use try_window_reusing_current_matrix in this case
16619 because it can have changed the buffer. */
16620 || !NILP (Vwindow_scroll_functions
)
16621 || !just_this_one_p
16622 || MINI_WINDOW_P (w
)
16623 || !(used_current_matrix_p
16624 = try_window_reusing_current_matrix (w
)))
16625 try_window (window
, startp
, 0);
16627 /* If new fonts have been loaded (due to fontsets), give up. We
16628 have to start a new redisplay since we need to re-adjust glyph
16630 if (f
->fonts_changed
)
16631 goto need_larger_matrices
;
16633 /* If cursor did not appear assume that the middle of the window is
16634 in the first line of the window. Do it again with the next line.
16635 (Imagine a window of height 100, displaying two lines of height
16636 60. Moving back 50 from it->last_visible_y will end in the first
16638 if (w
->cursor
.vpos
< 0)
16640 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16642 clear_glyph_matrix (w
->desired_matrix
);
16643 move_it_by_lines (&it
, 1);
16644 try_window (window
, it
.current
.pos
, 0);
16646 else if (PT
< IT_CHARPOS (it
))
16648 clear_glyph_matrix (w
->desired_matrix
);
16649 move_it_by_lines (&it
, -1);
16650 try_window (window
, it
.current
.pos
, 0);
16654 /* Not much we can do about it. */
16658 /* Consider the following case: Window starts at BEGV, there is
16659 invisible, intangible text at BEGV, so that display starts at
16660 some point START > BEGV. It can happen that we are called with
16661 PT somewhere between BEGV and START. Try to handle that case,
16662 and similar ones. */
16663 if (w
->cursor
.vpos
< 0)
16665 /* First, try locating the proper glyph row for PT. */
16666 struct glyph_row
*row
=
16667 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16669 /* Sometimes point is at the beginning of invisible text that is
16670 before the 1st character displayed in the row. In that case,
16671 row_containing_pos fails to find the row, because no glyphs
16672 with appropriate buffer positions are present in the row.
16673 Therefore, we next try to find the row which shows the 1st
16674 position after the invisible text. */
16678 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16681 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16684 Lisp_Object invis_end
=
16685 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16688 if (NATNUMP (invis_end
))
16689 alt_pos
= XFASTINT (invis_end
);
16692 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16696 /* Finally, fall back on the first row of the window after the
16697 header line (if any). This is slightly better than not
16698 displaying the cursor at all. */
16701 row
= w
->current_matrix
->rows
;
16702 if (row
->mode_line_p
)
16705 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16708 if (!cursor_row_fully_visible_p (w
, 0, 0))
16710 /* If vscroll is enabled, disable it and try again. */
16714 clear_glyph_matrix (w
->desired_matrix
);
16718 /* Users who set scroll-conservatively to a large number want
16719 point just above/below the scroll margin. If we ended up
16720 with point's row partially visible, move the window start to
16721 make that row fully visible and out of the margin. */
16722 if (scroll_conservatively
> SCROLL_LIMIT
)
16724 int window_total_lines
16725 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16728 ? min (scroll_margin
, window_total_lines
/ 4)
16730 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16732 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16733 clear_glyph_matrix (w
->desired_matrix
);
16734 if (1 == try_window (window
, it
.current
.pos
,
16735 TRY_WINDOW_CHECK_MARGINS
))
16739 /* If centering point failed to make the whole line visible,
16740 put point at the top instead. That has to make the whole line
16741 visible, if it can be done. */
16742 if (centering_position
== 0)
16745 clear_glyph_matrix (w
->desired_matrix
);
16746 centering_position
= 0;
16752 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16753 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16754 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16756 /* Display the mode line, if we must. */
16757 if ((update_mode_line
16758 /* If window not full width, must redo its mode line
16759 if (a) the window to its side is being redone and
16760 (b) we do a frame-based redisplay. This is a consequence
16761 of how inverted lines are drawn in frame-based redisplay. */
16762 || (!just_this_one_p
16763 && !FRAME_WINDOW_P (f
)
16764 && !WINDOW_FULL_WIDTH_P (w
))
16765 /* Line number to display. */
16766 || w
->base_line_pos
> 0
16767 /* Column number is displayed and different from the one displayed. */
16768 || (w
->column_number_displayed
!= -1
16769 && (w
->column_number_displayed
!= current_column ())))
16770 /* This means that the window has a mode line. */
16771 && (WINDOW_WANTS_MODELINE_P (w
)
16772 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16775 display_mode_lines (w
);
16777 /* If mode line height has changed, arrange for a thorough
16778 immediate redisplay using the correct mode line height. */
16779 if (WINDOW_WANTS_MODELINE_P (w
)
16780 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16782 f
->fonts_changed
= 1;
16783 w
->mode_line_height
= -1;
16784 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16785 = DESIRED_MODE_LINE_HEIGHT (w
);
16788 /* If header line height has changed, arrange for a thorough
16789 immediate redisplay using the correct header line height. */
16790 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16791 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16793 f
->fonts_changed
= 1;
16794 w
->header_line_height
= -1;
16795 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16796 = DESIRED_HEADER_LINE_HEIGHT (w
);
16799 if (f
->fonts_changed
)
16800 goto need_larger_matrices
;
16803 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16805 w
->base_line_pos
= 0;
16806 w
->base_line_number
= 0;
16811 /* When we reach a frame's selected window, redo the frame's menu bar. */
16812 if (update_mode_line
16813 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16815 int redisplay_menu_p
= 0;
16817 if (FRAME_WINDOW_P (f
))
16819 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16820 || defined (HAVE_NS) || defined (USE_GTK)
16821 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16823 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16827 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16829 if (redisplay_menu_p
)
16830 display_menu_bar (w
);
16832 #ifdef HAVE_WINDOW_SYSTEM
16833 if (FRAME_WINDOW_P (f
))
16835 #if defined (USE_GTK) || defined (HAVE_NS)
16836 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16837 redisplay_tool_bar (f
);
16839 if (WINDOWP (f
->tool_bar_window
)
16840 && (FRAME_TOOL_BAR_LINES (f
) > 0
16841 || !NILP (Vauto_resize_tool_bars
))
16842 && redisplay_tool_bar (f
))
16843 ignore_mouse_drag_p
= 1;
16849 #ifdef HAVE_WINDOW_SYSTEM
16850 if (FRAME_WINDOW_P (f
)
16851 && update_window_fringes (w
, (just_this_one_p
16852 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16853 || w
->pseudo_window_p
)))
16857 if (draw_window_fringes (w
, 1))
16859 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16860 x_draw_right_divider (w
);
16862 x_draw_vertical_border (w
);
16868 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16869 x_draw_bottom_divider (w
);
16870 #endif /* HAVE_WINDOW_SYSTEM */
16872 /* We go to this label, with fonts_changed set, if it is
16873 necessary to try again using larger glyph matrices.
16874 We have to redeem the scroll bar even in this case,
16875 because the loop in redisplay_internal expects that. */
16876 need_larger_matrices
:
16878 finish_scroll_bars
:
16880 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16882 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16883 /* Set the thumb's position and size. */
16884 set_vertical_scroll_bar (w
);
16886 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16887 /* Set the thumb's position and size. */
16888 set_horizontal_scroll_bar (w
);
16890 /* Note that we actually used the scroll bar attached to this
16891 window, so it shouldn't be deleted at the end of redisplay. */
16892 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16893 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16896 /* Restore current_buffer and value of point in it. The window
16897 update may have changed the buffer, so first make sure `opoint'
16898 is still valid (Bug#6177). */
16899 if (CHARPOS (opoint
) < BEGV
)
16900 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16901 else if (CHARPOS (opoint
) > ZV
)
16902 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16904 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16906 set_buffer_internal_1 (old
);
16907 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16908 shorter. This can be caused by log truncation in *Messages*. */
16909 if (CHARPOS (lpoint
) <= ZV
)
16910 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16912 unbind_to (count
, Qnil
);
16916 /* Build the complete desired matrix of WINDOW with a window start
16917 buffer position POS.
16919 Value is 1 if successful. It is zero if fonts were loaded during
16920 redisplay which makes re-adjusting glyph matrices necessary, and -1
16921 if point would appear in the scroll margins.
16922 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16923 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16927 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16929 struct window
*w
= XWINDOW (window
);
16931 struct glyph_row
*last_text_row
= NULL
;
16932 struct frame
*f
= XFRAME (w
->frame
);
16933 int frame_line_height
= default_line_pixel_height (w
);
16935 /* Make POS the new window start. */
16936 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16938 /* Mark cursor position as unknown. No overlay arrow seen. */
16939 w
->cursor
.vpos
= -1;
16940 overlay_arrow_seen
= 0;
16942 /* Initialize iterator and info to start at POS. */
16943 start_display (&it
, w
, pos
);
16944 it
.glyph_row
->reversed_p
= false;
16946 /* Display all lines of W. */
16947 while (it
.current_y
< it
.last_visible_y
)
16949 if (display_line (&it
))
16950 last_text_row
= it
.glyph_row
- 1;
16951 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16955 /* Don't let the cursor end in the scroll margins. */
16956 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16957 && !MINI_WINDOW_P (w
))
16959 int this_scroll_margin
;
16960 int window_total_lines
16961 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16963 if (scroll_margin
> 0)
16965 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16966 this_scroll_margin
*= frame_line_height
;
16969 this_scroll_margin
= 0;
16971 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16972 && w
->cursor
.y
< this_scroll_margin
16973 && CHARPOS (pos
) > BEGV
16974 && IT_CHARPOS (it
) < ZV
)
16975 /* rms: considering make_cursor_line_fully_visible_p here
16976 seems to give wrong results. We don't want to recenter
16977 when the last line is partly visible, we want to allow
16978 that case to be handled in the usual way. */
16979 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16981 w
->cursor
.vpos
= -1;
16982 clear_glyph_matrix (w
->desired_matrix
);
16987 /* If bottom moved off end of frame, change mode line percentage. */
16988 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16989 w
->update_mode_line
= 1;
16991 /* Set window_end_pos to the offset of the last character displayed
16992 on the window from the end of current_buffer. Set
16993 window_end_vpos to its row number. */
16996 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16997 adjust_window_ends (w
, last_text_row
, 0);
16999 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17000 w
->window_end_vpos
)));
17004 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17005 w
->window_end_pos
= Z
- ZV
;
17006 w
->window_end_vpos
= 0;
17009 /* But that is not valid info until redisplay finishes. */
17010 w
->window_end_valid
= 0;
17016 /************************************************************************
17017 Window redisplay reusing current matrix when buffer has not changed
17018 ************************************************************************/
17020 /* Try redisplay of window W showing an unchanged buffer with a
17021 different window start than the last time it was displayed by
17022 reusing its current matrix. Value is non-zero if successful.
17023 W->start is the new window start. */
17026 try_window_reusing_current_matrix (struct window
*w
)
17028 struct frame
*f
= XFRAME (w
->frame
);
17029 struct glyph_row
*bottom_row
;
17032 struct text_pos start
, new_start
;
17033 int nrows_scrolled
, i
;
17034 struct glyph_row
*last_text_row
;
17035 struct glyph_row
*last_reused_text_row
;
17036 struct glyph_row
*start_row
;
17037 int start_vpos
, min_y
, max_y
;
17040 if (inhibit_try_window_reusing
)
17044 if (/* This function doesn't handle terminal frames. */
17045 !FRAME_WINDOW_P (f
)
17046 /* Don't try to reuse the display if windows have been split
17048 || windows_or_buffers_changed
17049 || f
->cursor_type_changed
)
17052 /* Can't do this if showing trailing whitespace. */
17053 if (!NILP (Vshow_trailing_whitespace
))
17056 /* If top-line visibility has changed, give up. */
17057 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17058 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17061 /* Give up if old or new display is scrolled vertically. We could
17062 make this function handle this, but right now it doesn't. */
17063 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17064 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17067 /* The variable new_start now holds the new window start. The old
17068 start `start' can be determined from the current matrix. */
17069 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17070 start
= start_row
->minpos
;
17071 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17073 /* Clear the desired matrix for the display below. */
17074 clear_glyph_matrix (w
->desired_matrix
);
17076 if (CHARPOS (new_start
) <= CHARPOS (start
))
17078 /* Don't use this method if the display starts with an ellipsis
17079 displayed for invisible text. It's not easy to handle that case
17080 below, and it's certainly not worth the effort since this is
17081 not a frequent case. */
17082 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17085 IF_DEBUG (debug_method_add (w
, "twu1"));
17087 /* Display up to a row that can be reused. The variable
17088 last_text_row is set to the last row displayed that displays
17089 text. Note that it.vpos == 0 if or if not there is a
17090 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17091 start_display (&it
, w
, new_start
);
17092 w
->cursor
.vpos
= -1;
17093 last_text_row
= last_reused_text_row
= NULL
;
17095 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17097 /* If we have reached into the characters in the START row,
17098 that means the line boundaries have changed. So we
17099 can't start copying with the row START. Maybe it will
17100 work to start copying with the following row. */
17101 while (IT_CHARPOS (it
) > CHARPOS (start
))
17103 /* Advance to the next row as the "start". */
17105 start
= start_row
->minpos
;
17106 /* If there are no more rows to try, or just one, give up. */
17107 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17108 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17109 || CHARPOS (start
) == ZV
)
17111 clear_glyph_matrix (w
->desired_matrix
);
17115 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17117 /* If we have reached alignment, we can copy the rest of the
17119 if (IT_CHARPOS (it
) == CHARPOS (start
)
17120 /* Don't accept "alignment" inside a display vector,
17121 since start_row could have started in the middle of
17122 that same display vector (thus their character
17123 positions match), and we have no way of telling if
17124 that is the case. */
17125 && it
.current
.dpvec_index
< 0)
17128 it
.glyph_row
->reversed_p
= false;
17129 if (display_line (&it
))
17130 last_text_row
= it
.glyph_row
- 1;
17134 /* A value of current_y < last_visible_y means that we stopped
17135 at the previous window start, which in turn means that we
17136 have at least one reusable row. */
17137 if (it
.current_y
< it
.last_visible_y
)
17139 struct glyph_row
*row
;
17141 /* IT.vpos always starts from 0; it counts text lines. */
17142 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17144 /* Find PT if not already found in the lines displayed. */
17145 if (w
->cursor
.vpos
< 0)
17147 int dy
= it
.current_y
- start_row
->y
;
17149 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17150 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17152 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17153 dy
, nrows_scrolled
);
17156 clear_glyph_matrix (w
->desired_matrix
);
17161 /* Scroll the display. Do it before the current matrix is
17162 changed. The problem here is that update has not yet
17163 run, i.e. part of the current matrix is not up to date.
17164 scroll_run_hook will clear the cursor, and use the
17165 current matrix to get the height of the row the cursor is
17167 run
.current_y
= start_row
->y
;
17168 run
.desired_y
= it
.current_y
;
17169 run
.height
= it
.last_visible_y
- it
.current_y
;
17171 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17174 FRAME_RIF (f
)->update_window_begin_hook (w
);
17175 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17176 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17177 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17181 /* Shift current matrix down by nrows_scrolled lines. */
17182 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17183 rotate_matrix (w
->current_matrix
,
17185 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17188 /* Disable lines that must be updated. */
17189 for (i
= 0; i
< nrows_scrolled
; ++i
)
17190 (start_row
+ i
)->enabled_p
= false;
17192 /* Re-compute Y positions. */
17193 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17194 max_y
= it
.last_visible_y
;
17195 for (row
= start_row
+ nrows_scrolled
;
17199 row
->y
= it
.current_y
;
17200 row
->visible_height
= row
->height
;
17202 if (row
->y
< min_y
)
17203 row
->visible_height
-= min_y
- row
->y
;
17204 if (row
->y
+ row
->height
> max_y
)
17205 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17206 if (row
->fringe_bitmap_periodic_p
)
17207 row
->redraw_fringe_bitmaps_p
= 1;
17209 it
.current_y
+= row
->height
;
17211 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17212 last_reused_text_row
= row
;
17213 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17217 /* Disable lines in the current matrix which are now
17218 below the window. */
17219 for (++row
; row
< bottom_row
; ++row
)
17220 row
->enabled_p
= row
->mode_line_p
= 0;
17223 /* Update window_end_pos etc.; last_reused_text_row is the last
17224 reused row from the current matrix containing text, if any.
17225 The value of last_text_row is the last displayed line
17226 containing text. */
17227 if (last_reused_text_row
)
17228 adjust_window_ends (w
, last_reused_text_row
, 1);
17229 else if (last_text_row
)
17230 adjust_window_ends (w
, last_text_row
, 0);
17233 /* This window must be completely empty. */
17234 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17235 w
->window_end_pos
= Z
- ZV
;
17236 w
->window_end_vpos
= 0;
17238 w
->window_end_valid
= 0;
17240 /* Update hint: don't try scrolling again in update_window. */
17241 w
->desired_matrix
->no_scrolling_p
= 1;
17244 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17248 else if (CHARPOS (new_start
) > CHARPOS (start
))
17250 struct glyph_row
*pt_row
, *row
;
17251 struct glyph_row
*first_reusable_row
;
17252 struct glyph_row
*first_row_to_display
;
17254 int yb
= window_text_bottom_y (w
);
17256 /* Find the row starting at new_start, if there is one. Don't
17257 reuse a partially visible line at the end. */
17258 first_reusable_row
= start_row
;
17259 while (first_reusable_row
->enabled_p
17260 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17261 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17262 < CHARPOS (new_start
)))
17263 ++first_reusable_row
;
17265 /* Give up if there is no row to reuse. */
17266 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17267 || !first_reusable_row
->enabled_p
17268 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17269 != CHARPOS (new_start
)))
17272 /* We can reuse fully visible rows beginning with
17273 first_reusable_row to the end of the window. Set
17274 first_row_to_display to the first row that cannot be reused.
17275 Set pt_row to the row containing point, if there is any. */
17277 for (first_row_to_display
= first_reusable_row
;
17278 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17279 ++first_row_to_display
)
17281 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17282 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17283 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17284 && first_row_to_display
->ends_at_zv_p
17285 && pt_row
== NULL
)))
17286 pt_row
= first_row_to_display
;
17289 /* Start displaying at the start of first_row_to_display. */
17290 eassert (first_row_to_display
->y
< yb
);
17291 init_to_row_start (&it
, w
, first_row_to_display
);
17293 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17295 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17297 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17298 + WINDOW_HEADER_LINE_HEIGHT (w
));
17300 /* Display lines beginning with first_row_to_display in the
17301 desired matrix. Set last_text_row to the last row displayed
17302 that displays text. */
17303 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17304 if (pt_row
== NULL
)
17305 w
->cursor
.vpos
= -1;
17306 last_text_row
= NULL
;
17307 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17308 if (display_line (&it
))
17309 last_text_row
= it
.glyph_row
- 1;
17311 /* If point is in a reused row, adjust y and vpos of the cursor
17315 w
->cursor
.vpos
-= nrows_scrolled
;
17316 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17319 /* Give up if point isn't in a row displayed or reused. (This
17320 also handles the case where w->cursor.vpos < nrows_scrolled
17321 after the calls to display_line, which can happen with scroll
17322 margins. See bug#1295.) */
17323 if (w
->cursor
.vpos
< 0)
17325 clear_glyph_matrix (w
->desired_matrix
);
17329 /* Scroll the display. */
17330 run
.current_y
= first_reusable_row
->y
;
17331 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17332 run
.height
= it
.last_visible_y
- run
.current_y
;
17333 dy
= run
.current_y
- run
.desired_y
;
17338 FRAME_RIF (f
)->update_window_begin_hook (w
);
17339 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17340 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17341 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17345 /* Adjust Y positions of reused rows. */
17346 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17347 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17348 max_y
= it
.last_visible_y
;
17349 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17352 row
->visible_height
= row
->height
;
17353 if (row
->y
< min_y
)
17354 row
->visible_height
-= min_y
- row
->y
;
17355 if (row
->y
+ row
->height
> max_y
)
17356 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17357 if (row
->fringe_bitmap_periodic_p
)
17358 row
->redraw_fringe_bitmaps_p
= 1;
17361 /* Scroll the current matrix. */
17362 eassert (nrows_scrolled
> 0);
17363 rotate_matrix (w
->current_matrix
,
17365 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17368 /* Disable rows not reused. */
17369 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17370 row
->enabled_p
= false;
17372 /* Point may have moved to a different line, so we cannot assume that
17373 the previous cursor position is valid; locate the correct row. */
17376 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17378 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17379 && !row
->ends_at_zv_p
;
17383 w
->cursor
.y
= row
->y
;
17385 if (row
< bottom_row
)
17387 /* Can't simply scan the row for point with
17388 bidi-reordered glyph rows. Let set_cursor_from_row
17389 figure out where to put the cursor, and if it fails,
17391 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17393 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17396 clear_glyph_matrix (w
->desired_matrix
);
17402 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17403 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17406 && (!BUFFERP (glyph
->object
)
17407 || glyph
->charpos
< PT
);
17411 w
->cursor
.x
+= glyph
->pixel_width
;
17417 /* Adjust window end. A null value of last_text_row means that
17418 the window end is in reused rows which in turn means that
17419 only its vpos can have changed. */
17421 adjust_window_ends (w
, last_text_row
, 0);
17423 w
->window_end_vpos
-= nrows_scrolled
;
17425 w
->window_end_valid
= 0;
17426 w
->desired_matrix
->no_scrolling_p
= 1;
17429 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17439 /************************************************************************
17440 Window redisplay reusing current matrix when buffer has changed
17441 ************************************************************************/
17443 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17444 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17445 ptrdiff_t *, ptrdiff_t *);
17446 static struct glyph_row
*
17447 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17448 struct glyph_row
*);
17451 /* Return the last row in MATRIX displaying text. If row START is
17452 non-null, start searching with that row. IT gives the dimensions
17453 of the display. Value is null if matrix is empty; otherwise it is
17454 a pointer to the row found. */
17456 static struct glyph_row
*
17457 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17458 struct glyph_row
*start
)
17460 struct glyph_row
*row
, *row_found
;
17462 /* Set row_found to the last row in IT->w's current matrix
17463 displaying text. The loop looks funny but think of partially
17466 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17467 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17469 eassert (row
->enabled_p
);
17471 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17480 /* Return the last row in the current matrix of W that is not affected
17481 by changes at the start of current_buffer that occurred since W's
17482 current matrix was built. Value is null if no such row exists.
17484 BEG_UNCHANGED us the number of characters unchanged at the start of
17485 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17486 first changed character in current_buffer. Characters at positions <
17487 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17488 when the current matrix was built. */
17490 static struct glyph_row
*
17491 find_last_unchanged_at_beg_row (struct window
*w
)
17493 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17494 struct glyph_row
*row
;
17495 struct glyph_row
*row_found
= NULL
;
17496 int yb
= window_text_bottom_y (w
);
17498 /* Find the last row displaying unchanged text. */
17499 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17500 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17501 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17504 if (/* If row ends before first_changed_pos, it is unchanged,
17505 except in some case. */
17506 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17507 /* When row ends in ZV and we write at ZV it is not
17509 && !row
->ends_at_zv_p
17510 /* When first_changed_pos is the end of a continued line,
17511 row is not unchanged because it may be no longer
17513 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17514 && (row
->continued_p
17515 || row
->exact_window_width_line_p
))
17516 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17517 needs to be recomputed, so don't consider this row as
17518 unchanged. This happens when the last line was
17519 bidi-reordered and was killed immediately before this
17520 redisplay cycle. In that case, ROW->end stores the
17521 buffer position of the first visual-order character of
17522 the killed text, which is now beyond ZV. */
17523 && CHARPOS (row
->end
.pos
) <= ZV
)
17526 /* Stop if last visible row. */
17527 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17535 /* Find the first glyph row in the current matrix of W that is not
17536 affected by changes at the end of current_buffer since the
17537 time W's current matrix was built.
17539 Return in *DELTA the number of chars by which buffer positions in
17540 unchanged text at the end of current_buffer must be adjusted.
17542 Return in *DELTA_BYTES the corresponding number of bytes.
17544 Value is null if no such row exists, i.e. all rows are affected by
17547 static struct glyph_row
*
17548 find_first_unchanged_at_end_row (struct window
*w
,
17549 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17551 struct glyph_row
*row
;
17552 struct glyph_row
*row_found
= NULL
;
17554 *delta
= *delta_bytes
= 0;
17556 /* Display must not have been paused, otherwise the current matrix
17557 is not up to date. */
17558 eassert (w
->window_end_valid
);
17560 /* A value of window_end_pos >= END_UNCHANGED means that the window
17561 end is in the range of changed text. If so, there is no
17562 unchanged row at the end of W's current matrix. */
17563 if (w
->window_end_pos
>= END_UNCHANGED
)
17566 /* Set row to the last row in W's current matrix displaying text. */
17567 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17569 /* If matrix is entirely empty, no unchanged row exists. */
17570 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17572 /* The value of row is the last glyph row in the matrix having a
17573 meaningful buffer position in it. The end position of row
17574 corresponds to window_end_pos. This allows us to translate
17575 buffer positions in the current matrix to current buffer
17576 positions for characters not in changed text. */
17578 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17579 ptrdiff_t Z_BYTE_old
=
17580 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17581 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17582 struct glyph_row
*first_text_row
17583 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17585 *delta
= Z
- Z_old
;
17586 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17588 /* Set last_unchanged_pos to the buffer position of the last
17589 character in the buffer that has not been changed. Z is the
17590 index + 1 of the last character in current_buffer, i.e. by
17591 subtracting END_UNCHANGED we get the index of the last
17592 unchanged character, and we have to add BEG to get its buffer
17594 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17595 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17597 /* Search backward from ROW for a row displaying a line that
17598 starts at a minimum position >= last_unchanged_pos_old. */
17599 for (; row
> first_text_row
; --row
)
17601 /* This used to abort, but it can happen.
17602 It is ok to just stop the search instead here. KFS. */
17603 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17606 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17611 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17617 /* Make sure that glyph rows in the current matrix of window W
17618 reference the same glyph memory as corresponding rows in the
17619 frame's frame matrix. This function is called after scrolling W's
17620 current matrix on a terminal frame in try_window_id and
17621 try_window_reusing_current_matrix. */
17624 sync_frame_with_window_matrix_rows (struct window
*w
)
17626 struct frame
*f
= XFRAME (w
->frame
);
17627 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17629 /* Preconditions: W must be a leaf window and full-width. Its frame
17630 must have a frame matrix. */
17631 eassert (BUFFERP (w
->contents
));
17632 eassert (WINDOW_FULL_WIDTH_P (w
));
17633 eassert (!FRAME_WINDOW_P (f
));
17635 /* If W is a full-width window, glyph pointers in W's current matrix
17636 have, by definition, to be the same as glyph pointers in the
17637 corresponding frame matrix. Note that frame matrices have no
17638 marginal areas (see build_frame_matrix). */
17639 window_row
= w
->current_matrix
->rows
;
17640 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17641 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17642 while (window_row
< window_row_end
)
17644 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17645 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17647 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17648 frame_row
->glyphs
[TEXT_AREA
] = start
;
17649 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17650 frame_row
->glyphs
[LAST_AREA
] = end
;
17652 /* Disable frame rows whose corresponding window rows have
17653 been disabled in try_window_id. */
17654 if (!window_row
->enabled_p
)
17655 frame_row
->enabled_p
= false;
17657 ++window_row
, ++frame_row
;
17662 /* Find the glyph row in window W containing CHARPOS. Consider all
17663 rows between START and END (not inclusive). END null means search
17664 all rows to the end of the display area of W. Value is the row
17665 containing CHARPOS or null. */
17668 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17669 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17671 struct glyph_row
*row
= start
;
17672 struct glyph_row
*best_row
= NULL
;
17673 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17676 /* If we happen to start on a header-line, skip that. */
17677 if (row
->mode_line_p
)
17680 if ((end
&& row
>= end
) || !row
->enabled_p
)
17683 last_y
= window_text_bottom_y (w
) - dy
;
17687 /* Give up if we have gone too far. */
17688 if (end
&& row
>= end
)
17690 /* This formerly returned if they were equal.
17691 I think that both quantities are of a "last plus one" type;
17692 if so, when they are equal, the row is within the screen. -- rms. */
17693 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17696 /* If it is in this row, return this row. */
17697 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17698 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17699 /* The end position of a row equals the start
17700 position of the next row. If CHARPOS is there, we
17701 would rather consider it displayed in the next
17702 line, except when this line ends in ZV. */
17703 && !row_for_charpos_p (row
, charpos
)))
17704 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17708 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17709 || (!best_row
&& !row
->continued_p
))
17711 /* In bidi-reordered rows, there could be several rows whose
17712 edges surround CHARPOS, all of these rows belonging to
17713 the same continued line. We need to find the row which
17714 fits CHARPOS the best. */
17715 for (g
= row
->glyphs
[TEXT_AREA
];
17716 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17719 if (!STRINGP (g
->object
))
17721 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17723 mindif
= eabs (g
->charpos
- charpos
);
17725 /* Exact match always wins. */
17732 else if (best_row
&& !row
->continued_p
)
17739 /* Try to redisplay window W by reusing its existing display. W's
17740 current matrix must be up to date when this function is called,
17741 i.e. window_end_valid must be nonzero.
17745 >= 1 if successful, i.e. display has been updated
17747 1 means the changes were in front of a newline that precedes
17748 the window start, and the whole current matrix was reused
17749 2 means the changes were after the last position displayed
17750 in the window, and the whole current matrix was reused
17751 3 means portions of the current matrix were reused, while
17752 some of the screen lines were redrawn
17753 -1 if redisplay with same window start is known not to succeed
17754 0 if otherwise unsuccessful
17756 The following steps are performed:
17758 1. Find the last row in the current matrix of W that is not
17759 affected by changes at the start of current_buffer. If no such row
17762 2. Find the first row in W's current matrix that is not affected by
17763 changes at the end of current_buffer. Maybe there is no such row.
17765 3. Display lines beginning with the row + 1 found in step 1 to the
17766 row found in step 2 or, if step 2 didn't find a row, to the end of
17769 4. If cursor is not known to appear on the window, give up.
17771 5. If display stopped at the row found in step 2, scroll the
17772 display and current matrix as needed.
17774 6. Maybe display some lines at the end of W, if we must. This can
17775 happen under various circumstances, like a partially visible line
17776 becoming fully visible, or because newly displayed lines are displayed
17777 in smaller font sizes.
17779 7. Update W's window end information. */
17782 try_window_id (struct window
*w
)
17784 struct frame
*f
= XFRAME (w
->frame
);
17785 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17786 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17787 struct glyph_row
*last_unchanged_at_beg_row
;
17788 struct glyph_row
*first_unchanged_at_end_row
;
17789 struct glyph_row
*row
;
17790 struct glyph_row
*bottom_row
;
17793 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17795 struct text_pos start_pos
;
17797 int first_unchanged_at_end_vpos
= 0;
17798 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17799 struct text_pos start
;
17800 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17803 if (inhibit_try_window_id
)
17807 /* This is handy for debugging. */
17809 #define GIVE_UP(X) \
17811 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17815 #define GIVE_UP(X) return 0
17818 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17820 /* Don't use this for mini-windows because these can show
17821 messages and mini-buffers, and we don't handle that here. */
17822 if (MINI_WINDOW_P (w
))
17825 /* This flag is used to prevent redisplay optimizations. */
17826 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17829 /* This function's optimizations cannot be used if overlays have
17830 changed in the buffer displayed by the window, so give up if they
17832 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17835 /* Verify that narrowing has not changed.
17836 Also verify that we were not told to prevent redisplay optimizations.
17837 It would be nice to further
17838 reduce the number of cases where this prevents try_window_id. */
17839 if (current_buffer
->clip_changed
17840 || current_buffer
->prevent_redisplay_optimizations_p
)
17843 /* Window must either use window-based redisplay or be full width. */
17844 if (!FRAME_WINDOW_P (f
)
17845 && (!FRAME_LINE_INS_DEL_OK (f
)
17846 || !WINDOW_FULL_WIDTH_P (w
)))
17849 /* Give up if point is known NOT to appear in W. */
17850 if (PT
< CHARPOS (start
))
17853 /* Another way to prevent redisplay optimizations. */
17854 if (w
->last_modified
== 0)
17857 /* Verify that window is not hscrolled. */
17858 if (w
->hscroll
!= 0)
17861 /* Verify that display wasn't paused. */
17862 if (!w
->window_end_valid
)
17865 /* Likewise if highlighting trailing whitespace. */
17866 if (!NILP (Vshow_trailing_whitespace
))
17869 /* Can't use this if overlay arrow position and/or string have
17871 if (overlay_arrows_changed_p ())
17874 /* When word-wrap is on, adding a space to the first word of a
17875 wrapped line can change the wrap position, altering the line
17876 above it. It might be worthwhile to handle this more
17877 intelligently, but for now just redisplay from scratch. */
17878 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17881 /* Under bidi reordering, adding or deleting a character in the
17882 beginning of a paragraph, before the first strong directional
17883 character, can change the base direction of the paragraph (unless
17884 the buffer specifies a fixed paragraph direction), which will
17885 require to redisplay the whole paragraph. It might be worthwhile
17886 to find the paragraph limits and widen the range of redisplayed
17887 lines to that, but for now just give up this optimization and
17888 redisplay from scratch. */
17889 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17890 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17893 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17894 only if buffer has really changed. The reason is that the gap is
17895 initially at Z for freshly visited files. The code below would
17896 set end_unchanged to 0 in that case. */
17897 if (MODIFF
> SAVE_MODIFF
17898 /* This seems to happen sometimes after saving a buffer. */
17899 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17901 if (GPT
- BEG
< BEG_UNCHANGED
)
17902 BEG_UNCHANGED
= GPT
- BEG
;
17903 if (Z
- GPT
< END_UNCHANGED
)
17904 END_UNCHANGED
= Z
- GPT
;
17907 /* The position of the first and last character that has been changed. */
17908 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17909 last_changed_charpos
= Z
- END_UNCHANGED
;
17911 /* If window starts after a line end, and the last change is in
17912 front of that newline, then changes don't affect the display.
17913 This case happens with stealth-fontification. Note that although
17914 the display is unchanged, glyph positions in the matrix have to
17915 be adjusted, of course. */
17916 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17917 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17918 && ((last_changed_charpos
< CHARPOS (start
)
17919 && CHARPOS (start
) == BEGV
)
17920 || (last_changed_charpos
< CHARPOS (start
) - 1
17921 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17923 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17924 struct glyph_row
*r0
;
17926 /* Compute how many chars/bytes have been added to or removed
17927 from the buffer. */
17928 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17929 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17930 Z_delta
= Z
- Z_old
;
17931 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17933 /* Give up if PT is not in the window. Note that it already has
17934 been checked at the start of try_window_id that PT is not in
17935 front of the window start. */
17936 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17939 /* If window start is unchanged, we can reuse the whole matrix
17940 as is, after adjusting glyph positions. No need to compute
17941 the window end again, since its offset from Z hasn't changed. */
17942 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17943 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17944 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17945 /* PT must not be in a partially visible line. */
17946 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17947 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17949 /* Adjust positions in the glyph matrix. */
17950 if (Z_delta
|| Z_delta_bytes
)
17952 struct glyph_row
*r1
17953 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17954 increment_matrix_positions (w
->current_matrix
,
17955 MATRIX_ROW_VPOS (r0
, current_matrix
),
17956 MATRIX_ROW_VPOS (r1
, current_matrix
),
17957 Z_delta
, Z_delta_bytes
);
17960 /* Set the cursor. */
17961 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17963 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17968 /* Handle the case that changes are all below what is displayed in
17969 the window, and that PT is in the window. This shortcut cannot
17970 be taken if ZV is visible in the window, and text has been added
17971 there that is visible in the window. */
17972 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17973 /* ZV is not visible in the window, or there are no
17974 changes at ZV, actually. */
17975 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17976 || first_changed_charpos
== last_changed_charpos
))
17978 struct glyph_row
*r0
;
17980 /* Give up if PT is not in the window. Note that it already has
17981 been checked at the start of try_window_id that PT is not in
17982 front of the window start. */
17983 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17986 /* If window start is unchanged, we can reuse the whole matrix
17987 as is, without changing glyph positions since no text has
17988 been added/removed in front of the window end. */
17989 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17990 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17991 /* PT must not be in a partially visible line. */
17992 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17993 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17995 /* We have to compute the window end anew since text
17996 could have been added/removed after it. */
17997 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17998 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18000 /* Set the cursor. */
18001 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18003 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18008 /* Give up if window start is in the changed area.
18010 The condition used to read
18012 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18014 but why that was tested escapes me at the moment. */
18015 if (CHARPOS (start
) >= first_changed_charpos
18016 && CHARPOS (start
) <= last_changed_charpos
)
18019 /* Check that window start agrees with the start of the first glyph
18020 row in its current matrix. Check this after we know the window
18021 start is not in changed text, otherwise positions would not be
18023 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18024 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18027 /* Give up if the window ends in strings. Overlay strings
18028 at the end are difficult to handle, so don't try. */
18029 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18030 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18033 /* Compute the position at which we have to start displaying new
18034 lines. Some of the lines at the top of the window might be
18035 reusable because they are not displaying changed text. Find the
18036 last row in W's current matrix not affected by changes at the
18037 start of current_buffer. Value is null if changes start in the
18038 first line of window. */
18039 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18040 if (last_unchanged_at_beg_row
)
18042 /* Avoid starting to display in the middle of a character, a TAB
18043 for instance. This is easier than to set up the iterator
18044 exactly, and it's not a frequent case, so the additional
18045 effort wouldn't really pay off. */
18046 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18047 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18048 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18049 --last_unchanged_at_beg_row
;
18051 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18054 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18056 start_pos
= it
.current
.pos
;
18058 /* Start displaying new lines in the desired matrix at the same
18059 vpos we would use in the current matrix, i.e. below
18060 last_unchanged_at_beg_row. */
18061 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18063 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18064 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18066 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18070 /* There are no reusable lines at the start of the window.
18071 Start displaying in the first text line. */
18072 start_display (&it
, w
, start
);
18073 it
.vpos
= it
.first_vpos
;
18074 start_pos
= it
.current
.pos
;
18077 /* Find the first row that is not affected by changes at the end of
18078 the buffer. Value will be null if there is no unchanged row, in
18079 which case we must redisplay to the end of the window. delta
18080 will be set to the value by which buffer positions beginning with
18081 first_unchanged_at_end_row have to be adjusted due to text
18083 first_unchanged_at_end_row
18084 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18085 IF_DEBUG (debug_delta
= delta
);
18086 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18088 /* Set stop_pos to the buffer position up to which we will have to
18089 display new lines. If first_unchanged_at_end_row != NULL, this
18090 is the buffer position of the start of the line displayed in that
18091 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18092 that we don't stop at a buffer position. */
18094 if (first_unchanged_at_end_row
)
18096 eassert (last_unchanged_at_beg_row
== NULL
18097 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18099 /* If this is a continuation line, move forward to the next one
18100 that isn't. Changes in lines above affect this line.
18101 Caution: this may move first_unchanged_at_end_row to a row
18102 not displaying text. */
18103 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18104 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18105 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18106 < it
.last_visible_y
))
18107 ++first_unchanged_at_end_row
;
18109 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18110 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18111 >= it
.last_visible_y
))
18112 first_unchanged_at_end_row
= NULL
;
18115 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18117 first_unchanged_at_end_vpos
18118 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18119 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18122 else if (last_unchanged_at_beg_row
== NULL
)
18128 /* Either there is no unchanged row at the end, or the one we have
18129 now displays text. This is a necessary condition for the window
18130 end pos calculation at the end of this function. */
18131 eassert (first_unchanged_at_end_row
== NULL
18132 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18134 debug_last_unchanged_at_beg_vpos
18135 = (last_unchanged_at_beg_row
18136 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18138 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18140 #endif /* GLYPH_DEBUG */
18143 /* Display new lines. Set last_text_row to the last new line
18144 displayed which has text on it, i.e. might end up as being the
18145 line where the window_end_vpos is. */
18146 w
->cursor
.vpos
= -1;
18147 last_text_row
= NULL
;
18148 overlay_arrow_seen
= 0;
18149 if (it
.current_y
< it
.last_visible_y
18150 && !f
->fonts_changed
18151 && (first_unchanged_at_end_row
== NULL
18152 || IT_CHARPOS (it
) < stop_pos
))
18153 it
.glyph_row
->reversed_p
= false;
18154 while (it
.current_y
< it
.last_visible_y
18155 && !f
->fonts_changed
18156 && (first_unchanged_at_end_row
== NULL
18157 || IT_CHARPOS (it
) < stop_pos
))
18159 if (display_line (&it
))
18160 last_text_row
= it
.glyph_row
- 1;
18163 if (f
->fonts_changed
)
18167 /* Compute differences in buffer positions, y-positions etc. for
18168 lines reused at the bottom of the window. Compute what we can
18170 if (first_unchanged_at_end_row
18171 /* No lines reused because we displayed everything up to the
18172 bottom of the window. */
18173 && it
.current_y
< it
.last_visible_y
)
18176 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18178 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18179 run
.current_y
= first_unchanged_at_end_row
->y
;
18180 run
.desired_y
= run
.current_y
+ dy
;
18181 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18185 delta
= delta_bytes
= dvpos
= dy
18186 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18187 first_unchanged_at_end_row
= NULL
;
18189 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18192 /* Find the cursor if not already found. We have to decide whether
18193 PT will appear on this window (it sometimes doesn't, but this is
18194 not a very frequent case.) This decision has to be made before
18195 the current matrix is altered. A value of cursor.vpos < 0 means
18196 that PT is either in one of the lines beginning at
18197 first_unchanged_at_end_row or below the window. Don't care for
18198 lines that might be displayed later at the window end; as
18199 mentioned, this is not a frequent case. */
18200 if (w
->cursor
.vpos
< 0)
18202 /* Cursor in unchanged rows at the top? */
18203 if (PT
< CHARPOS (start_pos
)
18204 && last_unchanged_at_beg_row
)
18206 row
= row_containing_pos (w
, PT
,
18207 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18208 last_unchanged_at_beg_row
+ 1, 0);
18210 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18213 /* Start from first_unchanged_at_end_row looking for PT. */
18214 else if (first_unchanged_at_end_row
)
18216 row
= row_containing_pos (w
, PT
- delta
,
18217 first_unchanged_at_end_row
, NULL
, 0);
18219 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18220 delta_bytes
, dy
, dvpos
);
18223 /* Give up if cursor was not found. */
18224 if (w
->cursor
.vpos
< 0)
18226 clear_glyph_matrix (w
->desired_matrix
);
18231 /* Don't let the cursor end in the scroll margins. */
18233 int this_scroll_margin
, cursor_height
;
18234 int frame_line_height
= default_line_pixel_height (w
);
18235 int window_total_lines
18236 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18238 this_scroll_margin
=
18239 max (0, min (scroll_margin
, window_total_lines
/ 4));
18240 this_scroll_margin
*= frame_line_height
;
18241 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18243 if ((w
->cursor
.y
< this_scroll_margin
18244 && CHARPOS (start
) > BEGV
)
18245 /* Old redisplay didn't take scroll margin into account at the bottom,
18246 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18247 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18248 ? cursor_height
+ this_scroll_margin
18249 : 1)) > it
.last_visible_y
)
18251 w
->cursor
.vpos
= -1;
18252 clear_glyph_matrix (w
->desired_matrix
);
18257 /* Scroll the display. Do it before changing the current matrix so
18258 that xterm.c doesn't get confused about where the cursor glyph is
18260 if (dy
&& run
.height
)
18264 if (FRAME_WINDOW_P (f
))
18266 FRAME_RIF (f
)->update_window_begin_hook (w
);
18267 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18268 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18269 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18273 /* Terminal frame. In this case, dvpos gives the number of
18274 lines to scroll by; dvpos < 0 means scroll up. */
18276 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18277 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18278 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18279 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18280 + window_internal_height (w
));
18282 #if defined (HAVE_GPM) || defined (MSDOS)
18283 x_clear_window_mouse_face (w
);
18285 /* Perform the operation on the screen. */
18288 /* Scroll last_unchanged_at_beg_row to the end of the
18289 window down dvpos lines. */
18290 set_terminal_window (f
, end
);
18292 /* On dumb terminals delete dvpos lines at the end
18293 before inserting dvpos empty lines. */
18294 if (!FRAME_SCROLL_REGION_OK (f
))
18295 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18297 /* Insert dvpos empty lines in front of
18298 last_unchanged_at_beg_row. */
18299 ins_del_lines (f
, from
, dvpos
);
18301 else if (dvpos
< 0)
18303 /* Scroll up last_unchanged_at_beg_vpos to the end of
18304 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18305 set_terminal_window (f
, end
);
18307 /* Delete dvpos lines in front of
18308 last_unchanged_at_beg_vpos. ins_del_lines will set
18309 the cursor to the given vpos and emit |dvpos| delete
18311 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18313 /* On a dumb terminal insert dvpos empty lines at the
18315 if (!FRAME_SCROLL_REGION_OK (f
))
18316 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18319 set_terminal_window (f
, 0);
18325 /* Shift reused rows of the current matrix to the right position.
18326 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18328 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18329 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18332 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18333 bottom_vpos
, dvpos
);
18334 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18337 else if (dvpos
> 0)
18339 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18340 bottom_vpos
, dvpos
);
18341 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18342 first_unchanged_at_end_vpos
+ dvpos
);
18345 /* For frame-based redisplay, make sure that current frame and window
18346 matrix are in sync with respect to glyph memory. */
18347 if (!FRAME_WINDOW_P (f
))
18348 sync_frame_with_window_matrix_rows (w
);
18350 /* Adjust buffer positions in reused rows. */
18351 if (delta
|| delta_bytes
)
18352 increment_matrix_positions (current_matrix
,
18353 first_unchanged_at_end_vpos
+ dvpos
,
18354 bottom_vpos
, delta
, delta_bytes
);
18356 /* Adjust Y positions. */
18358 shift_glyph_matrix (w
, current_matrix
,
18359 first_unchanged_at_end_vpos
+ dvpos
,
18362 if (first_unchanged_at_end_row
)
18364 first_unchanged_at_end_row
+= dvpos
;
18365 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18366 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18367 first_unchanged_at_end_row
= NULL
;
18370 /* If scrolling up, there may be some lines to display at the end of
18372 last_text_row_at_end
= NULL
;
18375 /* Scrolling up can leave for example a partially visible line
18376 at the end of the window to be redisplayed. */
18377 /* Set last_row to the glyph row in the current matrix where the
18378 window end line is found. It has been moved up or down in
18379 the matrix by dvpos. */
18380 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18381 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18383 /* If last_row is the window end line, it should display text. */
18384 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18386 /* If window end line was partially visible before, begin
18387 displaying at that line. Otherwise begin displaying with the
18388 line following it. */
18389 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18391 init_to_row_start (&it
, w
, last_row
);
18392 it
.vpos
= last_vpos
;
18393 it
.current_y
= last_row
->y
;
18397 init_to_row_end (&it
, w
, last_row
);
18398 it
.vpos
= 1 + last_vpos
;
18399 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18403 /* We may start in a continuation line. If so, we have to
18404 get the right continuation_lines_width and current_x. */
18405 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18406 it
.hpos
= it
.current_x
= 0;
18408 /* Display the rest of the lines at the window end. */
18409 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18410 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18412 /* Is it always sure that the display agrees with lines in
18413 the current matrix? I don't think so, so we mark rows
18414 displayed invalid in the current matrix by setting their
18415 enabled_p flag to zero. */
18416 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18417 if (display_line (&it
))
18418 last_text_row_at_end
= it
.glyph_row
- 1;
18422 /* Update window_end_pos and window_end_vpos. */
18423 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18425 /* Window end line if one of the preserved rows from the current
18426 matrix. Set row to the last row displaying text in current
18427 matrix starting at first_unchanged_at_end_row, after
18429 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18430 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18431 first_unchanged_at_end_row
);
18432 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18433 adjust_window_ends (w
, row
, 1);
18434 eassert (w
->window_end_bytepos
>= 0);
18435 IF_DEBUG (debug_method_add (w
, "A"));
18437 else if (last_text_row_at_end
)
18439 adjust_window_ends (w
, last_text_row_at_end
, 0);
18440 eassert (w
->window_end_bytepos
>= 0);
18441 IF_DEBUG (debug_method_add (w
, "B"));
18443 else if (last_text_row
)
18445 /* We have displayed either to the end of the window or at the
18446 end of the window, i.e. the last row with text is to be found
18447 in the desired matrix. */
18448 adjust_window_ends (w
, last_text_row
, 0);
18449 eassert (w
->window_end_bytepos
>= 0);
18451 else if (first_unchanged_at_end_row
== NULL
18452 && last_text_row
== NULL
18453 && last_text_row_at_end
== NULL
)
18455 /* Displayed to end of window, but no line containing text was
18456 displayed. Lines were deleted at the end of the window. */
18457 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18458 int vpos
= w
->window_end_vpos
;
18459 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18460 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18463 row
== NULL
&& vpos
>= first_vpos
;
18464 --vpos
, --current_row
, --desired_row
)
18466 if (desired_row
->enabled_p
)
18468 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18471 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18475 eassert (row
!= NULL
);
18476 w
->window_end_vpos
= vpos
+ 1;
18477 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18478 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18479 eassert (w
->window_end_bytepos
>= 0);
18480 IF_DEBUG (debug_method_add (w
, "C"));
18485 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18486 debug_end_vpos
= w
->window_end_vpos
));
18488 /* Record that display has not been completed. */
18489 w
->window_end_valid
= 0;
18490 w
->desired_matrix
->no_scrolling_p
= 1;
18498 /***********************************************************************
18499 More debugging support
18500 ***********************************************************************/
18504 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18505 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18506 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18509 /* Dump the contents of glyph matrix MATRIX on stderr.
18511 GLYPHS 0 means don't show glyph contents.
18512 GLYPHS 1 means show glyphs in short form
18513 GLYPHS > 1 means show glyphs in long form. */
18516 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18519 for (i
= 0; i
< matrix
->nrows
; ++i
)
18520 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18524 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18525 the glyph row and area where the glyph comes from. */
18528 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18530 if (glyph
->type
== CHAR_GLYPH
18531 || glyph
->type
== GLYPHLESS_GLYPH
)
18534 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18535 glyph
- row
->glyphs
[TEXT_AREA
],
18536 (glyph
->type
== CHAR_GLYPH
18540 (BUFFERP (glyph
->object
)
18542 : (STRINGP (glyph
->object
)
18544 : (INTEGERP (glyph
->object
)
18547 glyph
->pixel_width
,
18549 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18553 glyph
->left_box_line_p
,
18554 glyph
->right_box_line_p
);
18556 else if (glyph
->type
== STRETCH_GLYPH
)
18559 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18560 glyph
- row
->glyphs
[TEXT_AREA
],
18563 (BUFFERP (glyph
->object
)
18565 : (STRINGP (glyph
->object
)
18567 : (INTEGERP (glyph
->object
)
18570 glyph
->pixel_width
,
18574 glyph
->left_box_line_p
,
18575 glyph
->right_box_line_p
);
18577 else if (glyph
->type
== IMAGE_GLYPH
)
18580 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18581 glyph
- row
->glyphs
[TEXT_AREA
],
18584 (BUFFERP (glyph
->object
)
18586 : (STRINGP (glyph
->object
)
18588 : (INTEGERP (glyph
->object
)
18591 glyph
->pixel_width
,
18595 glyph
->left_box_line_p
,
18596 glyph
->right_box_line_p
);
18598 else if (glyph
->type
== COMPOSITE_GLYPH
)
18601 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18602 glyph
- row
->glyphs
[TEXT_AREA
],
18605 (BUFFERP (glyph
->object
)
18607 : (STRINGP (glyph
->object
)
18609 : (INTEGERP (glyph
->object
)
18612 glyph
->pixel_width
,
18614 if (glyph
->u
.cmp
.automatic
)
18617 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18618 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18620 glyph
->left_box_line_p
,
18621 glyph
->right_box_line_p
);
18626 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18627 GLYPHS 0 means don't show glyph contents.
18628 GLYPHS 1 means show glyphs in short form
18629 GLYPHS > 1 means show glyphs in long form. */
18632 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18636 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18637 fprintf (stderr
, "==============================================================================\n");
18639 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18640 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18642 MATRIX_ROW_START_CHARPOS (row
),
18643 MATRIX_ROW_END_CHARPOS (row
),
18644 row
->used
[TEXT_AREA
],
18645 row
->contains_overlapping_glyphs_p
,
18647 row
->truncated_on_left_p
,
18648 row
->truncated_on_right_p
,
18650 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18651 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18654 row
->ends_in_middle_of_char_p
,
18655 row
->starts_in_middle_of_char_p
,
18661 row
->visible_height
,
18664 /* The next 3 lines should align to "Start" in the header. */
18665 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18666 row
->end
.overlay_string_index
,
18667 row
->continuation_lines_width
);
18668 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18669 CHARPOS (row
->start
.string_pos
),
18670 CHARPOS (row
->end
.string_pos
));
18671 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18672 row
->end
.dpvec_index
);
18679 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18681 struct glyph
*glyph
= row
->glyphs
[area
];
18682 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18684 /* Glyph for a line end in text. */
18685 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18688 if (glyph
< glyph_end
)
18689 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18691 for (; glyph
< glyph_end
; ++glyph
)
18692 dump_glyph (row
, glyph
, area
);
18695 else if (glyphs
== 1)
18699 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18701 char *s
= alloca (row
->used
[area
] + 4);
18704 for (i
= 0; i
< row
->used
[area
]; ++i
)
18706 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18707 if (i
== row
->used
[area
] - 1
18708 && area
== TEXT_AREA
18709 && INTEGERP (glyph
->object
)
18710 && glyph
->type
== CHAR_GLYPH
18711 && glyph
->u
.ch
== ' ')
18713 strcpy (&s
[i
], "[\\n]");
18716 else if (glyph
->type
== CHAR_GLYPH
18717 && glyph
->u
.ch
< 0x80
18718 && glyph
->u
.ch
>= ' ')
18719 s
[i
] = glyph
->u
.ch
;
18725 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18731 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18732 Sdump_glyph_matrix
, 0, 1, "p",
18733 doc
: /* Dump the current matrix of the selected window to stderr.
18734 Shows contents of glyph row structures. With non-nil
18735 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18736 glyphs in short form, otherwise show glyphs in long form. */)
18737 (Lisp_Object glyphs
)
18739 struct window
*w
= XWINDOW (selected_window
);
18740 struct buffer
*buffer
= XBUFFER (w
->contents
);
18742 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18743 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18744 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18745 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18746 fprintf (stderr
, "=============================================\n");
18747 dump_glyph_matrix (w
->current_matrix
,
18748 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18753 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18754 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18757 struct frame
*f
= XFRAME (selected_frame
);
18758 dump_glyph_matrix (f
->current_matrix
, 1);
18763 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18764 doc
: /* Dump glyph row ROW to stderr.
18765 GLYPH 0 means don't dump glyphs.
18766 GLYPH 1 means dump glyphs in short form.
18767 GLYPH > 1 or omitted means dump glyphs in long form. */)
18768 (Lisp_Object row
, Lisp_Object glyphs
)
18770 struct glyph_matrix
*matrix
;
18773 CHECK_NUMBER (row
);
18774 matrix
= XWINDOW (selected_window
)->current_matrix
;
18776 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18777 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18779 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18784 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18785 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18786 GLYPH 0 means don't dump glyphs.
18787 GLYPH 1 means dump glyphs in short form.
18788 GLYPH > 1 or omitted means dump glyphs in long form.
18790 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18792 (Lisp_Object row
, Lisp_Object glyphs
)
18794 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18795 struct frame
*sf
= SELECTED_FRAME ();
18796 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18799 CHECK_NUMBER (row
);
18801 if (vpos
>= 0 && vpos
< m
->nrows
)
18802 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18803 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18809 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18810 doc
: /* Toggle tracing of redisplay.
18811 With ARG, turn tracing on if and only if ARG is positive. */)
18815 trace_redisplay_p
= !trace_redisplay_p
;
18818 arg
= Fprefix_numeric_value (arg
);
18819 trace_redisplay_p
= XINT (arg
) > 0;
18826 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18827 doc
: /* Like `format', but print result to stderr.
18828 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18829 (ptrdiff_t nargs
, Lisp_Object
*args
)
18831 Lisp_Object s
= Fformat (nargs
, args
);
18832 fprintf (stderr
, "%s", SDATA (s
));
18836 #endif /* GLYPH_DEBUG */
18840 /***********************************************************************
18841 Building Desired Matrix Rows
18842 ***********************************************************************/
18844 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18845 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18847 static struct glyph_row
*
18848 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18850 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18851 struct buffer
*buffer
= XBUFFER (w
->contents
);
18852 struct buffer
*old
= current_buffer
;
18853 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18854 int arrow_len
= SCHARS (overlay_arrow_string
);
18855 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18856 const unsigned char *p
;
18859 int n_glyphs_before
;
18861 set_buffer_temp (buffer
);
18862 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18863 scratch_glyph_row
.reversed_p
= false;
18864 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18865 SET_TEXT_POS (it
.position
, 0, 0);
18867 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18869 while (p
< arrow_end
)
18871 Lisp_Object face
, ilisp
;
18873 /* Get the next character. */
18875 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18878 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18879 if (! ASCII_CHAR_P (it
.c
))
18880 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18884 /* Get its face. */
18885 ilisp
= make_number (p
- arrow_string
);
18886 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18887 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18889 /* Compute its width, get its glyphs. */
18890 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18891 SET_TEXT_POS (it
.position
, -1, -1);
18892 PRODUCE_GLYPHS (&it
);
18894 /* If this character doesn't fit any more in the line, we have
18895 to remove some glyphs. */
18896 if (it
.current_x
> it
.last_visible_x
)
18898 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18903 set_buffer_temp (old
);
18904 return it
.glyph_row
;
18908 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18909 glyphs to insert is determined by produce_special_glyphs. */
18912 insert_left_trunc_glyphs (struct it
*it
)
18914 struct it truncate_it
;
18915 struct glyph
*from
, *end
, *to
, *toend
;
18917 eassert (!FRAME_WINDOW_P (it
->f
)
18918 || (!it
->glyph_row
->reversed_p
18919 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18920 || (it
->glyph_row
->reversed_p
18921 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18923 /* Get the truncation glyphs. */
18925 truncate_it
.current_x
= 0;
18926 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18927 truncate_it
.glyph_row
= &scratch_glyph_row
;
18928 truncate_it
.area
= TEXT_AREA
;
18929 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18930 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18931 truncate_it
.object
= make_number (0);
18932 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18934 /* Overwrite glyphs from IT with truncation glyphs. */
18935 if (!it
->glyph_row
->reversed_p
)
18937 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18939 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18940 end
= from
+ tused
;
18941 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18942 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18943 if (FRAME_WINDOW_P (it
->f
))
18945 /* On GUI frames, when variable-size fonts are displayed,
18946 the truncation glyphs may need more pixels than the row's
18947 glyphs they overwrite. We overwrite more glyphs to free
18948 enough screen real estate, and enlarge the stretch glyph
18949 on the right (see display_line), if there is one, to
18950 preserve the screen position of the truncation glyphs on
18953 struct glyph
*g
= to
;
18956 /* The first glyph could be partially visible, in which case
18957 it->glyph_row->x will be negative. But we want the left
18958 truncation glyphs to be aligned at the left margin of the
18959 window, so we override the x coordinate at which the row
18961 it
->glyph_row
->x
= 0;
18962 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18964 w
+= g
->pixel_width
;
18967 if (g
- to
- tused
> 0)
18969 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18970 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18972 used
= it
->glyph_row
->used
[TEXT_AREA
];
18973 if (it
->glyph_row
->truncated_on_right_p
18974 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18975 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18978 int extra
= w
- it
->truncation_pixel_width
;
18980 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18987 /* There may be padding glyphs left over. Overwrite them too. */
18988 if (!FRAME_WINDOW_P (it
->f
))
18990 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18992 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18999 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19003 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19005 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19006 that back to front. */
19007 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19008 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19009 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19010 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19011 if (FRAME_WINDOW_P (it
->f
))
19014 struct glyph
*g
= to
;
19016 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19018 w
+= g
->pixel_width
;
19021 if (to
- g
- tused
> 0)
19023 if (it
->glyph_row
->truncated_on_right_p
19024 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19025 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19027 int extra
= w
- it
->truncation_pixel_width
;
19029 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19033 while (from
>= end
&& to
>= toend
)
19035 if (!FRAME_WINDOW_P (it
->f
))
19037 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19040 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19041 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19042 while (from
>= end
&& to
>= toend
)
19048 /* Need to free some room before prepending additional
19050 int move_by
= from
- end
+ 1;
19051 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19052 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19054 for ( ; g
>= g0
; g
--)
19056 while (from
>= end
)
19058 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19063 /* Compute the hash code for ROW. */
19065 row_hash (struct glyph_row
*row
)
19068 unsigned hashval
= 0;
19070 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19071 for (k
= 0; k
< row
->used
[area
]; ++k
)
19072 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19073 + row
->glyphs
[area
][k
].u
.val
19074 + row
->glyphs
[area
][k
].face_id
19075 + row
->glyphs
[area
][k
].padding_p
19076 + (row
->glyphs
[area
][k
].type
<< 2));
19081 /* Compute the pixel height and width of IT->glyph_row.
19083 Most of the time, ascent and height of a display line will be equal
19084 to the max_ascent and max_height values of the display iterator
19085 structure. This is not the case if
19087 1. We hit ZV without displaying anything. In this case, max_ascent
19088 and max_height will be zero.
19090 2. We have some glyphs that don't contribute to the line height.
19091 (The glyph row flag contributes_to_line_height_p is for future
19092 pixmap extensions).
19094 The first case is easily covered by using default values because in
19095 these cases, the line height does not really matter, except that it
19096 must not be zero. */
19099 compute_line_metrics (struct it
*it
)
19101 struct glyph_row
*row
= it
->glyph_row
;
19103 if (FRAME_WINDOW_P (it
->f
))
19105 int i
, min_y
, max_y
;
19107 /* The line may consist of one space only, that was added to
19108 place the cursor on it. If so, the row's height hasn't been
19110 if (row
->height
== 0)
19112 if (it
->max_ascent
+ it
->max_descent
== 0)
19113 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19114 row
->ascent
= it
->max_ascent
;
19115 row
->height
= it
->max_ascent
+ it
->max_descent
;
19116 row
->phys_ascent
= it
->max_phys_ascent
;
19117 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19118 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19121 /* Compute the width of this line. */
19122 row
->pixel_width
= row
->x
;
19123 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19124 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19126 eassert (row
->pixel_width
>= 0);
19127 eassert (row
->ascent
>= 0 && row
->height
> 0);
19129 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19130 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19132 /* If first line's physical ascent is larger than its logical
19133 ascent, use the physical ascent, and make the row taller.
19134 This makes accented characters fully visible. */
19135 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19136 && row
->phys_ascent
> row
->ascent
)
19138 row
->height
+= row
->phys_ascent
- row
->ascent
;
19139 row
->ascent
= row
->phys_ascent
;
19142 /* Compute how much of the line is visible. */
19143 row
->visible_height
= row
->height
;
19145 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19146 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19148 if (row
->y
< min_y
)
19149 row
->visible_height
-= min_y
- row
->y
;
19150 if (row
->y
+ row
->height
> max_y
)
19151 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19155 row
->pixel_width
= row
->used
[TEXT_AREA
];
19156 if (row
->continued_p
)
19157 row
->pixel_width
-= it
->continuation_pixel_width
;
19158 else if (row
->truncated_on_right_p
)
19159 row
->pixel_width
-= it
->truncation_pixel_width
;
19160 row
->ascent
= row
->phys_ascent
= 0;
19161 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19162 row
->extra_line_spacing
= 0;
19165 /* Compute a hash code for this row. */
19166 row
->hash
= row_hash (row
);
19168 it
->max_ascent
= it
->max_descent
= 0;
19169 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19173 /* Append one space to the glyph row of iterator IT if doing a
19174 window-based redisplay. The space has the same face as
19175 IT->face_id. Value is non-zero if a space was added.
19177 This function is called to make sure that there is always one glyph
19178 at the end of a glyph row that the cursor can be set on under
19179 window-systems. (If there weren't such a glyph we would not know
19180 how wide and tall a box cursor should be displayed).
19182 At the same time this space let's a nicely handle clearing to the
19183 end of the line if the row ends in italic text. */
19186 append_space_for_newline (struct it
*it
, int default_face_p
)
19188 if (FRAME_WINDOW_P (it
->f
))
19190 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19192 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19193 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19195 /* Save some values that must not be changed.
19196 Must save IT->c and IT->len because otherwise
19197 ITERATOR_AT_END_P wouldn't work anymore after
19198 append_space_for_newline has been called. */
19199 enum display_element_type saved_what
= it
->what
;
19200 int saved_c
= it
->c
, saved_len
= it
->len
;
19201 int saved_char_to_display
= it
->char_to_display
;
19202 int saved_x
= it
->current_x
;
19203 int saved_face_id
= it
->face_id
;
19204 int saved_box_end
= it
->end_of_box_run_p
;
19205 struct text_pos saved_pos
;
19206 Lisp_Object saved_object
;
19209 saved_object
= it
->object
;
19210 saved_pos
= it
->position
;
19212 it
->what
= IT_CHARACTER
;
19213 memset (&it
->position
, 0, sizeof it
->position
);
19214 it
->object
= make_number (0);
19215 it
->c
= it
->char_to_display
= ' ';
19218 /* If the default face was remapped, be sure to use the
19219 remapped face for the appended newline. */
19220 if (default_face_p
)
19221 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19222 else if (it
->face_before_selective_p
)
19223 it
->face_id
= it
->saved_face_id
;
19224 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19225 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19226 /* In R2L rows, we will prepend a stretch glyph that will
19227 have the end_of_box_run_p flag set for it, so there's no
19228 need for the appended newline glyph to have that flag
19230 if (it
->glyph_row
->reversed_p
19231 /* But if the appended newline glyph goes all the way to
19232 the end of the row, there will be no stretch glyph,
19233 so leave the box flag set. */
19234 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19235 it
->end_of_box_run_p
= 0;
19237 PRODUCE_GLYPHS (it
);
19239 it
->override_ascent
= -1;
19240 it
->constrain_row_ascent_descent_p
= 0;
19241 it
->current_x
= saved_x
;
19242 it
->object
= saved_object
;
19243 it
->position
= saved_pos
;
19244 it
->what
= saved_what
;
19245 it
->face_id
= saved_face_id
;
19246 it
->len
= saved_len
;
19248 it
->char_to_display
= saved_char_to_display
;
19249 it
->end_of_box_run_p
= saved_box_end
;
19258 /* Extend the face of the last glyph in the text area of IT->glyph_row
19259 to the end of the display line. Called from display_line. If the
19260 glyph row is empty, add a space glyph to it so that we know the
19261 face to draw. Set the glyph row flag fill_line_p. If the glyph
19262 row is R2L, prepend a stretch glyph to cover the empty space to the
19263 left of the leftmost glyph. */
19266 extend_face_to_end_of_line (struct it
*it
)
19268 struct face
*face
, *default_face
;
19269 struct frame
*f
= it
->f
;
19271 /* If line is already filled, do nothing. Non window-system frames
19272 get a grace of one more ``pixel'' because their characters are
19273 1-``pixel'' wide, so they hit the equality too early. This grace
19274 is needed only for R2L rows that are not continued, to produce
19275 one extra blank where we could display the cursor. */
19276 if ((it
->current_x
>= it
->last_visible_x
19277 + (!FRAME_WINDOW_P (f
)
19278 && it
->glyph_row
->reversed_p
19279 && !it
->glyph_row
->continued_p
))
19280 /* If the window has display margins, we will need to extend
19281 their face even if the text area is filled. */
19282 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19283 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19286 /* The default face, possibly remapped. */
19287 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19289 /* Face extension extends the background and box of IT->face_id
19290 to the end of the line. If the background equals the background
19291 of the frame, we don't have to do anything. */
19292 if (it
->face_before_selective_p
)
19293 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19295 face
= FACE_FROM_ID (f
, it
->face_id
);
19297 if (FRAME_WINDOW_P (f
)
19298 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19299 && face
->box
== FACE_NO_BOX
19300 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19301 #ifdef HAVE_WINDOW_SYSTEM
19304 && !it
->glyph_row
->reversed_p
)
19307 /* Set the glyph row flag indicating that the face of the last glyph
19308 in the text area has to be drawn to the end of the text area. */
19309 it
->glyph_row
->fill_line_p
= 1;
19311 /* If current character of IT is not ASCII, make sure we have the
19312 ASCII face. This will be automatically undone the next time
19313 get_next_display_element returns a multibyte character. Note
19314 that the character will always be single byte in unibyte
19316 if (!ASCII_CHAR_P (it
->c
))
19318 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19321 if (FRAME_WINDOW_P (f
))
19323 /* If the row is empty, add a space with the current face of IT,
19324 so that we know which face to draw. */
19325 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19327 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19328 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19329 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19331 /* Mode line and the header line don't have margins, and
19332 likewise the frame's tool-bar window, if there is any. */
19333 if (!(it
->glyph_row
->mode_line_p
19334 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19335 || (WINDOWP (f
->tool_bar_window
)
19336 && it
->w
== XWINDOW (f
->tool_bar_window
))
19340 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19341 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19343 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19344 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19346 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19348 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19349 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19351 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19352 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19354 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19357 #ifdef HAVE_WINDOW_SYSTEM
19358 if (it
->glyph_row
->reversed_p
)
19360 /* Prepend a stretch glyph to the row, such that the
19361 rightmost glyph will be drawn flushed all the way to the
19362 right margin of the window. The stretch glyph that will
19363 occupy the empty space, if any, to the left of the
19365 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19366 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19367 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19369 int row_width
, stretch_ascent
, stretch_width
;
19370 struct text_pos saved_pos
;
19371 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19373 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19374 row_width
+= g
->pixel_width
;
19375 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19376 if (stretch_width
> 0)
19379 (((it
->ascent
+ it
->descent
)
19380 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19381 saved_pos
= it
->position
;
19382 memset (&it
->position
, 0, sizeof it
->position
);
19383 saved_avoid_cursor
= it
->avoid_cursor_p
;
19384 it
->avoid_cursor_p
= 1;
19385 saved_face_id
= it
->face_id
;
19386 saved_box_start
= it
->start_of_box_run_p
;
19387 /* The last row's stretch glyph should get the default
19388 face, to avoid painting the rest of the window with
19389 the region face, if the region ends at ZV. */
19390 if (it
->glyph_row
->ends_at_zv_p
)
19391 it
->face_id
= default_face
->id
;
19393 it
->face_id
= face
->id
;
19394 it
->start_of_box_run_p
= 0;
19395 append_stretch_glyph (it
, make_number (0), stretch_width
,
19396 it
->ascent
+ it
->descent
, stretch_ascent
);
19397 it
->position
= saved_pos
;
19398 it
->avoid_cursor_p
= saved_avoid_cursor
;
19399 it
->face_id
= saved_face_id
;
19400 it
->start_of_box_run_p
= saved_box_start
;
19402 /* If stretch_width comes out negative, it means that the
19403 last glyph is only partially visible. In R2L rows, we
19404 want the leftmost glyph to be partially visible, so we
19405 need to give the row the corresponding left offset. */
19406 if (stretch_width
< 0)
19407 it
->glyph_row
->x
= stretch_width
;
19409 #endif /* HAVE_WINDOW_SYSTEM */
19413 /* Save some values that must not be changed. */
19414 int saved_x
= it
->current_x
;
19415 struct text_pos saved_pos
;
19416 Lisp_Object saved_object
;
19417 enum display_element_type saved_what
= it
->what
;
19418 int saved_face_id
= it
->face_id
;
19420 saved_object
= it
->object
;
19421 saved_pos
= it
->position
;
19423 it
->what
= IT_CHARACTER
;
19424 memset (&it
->position
, 0, sizeof it
->position
);
19425 it
->object
= make_number (0);
19426 it
->c
= it
->char_to_display
= ' ';
19429 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19430 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19431 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19432 && !it
->glyph_row
->mode_line_p
19433 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19435 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19436 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19438 for (it
->current_x
= 0; g
< e
; g
++)
19439 it
->current_x
+= g
->pixel_width
;
19441 it
->area
= LEFT_MARGIN_AREA
;
19442 it
->face_id
= default_face
->id
;
19443 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19444 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19446 PRODUCE_GLYPHS (it
);
19447 /* term.c:produce_glyphs advances it->current_x only for
19449 it
->current_x
+= it
->pixel_width
;
19452 it
->current_x
= saved_x
;
19453 it
->area
= TEXT_AREA
;
19456 /* The last row's blank glyphs should get the default face, to
19457 avoid painting the rest of the window with the region face,
19458 if the region ends at ZV. */
19459 if (it
->glyph_row
->ends_at_zv_p
)
19460 it
->face_id
= default_face
->id
;
19462 it
->face_id
= face
->id
;
19463 PRODUCE_GLYPHS (it
);
19465 while (it
->current_x
<= it
->last_visible_x
)
19466 PRODUCE_GLYPHS (it
);
19468 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19469 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19470 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19471 && !it
->glyph_row
->mode_line_p
19472 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19474 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19475 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19477 for ( ; g
< e
; g
++)
19478 it
->current_x
+= g
->pixel_width
;
19480 it
->area
= RIGHT_MARGIN_AREA
;
19481 it
->face_id
= default_face
->id
;
19482 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19483 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19485 PRODUCE_GLYPHS (it
);
19486 it
->current_x
+= it
->pixel_width
;
19489 it
->area
= TEXT_AREA
;
19492 /* Don't count these blanks really. It would let us insert a left
19493 truncation glyph below and make us set the cursor on them, maybe. */
19494 it
->current_x
= saved_x
;
19495 it
->object
= saved_object
;
19496 it
->position
= saved_pos
;
19497 it
->what
= saved_what
;
19498 it
->face_id
= saved_face_id
;
19503 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19504 trailing whitespace. */
19507 trailing_whitespace_p (ptrdiff_t charpos
)
19509 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19512 while (bytepos
< ZV_BYTE
19513 && (c
= FETCH_CHAR (bytepos
),
19514 c
== ' ' || c
== '\t'))
19517 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19519 if (bytepos
!= PT_BYTE
)
19526 /* Highlight trailing whitespace, if any, in ROW. */
19529 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19531 int used
= row
->used
[TEXT_AREA
];
19535 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19536 struct glyph
*glyph
= start
+ used
- 1;
19538 if (row
->reversed_p
)
19540 /* Right-to-left rows need to be processed in the opposite
19541 direction, so swap the edge pointers. */
19543 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19546 /* Skip over glyphs inserted to display the cursor at the
19547 end of a line, for extending the face of the last glyph
19548 to the end of the line on terminals, and for truncation
19549 and continuation glyphs. */
19550 if (!row
->reversed_p
)
19552 while (glyph
>= start
19553 && glyph
->type
== CHAR_GLYPH
19554 && INTEGERP (glyph
->object
))
19559 while (glyph
<= start
19560 && glyph
->type
== CHAR_GLYPH
19561 && INTEGERP (glyph
->object
))
19565 /* If last glyph is a space or stretch, and it's trailing
19566 whitespace, set the face of all trailing whitespace glyphs in
19567 IT->glyph_row to `trailing-whitespace'. */
19568 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19569 && BUFFERP (glyph
->object
)
19570 && (glyph
->type
== STRETCH_GLYPH
19571 || (glyph
->type
== CHAR_GLYPH
19572 && glyph
->u
.ch
== ' '))
19573 && trailing_whitespace_p (glyph
->charpos
))
19575 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19579 if (!row
->reversed_p
)
19581 while (glyph
>= start
19582 && BUFFERP (glyph
->object
)
19583 && (glyph
->type
== STRETCH_GLYPH
19584 || (glyph
->type
== CHAR_GLYPH
19585 && glyph
->u
.ch
== ' ')))
19586 (glyph
--)->face_id
= face_id
;
19590 while (glyph
<= start
19591 && BUFFERP (glyph
->object
)
19592 && (glyph
->type
== STRETCH_GLYPH
19593 || (glyph
->type
== CHAR_GLYPH
19594 && glyph
->u
.ch
== ' ')))
19595 (glyph
++)->face_id
= face_id
;
19602 /* Value is non-zero if glyph row ROW should be
19603 considered to hold the buffer position CHARPOS. */
19606 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19610 if (charpos
== CHARPOS (row
->end
.pos
)
19611 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19613 /* Suppose the row ends on a string.
19614 Unless the row is continued, that means it ends on a newline
19615 in the string. If it's anything other than a display string
19616 (e.g., a before-string from an overlay), we don't want the
19617 cursor there. (This heuristic seems to give the optimal
19618 behavior for the various types of multi-line strings.)
19619 One exception: if the string has `cursor' property on one of
19620 its characters, we _do_ want the cursor there. */
19621 if (CHARPOS (row
->end
.string_pos
) >= 0)
19623 if (row
->continued_p
)
19627 /* Check for `display' property. */
19628 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19629 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19630 struct glyph
*glyph
;
19633 for (glyph
= end
; glyph
>= beg
; --glyph
)
19634 if (STRINGP (glyph
->object
))
19637 = Fget_char_property (make_number (charpos
),
19641 && display_prop_string_p (prop
, glyph
->object
));
19642 /* If there's a `cursor' property on one of the
19643 string's characters, this row is a cursor row,
19644 even though this is not a display string. */
19647 Lisp_Object s
= glyph
->object
;
19649 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19651 ptrdiff_t gpos
= glyph
->charpos
;
19653 if (!NILP (Fget_char_property (make_number (gpos
),
19665 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19667 /* If the row ends in middle of a real character,
19668 and the line is continued, we want the cursor here.
19669 That's because CHARPOS (ROW->end.pos) would equal
19670 PT if PT is before the character. */
19671 if (!row
->ends_in_ellipsis_p
)
19672 result
= row
->continued_p
;
19674 /* If the row ends in an ellipsis, then
19675 CHARPOS (ROW->end.pos) will equal point after the
19676 invisible text. We want that position to be displayed
19677 after the ellipsis. */
19680 /* If the row ends at ZV, display the cursor at the end of that
19681 row instead of at the start of the row below. */
19682 else if (row
->ends_at_zv_p
)
19691 /* Value is non-zero if glyph row ROW should be
19692 used to hold the cursor. */
19695 cursor_row_p (struct glyph_row
*row
)
19697 return row_for_charpos_p (row
, PT
);
19702 /* Push the property PROP so that it will be rendered at the current
19703 position in IT. Return 1 if PROP was successfully pushed, 0
19704 otherwise. Called from handle_line_prefix to handle the
19705 `line-prefix' and `wrap-prefix' properties. */
19708 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19710 struct text_pos pos
=
19711 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19713 eassert (it
->method
== GET_FROM_BUFFER
19714 || it
->method
== GET_FROM_DISPLAY_VECTOR
19715 || it
->method
== GET_FROM_STRING
);
19717 /* We need to save the current buffer/string position, so it will be
19718 restored by pop_it, because iterate_out_of_display_property
19719 depends on that being set correctly, but some situations leave
19720 it->position not yet set when this function is called. */
19721 push_it (it
, &pos
);
19723 if (STRINGP (prop
))
19725 if (SCHARS (prop
) == 0)
19732 it
->string_from_prefix_prop_p
= 1;
19733 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19734 it
->current
.overlay_string_index
= -1;
19735 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19736 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19737 it
->method
= GET_FROM_STRING
;
19738 it
->stop_charpos
= 0;
19740 it
->base_level_stop
= 0;
19742 /* Force paragraph direction to be that of the parent
19744 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19745 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19747 it
->paragraph_embedding
= L2R
;
19749 /* Set up the bidi iterator for this display string. */
19752 it
->bidi_it
.string
.lstring
= it
->string
;
19753 it
->bidi_it
.string
.s
= NULL
;
19754 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19755 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19756 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19757 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19758 it
->bidi_it
.w
= it
->w
;
19759 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19762 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19764 it
->method
= GET_FROM_STRETCH
;
19767 #ifdef HAVE_WINDOW_SYSTEM
19768 else if (IMAGEP (prop
))
19770 it
->what
= IT_IMAGE
;
19771 it
->image_id
= lookup_image (it
->f
, prop
);
19772 it
->method
= GET_FROM_IMAGE
;
19774 #endif /* HAVE_WINDOW_SYSTEM */
19777 pop_it (it
); /* bogus display property, give up */
19784 /* Return the character-property PROP at the current position in IT. */
19787 get_it_property (struct it
*it
, Lisp_Object prop
)
19789 Lisp_Object position
, object
= it
->object
;
19791 if (STRINGP (object
))
19792 position
= make_number (IT_STRING_CHARPOS (*it
));
19793 else if (BUFFERP (object
))
19795 position
= make_number (IT_CHARPOS (*it
));
19796 object
= it
->window
;
19801 return Fget_char_property (position
, prop
, object
);
19804 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19807 handle_line_prefix (struct it
*it
)
19809 Lisp_Object prefix
;
19811 if (it
->continuation_lines_width
> 0)
19813 prefix
= get_it_property (it
, Qwrap_prefix
);
19815 prefix
= Vwrap_prefix
;
19819 prefix
= get_it_property (it
, Qline_prefix
);
19821 prefix
= Vline_prefix
;
19823 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19825 /* If the prefix is wider than the window, and we try to wrap
19826 it, it would acquire its own wrap prefix, and so on till the
19827 iterator stack overflows. So, don't wrap the prefix. */
19828 it
->line_wrap
= TRUNCATE
;
19829 it
->avoid_cursor_p
= 1;
19835 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19836 only for R2L lines from display_line and display_string, when they
19837 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19838 the line/string needs to be continued on the next glyph row. */
19840 unproduce_glyphs (struct it
*it
, int n
)
19842 struct glyph
*glyph
, *end
;
19844 eassert (it
->glyph_row
);
19845 eassert (it
->glyph_row
->reversed_p
);
19846 eassert (it
->area
== TEXT_AREA
);
19847 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19849 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19850 n
= it
->glyph_row
->used
[TEXT_AREA
];
19851 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19852 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19853 for ( ; glyph
< end
; glyph
++)
19854 glyph
[-n
] = *glyph
;
19857 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19858 and ROW->maxpos. */
19860 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19861 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19862 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19864 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19865 lines' rows is implemented for bidi-reordered rows. */
19867 /* ROW->minpos is the value of min_pos, the minimal buffer position
19868 we have in ROW, or ROW->start.pos if that is smaller. */
19869 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19870 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19872 /* We didn't find buffer positions smaller than ROW->start, or
19873 didn't find _any_ valid buffer positions in any of the glyphs,
19874 so we must trust the iterator's computed positions. */
19875 row
->minpos
= row
->start
.pos
;
19878 max_pos
= CHARPOS (it
->current
.pos
);
19879 max_bpos
= BYTEPOS (it
->current
.pos
);
19882 /* Here are the various use-cases for ending the row, and the
19883 corresponding values for ROW->maxpos:
19885 Line ends in a newline from buffer eol_pos + 1
19886 Line is continued from buffer max_pos + 1
19887 Line is truncated on right it->current.pos
19888 Line ends in a newline from string max_pos + 1(*)
19889 (*) + 1 only when line ends in a forward scan
19890 Line is continued from string max_pos
19891 Line is continued from display vector max_pos
19892 Line is entirely from a string min_pos == max_pos
19893 Line is entirely from a display vector min_pos == max_pos
19894 Line that ends at ZV ZV
19896 If you discover other use-cases, please add them here as
19898 if (row
->ends_at_zv_p
)
19899 row
->maxpos
= it
->current
.pos
;
19900 else if (row
->used
[TEXT_AREA
])
19902 int seen_this_string
= 0;
19903 struct glyph_row
*r1
= row
- 1;
19905 /* Did we see the same display string on the previous row? */
19906 if (STRINGP (it
->object
)
19907 /* this is not the first row */
19908 && row
> it
->w
->desired_matrix
->rows
19909 /* previous row is not the header line */
19910 && !r1
->mode_line_p
19911 /* previous row also ends in a newline from a string */
19912 && r1
->ends_in_newline_from_string_p
)
19914 struct glyph
*start
, *end
;
19916 /* Search for the last glyph of the previous row that came
19917 from buffer or string. Depending on whether the row is
19918 L2R or R2L, we need to process it front to back or the
19919 other way round. */
19920 if (!r1
->reversed_p
)
19922 start
= r1
->glyphs
[TEXT_AREA
];
19923 end
= start
+ r1
->used
[TEXT_AREA
];
19924 /* Glyphs inserted by redisplay have an integer (zero)
19925 as their object. */
19927 && INTEGERP ((end
- 1)->object
)
19928 && (end
- 1)->charpos
<= 0)
19932 if (EQ ((end
- 1)->object
, it
->object
))
19933 seen_this_string
= 1;
19936 /* If all the glyphs of the previous row were inserted
19937 by redisplay, it means the previous row was
19938 produced from a single newline, which is only
19939 possible if that newline came from the same string
19940 as the one which produced this ROW. */
19941 seen_this_string
= 1;
19945 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19946 start
= end
+ r1
->used
[TEXT_AREA
];
19948 && INTEGERP ((end
+ 1)->object
)
19949 && (end
+ 1)->charpos
<= 0)
19953 if (EQ ((end
+ 1)->object
, it
->object
))
19954 seen_this_string
= 1;
19957 seen_this_string
= 1;
19960 /* Take note of each display string that covers a newline only
19961 once, the first time we see it. This is for when a display
19962 string includes more than one newline in it. */
19963 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19965 /* If we were scanning the buffer forward when we displayed
19966 the string, we want to account for at least one buffer
19967 position that belongs to this row (position covered by
19968 the display string), so that cursor positioning will
19969 consider this row as a candidate when point is at the end
19970 of the visual line represented by this row. This is not
19971 required when scanning back, because max_pos will already
19972 have a much larger value. */
19973 if (CHARPOS (row
->end
.pos
) > max_pos
)
19974 INC_BOTH (max_pos
, max_bpos
);
19975 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19977 else if (CHARPOS (it
->eol_pos
) > 0)
19978 SET_TEXT_POS (row
->maxpos
,
19979 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19980 else if (row
->continued_p
)
19982 /* If max_pos is different from IT's current position, it
19983 means IT->method does not belong to the display element
19984 at max_pos. However, it also means that the display
19985 element at max_pos was displayed in its entirety on this
19986 line, which is equivalent to saying that the next line
19987 starts at the next buffer position. */
19988 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19989 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19992 INC_BOTH (max_pos
, max_bpos
);
19993 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19996 else if (row
->truncated_on_right_p
)
19997 /* display_line already called reseat_at_next_visible_line_start,
19998 which puts the iterator at the beginning of the next line, in
19999 the logical order. */
20000 row
->maxpos
= it
->current
.pos
;
20001 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20002 /* A line that is entirely from a string/image/stretch... */
20003 row
->maxpos
= row
->minpos
;
20008 row
->maxpos
= it
->current
.pos
;
20011 /* Construct the glyph row IT->glyph_row in the desired matrix of
20012 IT->w from text at the current position of IT. See dispextern.h
20013 for an overview of struct it. Value is non-zero if
20014 IT->glyph_row displays text, as opposed to a line displaying ZV
20018 display_line (struct it
*it
)
20020 struct glyph_row
*row
= it
->glyph_row
;
20021 Lisp_Object overlay_arrow_string
;
20023 void *wrap_data
= NULL
;
20024 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20025 int wrap_row_used
= -1;
20026 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20027 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20028 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20029 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20030 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20032 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20033 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20034 bool pending_handle_line_prefix
= false;
20036 /* We always start displaying at hpos zero even if hscrolled. */
20037 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20039 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20040 >= it
->w
->desired_matrix
->nrows
)
20042 it
->w
->nrows_scale_factor
++;
20043 it
->f
->fonts_changed
= 1;
20047 /* Clear the result glyph row and enable it. */
20048 prepare_desired_row (it
->w
, row
, false);
20050 row
->y
= it
->current_y
;
20051 row
->start
= it
->start
;
20052 row
->continuation_lines_width
= it
->continuation_lines_width
;
20053 row
->displays_text_p
= 1;
20054 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20055 it
->starts_in_middle_of_char_p
= 0;
20057 /* Arrange the overlays nicely for our purposes. Usually, we call
20058 display_line on only one line at a time, in which case this
20059 can't really hurt too much, or we call it on lines which appear
20060 one after another in the buffer, in which case all calls to
20061 recenter_overlay_lists but the first will be pretty cheap. */
20062 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20064 /* Move over display elements that are not visible because we are
20065 hscrolled. This may stop at an x-position < IT->first_visible_x
20066 if the first glyph is partially visible or if we hit a line end. */
20067 if (it
->current_x
< it
->first_visible_x
)
20069 enum move_it_result move_result
;
20071 this_line_min_pos
= row
->start
.pos
;
20072 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20073 MOVE_TO_POS
| MOVE_TO_X
);
20074 /* If we are under a large hscroll, move_it_in_display_line_to
20075 could hit the end of the line without reaching
20076 it->first_visible_x. Pretend that we did reach it. This is
20077 especially important on a TTY, where we will call
20078 extend_face_to_end_of_line, which needs to know how many
20079 blank glyphs to produce. */
20080 if (it
->current_x
< it
->first_visible_x
20081 && (move_result
== MOVE_NEWLINE_OR_CR
20082 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20083 it
->current_x
= it
->first_visible_x
;
20085 /* Record the smallest positions seen while we moved over
20086 display elements that are not visible. This is needed by
20087 redisplay_internal for optimizing the case where the cursor
20088 stays inside the same line. The rest of this function only
20089 considers positions that are actually displayed, so
20090 RECORD_MAX_MIN_POS will not otherwise record positions that
20091 are hscrolled to the left of the left edge of the window. */
20092 min_pos
= CHARPOS (this_line_min_pos
);
20093 min_bpos
= BYTEPOS (this_line_min_pos
);
20095 else if (it
->area
== TEXT_AREA
)
20097 /* We only do this when not calling move_it_in_display_line_to
20098 above, because that function calls itself handle_line_prefix. */
20099 handle_line_prefix (it
);
20103 /* Line-prefix and wrap-prefix are always displayed in the text
20104 area. But if this is the first call to display_line after
20105 init_iterator, the iterator might have been set up to write
20106 into a marginal area, e.g. if the line begins with some
20107 display property that writes to the margins. So we need to
20108 wait with the call to handle_line_prefix until whatever
20109 writes to the margin has done its job. */
20110 pending_handle_line_prefix
= true;
20113 /* Get the initial row height. This is either the height of the
20114 text hscrolled, if there is any, or zero. */
20115 row
->ascent
= it
->max_ascent
;
20116 row
->height
= it
->max_ascent
+ it
->max_descent
;
20117 row
->phys_ascent
= it
->max_phys_ascent
;
20118 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20119 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20121 /* Utility macro to record max and min buffer positions seen until now. */
20122 #define RECORD_MAX_MIN_POS(IT) \
20125 int composition_p = !STRINGP ((IT)->string) \
20126 && ((IT)->what == IT_COMPOSITION); \
20127 ptrdiff_t current_pos = \
20128 composition_p ? (IT)->cmp_it.charpos \
20129 : IT_CHARPOS (*(IT)); \
20130 ptrdiff_t current_bpos = \
20131 composition_p ? CHAR_TO_BYTE (current_pos) \
20132 : IT_BYTEPOS (*(IT)); \
20133 if (current_pos < min_pos) \
20135 min_pos = current_pos; \
20136 min_bpos = current_bpos; \
20138 if (IT_CHARPOS (*it) > max_pos) \
20140 max_pos = IT_CHARPOS (*it); \
20141 max_bpos = IT_BYTEPOS (*it); \
20146 /* Loop generating characters. The loop is left with IT on the next
20147 character to display. */
20150 int n_glyphs_before
, hpos_before
, x_before
;
20152 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20154 /* Retrieve the next thing to display. Value is zero if end of
20156 if (!get_next_display_element (it
))
20158 /* Maybe add a space at the end of this line that is used to
20159 display the cursor there under X. Set the charpos of the
20160 first glyph of blank lines not corresponding to any text
20162 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20163 row
->exact_window_width_line_p
= 1;
20164 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20165 || row
->used
[TEXT_AREA
] == 0)
20167 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20168 row
->displays_text_p
= 0;
20170 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20171 && (!MINI_WINDOW_P (it
->w
)
20172 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20173 row
->indicate_empty_line_p
= 1;
20176 it
->continuation_lines_width
= 0;
20177 row
->ends_at_zv_p
= 1;
20178 /* A row that displays right-to-left text must always have
20179 its last face extended all the way to the end of line,
20180 even if this row ends in ZV, because we still write to
20181 the screen left to right. We also need to extend the
20182 last face if the default face is remapped to some
20183 different face, otherwise the functions that clear
20184 portions of the screen will clear with the default face's
20185 background color. */
20186 if (row
->reversed_p
20187 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20188 extend_face_to_end_of_line (it
);
20192 /* Now, get the metrics of what we want to display. This also
20193 generates glyphs in `row' (which is IT->glyph_row). */
20194 n_glyphs_before
= row
->used
[TEXT_AREA
];
20197 /* Remember the line height so far in case the next element doesn't
20198 fit on the line. */
20199 if (it
->line_wrap
!= TRUNCATE
)
20201 ascent
= it
->max_ascent
;
20202 descent
= it
->max_descent
;
20203 phys_ascent
= it
->max_phys_ascent
;
20204 phys_descent
= it
->max_phys_descent
;
20206 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20208 if (IT_DISPLAYING_WHITESPACE (it
))
20212 SAVE_IT (wrap_it
, *it
, wrap_data
);
20214 wrap_row_used
= row
->used
[TEXT_AREA
];
20215 wrap_row_ascent
= row
->ascent
;
20216 wrap_row_height
= row
->height
;
20217 wrap_row_phys_ascent
= row
->phys_ascent
;
20218 wrap_row_phys_height
= row
->phys_height
;
20219 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20220 wrap_row_min_pos
= min_pos
;
20221 wrap_row_min_bpos
= min_bpos
;
20222 wrap_row_max_pos
= max_pos
;
20223 wrap_row_max_bpos
= max_bpos
;
20229 PRODUCE_GLYPHS (it
);
20231 /* If this display element was in marginal areas, continue with
20233 if (it
->area
!= TEXT_AREA
)
20235 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20236 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20237 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20238 row
->phys_height
= max (row
->phys_height
,
20239 it
->max_phys_ascent
+ it
->max_phys_descent
);
20240 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20241 it
->max_extra_line_spacing
);
20242 set_iterator_to_next (it
, 1);
20243 /* If we didn't handle the line/wrap prefix above, and the
20244 call to set_iterator_to_next just switched to TEXT_AREA,
20245 process the prefix now. */
20246 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20248 pending_handle_line_prefix
= false;
20249 handle_line_prefix (it
);
20254 /* Does the display element fit on the line? If we truncate
20255 lines, we should draw past the right edge of the window. If
20256 we don't truncate, we want to stop so that we can display the
20257 continuation glyph before the right margin. If lines are
20258 continued, there are two possible strategies for characters
20259 resulting in more than 1 glyph (e.g. tabs): Display as many
20260 glyphs as possible in this line and leave the rest for the
20261 continuation line, or display the whole element in the next
20262 line. Original redisplay did the former, so we do it also. */
20263 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20264 hpos_before
= it
->hpos
;
20267 if (/* Not a newline. */
20269 /* Glyphs produced fit entirely in the line. */
20270 && it
->current_x
< it
->last_visible_x
)
20272 it
->hpos
+= nglyphs
;
20273 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20274 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20275 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20276 row
->phys_height
= max (row
->phys_height
,
20277 it
->max_phys_ascent
+ it
->max_phys_descent
);
20278 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20279 it
->max_extra_line_spacing
);
20280 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20281 /* In R2L rows, we arrange in extend_face_to_end_of_line
20282 to add a right offset to the line, by a suitable
20283 change to the stretch glyph that is the leftmost
20284 glyph of the line. */
20285 && !row
->reversed_p
)
20286 row
->x
= x
- it
->first_visible_x
;
20287 /* Record the maximum and minimum buffer positions seen so
20288 far in glyphs that will be displayed by this row. */
20290 RECORD_MAX_MIN_POS (it
);
20295 struct glyph
*glyph
;
20297 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20299 /* Identify the glyphs added by the last call to
20300 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20301 the previous glyphs. */
20302 if (!row
->reversed_p
)
20303 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20305 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20306 new_x
= x
+ glyph
->pixel_width
;
20308 if (/* Lines are continued. */
20309 it
->line_wrap
!= TRUNCATE
20310 && (/* Glyph doesn't fit on the line. */
20311 new_x
> it
->last_visible_x
20312 /* Or it fits exactly on a window system frame. */
20313 || (new_x
== it
->last_visible_x
20314 && FRAME_WINDOW_P (it
->f
)
20315 && (row
->reversed_p
20316 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20317 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20319 /* End of a continued line. */
20322 || (new_x
== it
->last_visible_x
20323 && FRAME_WINDOW_P (it
->f
)
20324 && (row
->reversed_p
20325 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20326 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20328 /* Current glyph is the only one on the line or
20329 fits exactly on the line. We must continue
20330 the line because we can't draw the cursor
20331 after the glyph. */
20332 row
->continued_p
= 1;
20333 it
->current_x
= new_x
;
20334 it
->continuation_lines_width
+= new_x
;
20336 if (i
== nglyphs
- 1)
20338 /* If line-wrap is on, check if a previous
20339 wrap point was found. */
20340 if (wrap_row_used
> 0
20341 /* Even if there is a previous wrap
20342 point, continue the line here as
20343 usual, if (i) the previous character
20344 was a space or tab AND (ii) the
20345 current character is not. */
20347 || IT_DISPLAYING_WHITESPACE (it
)))
20350 /* Record the maximum and minimum buffer
20351 positions seen so far in glyphs that will be
20352 displayed by this row. */
20354 RECORD_MAX_MIN_POS (it
);
20355 set_iterator_to_next (it
, 1);
20356 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20358 if (!get_next_display_element (it
))
20360 row
->exact_window_width_line_p
= 1;
20361 it
->continuation_lines_width
= 0;
20362 row
->continued_p
= 0;
20363 row
->ends_at_zv_p
= 1;
20365 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20367 row
->continued_p
= 0;
20368 row
->exact_window_width_line_p
= 1;
20372 else if (it
->bidi_p
)
20373 RECORD_MAX_MIN_POS (it
);
20374 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20375 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20376 extend_face_to_end_of_line (it
);
20378 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20379 && !FRAME_WINDOW_P (it
->f
))
20381 /* A padding glyph that doesn't fit on this line.
20382 This means the whole character doesn't fit
20384 if (row
->reversed_p
)
20385 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20386 - n_glyphs_before
);
20387 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20389 /* Fill the rest of the row with continuation
20390 glyphs like in 20.x. */
20391 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20392 < row
->glyphs
[1 + TEXT_AREA
])
20393 produce_special_glyphs (it
, IT_CONTINUATION
);
20395 row
->continued_p
= 1;
20396 it
->current_x
= x_before
;
20397 it
->continuation_lines_width
+= x_before
;
20399 /* Restore the height to what it was before the
20400 element not fitting on the line. */
20401 it
->max_ascent
= ascent
;
20402 it
->max_descent
= descent
;
20403 it
->max_phys_ascent
= phys_ascent
;
20404 it
->max_phys_descent
= phys_descent
;
20405 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20406 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20407 extend_face_to_end_of_line (it
);
20409 else if (wrap_row_used
> 0)
20412 if (row
->reversed_p
)
20413 unproduce_glyphs (it
,
20414 row
->used
[TEXT_AREA
] - wrap_row_used
);
20415 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20416 it
->continuation_lines_width
+= wrap_x
;
20417 row
->used
[TEXT_AREA
] = wrap_row_used
;
20418 row
->ascent
= wrap_row_ascent
;
20419 row
->height
= wrap_row_height
;
20420 row
->phys_ascent
= wrap_row_phys_ascent
;
20421 row
->phys_height
= wrap_row_phys_height
;
20422 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20423 min_pos
= wrap_row_min_pos
;
20424 min_bpos
= wrap_row_min_bpos
;
20425 max_pos
= wrap_row_max_pos
;
20426 max_bpos
= wrap_row_max_bpos
;
20427 row
->continued_p
= 1;
20428 row
->ends_at_zv_p
= 0;
20429 row
->exact_window_width_line_p
= 0;
20430 it
->continuation_lines_width
+= x
;
20432 /* Make sure that a non-default face is extended
20433 up to the right margin of the window. */
20434 extend_face_to_end_of_line (it
);
20436 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20438 /* A TAB that extends past the right edge of the
20439 window. This produces a single glyph on
20440 window system frames. We leave the glyph in
20441 this row and let it fill the row, but don't
20442 consume the TAB. */
20443 if ((row
->reversed_p
20444 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20445 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20446 produce_special_glyphs (it
, IT_CONTINUATION
);
20447 it
->continuation_lines_width
+= it
->last_visible_x
;
20448 row
->ends_in_middle_of_char_p
= 1;
20449 row
->continued_p
= 1;
20450 glyph
->pixel_width
= it
->last_visible_x
- x
;
20451 it
->starts_in_middle_of_char_p
= 1;
20452 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20453 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20454 extend_face_to_end_of_line (it
);
20458 /* Something other than a TAB that draws past
20459 the right edge of the window. Restore
20460 positions to values before the element. */
20461 if (row
->reversed_p
)
20462 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20463 - (n_glyphs_before
+ i
));
20464 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20466 /* Display continuation glyphs. */
20467 it
->current_x
= x_before
;
20468 it
->continuation_lines_width
+= x
;
20469 if (!FRAME_WINDOW_P (it
->f
)
20470 || (row
->reversed_p
20471 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20472 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20473 produce_special_glyphs (it
, IT_CONTINUATION
);
20474 row
->continued_p
= 1;
20476 extend_face_to_end_of_line (it
);
20478 if (nglyphs
> 1 && i
> 0)
20480 row
->ends_in_middle_of_char_p
= 1;
20481 it
->starts_in_middle_of_char_p
= 1;
20484 /* Restore the height to what it was before the
20485 element not fitting on the line. */
20486 it
->max_ascent
= ascent
;
20487 it
->max_descent
= descent
;
20488 it
->max_phys_ascent
= phys_ascent
;
20489 it
->max_phys_descent
= phys_descent
;
20494 else if (new_x
> it
->first_visible_x
)
20496 /* Increment number of glyphs actually displayed. */
20499 /* Record the maximum and minimum buffer positions
20500 seen so far in glyphs that will be displayed by
20503 RECORD_MAX_MIN_POS (it
);
20505 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20506 /* Glyph is partially visible, i.e. row starts at
20507 negative X position. Don't do that in R2L
20508 rows, where we arrange to add a right offset to
20509 the line in extend_face_to_end_of_line, by a
20510 suitable change to the stretch glyph that is
20511 the leftmost glyph of the line. */
20512 row
->x
= x
- it
->first_visible_x
;
20513 /* When the last glyph of an R2L row only fits
20514 partially on the line, we need to set row->x to a
20515 negative offset, so that the leftmost glyph is
20516 the one that is partially visible. */
20517 if (row
->reversed_p
&& new_x
> it
->last_visible_x
)
20518 row
->x
= it
->last_visible_x
- new_x
;
20522 /* Glyph is completely off the left margin of the
20523 window. This should not happen because of the
20524 move_it_in_display_line at the start of this
20525 function, unless the text display area of the
20526 window is empty. */
20527 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20530 /* Even if this display element produced no glyphs at all,
20531 we want to record its position. */
20532 if (it
->bidi_p
&& nglyphs
== 0)
20533 RECORD_MAX_MIN_POS (it
);
20535 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20536 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20537 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20538 row
->phys_height
= max (row
->phys_height
,
20539 it
->max_phys_ascent
+ it
->max_phys_descent
);
20540 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20541 it
->max_extra_line_spacing
);
20543 /* End of this display line if row is continued. */
20544 if (row
->continued_p
|| row
->ends_at_zv_p
)
20549 /* Is this a line end? If yes, we're also done, after making
20550 sure that a non-default face is extended up to the right
20551 margin of the window. */
20552 if (ITERATOR_AT_END_OF_LINE_P (it
))
20554 int used_before
= row
->used
[TEXT_AREA
];
20556 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20558 /* Add a space at the end of the line that is used to
20559 display the cursor there. */
20560 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20561 append_space_for_newline (it
, 0);
20563 /* Extend the face to the end of the line. */
20564 extend_face_to_end_of_line (it
);
20566 /* Make sure we have the position. */
20567 if (used_before
== 0)
20568 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20570 /* Record the position of the newline, for use in
20572 it
->eol_pos
= it
->current
.pos
;
20574 /* Consume the line end. This skips over invisible lines. */
20575 set_iterator_to_next (it
, 1);
20576 it
->continuation_lines_width
= 0;
20580 /* Proceed with next display element. Note that this skips
20581 over lines invisible because of selective display. */
20582 set_iterator_to_next (it
, 1);
20584 /* If we truncate lines, we are done when the last displayed
20585 glyphs reach past the right margin of the window. */
20586 if (it
->line_wrap
== TRUNCATE
20587 && ((FRAME_WINDOW_P (it
->f
)
20588 /* Images are preprocessed in produce_image_glyph such
20589 that they are cropped at the right edge of the
20590 window, so an image glyph will always end exactly at
20591 last_visible_x, even if there's no right fringe. */
20592 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20593 ? (it
->current_x
>= it
->last_visible_x
)
20594 : (it
->current_x
> it
->last_visible_x
)))
20596 /* Maybe add truncation glyphs. */
20597 if (!FRAME_WINDOW_P (it
->f
)
20598 || (row
->reversed_p
20599 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20600 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20604 if (!row
->reversed_p
)
20606 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20607 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20612 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20613 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20615 /* Remove any padding glyphs at the front of ROW, to
20616 make room for the truncation glyphs we will be
20617 adding below. The loop below always inserts at
20618 least one truncation glyph, so also remove the
20619 last glyph added to ROW. */
20620 unproduce_glyphs (it
, i
+ 1);
20621 /* Adjust i for the loop below. */
20622 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20625 /* produce_special_glyphs overwrites the last glyph, so
20626 we don't want that if we want to keep that last
20627 glyph, which means it's an image. */
20628 if (it
->current_x
> it
->last_visible_x
)
20630 it
->current_x
= x_before
;
20631 if (!FRAME_WINDOW_P (it
->f
))
20633 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20635 row
->used
[TEXT_AREA
] = i
;
20636 produce_special_glyphs (it
, IT_TRUNCATION
);
20641 row
->used
[TEXT_AREA
] = i
;
20642 produce_special_glyphs (it
, IT_TRUNCATION
);
20644 it
->hpos
= hpos_before
;
20647 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20649 /* Don't truncate if we can overflow newline into fringe. */
20650 if (!get_next_display_element (it
))
20652 it
->continuation_lines_width
= 0;
20653 row
->ends_at_zv_p
= 1;
20654 row
->exact_window_width_line_p
= 1;
20657 if (ITERATOR_AT_END_OF_LINE_P (it
))
20659 row
->exact_window_width_line_p
= 1;
20660 goto at_end_of_line
;
20662 it
->current_x
= x_before
;
20663 it
->hpos
= hpos_before
;
20666 row
->truncated_on_right_p
= 1;
20667 it
->continuation_lines_width
= 0;
20668 reseat_at_next_visible_line_start (it
, 0);
20669 /* We insist below that IT's position be at ZV because in
20670 bidi-reordered lines the character at visible line start
20671 might not be the character that follows the newline in
20672 the logical order. */
20673 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20674 row
->ends_at_zv_p
=
20675 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20677 row
->ends_at_zv_p
= false;
20683 bidi_unshelve_cache (wrap_data
, 1);
20685 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20686 at the left window margin. */
20687 if (it
->first_visible_x
20688 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20690 if (!FRAME_WINDOW_P (it
->f
)
20691 || (((row
->reversed_p
20692 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20693 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20694 /* Don't let insert_left_trunc_glyphs overwrite the
20695 first glyph of the row if it is an image. */
20696 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20697 insert_left_trunc_glyphs (it
);
20698 row
->truncated_on_left_p
= 1;
20701 /* Remember the position at which this line ends.
20703 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20704 cannot be before the call to find_row_edges below, since that is
20705 where these positions are determined. */
20706 row
->end
= it
->current
;
20709 row
->minpos
= row
->start
.pos
;
20710 row
->maxpos
= row
->end
.pos
;
20714 /* ROW->minpos and ROW->maxpos must be the smallest and
20715 `1 + the largest' buffer positions in ROW. But if ROW was
20716 bidi-reordered, these two positions can be anywhere in the
20717 row, so we must determine them now. */
20718 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20721 /* If the start of this line is the overlay arrow-position, then
20722 mark this glyph row as the one containing the overlay arrow.
20723 This is clearly a mess with variable size fonts. It would be
20724 better to let it be displayed like cursors under X. */
20725 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20726 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20727 !NILP (overlay_arrow_string
)))
20729 /* Overlay arrow in window redisplay is a fringe bitmap. */
20730 if (STRINGP (overlay_arrow_string
))
20732 struct glyph_row
*arrow_row
20733 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20734 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20735 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20736 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20737 struct glyph
*p2
, *end
;
20739 /* Copy the arrow glyphs. */
20740 while (glyph
< arrow_end
)
20743 /* Throw away padding glyphs. */
20745 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20746 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20752 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20757 eassert (INTEGERP (overlay_arrow_string
));
20758 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20760 overlay_arrow_seen
= 1;
20763 /* Highlight trailing whitespace. */
20764 if (!NILP (Vshow_trailing_whitespace
))
20765 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20767 /* Compute pixel dimensions of this line. */
20768 compute_line_metrics (it
);
20770 /* Implementation note: No changes in the glyphs of ROW or in their
20771 faces can be done past this point, because compute_line_metrics
20772 computes ROW's hash value and stores it within the glyph_row
20775 /* Record whether this row ends inside an ellipsis. */
20776 row
->ends_in_ellipsis_p
20777 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20778 && it
->ellipsis_p
);
20780 /* Save fringe bitmaps in this row. */
20781 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20782 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20783 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20784 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20786 it
->left_user_fringe_bitmap
= 0;
20787 it
->left_user_fringe_face_id
= 0;
20788 it
->right_user_fringe_bitmap
= 0;
20789 it
->right_user_fringe_face_id
= 0;
20791 /* Maybe set the cursor. */
20792 cvpos
= it
->w
->cursor
.vpos
;
20794 /* In bidi-reordered rows, keep checking for proper cursor
20795 position even if one has been found already, because buffer
20796 positions in such rows change non-linearly with ROW->VPOS,
20797 when a line is continued. One exception: when we are at ZV,
20798 display cursor on the first suitable glyph row, since all
20799 the empty rows after that also have their position set to ZV. */
20800 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20801 lines' rows is implemented for bidi-reordered rows. */
20803 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20804 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20805 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20806 && cursor_row_p (row
))
20807 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20809 /* Prepare for the next line. This line starts horizontally at (X
20810 HPOS) = (0 0). Vertical positions are incremented. As a
20811 convenience for the caller, IT->glyph_row is set to the next
20813 it
->current_x
= it
->hpos
= 0;
20814 it
->current_y
+= row
->height
;
20815 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20818 /* The next row should by default use the same value of the
20819 reversed_p flag as this one. set_iterator_to_next decides when
20820 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20821 the flag accordingly. */
20822 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20823 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20824 it
->start
= row
->end
;
20825 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20827 #undef RECORD_MAX_MIN_POS
20830 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20831 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20832 doc
: /* Return paragraph direction at point in BUFFER.
20833 Value is either `left-to-right' or `right-to-left'.
20834 If BUFFER is omitted or nil, it defaults to the current buffer.
20836 Paragraph direction determines how the text in the paragraph is displayed.
20837 In left-to-right paragraphs, text begins at the left margin of the window
20838 and the reading direction is generally left to right. In right-to-left
20839 paragraphs, text begins at the right margin and is read from right to left.
20841 See also `bidi-paragraph-direction'. */)
20842 (Lisp_Object buffer
)
20844 struct buffer
*buf
= current_buffer
;
20845 struct buffer
*old
= buf
;
20847 if (! NILP (buffer
))
20849 CHECK_BUFFER (buffer
);
20850 buf
= XBUFFER (buffer
);
20853 if (NILP (BVAR (buf
, bidi_display_reordering
))
20854 || NILP (BVAR (buf
, enable_multibyte_characters
))
20855 /* When we are loading loadup.el, the character property tables
20856 needed for bidi iteration are not yet available. */
20857 || !NILP (Vpurify_flag
))
20858 return Qleft_to_right
;
20859 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20860 return BVAR (buf
, bidi_paragraph_direction
);
20863 /* Determine the direction from buffer text. We could try to
20864 use current_matrix if it is up to date, but this seems fast
20865 enough as it is. */
20866 struct bidi_it itb
;
20867 ptrdiff_t pos
= BUF_PT (buf
);
20868 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20870 void *itb_data
= bidi_shelve_cache ();
20872 set_buffer_temp (buf
);
20873 /* bidi_paragraph_init finds the base direction of the paragraph
20874 by searching forward from paragraph start. We need the base
20875 direction of the current or _previous_ paragraph, so we need
20876 to make sure we are within that paragraph. To that end, find
20877 the previous non-empty line. */
20878 if (pos
>= ZV
&& pos
> BEGV
)
20879 DEC_BOTH (pos
, bytepos
);
20880 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20881 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20883 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20884 || c
== ' ' || c
== '\t' || c
== '\f')
20886 if (bytepos
<= BEGV_BYTE
)
20891 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20894 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20895 itb
.paragraph_dir
= NEUTRAL_DIR
;
20896 itb
.string
.s
= NULL
;
20897 itb
.string
.lstring
= Qnil
;
20898 itb
.string
.bufpos
= 0;
20899 itb
.string
.from_disp_str
= 0;
20900 itb
.string
.unibyte
= 0;
20901 /* We have no window to use here for ignoring window-specific
20902 overlays. Using NULL for window pointer will cause
20903 compute_display_string_pos to use the current buffer. */
20905 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20906 bidi_unshelve_cache (itb_data
, 0);
20907 set_buffer_temp (old
);
20908 switch (itb
.paragraph_dir
)
20911 return Qleft_to_right
;
20914 return Qright_to_left
;
20922 DEFUN ("move-point-visually", Fmove_point_visually
,
20923 Smove_point_visually
, 1, 1, 0,
20924 doc
: /* Move point in the visual order in the specified DIRECTION.
20925 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20928 Value is the new character position of point. */)
20929 (Lisp_Object direction
)
20931 struct window
*w
= XWINDOW (selected_window
);
20932 struct buffer
*b
= XBUFFER (w
->contents
);
20933 struct glyph_row
*row
;
20935 Lisp_Object paragraph_dir
;
20937 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20938 (!(ROW)->continued_p \
20939 && INTEGERP ((GLYPH)->object) \
20940 && (GLYPH)->type == CHAR_GLYPH \
20941 && (GLYPH)->u.ch == ' ' \
20942 && (GLYPH)->charpos >= 0 \
20943 && !(GLYPH)->avoid_cursor_p)
20945 CHECK_NUMBER (direction
);
20946 dir
= XINT (direction
);
20952 /* If current matrix is up-to-date, we can use the information
20953 recorded in the glyphs, at least as long as the goal is on the
20955 if (w
->window_end_valid
20956 && !windows_or_buffers_changed
20958 && !b
->clip_changed
20959 && !b
->prevent_redisplay_optimizations_p
20960 && !window_outdated (w
)
20961 /* We rely below on the cursor coordinates to be up to date, but
20962 we cannot trust them if some command moved point since the
20963 last complete redisplay. */
20964 && w
->last_point
== BUF_PT (b
)
20965 && w
->cursor
.vpos
>= 0
20966 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20967 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20969 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20970 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20971 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20973 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20975 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20977 SET_PT (g
->charpos
);
20978 w
->cursor
.vpos
= -1;
20979 return make_number (PT
);
20981 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20985 if (BUFFERP (gpt
->object
))
20988 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20989 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20991 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20993 else if (BUFFERP (g
->object
))
20994 new_pos
= g
->charpos
;
20998 w
->cursor
.vpos
= -1;
20999 return make_number (PT
);
21001 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21003 /* Glyphs inserted at the end of a non-empty line for
21004 positioning the cursor have zero charpos, so we must
21005 deduce the value of point by other means. */
21006 if (g
->charpos
> 0)
21007 SET_PT (g
->charpos
);
21008 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21010 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21011 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21014 w
->cursor
.vpos
= -1;
21015 return make_number (PT
);
21018 if (g
== e
|| INTEGERP (g
->object
))
21020 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21021 goto simulate_display
;
21022 if (!row
->reversed_p
)
21026 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21027 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21028 goto simulate_display
;
21032 if (row
->reversed_p
&& !row
->continued_p
)
21034 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21035 w
->cursor
.vpos
= -1;
21036 return make_number (PT
);
21038 g
= row
->glyphs
[TEXT_AREA
];
21039 e
= g
+ row
->used
[TEXT_AREA
];
21040 for ( ; g
< e
; g
++)
21042 if (BUFFERP (g
->object
)
21043 /* Empty lines have only one glyph, which stands
21044 for the newline, and whose charpos is the
21045 buffer position of the newline. */
21046 || ROW_GLYPH_NEWLINE_P (row
, g
)
21047 /* When the buffer ends in a newline, the line at
21048 EOB also has one glyph, but its charpos is -1. */
21049 || (row
->ends_at_zv_p
21050 && !row
->reversed_p
21051 && INTEGERP (g
->object
)
21052 && g
->type
== CHAR_GLYPH
21053 && g
->u
.ch
== ' '))
21055 if (g
->charpos
> 0)
21056 SET_PT (g
->charpos
);
21057 else if (!row
->reversed_p
21058 && row
->ends_at_zv_p
21063 w
->cursor
.vpos
= -1;
21064 return make_number (PT
);
21070 if (!row
->reversed_p
&& !row
->continued_p
)
21072 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21073 w
->cursor
.vpos
= -1;
21074 return make_number (PT
);
21076 e
= row
->glyphs
[TEXT_AREA
];
21077 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21078 for ( ; g
>= e
; g
--)
21080 if (BUFFERP (g
->object
)
21081 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21083 /* Empty R2L lines on GUI frames have the buffer
21084 position of the newline stored in the stretch
21086 || g
->type
== STRETCH_GLYPH
21087 || (row
->ends_at_zv_p
21089 && INTEGERP (g
->object
)
21090 && g
->type
== CHAR_GLYPH
21091 && g
->u
.ch
== ' '))
21093 if (g
->charpos
> 0)
21094 SET_PT (g
->charpos
);
21095 else if (row
->reversed_p
21096 && row
->ends_at_zv_p
21101 w
->cursor
.vpos
= -1;
21102 return make_number (PT
);
21111 /* If we wind up here, we failed to move by using the glyphs, so we
21112 need to simulate display instead. */
21115 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21117 paragraph_dir
= Qleft_to_right
;
21118 if (EQ (paragraph_dir
, Qright_to_left
))
21120 if (PT
<= BEGV
&& dir
< 0)
21121 xsignal0 (Qbeginning_of_buffer
);
21122 else if (PT
>= ZV
&& dir
> 0)
21123 xsignal0 (Qend_of_buffer
);
21126 struct text_pos pt
;
21128 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21130 bool overshoot_expected
= false;
21131 bool target_is_eol_p
= false;
21133 /* Setup the arena. */
21134 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21135 start_display (&it
, w
, pt
);
21137 if (it
.cmp_it
.id
< 0
21138 && it
.method
== GET_FROM_STRING
21139 && it
.area
== TEXT_AREA
21140 && it
.string_from_display_prop_p
21141 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21142 overshoot_expected
= true;
21144 /* Find the X coordinate of point. We start from the beginning
21145 of this or previous line to make sure we are before point in
21146 the logical order (since the move_it_* functions can only
21149 reseat_at_previous_visible_line_start (&it
);
21150 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21151 if (IT_CHARPOS (it
) != PT
)
21153 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21154 -1, -1, -1, MOVE_TO_POS
);
21155 /* If we missed point because the character there is
21156 displayed out of a display vector that has more than one
21157 glyph, retry expecting overshoot. */
21158 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21159 && it
.current
.dpvec_index
> 0
21160 && !overshoot_expected
)
21162 overshoot_expected
= true;
21165 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21166 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21168 pt_x
= it
.current_x
;
21170 if (dir
> 0 || overshoot_expected
)
21172 struct glyph_row
*row
= it
.glyph_row
;
21174 /* When point is at beginning of line, we don't have
21175 information about the glyph there loaded into struct
21176 it. Calling get_next_display_element fixes that. */
21178 get_next_display_element (&it
);
21179 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21180 it
.glyph_row
= NULL
;
21181 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21182 it
.glyph_row
= row
;
21183 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21184 it, lest it will become out of sync with it's buffer
21186 it
.current_x
= pt_x
;
21189 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21190 pixel_width
= it
.pixel_width
;
21191 if (overshoot_expected
&& at_eol_p
)
21193 else if (pixel_width
<= 0)
21196 /* If there's a display string (or something similar) at point,
21197 we are actually at the glyph to the left of point, so we need
21198 to correct the X coordinate. */
21199 if (overshoot_expected
)
21202 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21204 pt_x
+= pixel_width
;
21207 /* Compute target X coordinate, either to the left or to the
21208 right of point. On TTY frames, all characters have the same
21209 pixel width of 1, so we can use that. On GUI frames we don't
21210 have an easy way of getting at the pixel width of the
21211 character to the left of point, so we use a different method
21212 of getting to that place. */
21214 target_x
= pt_x
+ pixel_width
;
21216 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21218 /* Target X coordinate could be one line above or below the line
21219 of point, in which case we need to adjust the target X
21220 coordinate. Also, if moving to the left, we need to begin at
21221 the left edge of the point's screen line. */
21226 start_display (&it
, w
, pt
);
21227 reseat_at_previous_visible_line_start (&it
);
21228 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21230 move_it_by_lines (&it
, pt_vpos
);
21234 move_it_by_lines (&it
, -1);
21235 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21236 target_is_eol_p
= true;
21237 /* Under word-wrap, we don't know the x coordinate of
21238 the last character displayed on the previous line,
21239 which immediately precedes the wrap point. To find
21240 out its x coordinate, we try moving to the right
21241 margin of the window, which will stop at the wrap
21242 point, and then reset target_x to point at the
21243 character that precedes the wrap point. This is not
21244 needed on GUI frames, because (see below) there we
21245 move from the left margin one grapheme cluster at a
21246 time, and stop when we hit the wrap point. */
21247 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21249 void *it_data
= NULL
;
21252 SAVE_IT (it2
, it
, it_data
);
21253 move_it_in_display_line_to (&it
, ZV
, target_x
,
21254 MOVE_TO_POS
| MOVE_TO_X
);
21255 /* If we arrived at target_x, that _is_ the last
21256 character on the previous line. */
21257 if (it
.current_x
!= target_x
)
21258 target_x
= it
.current_x
- 1;
21259 RESTORE_IT (&it
, &it2
, it_data
);
21266 || (target_x
>= it
.last_visible_x
21267 && it
.line_wrap
!= TRUNCATE
))
21270 move_it_by_lines (&it
, 0);
21271 move_it_by_lines (&it
, 1);
21276 /* Move to the target X coordinate. */
21277 #ifdef HAVE_WINDOW_SYSTEM
21278 /* On GUI frames, as we don't know the X coordinate of the
21279 character to the left of point, moving point to the left
21280 requires walking, one grapheme cluster at a time, until we
21281 find ourself at a place immediately to the left of the
21282 character at point. */
21283 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21285 struct text_pos new_pos
;
21286 enum move_it_result rc
= MOVE_X_REACHED
;
21288 if (it
.current_x
== 0)
21289 get_next_display_element (&it
);
21290 if (it
.what
== IT_COMPOSITION
)
21292 new_pos
.charpos
= it
.cmp_it
.charpos
;
21293 new_pos
.bytepos
= -1;
21296 new_pos
= it
.current
.pos
;
21298 while (it
.current_x
+ it
.pixel_width
<= target_x
21299 && (rc
== MOVE_X_REACHED
21300 /* Under word-wrap, move_it_in_display_line_to
21301 stops at correct coordinates, but sometimes
21302 returns MOVE_POS_MATCH_OR_ZV. */
21303 || (it
.line_wrap
== WORD_WRAP
21304 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21306 int new_x
= it
.current_x
+ it
.pixel_width
;
21308 /* For composed characters, we want the position of the
21309 first character in the grapheme cluster (usually, the
21310 composition's base character), whereas it.current
21311 might give us the position of the _last_ one, e.g. if
21312 the composition is rendered in reverse due to bidi
21314 if (it
.what
== IT_COMPOSITION
)
21316 new_pos
.charpos
= it
.cmp_it
.charpos
;
21317 new_pos
.bytepos
= -1;
21320 new_pos
= it
.current
.pos
;
21321 if (new_x
== it
.current_x
)
21323 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21324 MOVE_TO_POS
| MOVE_TO_X
);
21325 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21328 /* The previous position we saw in the loop is the one we
21330 if (new_pos
.bytepos
== -1)
21331 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21332 it
.current
.pos
= new_pos
;
21336 if (it
.current_x
!= target_x
)
21337 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21339 /* When lines are truncated, the above loop will stop at the
21340 window edge. But we want to get to the end of line, even if
21341 it is beyond the window edge; automatic hscroll will then
21342 scroll the window to show point as appropriate. */
21343 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21344 && get_next_display_element (&it
))
21346 struct text_pos new_pos
= it
.current
.pos
;
21348 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21350 set_iterator_to_next (&it
, 0);
21351 if (it
.method
== GET_FROM_BUFFER
)
21352 new_pos
= it
.current
.pos
;
21353 if (!get_next_display_element (&it
))
21357 it
.current
.pos
= new_pos
;
21360 /* If we ended up in a display string that covers point, move to
21361 buffer position to the right in the visual order. */
21364 while (IT_CHARPOS (it
) == PT
)
21366 set_iterator_to_next (&it
, 0);
21367 if (!get_next_display_element (&it
))
21372 /* Move point to that position. */
21373 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21376 return make_number (PT
);
21378 #undef ROW_GLYPH_NEWLINE_P
21382 /***********************************************************************
21384 ***********************************************************************/
21386 /* Redisplay the menu bar in the frame for window W.
21388 The menu bar of X frames that don't have X toolkit support is
21389 displayed in a special window W->frame->menu_bar_window.
21391 The menu bar of terminal frames is treated specially as far as
21392 glyph matrices are concerned. Menu bar lines are not part of
21393 windows, so the update is done directly on the frame matrix rows
21394 for the menu bar. */
21397 display_menu_bar (struct window
*w
)
21399 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21404 /* Don't do all this for graphical frames. */
21406 if (FRAME_W32_P (f
))
21409 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21415 if (FRAME_NS_P (f
))
21417 #endif /* HAVE_NS */
21419 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21420 eassert (!FRAME_WINDOW_P (f
));
21421 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21422 it
.first_visible_x
= 0;
21423 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21424 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21425 if (FRAME_WINDOW_P (f
))
21427 /* Menu bar lines are displayed in the desired matrix of the
21428 dummy window menu_bar_window. */
21429 struct window
*menu_w
;
21430 menu_w
= XWINDOW (f
->menu_bar_window
);
21431 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21433 it
.first_visible_x
= 0;
21434 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21437 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21439 /* This is a TTY frame, i.e. character hpos/vpos are used as
21441 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21443 it
.first_visible_x
= 0;
21444 it
.last_visible_x
= FRAME_COLS (f
);
21447 /* FIXME: This should be controlled by a user option. See the
21448 comments in redisplay_tool_bar and display_mode_line about
21450 it
.paragraph_embedding
= L2R
;
21452 /* Clear all rows of the menu bar. */
21453 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21455 struct glyph_row
*row
= it
.glyph_row
+ i
;
21456 clear_glyph_row (row
);
21457 row
->enabled_p
= true;
21458 row
->full_width_p
= 1;
21459 row
->reversed_p
= false;
21462 /* Display all items of the menu bar. */
21463 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21464 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21466 Lisp_Object string
;
21468 /* Stop at nil string. */
21469 string
= AREF (items
, i
+ 1);
21473 /* Remember where item was displayed. */
21474 ASET (items
, i
+ 3, make_number (it
.hpos
));
21476 /* Display the item, pad with one space. */
21477 if (it
.current_x
< it
.last_visible_x
)
21478 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21479 SCHARS (string
) + 1, 0, 0, -1);
21482 /* Fill out the line with spaces. */
21483 if (it
.current_x
< it
.last_visible_x
)
21484 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21486 /* Compute the total height of the lines. */
21487 compute_line_metrics (&it
);
21490 /* Deep copy of a glyph row, including the glyphs. */
21492 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21494 struct glyph
*pointers
[1 + LAST_AREA
];
21495 int to_used
= to
->used
[TEXT_AREA
];
21497 /* Save glyph pointers of TO. */
21498 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21500 /* Do a structure assignment. */
21503 /* Restore original glyph pointers of TO. */
21504 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21506 /* Copy the glyphs. */
21507 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21508 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21510 /* If we filled only part of the TO row, fill the rest with
21511 space_glyph (which will display as empty space). */
21512 if (to_used
> from
->used
[TEXT_AREA
])
21513 fill_up_frame_row_with_spaces (to
, to_used
);
21516 /* Display one menu item on a TTY, by overwriting the glyphs in the
21517 frame F's desired glyph matrix with glyphs produced from the menu
21518 item text. Called from term.c to display TTY drop-down menus one
21521 ITEM_TEXT is the menu item text as a C string.
21523 FACE_ID is the face ID to be used for this menu item. FACE_ID
21524 could specify one of 3 faces: a face for an enabled item, a face
21525 for a disabled item, or a face for a selected item.
21527 X and Y are coordinates of the first glyph in the frame's desired
21528 matrix to be overwritten by the menu item. Since this is a TTY, Y
21529 is the zero-based number of the glyph row and X is the zero-based
21530 glyph number in the row, starting from left, where to start
21531 displaying the item.
21533 SUBMENU non-zero means this menu item drops down a submenu, which
21534 should be indicated by displaying a proper visual cue after the
21538 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21539 int x
, int y
, int submenu
)
21542 struct frame
*f
= SELECTED_FRAME ();
21543 struct window
*w
= XWINDOW (f
->selected_window
);
21544 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21545 struct glyph_row
*row
;
21546 size_t item_len
= strlen (item_text
);
21548 eassert (FRAME_TERMCAP_P (f
));
21550 /* Don't write beyond the matrix's last row. This can happen for
21551 TTY screens that are not high enough to show the entire menu.
21552 (This is actually a bit of defensive programming, as
21553 tty_menu_display already limits the number of menu items to one
21554 less than the number of screen lines.) */
21555 if (y
>= f
->desired_matrix
->nrows
)
21558 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21559 it
.first_visible_x
= 0;
21560 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21561 row
= it
.glyph_row
;
21562 /* Start with the row contents from the current matrix. */
21563 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21564 saved_width
= row
->full_width_p
;
21565 row
->full_width_p
= 1;
21566 saved_reversed
= row
->reversed_p
;
21567 row
->reversed_p
= 0;
21568 row
->enabled_p
= true;
21570 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21572 eassert (x
< f
->desired_matrix
->matrix_w
);
21573 it
.current_x
= it
.hpos
= x
;
21574 it
.current_y
= it
.vpos
= y
;
21575 saved_used
= row
->used
[TEXT_AREA
];
21576 saved_truncated
= row
->truncated_on_right_p
;
21577 row
->used
[TEXT_AREA
] = x
;
21578 it
.face_id
= face_id
;
21579 it
.line_wrap
= TRUNCATE
;
21581 /* FIXME: This should be controlled by a user option. See the
21582 comments in redisplay_tool_bar and display_mode_line about this.
21583 Also, if paragraph_embedding could ever be R2L, changes will be
21584 needed to avoid shifting to the right the row characters in
21585 term.c:append_glyph. */
21586 it
.paragraph_embedding
= L2R
;
21588 /* Pad with a space on the left. */
21589 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21591 /* Display the menu item, pad with spaces to WIDTH. */
21594 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21595 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21597 /* Indicate with " >" that there's a submenu. */
21598 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21599 FRAME_COLS (f
) - 1, -1);
21602 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21603 width
, 0, FRAME_COLS (f
) - 1, -1);
21605 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21606 row
->truncated_on_right_p
= saved_truncated
;
21607 row
->hash
= row_hash (row
);
21608 row
->full_width_p
= saved_width
;
21609 row
->reversed_p
= saved_reversed
;
21612 /***********************************************************************
21614 ***********************************************************************/
21616 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21617 FORCE is non-zero, redisplay mode lines unconditionally.
21618 Otherwise, redisplay only mode lines that are garbaged. Value is
21619 the number of windows whose mode lines were redisplayed. */
21622 redisplay_mode_lines (Lisp_Object window
, bool force
)
21626 while (!NILP (window
))
21628 struct window
*w
= XWINDOW (window
);
21630 if (WINDOWP (w
->contents
))
21631 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21633 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21634 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21636 struct text_pos lpoint
;
21637 struct buffer
*old
= current_buffer
;
21639 /* Set the window's buffer for the mode line display. */
21640 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21641 set_buffer_internal_1 (XBUFFER (w
->contents
));
21643 /* Point refers normally to the selected window. For any
21644 other window, set up appropriate value. */
21645 if (!EQ (window
, selected_window
))
21647 struct text_pos pt
;
21649 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21650 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21653 /* Display mode lines. */
21654 clear_glyph_matrix (w
->desired_matrix
);
21655 if (display_mode_lines (w
))
21658 /* Restore old settings. */
21659 set_buffer_internal_1 (old
);
21660 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21670 /* Display the mode and/or header line of window W. Value is the
21671 sum number of mode lines and header lines displayed. */
21674 display_mode_lines (struct window
*w
)
21676 Lisp_Object old_selected_window
= selected_window
;
21677 Lisp_Object old_selected_frame
= selected_frame
;
21678 Lisp_Object new_frame
= w
->frame
;
21679 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21682 selected_frame
= new_frame
;
21683 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21684 or window's point, then we'd need select_window_1 here as well. */
21685 XSETWINDOW (selected_window
, w
);
21686 XFRAME (new_frame
)->selected_window
= selected_window
;
21688 /* These will be set while the mode line specs are processed. */
21689 line_number_displayed
= 0;
21690 w
->column_number_displayed
= -1;
21692 if (WINDOW_WANTS_MODELINE_P (w
))
21694 struct window
*sel_w
= XWINDOW (old_selected_window
);
21696 /* Select mode line face based on the real selected window. */
21697 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21698 BVAR (current_buffer
, mode_line_format
));
21702 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21704 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21705 BVAR (current_buffer
, header_line_format
));
21709 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21710 selected_frame
= old_selected_frame
;
21711 selected_window
= old_selected_window
;
21713 w
->must_be_updated_p
= true;
21718 /* Display mode or header line of window W. FACE_ID specifies which
21719 line to display; it is either MODE_LINE_FACE_ID or
21720 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21721 display. Value is the pixel height of the mode/header line
21725 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21729 ptrdiff_t count
= SPECPDL_INDEX ();
21731 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21732 /* Don't extend on a previously drawn mode-line.
21733 This may happen if called from pos_visible_p. */
21734 it
.glyph_row
->enabled_p
= false;
21735 prepare_desired_row (w
, it
.glyph_row
, true);
21737 it
.glyph_row
->mode_line_p
= 1;
21739 /* FIXME: This should be controlled by a user option. But
21740 supporting such an option is not trivial, since the mode line is
21741 made up of many separate strings. */
21742 it
.paragraph_embedding
= L2R
;
21744 record_unwind_protect (unwind_format_mode_line
,
21745 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21747 mode_line_target
= MODE_LINE_DISPLAY
;
21749 /* Temporarily make frame's keyboard the current kboard so that
21750 kboard-local variables in the mode_line_format will get the right
21752 push_kboard (FRAME_KBOARD (it
.f
));
21753 record_unwind_save_match_data ();
21754 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21757 unbind_to (count
, Qnil
);
21759 /* Fill up with spaces. */
21760 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21762 compute_line_metrics (&it
);
21763 it
.glyph_row
->full_width_p
= 1;
21764 it
.glyph_row
->continued_p
= 0;
21765 it
.glyph_row
->truncated_on_left_p
= 0;
21766 it
.glyph_row
->truncated_on_right_p
= 0;
21768 /* Make a 3D mode-line have a shadow at its right end. */
21769 face
= FACE_FROM_ID (it
.f
, face_id
);
21770 extend_face_to_end_of_line (&it
);
21771 if (face
->box
!= FACE_NO_BOX
)
21773 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21774 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21775 last
->right_box_line_p
= 1;
21778 return it
.glyph_row
->height
;
21781 /* Move element ELT in LIST to the front of LIST.
21782 Return the updated list. */
21785 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21787 register Lisp_Object tail
, prev
;
21788 register Lisp_Object tem
;
21792 while (CONSP (tail
))
21798 /* Splice out the link TAIL. */
21800 list
= XCDR (tail
);
21802 Fsetcdr (prev
, XCDR (tail
));
21804 /* Now make it the first. */
21805 Fsetcdr (tail
, list
);
21810 tail
= XCDR (tail
);
21814 /* Not found--return unchanged LIST. */
21818 /* Contribute ELT to the mode line for window IT->w. How it
21819 translates into text depends on its data type.
21821 IT describes the display environment in which we display, as usual.
21823 DEPTH is the depth in recursion. It is used to prevent
21824 infinite recursion here.
21826 FIELD_WIDTH is the number of characters the display of ELT should
21827 occupy in the mode line, and PRECISION is the maximum number of
21828 characters to display from ELT's representation. See
21829 display_string for details.
21831 Returns the hpos of the end of the text generated by ELT.
21833 PROPS is a property list to add to any string we encounter.
21835 If RISKY is nonzero, remove (disregard) any properties in any string
21836 we encounter, and ignore :eval and :propertize.
21838 The global variable `mode_line_target' determines whether the
21839 output is passed to `store_mode_line_noprop',
21840 `store_mode_line_string', or `display_string'. */
21843 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21844 Lisp_Object elt
, Lisp_Object props
, int risky
)
21846 int n
= 0, field
, prec
;
21851 elt
= build_string ("*too-deep*");
21855 switch (XTYPE (elt
))
21859 /* A string: output it and check for %-constructs within it. */
21861 ptrdiff_t offset
= 0;
21863 if (SCHARS (elt
) > 0
21864 && (!NILP (props
) || risky
))
21866 Lisp_Object oprops
, aelt
;
21867 oprops
= Ftext_properties_at (make_number (0), elt
);
21869 /* If the starting string's properties are not what
21870 we want, translate the string. Also, if the string
21871 is risky, do that anyway. */
21873 if (NILP (Fequal (props
, oprops
)) || risky
)
21875 /* If the starting string has properties,
21876 merge the specified ones onto the existing ones. */
21877 if (! NILP (oprops
) && !risky
)
21881 oprops
= Fcopy_sequence (oprops
);
21883 while (CONSP (tem
))
21885 oprops
= Fplist_put (oprops
, XCAR (tem
),
21886 XCAR (XCDR (tem
)));
21887 tem
= XCDR (XCDR (tem
));
21892 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21893 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21895 /* AELT is what we want. Move it to the front
21896 without consing. */
21898 mode_line_proptrans_alist
21899 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21905 /* If AELT has the wrong props, it is useless.
21906 so get rid of it. */
21908 mode_line_proptrans_alist
21909 = Fdelq (aelt
, mode_line_proptrans_alist
);
21911 elt
= Fcopy_sequence (elt
);
21912 Fset_text_properties (make_number (0), Flength (elt
),
21914 /* Add this item to mode_line_proptrans_alist. */
21915 mode_line_proptrans_alist
21916 = Fcons (Fcons (elt
, props
),
21917 mode_line_proptrans_alist
);
21918 /* Truncate mode_line_proptrans_alist
21919 to at most 50 elements. */
21920 tem
= Fnthcdr (make_number (50),
21921 mode_line_proptrans_alist
);
21923 XSETCDR (tem
, Qnil
);
21932 prec
= precision
- n
;
21933 switch (mode_line_target
)
21935 case MODE_LINE_NOPROP
:
21936 case MODE_LINE_TITLE
:
21937 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21939 case MODE_LINE_STRING
:
21940 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21942 case MODE_LINE_DISPLAY
:
21943 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21944 0, prec
, 0, STRING_MULTIBYTE (elt
));
21951 /* Handle the non-literal case. */
21953 while ((precision
<= 0 || n
< precision
)
21954 && SREF (elt
, offset
) != 0
21955 && (mode_line_target
!= MODE_LINE_DISPLAY
21956 || it
->current_x
< it
->last_visible_x
))
21958 ptrdiff_t last_offset
= offset
;
21960 /* Advance to end of string or next format specifier. */
21961 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21964 if (offset
- 1 != last_offset
)
21966 ptrdiff_t nchars
, nbytes
;
21968 /* Output to end of string or up to '%'. Field width
21969 is length of string. Don't output more than
21970 PRECISION allows us. */
21973 prec
= c_string_width (SDATA (elt
) + last_offset
,
21974 offset
- last_offset
, precision
- n
,
21977 switch (mode_line_target
)
21979 case MODE_LINE_NOPROP
:
21980 case MODE_LINE_TITLE
:
21981 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21983 case MODE_LINE_STRING
:
21985 ptrdiff_t bytepos
= last_offset
;
21986 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21987 ptrdiff_t endpos
= (precision
<= 0
21988 ? string_byte_to_char (elt
, offset
)
21989 : charpos
+ nchars
);
21991 n
+= store_mode_line_string (NULL
,
21992 Fsubstring (elt
, make_number (charpos
),
21993 make_number (endpos
)),
21997 case MODE_LINE_DISPLAY
:
21999 ptrdiff_t bytepos
= last_offset
;
22000 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22002 if (precision
<= 0)
22003 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22004 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22006 STRING_MULTIBYTE (elt
));
22011 else /* c == '%' */
22013 ptrdiff_t percent_position
= offset
;
22015 /* Get the specified minimum width. Zero means
22018 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22019 field
= field
* 10 + c
- '0';
22021 /* Don't pad beyond the total padding allowed. */
22022 if (field_width
- n
> 0 && field
> field_width
- n
)
22023 field
= field_width
- n
;
22025 /* Note that either PRECISION <= 0 or N < PRECISION. */
22026 prec
= precision
- n
;
22029 n
+= display_mode_element (it
, depth
, field
, prec
,
22030 Vglobal_mode_string
, props
,
22035 ptrdiff_t bytepos
, charpos
;
22037 Lisp_Object string
;
22039 bytepos
= percent_position
;
22040 charpos
= (STRING_MULTIBYTE (elt
)
22041 ? string_byte_to_char (elt
, bytepos
)
22043 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22044 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22046 switch (mode_line_target
)
22048 case MODE_LINE_NOPROP
:
22049 case MODE_LINE_TITLE
:
22050 n
+= store_mode_line_noprop (spec
, field
, prec
);
22052 case MODE_LINE_STRING
:
22054 Lisp_Object tem
= build_string (spec
);
22055 props
= Ftext_properties_at (make_number (charpos
), elt
);
22056 /* Should only keep face property in props */
22057 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22060 case MODE_LINE_DISPLAY
:
22062 int nglyphs_before
, nwritten
;
22064 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22065 nwritten
= display_string (spec
, string
, elt
,
22070 /* Assign to the glyphs written above the
22071 string where the `%x' came from, position
22075 struct glyph
*glyph
22076 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22080 for (i
= 0; i
< nwritten
; ++i
)
22082 glyph
[i
].object
= elt
;
22083 glyph
[i
].charpos
= charpos
;
22100 /* A symbol: process the value of the symbol recursively
22101 as if it appeared here directly. Avoid error if symbol void.
22102 Special case: if value of symbol is a string, output the string
22105 register Lisp_Object tem
;
22107 /* If the variable is not marked as risky to set
22108 then its contents are risky to use. */
22109 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22112 tem
= Fboundp (elt
);
22115 tem
= Fsymbol_value (elt
);
22116 /* If value is a string, output that string literally:
22117 don't check for % within it. */
22121 if (!EQ (tem
, elt
))
22123 /* Give up right away for nil or t. */
22133 register Lisp_Object car
, tem
;
22135 /* A cons cell: five distinct cases.
22136 If first element is :eval or :propertize, do something special.
22137 If first element is a string or a cons, process all the elements
22138 and effectively concatenate them.
22139 If first element is a negative number, truncate displaying cdr to
22140 at most that many characters. If positive, pad (with spaces)
22141 to at least that many characters.
22142 If first element is a symbol, process the cadr or caddr recursively
22143 according to whether the symbol's value is non-nil or nil. */
22145 if (EQ (car
, QCeval
))
22147 /* An element of the form (:eval FORM) means evaluate FORM
22148 and use the result as mode line elements. */
22153 if (CONSP (XCDR (elt
)))
22156 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22157 n
+= display_mode_element (it
, depth
, field_width
- n
,
22158 precision
- n
, spec
, props
,
22162 else if (EQ (car
, QCpropertize
))
22164 /* An element of the form (:propertize ELT PROPS...)
22165 means display ELT but applying properties PROPS. */
22170 if (CONSP (XCDR (elt
)))
22171 n
+= display_mode_element (it
, depth
, field_width
- n
,
22172 precision
- n
, XCAR (XCDR (elt
)),
22173 XCDR (XCDR (elt
)), risky
);
22175 else if (SYMBOLP (car
))
22177 tem
= Fboundp (car
);
22181 /* elt is now the cdr, and we know it is a cons cell.
22182 Use its car if CAR has a non-nil value. */
22185 tem
= Fsymbol_value (car
);
22192 /* Symbol's value is nil (or symbol is unbound)
22193 Get the cddr of the original list
22194 and if possible find the caddr and use that. */
22198 else if (!CONSP (elt
))
22203 else if (INTEGERP (car
))
22205 register int lim
= XINT (car
);
22209 /* Negative int means reduce maximum width. */
22210 if (precision
<= 0)
22213 precision
= min (precision
, -lim
);
22217 /* Padding specified. Don't let it be more than
22218 current maximum. */
22220 lim
= min (precision
, lim
);
22222 /* If that's more padding than already wanted, queue it.
22223 But don't reduce padding already specified even if
22224 that is beyond the current truncation point. */
22225 field_width
= max (lim
, field_width
);
22229 else if (STRINGP (car
) || CONSP (car
))
22231 Lisp_Object halftail
= elt
;
22235 && (precision
<= 0 || n
< precision
))
22237 n
+= display_mode_element (it
, depth
,
22238 /* Do padding only after the last
22239 element in the list. */
22240 (! CONSP (XCDR (elt
))
22243 precision
- n
, XCAR (elt
),
22247 if ((len
& 1) == 0)
22248 halftail
= XCDR (halftail
);
22249 /* Check for cycle. */
22250 if (EQ (halftail
, elt
))
22259 elt
= build_string ("*invalid*");
22263 /* Pad to FIELD_WIDTH. */
22264 if (field_width
> 0 && n
< field_width
)
22266 switch (mode_line_target
)
22268 case MODE_LINE_NOPROP
:
22269 case MODE_LINE_TITLE
:
22270 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22272 case MODE_LINE_STRING
:
22273 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22275 case MODE_LINE_DISPLAY
:
22276 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22285 /* Store a mode-line string element in mode_line_string_list.
22287 If STRING is non-null, display that C string. Otherwise, the Lisp
22288 string LISP_STRING is displayed.
22290 FIELD_WIDTH is the minimum number of output glyphs to produce.
22291 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22292 with spaces. FIELD_WIDTH <= 0 means don't pad.
22294 PRECISION is the maximum number of characters to output from
22295 STRING. PRECISION <= 0 means don't truncate the string.
22297 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22298 properties to the string.
22300 PROPS are the properties to add to the string.
22301 The mode_line_string_face face property is always added to the string.
22305 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22306 int field_width
, int precision
, Lisp_Object props
)
22311 if (string
!= NULL
)
22313 len
= strlen (string
);
22314 if (precision
> 0 && len
> precision
)
22316 lisp_string
= make_string (string
, len
);
22318 props
= mode_line_string_face_prop
;
22319 else if (!NILP (mode_line_string_face
))
22321 Lisp_Object face
= Fplist_get (props
, Qface
);
22322 props
= Fcopy_sequence (props
);
22324 face
= mode_line_string_face
;
22326 face
= list2 (face
, mode_line_string_face
);
22327 props
= Fplist_put (props
, Qface
, face
);
22329 Fadd_text_properties (make_number (0), make_number (len
),
22330 props
, lisp_string
);
22334 len
= XFASTINT (Flength (lisp_string
));
22335 if (precision
> 0 && len
> precision
)
22338 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22341 if (!NILP (mode_line_string_face
))
22345 props
= Ftext_properties_at (make_number (0), lisp_string
);
22346 face
= Fplist_get (props
, Qface
);
22348 face
= mode_line_string_face
;
22350 face
= list2 (face
, mode_line_string_face
);
22351 props
= list2 (Qface
, face
);
22353 lisp_string
= Fcopy_sequence (lisp_string
);
22356 Fadd_text_properties (make_number (0), make_number (len
),
22357 props
, lisp_string
);
22362 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22366 if (field_width
> len
)
22368 field_width
-= len
;
22369 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22371 Fadd_text_properties (make_number (0), make_number (field_width
),
22372 props
, lisp_string
);
22373 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22381 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22383 doc
: /* Format a string out of a mode line format specification.
22384 First arg FORMAT specifies the mode line format (see `mode-line-format'
22385 for details) to use.
22387 By default, the format is evaluated for the currently selected window.
22389 Optional second arg FACE specifies the face property to put on all
22390 characters for which no face is specified. The value nil means the
22391 default face. The value t means whatever face the window's mode line
22392 currently uses (either `mode-line' or `mode-line-inactive',
22393 depending on whether the window is the selected window or not).
22394 An integer value means the value string has no text
22397 Optional third and fourth args WINDOW and BUFFER specify the window
22398 and buffer to use as the context for the formatting (defaults
22399 are the selected window and the WINDOW's buffer). */)
22400 (Lisp_Object format
, Lisp_Object face
,
22401 Lisp_Object window
, Lisp_Object buffer
)
22406 struct buffer
*old_buffer
= NULL
;
22408 int no_props
= INTEGERP (face
);
22409 ptrdiff_t count
= SPECPDL_INDEX ();
22411 int string_start
= 0;
22413 w
= decode_any_window (window
);
22414 XSETWINDOW (window
, w
);
22417 buffer
= w
->contents
;
22418 CHECK_BUFFER (buffer
);
22420 /* Make formatting the modeline a non-op when noninteractive, otherwise
22421 there will be problems later caused by a partially initialized frame. */
22422 if (NILP (format
) || noninteractive
)
22423 return empty_unibyte_string
;
22428 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22429 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22430 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22431 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22432 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22433 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22434 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22437 old_buffer
= current_buffer
;
22439 /* Save things including mode_line_proptrans_alist,
22440 and set that to nil so that we don't alter the outer value. */
22441 record_unwind_protect (unwind_format_mode_line
,
22442 format_mode_line_unwind_data
22443 (XFRAME (WINDOW_FRAME (w
)),
22444 old_buffer
, selected_window
, 1));
22445 mode_line_proptrans_alist
= Qnil
;
22447 Fselect_window (window
, Qt
);
22448 set_buffer_internal_1 (XBUFFER (buffer
));
22450 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22454 mode_line_target
= MODE_LINE_NOPROP
;
22455 mode_line_string_face_prop
= Qnil
;
22456 mode_line_string_list
= Qnil
;
22457 string_start
= MODE_LINE_NOPROP_LEN (0);
22461 mode_line_target
= MODE_LINE_STRING
;
22462 mode_line_string_list
= Qnil
;
22463 mode_line_string_face
= face
;
22464 mode_line_string_face_prop
22465 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22468 push_kboard (FRAME_KBOARD (it
.f
));
22469 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22474 len
= MODE_LINE_NOPROP_LEN (string_start
);
22475 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22479 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22480 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22481 empty_unibyte_string
);
22484 unbind_to (count
, Qnil
);
22488 /* Write a null-terminated, right justified decimal representation of
22489 the positive integer D to BUF using a minimal field width WIDTH. */
22492 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22494 register char *p
= buf
;
22502 *p
++ = d
% 10 + '0';
22507 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22518 /* Write a null-terminated, right justified decimal and "human
22519 readable" representation of the nonnegative integer D to BUF using
22520 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22522 static const char power_letter
[] =
22536 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22538 /* We aim to represent the nonnegative integer D as
22539 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22540 ptrdiff_t quotient
= d
;
22542 /* -1 means: do not use TENTHS. */
22546 /* Length of QUOTIENT.TENTHS as a string. */
22552 if (quotient
>= 1000)
22554 /* Scale to the appropriate EXPONENT. */
22557 remainder
= quotient
% 1000;
22561 while (quotient
>= 1000);
22563 /* Round to nearest and decide whether to use TENTHS or not. */
22566 tenths
= remainder
/ 100;
22567 if (remainder
% 100 >= 50)
22574 if (quotient
== 10)
22582 if (remainder
>= 500)
22584 if (quotient
< 999)
22595 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22596 if (tenths
== -1 && quotient
<= 99)
22603 p
= psuffix
= buf
+ max (width
, length
);
22605 /* Print EXPONENT. */
22606 *psuffix
++ = power_letter
[exponent
];
22609 /* Print TENTHS. */
22612 *--p
= '0' + tenths
;
22616 /* Print QUOTIENT. */
22619 int digit
= quotient
% 10;
22620 *--p
= '0' + digit
;
22622 while ((quotient
/= 10) != 0);
22624 /* Print leading spaces. */
22629 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22630 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22631 type of CODING_SYSTEM. Return updated pointer into BUF. */
22633 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22636 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22639 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22640 const unsigned char *eol_str
;
22642 /* The EOL conversion we are using. */
22643 Lisp_Object eoltype
;
22645 val
= CODING_SYSTEM_SPEC (coding_system
);
22648 if (!VECTORP (val
)) /* Not yet decided. */
22650 *buf
++ = multibyte
? '-' : ' ';
22652 eoltype
= eol_mnemonic_undecided
;
22653 /* Don't mention EOL conversion if it isn't decided. */
22658 Lisp_Object eolvalue
;
22660 attrs
= AREF (val
, 0);
22661 eolvalue
= AREF (val
, 2);
22664 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22669 /* The EOL conversion that is normal on this system. */
22671 if (NILP (eolvalue
)) /* Not yet decided. */
22672 eoltype
= eol_mnemonic_undecided
;
22673 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22674 eoltype
= eol_mnemonic_undecided
;
22675 else /* eolvalue is Qunix, Qdos, or Qmac. */
22676 eoltype
= (EQ (eolvalue
, Qunix
)
22677 ? eol_mnemonic_unix
22678 : (EQ (eolvalue
, Qdos
) == 1
22679 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22685 /* Mention the EOL conversion if it is not the usual one. */
22686 if (STRINGP (eoltype
))
22688 eol_str
= SDATA (eoltype
);
22689 eol_str_len
= SBYTES (eoltype
);
22691 else if (CHARACTERP (eoltype
))
22693 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22694 int c
= XFASTINT (eoltype
);
22695 eol_str_len
= CHAR_STRING (c
, tmp
);
22700 eol_str
= invalid_eol_type
;
22701 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22703 memcpy (buf
, eol_str
, eol_str_len
);
22704 buf
+= eol_str_len
;
22710 /* Return a string for the output of a mode line %-spec for window W,
22711 generated by character C. FIELD_WIDTH > 0 means pad the string
22712 returned with spaces to that value. Return a Lisp string in
22713 *STRING if the resulting string is taken from that Lisp string.
22715 Note we operate on the current buffer for most purposes. */
22717 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22719 static const char *
22720 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22721 Lisp_Object
*string
)
22724 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22725 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22726 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22727 produce strings from numerical values, so limit preposterously
22728 large values of FIELD_WIDTH to avoid overrunning the buffer's
22729 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22730 bytes plus the terminating null. */
22731 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22732 struct buffer
*b
= current_buffer
;
22740 if (!NILP (BVAR (b
, read_only
)))
22742 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22747 /* This differs from %* only for a modified read-only buffer. */
22748 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22750 if (!NILP (BVAR (b
, read_only
)))
22755 /* This differs from %* in ignoring read-only-ness. */
22756 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22768 if (command_loop_level
> 5)
22770 p
= decode_mode_spec_buf
;
22771 for (i
= 0; i
< command_loop_level
; i
++)
22774 return decode_mode_spec_buf
;
22782 if (command_loop_level
> 5)
22784 p
= decode_mode_spec_buf
;
22785 for (i
= 0; i
< command_loop_level
; i
++)
22788 return decode_mode_spec_buf
;
22795 /* Let lots_of_dashes be a string of infinite length. */
22796 if (mode_line_target
== MODE_LINE_NOPROP
22797 || mode_line_target
== MODE_LINE_STRING
)
22799 if (field_width
<= 0
22800 || field_width
> sizeof (lots_of_dashes
))
22802 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22803 decode_mode_spec_buf
[i
] = '-';
22804 decode_mode_spec_buf
[i
] = '\0';
22805 return decode_mode_spec_buf
;
22808 return lots_of_dashes
;
22812 obj
= BVAR (b
, name
);
22816 /* %c and %l are ignored in `frame-title-format'.
22817 (In redisplay_internal, the frame title is drawn _before_ the
22818 windows are updated, so the stuff which depends on actual
22819 window contents (such as %l) may fail to render properly, or
22820 even crash emacs.) */
22821 if (mode_line_target
== MODE_LINE_TITLE
)
22825 ptrdiff_t col
= current_column ();
22826 w
->column_number_displayed
= col
;
22827 pint2str (decode_mode_spec_buf
, width
, col
);
22828 return decode_mode_spec_buf
;
22832 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
22834 if (NILP (Vmemory_full
))
22837 return "!MEM FULL! ";
22844 /* %F displays the frame name. */
22845 if (!NILP (f
->title
))
22846 return SSDATA (f
->title
);
22847 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22848 return SSDATA (f
->name
);
22852 obj
= BVAR (b
, filename
);
22857 ptrdiff_t size
= ZV
- BEGV
;
22858 pint2str (decode_mode_spec_buf
, width
, size
);
22859 return decode_mode_spec_buf
;
22864 ptrdiff_t size
= ZV
- BEGV
;
22865 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22866 return decode_mode_spec_buf
;
22871 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22872 ptrdiff_t topline
, nlines
, height
;
22875 /* %c and %l are ignored in `frame-title-format'. */
22876 if (mode_line_target
== MODE_LINE_TITLE
)
22879 startpos
= marker_position (w
->start
);
22880 startpos_byte
= marker_byte_position (w
->start
);
22881 height
= WINDOW_TOTAL_LINES (w
);
22883 /* If we decided that this buffer isn't suitable for line numbers,
22884 don't forget that too fast. */
22885 if (w
->base_line_pos
== -1)
22888 /* If the buffer is very big, don't waste time. */
22889 if (INTEGERP (Vline_number_display_limit
)
22890 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22892 w
->base_line_pos
= 0;
22893 w
->base_line_number
= 0;
22897 if (w
->base_line_number
> 0
22898 && w
->base_line_pos
> 0
22899 && w
->base_line_pos
<= startpos
)
22901 line
= w
->base_line_number
;
22902 linepos
= w
->base_line_pos
;
22903 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22908 linepos
= BUF_BEGV (b
);
22909 linepos_byte
= BUF_BEGV_BYTE (b
);
22912 /* Count lines from base line to window start position. */
22913 nlines
= display_count_lines (linepos_byte
,
22917 topline
= nlines
+ line
;
22919 /* Determine a new base line, if the old one is too close
22920 or too far away, or if we did not have one.
22921 "Too close" means it's plausible a scroll-down would
22922 go back past it. */
22923 if (startpos
== BUF_BEGV (b
))
22925 w
->base_line_number
= topline
;
22926 w
->base_line_pos
= BUF_BEGV (b
);
22928 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22929 || linepos
== BUF_BEGV (b
))
22931 ptrdiff_t limit
= BUF_BEGV (b
);
22932 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22933 ptrdiff_t position
;
22934 ptrdiff_t distance
=
22935 (height
* 2 + 30) * line_number_display_limit_width
;
22937 if (startpos
- distance
> limit
)
22939 limit
= startpos
- distance
;
22940 limit_byte
= CHAR_TO_BYTE (limit
);
22943 nlines
= display_count_lines (startpos_byte
,
22945 - (height
* 2 + 30),
22947 /* If we couldn't find the lines we wanted within
22948 line_number_display_limit_width chars per line,
22949 give up on line numbers for this window. */
22950 if (position
== limit_byte
&& limit
== startpos
- distance
)
22952 w
->base_line_pos
= -1;
22953 w
->base_line_number
= 0;
22957 w
->base_line_number
= topline
- nlines
;
22958 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22961 /* Now count lines from the start pos to point. */
22962 nlines
= display_count_lines (startpos_byte
,
22963 PT_BYTE
, PT
, &junk
);
22965 /* Record that we did display the line number. */
22966 line_number_displayed
= 1;
22968 /* Make the string to show. */
22969 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22970 return decode_mode_spec_buf
;
22973 char *p
= decode_mode_spec_buf
;
22974 int pad
= width
- 2;
22980 return decode_mode_spec_buf
;
22986 obj
= BVAR (b
, mode_name
);
22990 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22996 ptrdiff_t pos
= marker_position (w
->start
);
22997 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22999 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23001 if (pos
<= BUF_BEGV (b
))
23006 else if (pos
<= BUF_BEGV (b
))
23010 if (total
> 1000000)
23011 /* Do it differently for a large value, to avoid overflow. */
23012 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23014 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23015 /* We can't normally display a 3-digit number,
23016 so get us a 2-digit number that is close. */
23019 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23020 return decode_mode_spec_buf
;
23024 /* Display percentage of size above the bottom of the screen. */
23027 ptrdiff_t toppos
= marker_position (w
->start
);
23028 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23029 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23031 if (botpos
>= BUF_ZV (b
))
23033 if (toppos
<= BUF_BEGV (b
))
23040 if (total
> 1000000)
23041 /* Do it differently for a large value, to avoid overflow. */
23042 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23044 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23045 /* We can't normally display a 3-digit number,
23046 so get us a 2-digit number that is close. */
23049 if (toppos
<= BUF_BEGV (b
))
23050 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23052 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23053 return decode_mode_spec_buf
;
23058 /* status of process */
23059 obj
= Fget_buffer_process (Fcurrent_buffer ());
23061 return "no process";
23063 obj
= Fsymbol_name (Fprocess_status (obj
));
23069 ptrdiff_t count
= inhibit_garbage_collection ();
23070 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23071 Lisp_Object val
= Qnil
;
23073 if (STRINGP (curdir
))
23074 val
= call1 (intern ("file-remote-p"), curdir
);
23076 unbind_to (count
, Qnil
);
23085 /* coding-system (not including end-of-line format) */
23087 /* coding-system (including end-of-line type) */
23089 int eol_flag
= (c
== 'Z');
23090 char *p
= decode_mode_spec_buf
;
23092 if (! FRAME_WINDOW_P (f
))
23094 /* No need to mention EOL here--the terminal never needs
23095 to do EOL conversion. */
23096 p
= decode_mode_spec_coding (CODING_ID_NAME
23097 (FRAME_KEYBOARD_CODING (f
)->id
),
23099 p
= decode_mode_spec_coding (CODING_ID_NAME
23100 (FRAME_TERMINAL_CODING (f
)->id
),
23103 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23106 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23107 #ifdef subprocesses
23108 obj
= Fget_buffer_process (Fcurrent_buffer ());
23109 if (PROCESSP (obj
))
23111 p
= decode_mode_spec_coding
23112 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23113 p
= decode_mode_spec_coding
23114 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23116 #endif /* subprocesses */
23119 return decode_mode_spec_buf
;
23126 return SSDATA (obj
);
23133 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23134 means count lines back from START_BYTE. But don't go beyond
23135 LIMIT_BYTE. Return the number of lines thus found (always
23138 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23139 either the position COUNT lines after/before START_BYTE, if we
23140 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23144 display_count_lines (ptrdiff_t start_byte
,
23145 ptrdiff_t limit_byte
, ptrdiff_t count
,
23146 ptrdiff_t *byte_pos_ptr
)
23148 register unsigned char *cursor
;
23149 unsigned char *base
;
23151 register ptrdiff_t ceiling
;
23152 register unsigned char *ceiling_addr
;
23153 ptrdiff_t orig_count
= count
;
23155 /* If we are not in selective display mode,
23156 check only for newlines. */
23157 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23158 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23162 while (start_byte
< limit_byte
)
23164 ceiling
= BUFFER_CEILING_OF (start_byte
);
23165 ceiling
= min (limit_byte
- 1, ceiling
);
23166 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23167 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23171 if (selective_display
)
23173 while (*cursor
!= '\n' && *cursor
!= 015
23174 && ++cursor
!= ceiling_addr
)
23176 if (cursor
== ceiling_addr
)
23181 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23190 start_byte
+= cursor
- base
;
23191 *byte_pos_ptr
= start_byte
;
23195 while (cursor
< ceiling_addr
);
23197 start_byte
+= ceiling_addr
- base
;
23202 while (start_byte
> limit_byte
)
23204 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23205 ceiling
= max (limit_byte
, ceiling
);
23206 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23207 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23210 if (selective_display
)
23212 while (--cursor
>= ceiling_addr
23213 && *cursor
!= '\n' && *cursor
!= 015)
23215 if (cursor
< ceiling_addr
)
23220 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23227 start_byte
+= cursor
- base
+ 1;
23228 *byte_pos_ptr
= start_byte
;
23229 /* When scanning backwards, we should
23230 not count the newline posterior to which we stop. */
23231 return - orig_count
- 1;
23234 start_byte
+= ceiling_addr
- base
;
23238 *byte_pos_ptr
= limit_byte
;
23241 return - orig_count
+ count
;
23242 return orig_count
- count
;
23248 /***********************************************************************
23250 ***********************************************************************/
23252 /* Display a NUL-terminated string, starting with index START.
23254 If STRING is non-null, display that C string. Otherwise, the Lisp
23255 string LISP_STRING is displayed. There's a case that STRING is
23256 non-null and LISP_STRING is not nil. It means STRING is a string
23257 data of LISP_STRING. In that case, we display LISP_STRING while
23258 ignoring its text properties.
23260 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23261 FACE_STRING. Display STRING or LISP_STRING with the face at
23262 FACE_STRING_POS in FACE_STRING:
23264 Display the string in the environment given by IT, but use the
23265 standard display table, temporarily.
23267 FIELD_WIDTH is the minimum number of output glyphs to produce.
23268 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23269 with spaces. If STRING has more characters, more than FIELD_WIDTH
23270 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23272 PRECISION is the maximum number of characters to output from
23273 STRING. PRECISION < 0 means don't truncate the string.
23275 This is roughly equivalent to printf format specifiers:
23277 FIELD_WIDTH PRECISION PRINTF
23278 ----------------------------------------
23284 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23285 display them, and < 0 means obey the current buffer's value of
23286 enable_multibyte_characters.
23288 Value is the number of columns displayed. */
23291 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23292 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23293 int field_width
, int precision
, int max_x
, int multibyte
)
23295 int hpos_at_start
= it
->hpos
;
23296 int saved_face_id
= it
->face_id
;
23297 struct glyph_row
*row
= it
->glyph_row
;
23298 ptrdiff_t it_charpos
;
23300 /* Initialize the iterator IT for iteration over STRING beginning
23301 with index START. */
23302 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23303 precision
, field_width
, multibyte
);
23304 if (string
&& STRINGP (lisp_string
))
23305 /* LISP_STRING is the one returned by decode_mode_spec. We should
23306 ignore its text properties. */
23307 it
->stop_charpos
= it
->end_charpos
;
23309 /* If displaying STRING, set up the face of the iterator from
23310 FACE_STRING, if that's given. */
23311 if (STRINGP (face_string
))
23317 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23318 0, &endptr
, it
->base_face_id
, 0);
23319 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23320 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23323 /* Set max_x to the maximum allowed X position. Don't let it go
23324 beyond the right edge of the window. */
23326 max_x
= it
->last_visible_x
;
23328 max_x
= min (max_x
, it
->last_visible_x
);
23330 /* Skip over display elements that are not visible. because IT->w is
23332 if (it
->current_x
< it
->first_visible_x
)
23333 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23334 MOVE_TO_POS
| MOVE_TO_X
);
23336 row
->ascent
= it
->max_ascent
;
23337 row
->height
= it
->max_ascent
+ it
->max_descent
;
23338 row
->phys_ascent
= it
->max_phys_ascent
;
23339 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23340 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23342 if (STRINGP (it
->string
))
23343 it_charpos
= IT_STRING_CHARPOS (*it
);
23345 it_charpos
= IT_CHARPOS (*it
);
23347 /* This condition is for the case that we are called with current_x
23348 past last_visible_x. */
23349 while (it
->current_x
< max_x
)
23351 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23353 /* Get the next display element. */
23354 if (!get_next_display_element (it
))
23357 /* Produce glyphs. */
23358 x_before
= it
->current_x
;
23359 n_glyphs_before
= row
->used
[TEXT_AREA
];
23360 PRODUCE_GLYPHS (it
);
23362 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23365 while (i
< nglyphs
)
23367 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23369 if (it
->line_wrap
!= TRUNCATE
23370 && x
+ glyph
->pixel_width
> max_x
)
23372 /* End of continued line or max_x reached. */
23373 if (CHAR_GLYPH_PADDING_P (*glyph
))
23375 /* A wide character is unbreakable. */
23376 if (row
->reversed_p
)
23377 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23378 - n_glyphs_before
);
23379 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23380 it
->current_x
= x_before
;
23384 if (row
->reversed_p
)
23385 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23386 - (n_glyphs_before
+ i
));
23387 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23392 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23394 /* Glyph is at least partially visible. */
23396 if (x
< it
->first_visible_x
)
23397 row
->x
= x
- it
->first_visible_x
;
23401 /* Glyph is off the left margin of the display area.
23402 Should not happen. */
23406 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23407 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23408 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23409 row
->phys_height
= max (row
->phys_height
,
23410 it
->max_phys_ascent
+ it
->max_phys_descent
);
23411 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23412 it
->max_extra_line_spacing
);
23413 x
+= glyph
->pixel_width
;
23417 /* Stop if max_x reached. */
23421 /* Stop at line ends. */
23422 if (ITERATOR_AT_END_OF_LINE_P (it
))
23424 it
->continuation_lines_width
= 0;
23428 set_iterator_to_next (it
, 1);
23429 if (STRINGP (it
->string
))
23430 it_charpos
= IT_STRING_CHARPOS (*it
);
23432 it_charpos
= IT_CHARPOS (*it
);
23434 /* Stop if truncating at the right edge. */
23435 if (it
->line_wrap
== TRUNCATE
23436 && it
->current_x
>= it
->last_visible_x
)
23438 /* Add truncation mark, but don't do it if the line is
23439 truncated at a padding space. */
23440 if (it_charpos
< it
->string_nchars
)
23442 if (!FRAME_WINDOW_P (it
->f
))
23446 if (it
->current_x
> it
->last_visible_x
)
23448 if (!row
->reversed_p
)
23450 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23451 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23456 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23457 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23459 unproduce_glyphs (it
, ii
+ 1);
23460 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23462 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23464 row
->used
[TEXT_AREA
] = ii
;
23465 produce_special_glyphs (it
, IT_TRUNCATION
);
23468 produce_special_glyphs (it
, IT_TRUNCATION
);
23470 row
->truncated_on_right_p
= 1;
23476 /* Maybe insert a truncation at the left. */
23477 if (it
->first_visible_x
23480 if (!FRAME_WINDOW_P (it
->f
)
23481 || (row
->reversed_p
23482 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23483 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23484 insert_left_trunc_glyphs (it
);
23485 row
->truncated_on_left_p
= 1;
23488 it
->face_id
= saved_face_id
;
23490 /* Value is number of columns displayed. */
23491 return it
->hpos
- hpos_at_start
;
23496 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23497 appears as an element of LIST or as the car of an element of LIST.
23498 If PROPVAL is a list, compare each element against LIST in that
23499 way, and return 1/2 if any element of PROPVAL is found in LIST.
23500 Otherwise return 0. This function cannot quit.
23501 The return value is 2 if the text is invisible but with an ellipsis
23502 and 1 if it's invisible and without an ellipsis. */
23505 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23507 register Lisp_Object tail
, proptail
;
23509 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23511 register Lisp_Object tem
;
23513 if (EQ (propval
, tem
))
23515 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23516 return NILP (XCDR (tem
)) ? 1 : 2;
23519 if (CONSP (propval
))
23521 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23523 Lisp_Object propelt
;
23524 propelt
= XCAR (proptail
);
23525 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23527 register Lisp_Object tem
;
23529 if (EQ (propelt
, tem
))
23531 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23532 return NILP (XCDR (tem
)) ? 1 : 2;
23540 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23541 doc
: /* Non-nil if the property makes the text invisible.
23542 POS-OR-PROP can be a marker or number, in which case it is taken to be
23543 a position in the current buffer and the value of the `invisible' property
23544 is checked; or it can be some other value, which is then presumed to be the
23545 value of the `invisible' property of the text of interest.
23546 The non-nil value returned can be t for truly invisible text or something
23547 else if the text is replaced by an ellipsis. */)
23548 (Lisp_Object pos_or_prop
)
23551 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23552 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23554 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23555 return (invis
== 0 ? Qnil
23557 : make_number (invis
));
23560 /* Calculate a width or height in pixels from a specification using
23561 the following elements:
23564 NUM - a (fractional) multiple of the default font width/height
23565 (NUM) - specifies exactly NUM pixels
23566 UNIT - a fixed number of pixels, see below.
23567 ELEMENT - size of a display element in pixels, see below.
23568 (NUM . SPEC) - equals NUM * SPEC
23569 (+ SPEC SPEC ...) - add pixel values
23570 (- SPEC SPEC ...) - subtract pixel values
23571 (- SPEC) - negate pixel value
23574 INT or FLOAT - a number constant
23575 SYMBOL - use symbol's (buffer local) variable binding.
23578 in - pixels per inch *)
23579 mm - pixels per 1/1000 meter *)
23580 cm - pixels per 1/100 meter *)
23581 width - width of current font in pixels.
23582 height - height of current font in pixels.
23584 *) using the ratio(s) defined in display-pixels-per-inch.
23588 left-fringe - left fringe width in pixels
23589 right-fringe - right fringe width in pixels
23591 left-margin - left margin width in pixels
23592 right-margin - right margin width in pixels
23594 scroll-bar - scroll-bar area width in pixels
23598 Pixels corresponding to 5 inches:
23601 Total width of non-text areas on left side of window (if scroll-bar is on left):
23602 '(space :width (+ left-fringe left-margin scroll-bar))
23604 Align to first text column (in header line):
23605 '(space :align-to 0)
23607 Align to middle of text area minus half the width of variable `my-image'
23608 containing a loaded image:
23609 '(space :align-to (0.5 . (- text my-image)))
23611 Width of left margin minus width of 1 character in the default font:
23612 '(space :width (- left-margin 1))
23614 Width of left margin minus width of 2 characters in the current font:
23615 '(space :width (- left-margin (2 . width)))
23617 Center 1 character over left-margin (in header line):
23618 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23620 Different ways to express width of left fringe plus left margin minus one pixel:
23621 '(space :width (- (+ left-fringe left-margin) (1)))
23622 '(space :width (+ left-fringe left-margin (- (1))))
23623 '(space :width (+ left-fringe left-margin (-1)))
23628 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23629 struct font
*font
, int width_p
, int *align_to
)
23633 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23634 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23637 return OK_PIXELS (0);
23639 eassert (FRAME_LIVE_P (it
->f
));
23641 if (SYMBOLP (prop
))
23643 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23645 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23647 if (unit
[0] == 'i' && unit
[1] == 'n')
23649 else if (unit
[0] == 'm' && unit
[1] == 'm')
23651 else if (unit
[0] == 'c' && unit
[1] == 'm')
23657 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23658 : FRAME_RES_Y (it
->f
));
23661 return OK_PIXELS (ppi
/ pixels
);
23666 #ifdef HAVE_WINDOW_SYSTEM
23667 if (EQ (prop
, Qheight
))
23668 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23669 if (EQ (prop
, Qwidth
))
23670 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23672 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23673 return OK_PIXELS (1);
23676 if (EQ (prop
, Qtext
))
23677 return OK_PIXELS (width_p
23678 ? window_box_width (it
->w
, TEXT_AREA
)
23679 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23681 if (align_to
&& *align_to
< 0)
23684 if (EQ (prop
, Qleft
))
23685 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23686 if (EQ (prop
, Qright
))
23687 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23688 if (EQ (prop
, Qcenter
))
23689 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23690 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23691 if (EQ (prop
, Qleft_fringe
))
23692 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23693 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23694 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23695 if (EQ (prop
, Qright_fringe
))
23696 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23697 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23698 : window_box_right_offset (it
->w
, TEXT_AREA
));
23699 if (EQ (prop
, Qleft_margin
))
23700 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23701 if (EQ (prop
, Qright_margin
))
23702 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23703 if (EQ (prop
, Qscroll_bar
))
23704 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23706 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23707 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23708 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23713 if (EQ (prop
, Qleft_fringe
))
23714 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23715 if (EQ (prop
, Qright_fringe
))
23716 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23717 if (EQ (prop
, Qleft_margin
))
23718 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23719 if (EQ (prop
, Qright_margin
))
23720 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23721 if (EQ (prop
, Qscroll_bar
))
23722 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23725 prop
= buffer_local_value (prop
, it
->w
->contents
);
23726 if (EQ (prop
, Qunbound
))
23730 if (INTEGERP (prop
) || FLOATP (prop
))
23732 int base_unit
= (width_p
23733 ? FRAME_COLUMN_WIDTH (it
->f
)
23734 : FRAME_LINE_HEIGHT (it
->f
));
23735 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23740 Lisp_Object car
= XCAR (prop
);
23741 Lisp_Object cdr
= XCDR (prop
);
23745 #ifdef HAVE_WINDOW_SYSTEM
23746 if (FRAME_WINDOW_P (it
->f
)
23747 && valid_image_p (prop
))
23749 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23750 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23752 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23755 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23761 while (CONSP (cdr
))
23763 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23764 font
, width_p
, align_to
))
23767 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23772 if (EQ (car
, Qminus
))
23774 return OK_PIXELS (pixels
);
23777 car
= buffer_local_value (car
, it
->w
->contents
);
23778 if (EQ (car
, Qunbound
))
23782 if (INTEGERP (car
) || FLOATP (car
))
23785 pixels
= XFLOATINT (car
);
23787 return OK_PIXELS (pixels
);
23788 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23789 font
, width_p
, align_to
))
23790 return OK_PIXELS (pixels
* fact
);
23801 /***********************************************************************
23803 ***********************************************************************/
23805 #ifdef HAVE_WINDOW_SYSTEM
23810 dump_glyph_string (struct glyph_string
*s
)
23812 fprintf (stderr
, "glyph string\n");
23813 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23814 s
->x
, s
->y
, s
->width
, s
->height
);
23815 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23816 fprintf (stderr
, " hl = %d\n", s
->hl
);
23817 fprintf (stderr
, " left overhang = %d, right = %d\n",
23818 s
->left_overhang
, s
->right_overhang
);
23819 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23820 fprintf (stderr
, " extends to end of line = %d\n",
23821 s
->extends_to_end_of_line_p
);
23822 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23823 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23826 #endif /* GLYPH_DEBUG */
23828 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23829 of XChar2b structures for S; it can't be allocated in
23830 init_glyph_string because it must be allocated via `alloca'. W
23831 is the window on which S is drawn. ROW and AREA are the glyph row
23832 and area within the row from which S is constructed. START is the
23833 index of the first glyph structure covered by S. HL is a
23834 face-override for drawing S. */
23837 #define OPTIONAL_HDC(hdc) HDC hdc,
23838 #define DECLARE_HDC(hdc) HDC hdc;
23839 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23840 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23843 #ifndef OPTIONAL_HDC
23844 #define OPTIONAL_HDC(hdc)
23845 #define DECLARE_HDC(hdc)
23846 #define ALLOCATE_HDC(hdc, f)
23847 #define RELEASE_HDC(hdc, f)
23851 init_glyph_string (struct glyph_string
*s
,
23853 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23854 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23856 memset (s
, 0, sizeof *s
);
23858 s
->f
= XFRAME (w
->frame
);
23862 s
->display
= FRAME_X_DISPLAY (s
->f
);
23863 s
->window
= FRAME_X_WINDOW (s
->f
);
23864 s
->char2b
= char2b
;
23868 s
->first_glyph
= row
->glyphs
[area
] + start
;
23869 s
->height
= row
->height
;
23870 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23871 s
->ybase
= s
->y
+ row
->ascent
;
23875 /* Append the list of glyph strings with head H and tail T to the list
23876 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23879 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23880 struct glyph_string
*h
, struct glyph_string
*t
)
23894 /* Prepend the list of glyph strings with head H and tail T to the
23895 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23899 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23900 struct glyph_string
*h
, struct glyph_string
*t
)
23914 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23915 Set *HEAD and *TAIL to the resulting list. */
23918 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23919 struct glyph_string
*s
)
23921 s
->next
= s
->prev
= NULL
;
23922 append_glyph_string_lists (head
, tail
, s
, s
);
23926 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23927 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23928 make sure that X resources for the face returned are allocated.
23929 Value is a pointer to a realized face that is ready for display if
23930 DISPLAY_P is non-zero. */
23932 static struct face
*
23933 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23934 XChar2b
*char2b
, int display_p
)
23936 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23941 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23943 if (code
== FONT_INVALID_CODE
)
23946 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23948 /* Make sure X resources of the face are allocated. */
23949 #ifdef HAVE_X_WINDOWS
23953 eassert (face
!= NULL
);
23954 prepare_face_for_display (f
, face
);
23961 /* Get face and two-byte form of character glyph GLYPH on frame F.
23962 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23963 a pointer to a realized face that is ready for display. */
23965 static struct face
*
23966 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23967 XChar2b
*char2b
, int *two_byte_p
)
23972 eassert (glyph
->type
== CHAR_GLYPH
);
23973 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23975 /* Make sure X resources of the face are allocated. */
23976 eassert (face
!= NULL
);
23977 prepare_face_for_display (f
, face
);
23984 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23985 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23987 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23989 if (code
== FONT_INVALID_CODE
)
23993 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23998 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23999 Return 1 if FONT has a glyph for C, otherwise return 0. */
24002 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24006 if (CHAR_BYTE8_P (c
))
24007 code
= CHAR_TO_BYTE8 (c
);
24009 code
= font
->driver
->encode_char (font
, c
);
24011 if (code
== FONT_INVALID_CODE
)
24013 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24018 /* Fill glyph string S with composition components specified by S->cmp.
24020 BASE_FACE is the base face of the composition.
24021 S->cmp_from is the index of the first component for S.
24023 OVERLAPS non-zero means S should draw the foreground only, and use
24024 its physical height for clipping. See also draw_glyphs.
24026 Value is the index of a component not in S. */
24029 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24033 /* For all glyphs of this composition, starting at the offset
24034 S->cmp_from, until we reach the end of the definition or encounter a
24035 glyph that requires the different face, add it to S. */
24040 s
->for_overlaps
= overlaps
;
24043 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24045 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24047 /* TAB in a composition means display glyphs with padding space
24048 on the left or right. */
24051 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24054 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24061 s
->font
= s
->face
->font
;
24063 else if (s
->face
!= face
)
24071 if (s
->face
== NULL
)
24073 s
->face
= base_face
->ascii_face
;
24074 s
->font
= s
->face
->font
;
24077 /* All glyph strings for the same composition has the same width,
24078 i.e. the width set for the first component of the composition. */
24079 s
->width
= s
->first_glyph
->pixel_width
;
24081 /* If the specified font could not be loaded, use the frame's
24082 default font, but record the fact that we couldn't load it in
24083 the glyph string so that we can draw rectangles for the
24084 characters of the glyph string. */
24085 if (s
->font
== NULL
)
24087 s
->font_not_found_p
= 1;
24088 s
->font
= FRAME_FONT (s
->f
);
24091 /* Adjust base line for subscript/superscript text. */
24092 s
->ybase
+= s
->first_glyph
->voffset
;
24094 /* This glyph string must always be drawn with 16-bit functions. */
24101 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24102 int start
, int end
, int overlaps
)
24104 struct glyph
*glyph
, *last
;
24105 Lisp_Object lgstring
;
24108 s
->for_overlaps
= overlaps
;
24109 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24110 last
= s
->row
->glyphs
[s
->area
] + end
;
24111 s
->cmp_id
= glyph
->u
.cmp
.id
;
24112 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24113 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24114 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24115 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24116 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24118 while (glyph
< last
24119 && glyph
->u
.cmp
.automatic
24120 && glyph
->u
.cmp
.id
== s
->cmp_id
24121 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24122 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24124 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24126 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24127 unsigned code
= LGLYPH_CODE (lglyph
);
24129 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24131 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24132 return glyph
- s
->row
->glyphs
[s
->area
];
24136 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24137 See the comment of fill_glyph_string for arguments.
24138 Value is the index of the first glyph not in S. */
24142 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24143 int start
, int end
, int overlaps
)
24145 struct glyph
*glyph
, *last
;
24148 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24149 s
->for_overlaps
= overlaps
;
24150 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24151 last
= s
->row
->glyphs
[s
->area
] + end
;
24152 voffset
= glyph
->voffset
;
24153 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24154 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24156 s
->width
= glyph
->pixel_width
;
24158 while (glyph
< last
24159 && glyph
->type
== GLYPHLESS_GLYPH
24160 && glyph
->voffset
== voffset
24161 && glyph
->face_id
== face_id
)
24164 s
->width
+= glyph
->pixel_width
;
24167 s
->ybase
+= voffset
;
24168 return glyph
- s
->row
->glyphs
[s
->area
];
24172 /* Fill glyph string S from a sequence of character glyphs.
24174 FACE_ID is the face id of the string. START is the index of the
24175 first glyph to consider, END is the index of the last + 1.
24176 OVERLAPS non-zero means S should draw the foreground only, and use
24177 its physical height for clipping. See also draw_glyphs.
24179 Value is the index of the first glyph not in S. */
24182 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24183 int start
, int end
, int overlaps
)
24185 struct glyph
*glyph
, *last
;
24187 int glyph_not_available_p
;
24189 eassert (s
->f
== XFRAME (s
->w
->frame
));
24190 eassert (s
->nchars
== 0);
24191 eassert (start
>= 0 && end
> start
);
24193 s
->for_overlaps
= overlaps
;
24194 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24195 last
= s
->row
->glyphs
[s
->area
] + end
;
24196 voffset
= glyph
->voffset
;
24197 s
->padding_p
= glyph
->padding_p
;
24198 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24200 while (glyph
< last
24201 && glyph
->type
== CHAR_GLYPH
24202 && glyph
->voffset
== voffset
24203 /* Same face id implies same font, nowadays. */
24204 && glyph
->face_id
== face_id
24205 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24209 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24210 s
->char2b
+ s
->nchars
,
24212 s
->two_byte_p
= two_byte_p
;
24214 eassert (s
->nchars
<= end
- start
);
24215 s
->width
+= glyph
->pixel_width
;
24216 if (glyph
++->padding_p
!= s
->padding_p
)
24220 s
->font
= s
->face
->font
;
24222 /* If the specified font could not be loaded, use the frame's font,
24223 but record the fact that we couldn't load it in
24224 S->font_not_found_p so that we can draw rectangles for the
24225 characters of the glyph string. */
24226 if (s
->font
== NULL
|| glyph_not_available_p
)
24228 s
->font_not_found_p
= 1;
24229 s
->font
= FRAME_FONT (s
->f
);
24232 /* Adjust base line for subscript/superscript text. */
24233 s
->ybase
+= voffset
;
24235 eassert (s
->face
&& s
->face
->gc
);
24236 return glyph
- s
->row
->glyphs
[s
->area
];
24240 /* Fill glyph string S from image glyph S->first_glyph. */
24243 fill_image_glyph_string (struct glyph_string
*s
)
24245 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24246 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24248 s
->slice
= s
->first_glyph
->slice
.img
;
24249 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24250 s
->font
= s
->face
->font
;
24251 s
->width
= s
->first_glyph
->pixel_width
;
24253 /* Adjust base line for subscript/superscript text. */
24254 s
->ybase
+= s
->first_glyph
->voffset
;
24258 /* Fill glyph string S from a sequence of stretch glyphs.
24260 START is the index of the first glyph to consider,
24261 END is the index of the last + 1.
24263 Value is the index of the first glyph not in S. */
24266 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24268 struct glyph
*glyph
, *last
;
24269 int voffset
, face_id
;
24271 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24273 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24274 last
= s
->row
->glyphs
[s
->area
] + end
;
24275 face_id
= glyph
->face_id
;
24276 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24277 s
->font
= s
->face
->font
;
24278 s
->width
= glyph
->pixel_width
;
24280 voffset
= glyph
->voffset
;
24284 && glyph
->type
== STRETCH_GLYPH
24285 && glyph
->voffset
== voffset
24286 && glyph
->face_id
== face_id
);
24288 s
->width
+= glyph
->pixel_width
;
24290 /* Adjust base line for subscript/superscript text. */
24291 s
->ybase
+= voffset
;
24293 /* The case that face->gc == 0 is handled when drawing the glyph
24294 string by calling prepare_face_for_display. */
24296 return glyph
- s
->row
->glyphs
[s
->area
];
24299 static struct font_metrics
*
24300 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24302 static struct font_metrics metrics
;
24307 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24308 if (code
== FONT_INVALID_CODE
)
24310 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24315 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24316 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24317 assumed to be zero. */
24320 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24322 *left
= *right
= 0;
24324 if (glyph
->type
== CHAR_GLYPH
)
24328 struct font_metrics
*pcm
;
24330 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24331 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24333 if (pcm
->rbearing
> pcm
->width
)
24334 *right
= pcm
->rbearing
- pcm
->width
;
24335 if (pcm
->lbearing
< 0)
24336 *left
= -pcm
->lbearing
;
24339 else if (glyph
->type
== COMPOSITE_GLYPH
)
24341 if (! glyph
->u
.cmp
.automatic
)
24343 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24345 if (cmp
->rbearing
> cmp
->pixel_width
)
24346 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24347 if (cmp
->lbearing
< 0)
24348 *left
= - cmp
->lbearing
;
24352 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24353 struct font_metrics metrics
;
24355 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24356 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24357 if (metrics
.rbearing
> metrics
.width
)
24358 *right
= metrics
.rbearing
- metrics
.width
;
24359 if (metrics
.lbearing
< 0)
24360 *left
= - metrics
.lbearing
;
24366 /* Return the index of the first glyph preceding glyph string S that
24367 is overwritten by S because of S's left overhang. Value is -1
24368 if no glyphs are overwritten. */
24371 left_overwritten (struct glyph_string
*s
)
24375 if (s
->left_overhang
)
24378 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24379 int first
= s
->first_glyph
- glyphs
;
24381 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24382 x
-= glyphs
[i
].pixel_width
;
24393 /* Return the index of the first glyph preceding glyph string S that
24394 is overwriting S because of its right overhang. Value is -1 if no
24395 glyph in front of S overwrites S. */
24398 left_overwriting (struct glyph_string
*s
)
24401 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24402 int first
= s
->first_glyph
- glyphs
;
24406 for (i
= first
- 1; i
>= 0; --i
)
24409 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24412 x
-= glyphs
[i
].pixel_width
;
24419 /* Return the index of the last glyph following glyph string S that is
24420 overwritten by S because of S's right overhang. Value is -1 if
24421 no such glyph is found. */
24424 right_overwritten (struct glyph_string
*s
)
24428 if (s
->right_overhang
)
24431 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24432 int first
= (s
->first_glyph
- glyphs
24433 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24434 int end
= s
->row
->used
[s
->area
];
24436 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24437 x
+= glyphs
[i
].pixel_width
;
24446 /* Return the index of the last glyph following glyph string S that
24447 overwrites S because of its left overhang. Value is negative
24448 if no such glyph is found. */
24451 right_overwriting (struct glyph_string
*s
)
24454 int end
= s
->row
->used
[s
->area
];
24455 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24456 int first
= (s
->first_glyph
- glyphs
24457 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24461 for (i
= first
; i
< end
; ++i
)
24464 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24467 x
+= glyphs
[i
].pixel_width
;
24474 /* Set background width of glyph string S. START is the index of the
24475 first glyph following S. LAST_X is the right-most x-position + 1
24476 in the drawing area. */
24479 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24481 /* If the face of this glyph string has to be drawn to the end of
24482 the drawing area, set S->extends_to_end_of_line_p. */
24484 if (start
== s
->row
->used
[s
->area
]
24485 && ((s
->row
->fill_line_p
24486 && (s
->hl
== DRAW_NORMAL_TEXT
24487 || s
->hl
== DRAW_IMAGE_RAISED
24488 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24489 || s
->hl
== DRAW_MOUSE_FACE
))
24490 s
->extends_to_end_of_line_p
= 1;
24492 /* If S extends its face to the end of the line, set its
24493 background_width to the distance to the right edge of the drawing
24495 if (s
->extends_to_end_of_line_p
)
24496 s
->background_width
= last_x
- s
->x
+ 1;
24498 s
->background_width
= s
->width
;
24502 /* Compute overhangs and x-positions for glyph string S and its
24503 predecessors, or successors. X is the starting x-position for S.
24504 BACKWARD_P non-zero means process predecessors. */
24507 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24513 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24514 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24524 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24525 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24535 /* The following macros are only called from draw_glyphs below.
24536 They reference the following parameters of that function directly:
24537 `w', `row', `area', and `overlap_p'
24538 as well as the following local variables:
24539 `s', `f', and `hdc' (in W32) */
24542 /* On W32, silently add local `hdc' variable to argument list of
24543 init_glyph_string. */
24544 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24545 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24547 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24548 init_glyph_string (s, char2b, w, row, area, start, hl)
24551 /* Add a glyph string for a stretch glyph to the list of strings
24552 between HEAD and TAIL. START is the index of the stretch glyph in
24553 row area AREA of glyph row ROW. END is the index of the last glyph
24554 in that glyph row area. X is the current output position assigned
24555 to the new glyph string constructed. HL overrides that face of the
24556 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24557 is the right-most x-position of the drawing area. */
24559 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24560 and below -- keep them on one line. */
24561 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24564 s = alloca (sizeof *s); \
24565 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24566 START = fill_stretch_glyph_string (s, START, END); \
24567 append_glyph_string (&HEAD, &TAIL, s); \
24573 /* Add a glyph string for an image glyph to the list of strings
24574 between HEAD and TAIL. START is the index of the image glyph in
24575 row area AREA of glyph row ROW. END is the index of the last glyph
24576 in that glyph row area. X is the current output position assigned
24577 to the new glyph string constructed. HL overrides that face of the
24578 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24579 is the right-most x-position of the drawing area. */
24581 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24584 s = alloca (sizeof *s); \
24585 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24586 fill_image_glyph_string (s); \
24587 append_glyph_string (&HEAD, &TAIL, s); \
24594 /* Add a glyph string for a sequence of character glyphs to the list
24595 of strings between HEAD and TAIL. START is the index of the first
24596 glyph in row area AREA of glyph row ROW that is part of the new
24597 glyph string. END is the index of the last glyph in that glyph row
24598 area. X is the current output position assigned to the new glyph
24599 string constructed. HL overrides that face of the glyph; e.g. it
24600 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24601 right-most x-position of the drawing area. */
24603 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24609 face_id = (row)->glyphs[area][START].face_id; \
24611 s = alloca (sizeof *s); \
24612 char2b = alloca ((END - START) * sizeof *char2b); \
24613 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24614 append_glyph_string (&HEAD, &TAIL, s); \
24616 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24621 /* Add a glyph string for a composite sequence to the list of strings
24622 between HEAD and TAIL. START is the index of the first glyph in
24623 row area AREA of glyph row ROW that is part of the new glyph
24624 string. END is the index of the last glyph in that glyph row area.
24625 X is the current output position assigned to the new glyph string
24626 constructed. HL overrides that face of the glyph; e.g. it is
24627 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24628 x-position of the drawing area. */
24630 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24632 int face_id = (row)->glyphs[area][START].face_id; \
24633 struct face *base_face = FACE_FROM_ID (f, face_id); \
24634 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24635 struct composition *cmp = composition_table[cmp_id]; \
24637 struct glyph_string *first_s = NULL; \
24640 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24642 /* Make glyph_strings for each glyph sequence that is drawable by \
24643 the same face, and append them to HEAD/TAIL. */ \
24644 for (n = 0; n < cmp->glyph_len;) \
24646 s = alloca (sizeof *s); \
24647 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24648 append_glyph_string (&(HEAD), &(TAIL), s); \
24654 n = fill_composite_glyph_string (s, base_face, overlaps); \
24662 /* Add a glyph string for a glyph-string sequence to the list of strings
24663 between HEAD and TAIL. */
24665 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24669 Lisp_Object gstring; \
24671 face_id = (row)->glyphs[area][START].face_id; \
24672 gstring = (composition_gstring_from_id \
24673 ((row)->glyphs[area][START].u.cmp.id)); \
24674 s = alloca (sizeof *s); \
24675 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24676 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24677 append_glyph_string (&(HEAD), &(TAIL), s); \
24679 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24683 /* Add a glyph string for a sequence of glyphless character's glyphs
24684 to the list of strings between HEAD and TAIL. The meanings of
24685 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24687 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24692 face_id = (row)->glyphs[area][START].face_id; \
24694 s = alloca (sizeof *s); \
24695 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24696 append_glyph_string (&HEAD, &TAIL, s); \
24698 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24704 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24705 of AREA of glyph row ROW on window W between indices START and END.
24706 HL overrides the face for drawing glyph strings, e.g. it is
24707 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24708 x-positions of the drawing area.
24710 This is an ugly monster macro construct because we must use alloca
24711 to allocate glyph strings (because draw_glyphs can be called
24712 asynchronously). */
24714 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24717 HEAD = TAIL = NULL; \
24718 while (START < END) \
24720 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24721 switch (first_glyph->type) \
24724 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24728 case COMPOSITE_GLYPH: \
24729 if (first_glyph->u.cmp.automatic) \
24730 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24733 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24737 case STRETCH_GLYPH: \
24738 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24742 case IMAGE_GLYPH: \
24743 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24747 case GLYPHLESS_GLYPH: \
24748 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24758 set_glyph_string_background_width (s, START, LAST_X); \
24765 /* Draw glyphs between START and END in AREA of ROW on window W,
24766 starting at x-position X. X is relative to AREA in W. HL is a
24767 face-override with the following meaning:
24769 DRAW_NORMAL_TEXT draw normally
24770 DRAW_CURSOR draw in cursor face
24771 DRAW_MOUSE_FACE draw in mouse face.
24772 DRAW_INVERSE_VIDEO draw in mode line face
24773 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24774 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24776 If OVERLAPS is non-zero, draw only the foreground of characters and
24777 clip to the physical height of ROW. Non-zero value also defines
24778 the overlapping part to be drawn:
24780 OVERLAPS_PRED overlap with preceding rows
24781 OVERLAPS_SUCC overlap with succeeding rows
24782 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24783 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24785 Value is the x-position reached, relative to AREA of W. */
24788 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24789 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24790 enum draw_glyphs_face hl
, int overlaps
)
24792 struct glyph_string
*head
, *tail
;
24793 struct glyph_string
*s
;
24794 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24795 int i
, j
, x_reached
, last_x
, area_left
= 0;
24796 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24799 ALLOCATE_HDC (hdc
, f
);
24801 /* Let's rather be paranoid than getting a SEGV. */
24802 end
= min (end
, row
->used
[area
]);
24803 start
= clip_to_bounds (0, start
, end
);
24805 /* Translate X to frame coordinates. Set last_x to the right
24806 end of the drawing area. */
24807 if (row
->full_width_p
)
24809 /* X is relative to the left edge of W, without scroll bars
24811 area_left
= WINDOW_LEFT_EDGE_X (w
);
24812 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24813 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24817 area_left
= window_box_left (w
, area
);
24818 last_x
= area_left
+ window_box_width (w
, area
);
24822 /* Build a doubly-linked list of glyph_string structures between
24823 head and tail from what we have to draw. Note that the macro
24824 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24825 the reason we use a separate variable `i'. */
24827 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24829 x_reached
= tail
->x
+ tail
->background_width
;
24833 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24834 the row, redraw some glyphs in front or following the glyph
24835 strings built above. */
24836 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24838 struct glyph_string
*h
, *t
;
24839 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24840 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24841 int check_mouse_face
= 0;
24844 /* If mouse highlighting is on, we may need to draw adjacent
24845 glyphs using mouse-face highlighting. */
24846 if (area
== TEXT_AREA
&& row
->mouse_face_p
24847 && hlinfo
->mouse_face_beg_row
>= 0
24848 && hlinfo
->mouse_face_end_row
>= 0)
24850 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24852 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24853 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24855 check_mouse_face
= 1;
24856 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24857 ? hlinfo
->mouse_face_beg_col
: 0;
24858 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24859 ? hlinfo
->mouse_face_end_col
24860 : row
->used
[TEXT_AREA
];
24864 /* Compute overhangs for all glyph strings. */
24865 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24866 for (s
= head
; s
; s
= s
->next
)
24867 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24869 /* Prepend glyph strings for glyphs in front of the first glyph
24870 string that are overwritten because of the first glyph
24871 string's left overhang. The background of all strings
24872 prepended must be drawn because the first glyph string
24874 i
= left_overwritten (head
);
24877 enum draw_glyphs_face overlap_hl
;
24879 /* If this row contains mouse highlighting, attempt to draw
24880 the overlapped glyphs with the correct highlight. This
24881 code fails if the overlap encompasses more than one glyph
24882 and mouse-highlight spans only some of these glyphs.
24883 However, making it work perfectly involves a lot more
24884 code, and I don't know if the pathological case occurs in
24885 practice, so we'll stick to this for now. --- cyd */
24886 if (check_mouse_face
24887 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24888 overlap_hl
= DRAW_MOUSE_FACE
;
24890 overlap_hl
= DRAW_NORMAL_TEXT
;
24892 if (hl
!= overlap_hl
)
24895 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24896 overlap_hl
, dummy_x
, last_x
);
24898 compute_overhangs_and_x (t
, head
->x
, 1);
24899 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24900 if (clip_head
== NULL
)
24904 /* Prepend glyph strings for glyphs in front of the first glyph
24905 string that overwrite that glyph string because of their
24906 right overhang. For these strings, only the foreground must
24907 be drawn, because it draws over the glyph string at `head'.
24908 The background must not be drawn because this would overwrite
24909 right overhangs of preceding glyphs for which no glyph
24911 i
= left_overwriting (head
);
24914 enum draw_glyphs_face overlap_hl
;
24916 if (check_mouse_face
24917 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24918 overlap_hl
= DRAW_MOUSE_FACE
;
24920 overlap_hl
= DRAW_NORMAL_TEXT
;
24922 if (hl
== overlap_hl
|| clip_head
== NULL
)
24924 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24925 overlap_hl
, dummy_x
, last_x
);
24926 for (s
= h
; s
; s
= s
->next
)
24927 s
->background_filled_p
= 1;
24928 compute_overhangs_and_x (t
, head
->x
, 1);
24929 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24932 /* Append glyphs strings for glyphs following the last glyph
24933 string tail that are overwritten by tail. The background of
24934 these strings has to be drawn because tail's foreground draws
24936 i
= right_overwritten (tail
);
24939 enum draw_glyphs_face overlap_hl
;
24941 if (check_mouse_face
24942 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24943 overlap_hl
= DRAW_MOUSE_FACE
;
24945 overlap_hl
= DRAW_NORMAL_TEXT
;
24947 if (hl
!= overlap_hl
)
24949 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24950 overlap_hl
, x
, last_x
);
24951 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24952 we don't have `end = i;' here. */
24953 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24954 append_glyph_string_lists (&head
, &tail
, h
, t
);
24955 if (clip_tail
== NULL
)
24959 /* Append glyph strings for glyphs following the last glyph
24960 string tail that overwrite tail. The foreground of such
24961 glyphs has to be drawn because it writes into the background
24962 of tail. The background must not be drawn because it could
24963 paint over the foreground of following glyphs. */
24964 i
= right_overwriting (tail
);
24967 enum draw_glyphs_face overlap_hl
;
24968 if (check_mouse_face
24969 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24970 overlap_hl
= DRAW_MOUSE_FACE
;
24972 overlap_hl
= DRAW_NORMAL_TEXT
;
24974 if (hl
== overlap_hl
|| clip_tail
== NULL
)
24976 i
++; /* We must include the Ith glyph. */
24977 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24978 overlap_hl
, x
, last_x
);
24979 for (s
= h
; s
; s
= s
->next
)
24980 s
->background_filled_p
= 1;
24981 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24982 append_glyph_string_lists (&head
, &tail
, h
, t
);
24984 if (clip_head
|| clip_tail
)
24985 for (s
= head
; s
; s
= s
->next
)
24987 s
->clip_head
= clip_head
;
24988 s
->clip_tail
= clip_tail
;
24992 /* Draw all strings. */
24993 for (s
= head
; s
; s
= s
->next
)
24994 FRAME_RIF (f
)->draw_glyph_string (s
);
24997 /* When focus a sole frame and move horizontally, this sets on_p to 0
24998 causing a failure to erase prev cursor position. */
24999 if (area
== TEXT_AREA
25000 && !row
->full_width_p
25001 /* When drawing overlapping rows, only the glyph strings'
25002 foreground is drawn, which doesn't erase a cursor
25006 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25007 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25008 : (tail
? tail
->x
+ tail
->background_width
: x
));
25012 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25013 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25017 /* Value is the x-position up to which drawn, relative to AREA of W.
25018 This doesn't include parts drawn because of overhangs. */
25019 if (row
->full_width_p
)
25020 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25022 x_reached
-= area_left
;
25024 RELEASE_HDC (hdc
, f
);
25029 /* Expand row matrix if too narrow. Don't expand if area
25032 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25034 if (!it->f->fonts_changed \
25035 && (it->glyph_row->glyphs[area] \
25036 < it->glyph_row->glyphs[area + 1])) \
25038 it->w->ncols_scale_factor++; \
25039 it->f->fonts_changed = 1; \
25043 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25044 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25047 append_glyph (struct it
*it
)
25049 struct glyph
*glyph
;
25050 enum glyph_row_area area
= it
->area
;
25052 eassert (it
->glyph_row
);
25053 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25055 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25056 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25058 /* If the glyph row is reversed, we need to prepend the glyph
25059 rather than append it. */
25060 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25064 /* Make room for the additional glyph. */
25065 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25067 glyph
= it
->glyph_row
->glyphs
[area
];
25069 glyph
->charpos
= CHARPOS (it
->position
);
25070 glyph
->object
= it
->object
;
25071 if (it
->pixel_width
> 0)
25073 glyph
->pixel_width
= it
->pixel_width
;
25074 glyph
->padding_p
= 0;
25078 /* Assure at least 1-pixel width. Otherwise, cursor can't
25079 be displayed correctly. */
25080 glyph
->pixel_width
= 1;
25081 glyph
->padding_p
= 1;
25083 glyph
->ascent
= it
->ascent
;
25084 glyph
->descent
= it
->descent
;
25085 glyph
->voffset
= it
->voffset
;
25086 glyph
->type
= CHAR_GLYPH
;
25087 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25088 glyph
->multibyte_p
= it
->multibyte_p
;
25089 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25091 /* In R2L rows, the left and the right box edges need to be
25092 drawn in reverse direction. */
25093 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25094 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25098 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25099 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25101 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25102 || it
->phys_descent
> it
->descent
);
25103 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25104 glyph
->face_id
= it
->face_id
;
25105 glyph
->u
.ch
= it
->char_to_display
;
25106 glyph
->slice
.img
= null_glyph_slice
;
25107 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25110 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25111 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25113 glyph
->bidi_type
= it
->bidi_it
.type
;
25117 glyph
->resolved_level
= 0;
25118 glyph
->bidi_type
= UNKNOWN_BT
;
25120 ++it
->glyph_row
->used
[area
];
25123 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25126 /* Store one glyph for the composition IT->cmp_it.id in
25127 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25131 append_composite_glyph (struct it
*it
)
25133 struct glyph
*glyph
;
25134 enum glyph_row_area area
= it
->area
;
25136 eassert (it
->glyph_row
);
25138 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25139 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25141 /* If the glyph row is reversed, we need to prepend the glyph
25142 rather than append it. */
25143 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25147 /* Make room for the new glyph. */
25148 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25150 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25152 glyph
->charpos
= it
->cmp_it
.charpos
;
25153 glyph
->object
= it
->object
;
25154 glyph
->pixel_width
= it
->pixel_width
;
25155 glyph
->ascent
= it
->ascent
;
25156 glyph
->descent
= it
->descent
;
25157 glyph
->voffset
= it
->voffset
;
25158 glyph
->type
= COMPOSITE_GLYPH
;
25159 if (it
->cmp_it
.ch
< 0)
25161 glyph
->u
.cmp
.automatic
= 0;
25162 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25163 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25167 glyph
->u
.cmp
.automatic
= 1;
25168 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25169 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25170 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25172 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25173 glyph
->multibyte_p
= it
->multibyte_p
;
25174 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25176 /* In R2L rows, the left and the right box edges need to be
25177 drawn in reverse direction. */
25178 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25179 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25183 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25184 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25186 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25187 || it
->phys_descent
> it
->descent
);
25188 glyph
->padding_p
= 0;
25189 glyph
->glyph_not_available_p
= 0;
25190 glyph
->face_id
= it
->face_id
;
25191 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25194 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25195 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25197 glyph
->bidi_type
= it
->bidi_it
.type
;
25199 ++it
->glyph_row
->used
[area
];
25202 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25206 /* Change IT->ascent and IT->height according to the setting of
25210 take_vertical_position_into_account (struct it
*it
)
25214 if (it
->voffset
< 0)
25215 /* Increase the ascent so that we can display the text higher
25217 it
->ascent
-= it
->voffset
;
25219 /* Increase the descent so that we can display the text lower
25221 it
->descent
+= it
->voffset
;
25226 /* Produce glyphs/get display metrics for the image IT is loaded with.
25227 See the description of struct display_iterator in dispextern.h for
25228 an overview of struct display_iterator. */
25231 produce_image_glyph (struct it
*it
)
25235 int glyph_ascent
, crop
;
25236 struct glyph_slice slice
;
25238 eassert (it
->what
== IT_IMAGE
);
25240 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25242 /* Make sure X resources of the face is loaded. */
25243 prepare_face_for_display (it
->f
, face
);
25245 if (it
->image_id
< 0)
25247 /* Fringe bitmap. */
25248 it
->ascent
= it
->phys_ascent
= 0;
25249 it
->descent
= it
->phys_descent
= 0;
25250 it
->pixel_width
= 0;
25255 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25257 /* Make sure X resources of the image is loaded. */
25258 prepare_image_for_display (it
->f
, img
);
25260 slice
.x
= slice
.y
= 0;
25261 slice
.width
= img
->width
;
25262 slice
.height
= img
->height
;
25264 if (INTEGERP (it
->slice
.x
))
25265 slice
.x
= XINT (it
->slice
.x
);
25266 else if (FLOATP (it
->slice
.x
))
25267 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25269 if (INTEGERP (it
->slice
.y
))
25270 slice
.y
= XINT (it
->slice
.y
);
25271 else if (FLOATP (it
->slice
.y
))
25272 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25274 if (INTEGERP (it
->slice
.width
))
25275 slice
.width
= XINT (it
->slice
.width
);
25276 else if (FLOATP (it
->slice
.width
))
25277 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25279 if (INTEGERP (it
->slice
.height
))
25280 slice
.height
= XINT (it
->slice
.height
);
25281 else if (FLOATP (it
->slice
.height
))
25282 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25284 if (slice
.x
>= img
->width
)
25285 slice
.x
= img
->width
;
25286 if (slice
.y
>= img
->height
)
25287 slice
.y
= img
->height
;
25288 if (slice
.x
+ slice
.width
>= img
->width
)
25289 slice
.width
= img
->width
- slice
.x
;
25290 if (slice
.y
+ slice
.height
> img
->height
)
25291 slice
.height
= img
->height
- slice
.y
;
25293 if (slice
.width
== 0 || slice
.height
== 0)
25296 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25298 it
->descent
= slice
.height
- glyph_ascent
;
25300 it
->descent
+= img
->vmargin
;
25301 if (slice
.y
+ slice
.height
== img
->height
)
25302 it
->descent
+= img
->vmargin
;
25303 it
->phys_descent
= it
->descent
;
25305 it
->pixel_width
= slice
.width
;
25307 it
->pixel_width
+= img
->hmargin
;
25308 if (slice
.x
+ slice
.width
== img
->width
)
25309 it
->pixel_width
+= img
->hmargin
;
25311 /* It's quite possible for images to have an ascent greater than
25312 their height, so don't get confused in that case. */
25313 if (it
->descent
< 0)
25318 if (face
->box
!= FACE_NO_BOX
)
25320 if (face
->box_line_width
> 0)
25323 it
->ascent
+= face
->box_line_width
;
25324 if (slice
.y
+ slice
.height
== img
->height
)
25325 it
->descent
+= face
->box_line_width
;
25328 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25329 it
->pixel_width
+= eabs (face
->box_line_width
);
25330 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25331 it
->pixel_width
+= eabs (face
->box_line_width
);
25334 take_vertical_position_into_account (it
);
25336 /* Automatically crop wide image glyphs at right edge so we can
25337 draw the cursor on same display row. */
25338 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25339 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25341 it
->pixel_width
-= crop
;
25342 slice
.width
-= crop
;
25347 struct glyph
*glyph
;
25348 enum glyph_row_area area
= it
->area
;
25350 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25351 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25353 glyph
->charpos
= CHARPOS (it
->position
);
25354 glyph
->object
= it
->object
;
25355 glyph
->pixel_width
= it
->pixel_width
;
25356 glyph
->ascent
= glyph_ascent
;
25357 glyph
->descent
= it
->descent
;
25358 glyph
->voffset
= it
->voffset
;
25359 glyph
->type
= IMAGE_GLYPH
;
25360 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25361 glyph
->multibyte_p
= it
->multibyte_p
;
25362 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25364 /* In R2L rows, the left and the right box edges need to be
25365 drawn in reverse direction. */
25366 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25367 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25371 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25372 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25374 glyph
->overlaps_vertically_p
= 0;
25375 glyph
->padding_p
= 0;
25376 glyph
->glyph_not_available_p
= 0;
25377 glyph
->face_id
= it
->face_id
;
25378 glyph
->u
.img_id
= img
->id
;
25379 glyph
->slice
.img
= slice
;
25380 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25383 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25384 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25386 glyph
->bidi_type
= it
->bidi_it
.type
;
25388 ++it
->glyph_row
->used
[area
];
25391 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25396 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25397 of the glyph, WIDTH and HEIGHT are the width and height of the
25398 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25401 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25402 int width
, int height
, int ascent
)
25404 struct glyph
*glyph
;
25405 enum glyph_row_area area
= it
->area
;
25407 eassert (ascent
>= 0 && ascent
<= height
);
25409 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25410 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25412 /* If the glyph row is reversed, we need to prepend the glyph
25413 rather than append it. */
25414 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25418 /* Make room for the additional glyph. */
25419 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25421 glyph
= it
->glyph_row
->glyphs
[area
];
25423 /* Decrease the width of the first glyph of the row that
25424 begins before first_visible_x (e.g., due to hscroll).
25425 This is so the overall width of the row becomes smaller
25426 by the scroll amount, and the stretch glyph appended by
25427 extend_face_to_end_of_line will be wider, to shift the
25428 row glyphs to the right. (In L2R rows, the corresponding
25429 left-shift effect is accomplished by setting row->x to a
25430 negative value, which won't work with R2L rows.)
25432 This must leave us with a positive value of WIDTH, since
25433 otherwise the call to move_it_in_display_line_to at the
25434 beginning of display_line would have got past the entire
25435 first glyph, and then it->current_x would have been
25436 greater or equal to it->first_visible_x. */
25437 if (it
->current_x
< it
->first_visible_x
)
25438 width
-= it
->first_visible_x
- it
->current_x
;
25439 eassert (width
> 0);
25441 glyph
->charpos
= CHARPOS (it
->position
);
25442 glyph
->object
= object
;
25443 glyph
->pixel_width
= width
;
25444 glyph
->ascent
= ascent
;
25445 glyph
->descent
= height
- ascent
;
25446 glyph
->voffset
= it
->voffset
;
25447 glyph
->type
= STRETCH_GLYPH
;
25448 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25449 glyph
->multibyte_p
= it
->multibyte_p
;
25450 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25452 /* In R2L rows, the left and the right box edges need to be
25453 drawn in reverse direction. */
25454 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25455 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25459 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25460 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25462 glyph
->overlaps_vertically_p
= 0;
25463 glyph
->padding_p
= 0;
25464 glyph
->glyph_not_available_p
= 0;
25465 glyph
->face_id
= it
->face_id
;
25466 glyph
->u
.stretch
.ascent
= ascent
;
25467 glyph
->u
.stretch
.height
= height
;
25468 glyph
->slice
.img
= null_glyph_slice
;
25469 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25472 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25473 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25475 glyph
->bidi_type
= it
->bidi_it
.type
;
25479 glyph
->resolved_level
= 0;
25480 glyph
->bidi_type
= UNKNOWN_BT
;
25482 ++it
->glyph_row
->used
[area
];
25485 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25488 #endif /* HAVE_WINDOW_SYSTEM */
25490 /* Produce a stretch glyph for iterator IT. IT->object is the value
25491 of the glyph property displayed. The value must be a list
25492 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25495 1. `:width WIDTH' specifies that the space should be WIDTH *
25496 canonical char width wide. WIDTH may be an integer or floating
25499 2. `:relative-width FACTOR' specifies that the width of the stretch
25500 should be computed from the width of the first character having the
25501 `glyph' property, and should be FACTOR times that width.
25503 3. `:align-to HPOS' specifies that the space should be wide enough
25504 to reach HPOS, a value in canonical character units.
25506 Exactly one of the above pairs must be present.
25508 4. `:height HEIGHT' specifies that the height of the stretch produced
25509 should be HEIGHT, measured in canonical character units.
25511 5. `:relative-height FACTOR' specifies that the height of the
25512 stretch should be FACTOR times the height of the characters having
25513 the glyph property.
25515 Either none or exactly one of 4 or 5 must be present.
25517 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25518 of the stretch should be used for the ascent of the stretch.
25519 ASCENT must be in the range 0 <= ASCENT <= 100. */
25522 produce_stretch_glyph (struct it
*it
)
25524 /* (space :width WIDTH :height HEIGHT ...) */
25525 Lisp_Object prop
, plist
;
25526 int width
= 0, height
= 0, align_to
= -1;
25527 int zero_width_ok_p
= 0;
25529 struct font
*font
= NULL
;
25531 #ifdef HAVE_WINDOW_SYSTEM
25533 int zero_height_ok_p
= 0;
25535 if (FRAME_WINDOW_P (it
->f
))
25537 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25538 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25539 prepare_face_for_display (it
->f
, face
);
25543 /* List should start with `space'. */
25544 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25545 plist
= XCDR (it
->object
);
25547 /* Compute the width of the stretch. */
25548 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25549 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25551 /* Absolute width `:width WIDTH' specified and valid. */
25552 zero_width_ok_p
= 1;
25555 #ifdef HAVE_WINDOW_SYSTEM
25556 else if (FRAME_WINDOW_P (it
->f
)
25557 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25559 /* Relative width `:relative-width FACTOR' specified and valid.
25560 Compute the width of the characters having the `glyph'
25563 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25566 if (it
->multibyte_p
)
25567 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25570 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25571 if (! ASCII_CHAR_P (it2
.c
))
25572 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25575 it2
.glyph_row
= NULL
;
25576 it2
.what
= IT_CHARACTER
;
25577 x_produce_glyphs (&it2
);
25578 width
= NUMVAL (prop
) * it2
.pixel_width
;
25580 #endif /* HAVE_WINDOW_SYSTEM */
25581 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25582 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25584 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25585 align_to
= (align_to
< 0
25587 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25588 else if (align_to
< 0)
25589 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25590 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25591 zero_width_ok_p
= 1;
25594 /* Nothing specified -> width defaults to canonical char width. */
25595 width
= FRAME_COLUMN_WIDTH (it
->f
);
25597 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25600 #ifdef HAVE_WINDOW_SYSTEM
25601 /* Compute height. */
25602 if (FRAME_WINDOW_P (it
->f
))
25604 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25605 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25608 zero_height_ok_p
= 1;
25610 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25612 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25614 height
= FONT_HEIGHT (font
);
25616 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25619 /* Compute percentage of height used for ascent. If
25620 `:ascent ASCENT' is present and valid, use that. Otherwise,
25621 derive the ascent from the font in use. */
25622 if (prop
= Fplist_get (plist
, QCascent
),
25623 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25624 ascent
= height
* NUMVAL (prop
) / 100.0;
25625 else if (!NILP (prop
)
25626 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25627 ascent
= min (max (0, (int)tem
), height
);
25629 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25632 #endif /* HAVE_WINDOW_SYSTEM */
25635 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25636 && it
->current_x
+ width
> it
->last_visible_x
)
25638 width
= it
->last_visible_x
- it
->current_x
;
25639 #ifdef HAVE_WINDOW_SYSTEM
25640 /* Subtract one more pixel from the stretch width, but only on
25641 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25642 width
-= FRAME_WINDOW_P (it
->f
);
25646 if (width
> 0 && height
> 0 && it
->glyph_row
)
25648 Lisp_Object o_object
= it
->object
;
25649 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25652 if (!STRINGP (object
))
25653 object
= it
->w
->contents
;
25654 #ifdef HAVE_WINDOW_SYSTEM
25655 if (FRAME_WINDOW_P (it
->f
))
25656 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25660 it
->object
= object
;
25661 it
->char_to_display
= ' ';
25662 it
->pixel_width
= it
->len
= 1;
25664 tty_append_glyph (it
);
25665 it
->object
= o_object
;
25669 it
->pixel_width
= width
;
25670 #ifdef HAVE_WINDOW_SYSTEM
25671 if (FRAME_WINDOW_P (it
->f
))
25673 it
->ascent
= it
->phys_ascent
= ascent
;
25674 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25675 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25676 take_vertical_position_into_account (it
);
25680 it
->nglyphs
= width
;
25683 /* Get information about special display element WHAT in an
25684 environment described by IT. WHAT is one of IT_TRUNCATION or
25685 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25686 non-null glyph_row member. This function ensures that fields like
25687 face_id, c, len of IT are left untouched. */
25690 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25697 temp_it
.object
= make_number (0);
25698 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25700 if (what
== IT_CONTINUATION
)
25702 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25703 if (it
->bidi_it
.paragraph_dir
== R2L
)
25704 SET_GLYPH_FROM_CHAR (glyph
, '/');
25706 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25708 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25710 /* FIXME: Should we mirror GC for R2L lines? */
25711 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25712 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25715 else if (what
== IT_TRUNCATION
)
25717 /* Truncation glyph. */
25718 SET_GLYPH_FROM_CHAR (glyph
, '$');
25720 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25722 /* FIXME: Should we mirror GC for R2L lines? */
25723 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25724 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25730 #ifdef HAVE_WINDOW_SYSTEM
25731 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25732 is turned off, we precede the truncation/continuation glyphs by a
25733 stretch glyph whose width is computed such that these special
25734 glyphs are aligned at the window margin, even when very different
25735 fonts are used in different glyph rows. */
25736 if (FRAME_WINDOW_P (temp_it
.f
)
25737 /* init_iterator calls this with it->glyph_row == NULL, and it
25738 wants only the pixel width of the truncation/continuation
25740 && temp_it
.glyph_row
25741 /* insert_left_trunc_glyphs calls us at the beginning of the
25742 row, and it has its own calculation of the stretch glyph
25744 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25745 && (temp_it
.glyph_row
->reversed_p
25746 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25747 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25749 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25751 if (stretch_width
> 0)
25753 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25754 struct font
*font
=
25755 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25756 int stretch_ascent
=
25757 (((temp_it
.ascent
+ temp_it
.descent
)
25758 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25760 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25761 temp_it
.ascent
+ temp_it
.descent
,
25768 temp_it
.what
= IT_CHARACTER
;
25770 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25771 temp_it
.face_id
= GLYPH_FACE (glyph
);
25772 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25774 PRODUCE_GLYPHS (&temp_it
);
25775 it
->pixel_width
= temp_it
.pixel_width
;
25776 it
->nglyphs
= temp_it
.pixel_width
;
25779 #ifdef HAVE_WINDOW_SYSTEM
25781 /* Calculate line-height and line-spacing properties.
25782 An integer value specifies explicit pixel value.
25783 A float value specifies relative value to current face height.
25784 A cons (float . face-name) specifies relative value to
25785 height of specified face font.
25787 Returns height in pixels, or nil. */
25791 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25792 int boff
, int override
)
25794 Lisp_Object face_name
= Qnil
;
25795 int ascent
, descent
, height
;
25797 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25802 face_name
= XCAR (val
);
25804 if (!NUMBERP (val
))
25805 val
= make_number (1);
25806 if (NILP (face_name
))
25808 height
= it
->ascent
+ it
->descent
;
25813 if (NILP (face_name
))
25815 font
= FRAME_FONT (it
->f
);
25816 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25818 else if (EQ (face_name
, Qt
))
25827 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25829 return make_number (-1);
25831 face
= FACE_FROM_ID (it
->f
, face_id
);
25834 return make_number (-1);
25835 boff
= font
->baseline_offset
;
25836 if (font
->vertical_centering
)
25837 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25840 ascent
= FONT_BASE (font
) + boff
;
25841 descent
= FONT_DESCENT (font
) - boff
;
25845 it
->override_ascent
= ascent
;
25846 it
->override_descent
= descent
;
25847 it
->override_boff
= boff
;
25850 height
= ascent
+ descent
;
25854 height
= (int)(XFLOAT_DATA (val
) * height
);
25855 else if (INTEGERP (val
))
25856 height
*= XINT (val
);
25858 return make_number (height
);
25862 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25863 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25864 and only if this is for a character for which no font was found.
25866 If the display method (it->glyphless_method) is
25867 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25868 length of the acronym or the hexadecimal string, UPPER_XOFF and
25869 UPPER_YOFF are pixel offsets for the upper part of the string,
25870 LOWER_XOFF and LOWER_YOFF are for the lower part.
25872 For the other display methods, LEN through LOWER_YOFF are zero. */
25875 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25876 short upper_xoff
, short upper_yoff
,
25877 short lower_xoff
, short lower_yoff
)
25879 struct glyph
*glyph
;
25880 enum glyph_row_area area
= it
->area
;
25882 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25883 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25885 /* If the glyph row is reversed, we need to prepend the glyph
25886 rather than append it. */
25887 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25891 /* Make room for the additional glyph. */
25892 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25894 glyph
= it
->glyph_row
->glyphs
[area
];
25896 glyph
->charpos
= CHARPOS (it
->position
);
25897 glyph
->object
= it
->object
;
25898 glyph
->pixel_width
= it
->pixel_width
;
25899 glyph
->ascent
= it
->ascent
;
25900 glyph
->descent
= it
->descent
;
25901 glyph
->voffset
= it
->voffset
;
25902 glyph
->type
= GLYPHLESS_GLYPH
;
25903 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25904 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25905 glyph
->u
.glyphless
.len
= len
;
25906 glyph
->u
.glyphless
.ch
= it
->c
;
25907 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25908 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25909 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25910 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25911 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25912 glyph
->multibyte_p
= it
->multibyte_p
;
25913 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25915 /* In R2L rows, the left and the right box edges need to be
25916 drawn in reverse direction. */
25917 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25918 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25922 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25923 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25925 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25926 || it
->phys_descent
> it
->descent
);
25927 glyph
->padding_p
= 0;
25928 glyph
->glyph_not_available_p
= 0;
25929 glyph
->face_id
= face_id
;
25930 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25933 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25934 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25936 glyph
->bidi_type
= it
->bidi_it
.type
;
25938 ++it
->glyph_row
->used
[area
];
25941 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25945 /* Produce a glyph for a glyphless character for iterator IT.
25946 IT->glyphless_method specifies which method to use for displaying
25947 the character. See the description of enum
25948 glyphless_display_method in dispextern.h for the detail.
25950 FOR_NO_FONT is nonzero if and only if this is for a character for
25951 which no font was found. ACRONYM, if non-nil, is an acronym string
25952 for the character. */
25955 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25960 int base_width
, base_height
, width
, height
;
25961 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25964 /* Get the metrics of the base font. We always refer to the current
25966 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25967 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25968 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25969 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25970 base_height
= it
->ascent
+ it
->descent
;
25971 base_width
= font
->average_width
;
25973 face_id
= merge_glyphless_glyph_face (it
);
25975 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25977 it
->pixel_width
= THIN_SPACE_WIDTH
;
25979 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25981 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25983 width
= CHAR_WIDTH (it
->c
);
25986 else if (width
> 4)
25988 it
->pixel_width
= base_width
* width
;
25990 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25996 unsigned int code
[6];
25998 int ascent
, descent
;
25999 struct font_metrics metrics_upper
, metrics_lower
;
26001 face
= FACE_FROM_ID (it
->f
, face_id
);
26002 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26003 prepare_face_for_display (it
->f
, face
);
26005 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26007 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26008 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26009 if (CONSP (acronym
))
26010 acronym
= XCAR (acronym
);
26011 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26015 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26016 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26019 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26020 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26021 upper_len
= (len
+ 1) / 2;
26022 font
->driver
->text_extents (font
, code
, upper_len
,
26024 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26029 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26030 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26031 upper_xoff
= upper_yoff
= 2; /* the typical case */
26032 if (base_width
>= width
)
26034 /* Align the upper to the left, the lower to the right. */
26035 it
->pixel_width
= base_width
;
26036 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26040 /* Center the shorter one. */
26041 it
->pixel_width
= width
;
26042 if (metrics_upper
.width
>= metrics_lower
.width
)
26043 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26046 /* FIXME: This code doesn't look right. It formerly was
26047 missing the "lower_xoff = 0;", which couldn't have
26048 been right since it left lower_xoff uninitialized. */
26050 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26054 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26055 top, bottom, and between upper and lower strings. */
26056 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26057 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26058 /* Center vertically.
26059 H:base_height, D:base_descent
26060 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26062 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26063 descent = D - H/2 + h/2;
26064 lower_yoff = descent - 2 - ld;
26065 upper_yoff = lower_yoff - la - 1 - ud; */
26066 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26067 descent
= it
->descent
- (base_height
- height
) / 2;
26068 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26069 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26070 - metrics_upper
.descent
);
26071 /* Don't make the height shorter than the base height. */
26072 if (height
> base_height
)
26074 it
->ascent
= ascent
;
26075 it
->descent
= descent
;
26079 it
->phys_ascent
= it
->ascent
;
26080 it
->phys_descent
= it
->descent
;
26082 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26083 upper_xoff
, upper_yoff
,
26084 lower_xoff
, lower_yoff
);
26086 take_vertical_position_into_account (it
);
26091 Produce glyphs/get display metrics for the display element IT is
26092 loaded with. See the description of struct it in dispextern.h
26093 for an overview of struct it. */
26096 x_produce_glyphs (struct it
*it
)
26098 int extra_line_spacing
= it
->extra_line_spacing
;
26100 it
->glyph_not_available_p
= 0;
26102 if (it
->what
== IT_CHARACTER
)
26105 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26106 struct font
*font
= face
->font
;
26107 struct font_metrics
*pcm
= NULL
;
26108 int boff
; /* Baseline offset. */
26112 /* When no suitable font is found, display this character by
26113 the method specified in the first extra slot of
26114 Vglyphless_char_display. */
26115 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26117 eassert (it
->what
== IT_GLYPHLESS
);
26118 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26122 boff
= font
->baseline_offset
;
26123 if (font
->vertical_centering
)
26124 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26126 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26132 if (it
->override_ascent
>= 0)
26134 it
->ascent
= it
->override_ascent
;
26135 it
->descent
= it
->override_descent
;
26136 boff
= it
->override_boff
;
26140 it
->ascent
= FONT_BASE (font
) + boff
;
26141 it
->descent
= FONT_DESCENT (font
) - boff
;
26144 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26146 pcm
= get_per_char_metric (font
, &char2b
);
26147 if (pcm
->width
== 0
26148 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26154 it
->phys_ascent
= pcm
->ascent
+ boff
;
26155 it
->phys_descent
= pcm
->descent
- boff
;
26156 it
->pixel_width
= pcm
->width
;
26160 it
->glyph_not_available_p
= 1;
26161 it
->phys_ascent
= it
->ascent
;
26162 it
->phys_descent
= it
->descent
;
26163 it
->pixel_width
= font
->space_width
;
26166 if (it
->constrain_row_ascent_descent_p
)
26168 if (it
->descent
> it
->max_descent
)
26170 it
->ascent
+= it
->descent
- it
->max_descent
;
26171 it
->descent
= it
->max_descent
;
26173 if (it
->ascent
> it
->max_ascent
)
26175 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26176 it
->ascent
= it
->max_ascent
;
26178 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26179 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26180 extra_line_spacing
= 0;
26183 /* If this is a space inside a region of text with
26184 `space-width' property, change its width. */
26185 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26187 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26189 /* If face has a box, add the box thickness to the character
26190 height. If character has a box line to the left and/or
26191 right, add the box line width to the character's width. */
26192 if (face
->box
!= FACE_NO_BOX
)
26194 int thick
= face
->box_line_width
;
26198 it
->ascent
+= thick
;
26199 it
->descent
+= thick
;
26204 if (it
->start_of_box_run_p
)
26205 it
->pixel_width
+= thick
;
26206 if (it
->end_of_box_run_p
)
26207 it
->pixel_width
+= thick
;
26210 /* If face has an overline, add the height of the overline
26211 (1 pixel) and a 1 pixel margin to the character height. */
26212 if (face
->overline_p
)
26213 it
->ascent
+= overline_margin
;
26215 if (it
->constrain_row_ascent_descent_p
)
26217 if (it
->ascent
> it
->max_ascent
)
26218 it
->ascent
= it
->max_ascent
;
26219 if (it
->descent
> it
->max_descent
)
26220 it
->descent
= it
->max_descent
;
26223 take_vertical_position_into_account (it
);
26225 /* If we have to actually produce glyphs, do it. */
26230 /* Translate a space with a `space-width' property
26231 into a stretch glyph. */
26232 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26233 / FONT_HEIGHT (font
));
26234 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26235 it
->ascent
+ it
->descent
, ascent
);
26240 /* If characters with lbearing or rbearing are displayed
26241 in this line, record that fact in a flag of the
26242 glyph row. This is used to optimize X output code. */
26243 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26244 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26246 if (! stretched_p
&& it
->pixel_width
== 0)
26247 /* We assure that all visible glyphs have at least 1-pixel
26249 it
->pixel_width
= 1;
26251 else if (it
->char_to_display
== '\n')
26253 /* A newline has no width, but we need the height of the
26254 line. But if previous part of the line sets a height,
26255 don't increase that height. */
26257 Lisp_Object height
;
26258 Lisp_Object total_height
= Qnil
;
26260 it
->override_ascent
= -1;
26261 it
->pixel_width
= 0;
26264 height
= get_it_property (it
, Qline_height
);
26265 /* Split (line-height total-height) list. */
26267 && CONSP (XCDR (height
))
26268 && NILP (XCDR (XCDR (height
))))
26270 total_height
= XCAR (XCDR (height
));
26271 height
= XCAR (height
);
26273 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26275 if (it
->override_ascent
>= 0)
26277 it
->ascent
= it
->override_ascent
;
26278 it
->descent
= it
->override_descent
;
26279 boff
= it
->override_boff
;
26283 it
->ascent
= FONT_BASE (font
) + boff
;
26284 it
->descent
= FONT_DESCENT (font
) - boff
;
26287 if (EQ (height
, Qt
))
26289 if (it
->descent
> it
->max_descent
)
26291 it
->ascent
+= it
->descent
- it
->max_descent
;
26292 it
->descent
= it
->max_descent
;
26294 if (it
->ascent
> it
->max_ascent
)
26296 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26297 it
->ascent
= it
->max_ascent
;
26299 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26300 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26301 it
->constrain_row_ascent_descent_p
= 1;
26302 extra_line_spacing
= 0;
26306 Lisp_Object spacing
;
26308 it
->phys_ascent
= it
->ascent
;
26309 it
->phys_descent
= it
->descent
;
26311 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26312 && face
->box
!= FACE_NO_BOX
26313 && face
->box_line_width
> 0)
26315 it
->ascent
+= face
->box_line_width
;
26316 it
->descent
+= face
->box_line_width
;
26319 && XINT (height
) > it
->ascent
+ it
->descent
)
26320 it
->ascent
= XINT (height
) - it
->descent
;
26322 if (!NILP (total_height
))
26323 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26326 spacing
= get_it_property (it
, Qline_spacing
);
26327 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26329 if (INTEGERP (spacing
))
26331 extra_line_spacing
= XINT (spacing
);
26332 if (!NILP (total_height
))
26333 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26337 else /* i.e. (it->char_to_display == '\t') */
26339 if (font
->space_width
> 0)
26341 int tab_width
= it
->tab_width
* font
->space_width
;
26342 int x
= it
->current_x
+ it
->continuation_lines_width
;
26343 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26345 /* If the distance from the current position to the next tab
26346 stop is less than a space character width, use the
26347 tab stop after that. */
26348 if (next_tab_x
- x
< font
->space_width
)
26349 next_tab_x
+= tab_width
;
26351 it
->pixel_width
= next_tab_x
- x
;
26353 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26354 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26358 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26359 it
->ascent
+ it
->descent
, it
->ascent
);
26364 it
->pixel_width
= 0;
26369 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26371 /* A static composition.
26373 Note: A composition is represented as one glyph in the
26374 glyph matrix. There are no padding glyphs.
26376 Important note: pixel_width, ascent, and descent are the
26377 values of what is drawn by draw_glyphs (i.e. the values of
26378 the overall glyphs composed). */
26379 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26380 int boff
; /* baseline offset */
26381 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26382 int glyph_len
= cmp
->glyph_len
;
26383 struct font
*font
= face
->font
;
26387 /* If we have not yet calculated pixel size data of glyphs of
26388 the composition for the current face font, calculate them
26389 now. Theoretically, we have to check all fonts for the
26390 glyphs, but that requires much time and memory space. So,
26391 here we check only the font of the first glyph. This may
26392 lead to incorrect display, but it's very rare, and C-l
26393 (recenter-top-bottom) can correct the display anyway. */
26394 if (! cmp
->font
|| cmp
->font
!= font
)
26396 /* Ascent and descent of the font of the first character
26397 of this composition (adjusted by baseline offset).
26398 Ascent and descent of overall glyphs should not be less
26399 than these, respectively. */
26400 int font_ascent
, font_descent
, font_height
;
26401 /* Bounding box of the overall glyphs. */
26402 int leftmost
, rightmost
, lowest
, highest
;
26403 int lbearing
, rbearing
;
26404 int i
, width
, ascent
, descent
;
26405 int left_padded
= 0, right_padded
= 0;
26406 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26408 struct font_metrics
*pcm
;
26409 int font_not_found_p
;
26412 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26413 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26415 if (glyph_len
< cmp
->glyph_len
)
26417 for (i
= 0; i
< glyph_len
; i
++)
26419 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26421 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26426 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26427 : IT_CHARPOS (*it
));
26428 /* If no suitable font is found, use the default font. */
26429 font_not_found_p
= font
== NULL
;
26430 if (font_not_found_p
)
26432 face
= face
->ascii_face
;
26435 boff
= font
->baseline_offset
;
26436 if (font
->vertical_centering
)
26437 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26438 font_ascent
= FONT_BASE (font
) + boff
;
26439 font_descent
= FONT_DESCENT (font
) - boff
;
26440 font_height
= FONT_HEIGHT (font
);
26445 if (! font_not_found_p
)
26447 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26449 pcm
= get_per_char_metric (font
, &char2b
);
26452 /* Initialize the bounding box. */
26455 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26456 ascent
= pcm
->ascent
;
26457 descent
= pcm
->descent
;
26458 lbearing
= pcm
->lbearing
;
26459 rbearing
= pcm
->rbearing
;
26463 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26464 ascent
= FONT_BASE (font
);
26465 descent
= FONT_DESCENT (font
);
26472 lowest
= - descent
+ boff
;
26473 highest
= ascent
+ boff
;
26475 if (! font_not_found_p
26476 && font
->default_ascent
26477 && CHAR_TABLE_P (Vuse_default_ascent
)
26478 && !NILP (Faref (Vuse_default_ascent
,
26479 make_number (it
->char_to_display
))))
26480 highest
= font
->default_ascent
+ boff
;
26482 /* Draw the first glyph at the normal position. It may be
26483 shifted to right later if some other glyphs are drawn
26485 cmp
->offsets
[i
* 2] = 0;
26486 cmp
->offsets
[i
* 2 + 1] = boff
;
26487 cmp
->lbearing
= lbearing
;
26488 cmp
->rbearing
= rbearing
;
26490 /* Set cmp->offsets for the remaining glyphs. */
26491 for (i
++; i
< glyph_len
; i
++)
26493 int left
, right
, btm
, top
;
26494 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26496 struct face
*this_face
;
26500 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26501 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26502 font
= this_face
->font
;
26508 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26510 pcm
= get_per_char_metric (font
, &char2b
);
26513 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26516 width
= pcm
->width
;
26517 ascent
= pcm
->ascent
;
26518 descent
= pcm
->descent
;
26519 lbearing
= pcm
->lbearing
;
26520 rbearing
= pcm
->rbearing
;
26521 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26523 /* Relative composition with or without
26524 alternate chars. */
26525 left
= (leftmost
+ rightmost
- width
) / 2;
26526 btm
= - descent
+ boff
;
26527 if (font
->relative_compose
26528 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26529 || NILP (Faref (Vignore_relative_composition
,
26530 make_number (ch
)))))
26533 if (- descent
>= font
->relative_compose
)
26534 /* One extra pixel between two glyphs. */
26536 else if (ascent
<= 0)
26537 /* One extra pixel between two glyphs. */
26538 btm
= lowest
- 1 - ascent
- descent
;
26543 /* A composition rule is specified by an integer
26544 value that encodes global and new reference
26545 points (GREF and NREF). GREF and NREF are
26546 specified by numbers as below:
26548 0---1---2 -- ascent
26552 9--10--11 -- center
26554 ---3---4---5--- baseline
26556 6---7---8 -- descent
26558 int rule
= COMPOSITION_RULE (cmp
, i
);
26559 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26561 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26562 grefx
= gref
% 3, nrefx
= nref
% 3;
26563 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26565 xoff
= font_height
* (xoff
- 128) / 256;
26567 yoff
= font_height
* (yoff
- 128) / 256;
26570 + grefx
* (rightmost
- leftmost
) / 2
26571 - nrefx
* width
/ 2
26574 btm
= ((grefy
== 0 ? highest
26576 : grefy
== 2 ? lowest
26577 : (highest
+ lowest
) / 2)
26578 - (nrefy
== 0 ? ascent
+ descent
26579 : nrefy
== 1 ? descent
- boff
26581 : (ascent
+ descent
) / 2)
26585 cmp
->offsets
[i
* 2] = left
;
26586 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26588 /* Update the bounding box of the overall glyphs. */
26591 right
= left
+ width
;
26592 if (left
< leftmost
)
26594 if (right
> rightmost
)
26597 top
= btm
+ descent
+ ascent
;
26603 if (cmp
->lbearing
> left
+ lbearing
)
26604 cmp
->lbearing
= left
+ lbearing
;
26605 if (cmp
->rbearing
< left
+ rbearing
)
26606 cmp
->rbearing
= left
+ rbearing
;
26610 /* If there are glyphs whose x-offsets are negative,
26611 shift all glyphs to the right and make all x-offsets
26615 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26616 cmp
->offsets
[i
* 2] -= leftmost
;
26617 rightmost
-= leftmost
;
26618 cmp
->lbearing
-= leftmost
;
26619 cmp
->rbearing
-= leftmost
;
26622 if (left_padded
&& cmp
->lbearing
< 0)
26624 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26625 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26626 rightmost
-= cmp
->lbearing
;
26627 cmp
->rbearing
-= cmp
->lbearing
;
26630 if (right_padded
&& rightmost
< cmp
->rbearing
)
26632 rightmost
= cmp
->rbearing
;
26635 cmp
->pixel_width
= rightmost
;
26636 cmp
->ascent
= highest
;
26637 cmp
->descent
= - lowest
;
26638 if (cmp
->ascent
< font_ascent
)
26639 cmp
->ascent
= font_ascent
;
26640 if (cmp
->descent
< font_descent
)
26641 cmp
->descent
= font_descent
;
26645 && (cmp
->lbearing
< 0
26646 || cmp
->rbearing
> cmp
->pixel_width
))
26647 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26649 it
->pixel_width
= cmp
->pixel_width
;
26650 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26651 it
->descent
= it
->phys_descent
= cmp
->descent
;
26652 if (face
->box
!= FACE_NO_BOX
)
26654 int thick
= face
->box_line_width
;
26658 it
->ascent
+= thick
;
26659 it
->descent
+= thick
;
26664 if (it
->start_of_box_run_p
)
26665 it
->pixel_width
+= thick
;
26666 if (it
->end_of_box_run_p
)
26667 it
->pixel_width
+= thick
;
26670 /* If face has an overline, add the height of the overline
26671 (1 pixel) and a 1 pixel margin to the character height. */
26672 if (face
->overline_p
)
26673 it
->ascent
+= overline_margin
;
26675 take_vertical_position_into_account (it
);
26676 if (it
->ascent
< 0)
26678 if (it
->descent
< 0)
26681 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26682 append_composite_glyph (it
);
26684 else if (it
->what
== IT_COMPOSITION
)
26686 /* A dynamic (automatic) composition. */
26687 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26688 Lisp_Object gstring
;
26689 struct font_metrics metrics
;
26693 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26695 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26698 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26699 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26700 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26701 it
->descent
= it
->phys_descent
= metrics
.descent
;
26702 if (face
->box
!= FACE_NO_BOX
)
26704 int thick
= face
->box_line_width
;
26708 it
->ascent
+= thick
;
26709 it
->descent
+= thick
;
26714 if (it
->start_of_box_run_p
)
26715 it
->pixel_width
+= thick
;
26716 if (it
->end_of_box_run_p
)
26717 it
->pixel_width
+= thick
;
26719 /* If face has an overline, add the height of the overline
26720 (1 pixel) and a 1 pixel margin to the character height. */
26721 if (face
->overline_p
)
26722 it
->ascent
+= overline_margin
;
26723 take_vertical_position_into_account (it
);
26724 if (it
->ascent
< 0)
26726 if (it
->descent
< 0)
26730 append_composite_glyph (it
);
26732 else if (it
->what
== IT_GLYPHLESS
)
26733 produce_glyphless_glyph (it
, 0, Qnil
);
26734 else if (it
->what
== IT_IMAGE
)
26735 produce_image_glyph (it
);
26736 else if (it
->what
== IT_STRETCH
)
26737 produce_stretch_glyph (it
);
26740 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26741 because this isn't true for images with `:ascent 100'. */
26742 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26743 if (it
->area
== TEXT_AREA
)
26744 it
->current_x
+= it
->pixel_width
;
26746 if (extra_line_spacing
> 0)
26748 it
->descent
+= extra_line_spacing
;
26749 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26750 it
->max_extra_line_spacing
= extra_line_spacing
;
26753 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26754 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26755 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26756 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26760 Output LEN glyphs starting at START at the nominal cursor position.
26761 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26762 being updated, and UPDATED_AREA is the area of that row being updated. */
26765 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26766 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26768 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26770 eassert (updated_row
);
26771 /* When the window is hscrolled, cursor hpos can legitimately be out
26772 of bounds, but we draw the cursor at the corresponding window
26773 margin in that case. */
26774 if (!updated_row
->reversed_p
&& chpos
< 0)
26776 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26777 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26781 /* Write glyphs. */
26783 hpos
= start
- updated_row
->glyphs
[updated_area
];
26784 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26785 updated_row
, updated_area
,
26787 DRAW_NORMAL_TEXT
, 0);
26789 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26790 if (updated_area
== TEXT_AREA
26791 && w
->phys_cursor_on_p
26792 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26794 && chpos
< hpos
+ len
)
26795 w
->phys_cursor_on_p
= 0;
26799 /* Advance the output cursor. */
26800 w
->output_cursor
.hpos
+= len
;
26801 w
->output_cursor
.x
= x
;
26806 Insert LEN glyphs from START at the nominal cursor position. */
26809 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26810 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26813 int line_height
, shift_by_width
, shifted_region_width
;
26814 struct glyph_row
*row
;
26815 struct glyph
*glyph
;
26816 int frame_x
, frame_y
;
26819 eassert (updated_row
);
26821 f
= XFRAME (WINDOW_FRAME (w
));
26823 /* Get the height of the line we are in. */
26825 line_height
= row
->height
;
26827 /* Get the width of the glyphs to insert. */
26828 shift_by_width
= 0;
26829 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26830 shift_by_width
+= glyph
->pixel_width
;
26832 /* Get the width of the region to shift right. */
26833 shifted_region_width
= (window_box_width (w
, updated_area
)
26834 - w
->output_cursor
.x
26838 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26839 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26841 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26842 line_height
, shift_by_width
);
26844 /* Write the glyphs. */
26845 hpos
= start
- row
->glyphs
[updated_area
];
26846 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26848 DRAW_NORMAL_TEXT
, 0);
26850 /* Advance the output cursor. */
26851 w
->output_cursor
.hpos
+= len
;
26852 w
->output_cursor
.x
+= shift_by_width
;
26858 Erase the current text line from the nominal cursor position
26859 (inclusive) to pixel column TO_X (exclusive). The idea is that
26860 everything from TO_X onward is already erased.
26862 TO_X is a pixel position relative to UPDATED_AREA of currently
26863 updated window W. TO_X == -1 means clear to the end of this area. */
26866 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26867 enum glyph_row_area updated_area
, int to_x
)
26870 int max_x
, min_y
, max_y
;
26871 int from_x
, from_y
, to_y
;
26873 eassert (updated_row
);
26874 f
= XFRAME (w
->frame
);
26876 if (updated_row
->full_width_p
)
26877 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26878 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26880 max_x
= window_box_width (w
, updated_area
);
26881 max_y
= window_text_bottom_y (w
);
26883 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26884 of window. For TO_X > 0, truncate to end of drawing area. */
26890 to_x
= min (to_x
, max_x
);
26892 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26894 /* Notice if the cursor will be cleared by this operation. */
26895 if (!updated_row
->full_width_p
)
26896 notice_overwritten_cursor (w
, updated_area
,
26897 w
->output_cursor
.x
, -1,
26899 MATRIX_ROW_BOTTOM_Y (updated_row
));
26901 from_x
= w
->output_cursor
.x
;
26903 /* Translate to frame coordinates. */
26904 if (updated_row
->full_width_p
)
26906 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26907 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26911 int area_left
= window_box_left (w
, updated_area
);
26912 from_x
+= area_left
;
26916 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26917 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26918 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26920 /* Prevent inadvertently clearing to end of the X window. */
26921 if (to_x
> from_x
&& to_y
> from_y
)
26924 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26925 to_x
- from_x
, to_y
- from_y
);
26930 #endif /* HAVE_WINDOW_SYSTEM */
26934 /***********************************************************************
26936 ***********************************************************************/
26938 /* Value is the internal representation of the specified cursor type
26939 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26940 of the bar cursor. */
26942 static enum text_cursor_kinds
26943 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26945 enum text_cursor_kinds type
;
26950 if (EQ (arg
, Qbox
))
26951 return FILLED_BOX_CURSOR
;
26953 if (EQ (arg
, Qhollow
))
26954 return HOLLOW_BOX_CURSOR
;
26956 if (EQ (arg
, Qbar
))
26963 && EQ (XCAR (arg
), Qbar
)
26964 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26966 *width
= XINT (XCDR (arg
));
26970 if (EQ (arg
, Qhbar
))
26973 return HBAR_CURSOR
;
26977 && EQ (XCAR (arg
), Qhbar
)
26978 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26980 *width
= XINT (XCDR (arg
));
26981 return HBAR_CURSOR
;
26984 /* Treat anything unknown as "hollow box cursor".
26985 It was bad to signal an error; people have trouble fixing
26986 .Xdefaults with Emacs, when it has something bad in it. */
26987 type
= HOLLOW_BOX_CURSOR
;
26992 /* Set the default cursor types for specified frame. */
26994 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26999 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27000 FRAME_CURSOR_WIDTH (f
) = width
;
27002 /* By default, set up the blink-off state depending on the on-state. */
27004 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27007 FRAME_BLINK_OFF_CURSOR (f
)
27008 = get_specified_cursor_type (XCDR (tem
), &width
);
27009 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27012 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27014 /* Make sure the cursor gets redrawn. */
27015 f
->cursor_type_changed
= 1;
27019 #ifdef HAVE_WINDOW_SYSTEM
27021 /* Return the cursor we want to be displayed in window W. Return
27022 width of bar/hbar cursor through WIDTH arg. Return with
27023 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27024 (i.e. if the `system caret' should track this cursor).
27026 In a mini-buffer window, we want the cursor only to appear if we
27027 are reading input from this window. For the selected window, we
27028 want the cursor type given by the frame parameter or buffer local
27029 setting of cursor-type. If explicitly marked off, draw no cursor.
27030 In all other cases, we want a hollow box cursor. */
27032 static enum text_cursor_kinds
27033 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27034 int *active_cursor
)
27036 struct frame
*f
= XFRAME (w
->frame
);
27037 struct buffer
*b
= XBUFFER (w
->contents
);
27038 int cursor_type
= DEFAULT_CURSOR
;
27039 Lisp_Object alt_cursor
;
27040 int non_selected
= 0;
27042 *active_cursor
= 1;
27045 if (cursor_in_echo_area
27046 && FRAME_HAS_MINIBUF_P (f
)
27047 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27049 if (w
== XWINDOW (echo_area_window
))
27051 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27053 *width
= FRAME_CURSOR_WIDTH (f
);
27054 return FRAME_DESIRED_CURSOR (f
);
27057 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27060 *active_cursor
= 0;
27064 /* Detect a nonselected window or nonselected frame. */
27065 else if (w
!= XWINDOW (f
->selected_window
)
27066 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27068 *active_cursor
= 0;
27070 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27076 /* Never display a cursor in a window in which cursor-type is nil. */
27077 if (NILP (BVAR (b
, cursor_type
)))
27080 /* Get the normal cursor type for this window. */
27081 if (EQ (BVAR (b
, cursor_type
), Qt
))
27083 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27084 *width
= FRAME_CURSOR_WIDTH (f
);
27087 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27089 /* Use cursor-in-non-selected-windows instead
27090 for non-selected window or frame. */
27093 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27094 if (!EQ (Qt
, alt_cursor
))
27095 return get_specified_cursor_type (alt_cursor
, width
);
27096 /* t means modify the normal cursor type. */
27097 if (cursor_type
== FILLED_BOX_CURSOR
)
27098 cursor_type
= HOLLOW_BOX_CURSOR
;
27099 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27101 return cursor_type
;
27104 /* Use normal cursor if not blinked off. */
27105 if (!w
->cursor_off_p
)
27107 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27109 if (cursor_type
== FILLED_BOX_CURSOR
)
27111 /* Using a block cursor on large images can be very annoying.
27112 So use a hollow cursor for "large" images.
27113 If image is not transparent (no mask), also use hollow cursor. */
27114 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27115 if (img
!= NULL
&& IMAGEP (img
->spec
))
27117 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27118 where N = size of default frame font size.
27119 This should cover most of the "tiny" icons people may use. */
27121 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27122 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27123 cursor_type
= HOLLOW_BOX_CURSOR
;
27126 else if (cursor_type
!= NO_CURSOR
)
27128 /* Display current only supports BOX and HOLLOW cursors for images.
27129 So for now, unconditionally use a HOLLOW cursor when cursor is
27130 not a solid box cursor. */
27131 cursor_type
= HOLLOW_BOX_CURSOR
;
27134 return cursor_type
;
27137 /* Cursor is blinked off, so determine how to "toggle" it. */
27139 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27140 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27141 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27143 /* Then see if frame has specified a specific blink off cursor type. */
27144 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27146 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27147 return FRAME_BLINK_OFF_CURSOR (f
);
27151 /* Some people liked having a permanently visible blinking cursor,
27152 while others had very strong opinions against it. So it was
27153 decided to remove it. KFS 2003-09-03 */
27155 /* Finally perform built-in cursor blinking:
27156 filled box <-> hollow box
27157 wide [h]bar <-> narrow [h]bar
27158 narrow [h]bar <-> no cursor
27159 other type <-> no cursor */
27161 if (cursor_type
== FILLED_BOX_CURSOR
)
27162 return HOLLOW_BOX_CURSOR
;
27164 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27167 return cursor_type
;
27175 /* Notice when the text cursor of window W has been completely
27176 overwritten by a drawing operation that outputs glyphs in AREA
27177 starting at X0 and ending at X1 in the line starting at Y0 and
27178 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27179 the rest of the line after X0 has been written. Y coordinates
27180 are window-relative. */
27183 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27184 int x0
, int x1
, int y0
, int y1
)
27186 int cx0
, cx1
, cy0
, cy1
;
27187 struct glyph_row
*row
;
27189 if (!w
->phys_cursor_on_p
)
27191 if (area
!= TEXT_AREA
)
27194 if (w
->phys_cursor
.vpos
< 0
27195 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27196 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27197 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27200 if (row
->cursor_in_fringe_p
)
27202 row
->cursor_in_fringe_p
= 0;
27203 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27204 w
->phys_cursor_on_p
= 0;
27208 cx0
= w
->phys_cursor
.x
;
27209 cx1
= cx0
+ w
->phys_cursor_width
;
27210 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27213 /* The cursor image will be completely removed from the
27214 screen if the output area intersects the cursor area in
27215 y-direction. When we draw in [y0 y1[, and some part of
27216 the cursor is at y < y0, that part must have been drawn
27217 before. When scrolling, the cursor is erased before
27218 actually scrolling, so we don't come here. When not
27219 scrolling, the rows above the old cursor row must have
27220 changed, and in this case these rows must have written
27221 over the cursor image.
27223 Likewise if part of the cursor is below y1, with the
27224 exception of the cursor being in the first blank row at
27225 the buffer and window end because update_text_area
27226 doesn't draw that row. (Except when it does, but
27227 that's handled in update_text_area.) */
27229 cy0
= w
->phys_cursor
.y
;
27230 cy1
= cy0
+ w
->phys_cursor_height
;
27231 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27234 w
->phys_cursor_on_p
= 0;
27237 #endif /* HAVE_WINDOW_SYSTEM */
27240 /************************************************************************
27242 ************************************************************************/
27244 #ifdef HAVE_WINDOW_SYSTEM
27247 Fix the display of area AREA of overlapping row ROW in window W
27248 with respect to the overlapping part OVERLAPS. */
27251 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27252 enum glyph_row_area area
, int overlaps
)
27259 for (i
= 0; i
< row
->used
[area
];)
27261 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27263 int start
= i
, start_x
= x
;
27267 x
+= row
->glyphs
[area
][i
].pixel_width
;
27270 while (i
< row
->used
[area
]
27271 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27273 draw_glyphs (w
, start_x
, row
, area
,
27275 DRAW_NORMAL_TEXT
, overlaps
);
27279 x
+= row
->glyphs
[area
][i
].pixel_width
;
27289 Draw the cursor glyph of window W in glyph row ROW. See the
27290 comment of draw_glyphs for the meaning of HL. */
27293 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27294 enum draw_glyphs_face hl
)
27296 /* If cursor hpos is out of bounds, don't draw garbage. This can
27297 happen in mini-buffer windows when switching between echo area
27298 glyphs and mini-buffer. */
27299 if ((row
->reversed_p
27300 ? (w
->phys_cursor
.hpos
>= 0)
27301 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27303 int on_p
= w
->phys_cursor_on_p
;
27305 int hpos
= w
->phys_cursor
.hpos
;
27307 /* When the window is hscrolled, cursor hpos can legitimately be
27308 out of bounds, but we draw the cursor at the corresponding
27309 window margin in that case. */
27310 if (!row
->reversed_p
&& hpos
< 0)
27312 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27313 hpos
= row
->used
[TEXT_AREA
] - 1;
27315 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27317 w
->phys_cursor_on_p
= on_p
;
27319 if (hl
== DRAW_CURSOR
)
27320 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27321 /* When we erase the cursor, and ROW is overlapped by other
27322 rows, make sure that these overlapping parts of other rows
27324 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27326 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27328 if (row
> w
->current_matrix
->rows
27329 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27330 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27331 OVERLAPS_ERASED_CURSOR
);
27333 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27334 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27335 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27336 OVERLAPS_ERASED_CURSOR
);
27342 /* Erase the image of a cursor of window W from the screen. */
27345 erase_phys_cursor (struct window
*w
)
27347 struct frame
*f
= XFRAME (w
->frame
);
27348 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27349 int hpos
= w
->phys_cursor
.hpos
;
27350 int vpos
= w
->phys_cursor
.vpos
;
27351 int mouse_face_here_p
= 0;
27352 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27353 struct glyph_row
*cursor_row
;
27354 struct glyph
*cursor_glyph
;
27355 enum draw_glyphs_face hl
;
27357 /* No cursor displayed or row invalidated => nothing to do on the
27359 if (w
->phys_cursor_type
== NO_CURSOR
)
27360 goto mark_cursor_off
;
27362 /* VPOS >= active_glyphs->nrows means that window has been resized.
27363 Don't bother to erase the cursor. */
27364 if (vpos
>= active_glyphs
->nrows
)
27365 goto mark_cursor_off
;
27367 /* If row containing cursor is marked invalid, there is nothing we
27369 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27370 if (!cursor_row
->enabled_p
)
27371 goto mark_cursor_off
;
27373 /* If line spacing is > 0, old cursor may only be partially visible in
27374 window after split-window. So adjust visible height. */
27375 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27376 window_text_bottom_y (w
) - cursor_row
->y
);
27378 /* If row is completely invisible, don't attempt to delete a cursor which
27379 isn't there. This can happen if cursor is at top of a window, and
27380 we switch to a buffer with a header line in that window. */
27381 if (cursor_row
->visible_height
<= 0)
27382 goto mark_cursor_off
;
27384 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27385 if (cursor_row
->cursor_in_fringe_p
)
27387 cursor_row
->cursor_in_fringe_p
= 0;
27388 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27389 goto mark_cursor_off
;
27392 /* This can happen when the new row is shorter than the old one.
27393 In this case, either draw_glyphs or clear_end_of_line
27394 should have cleared the cursor. Note that we wouldn't be
27395 able to erase the cursor in this case because we don't have a
27396 cursor glyph at hand. */
27397 if ((cursor_row
->reversed_p
27398 ? (w
->phys_cursor
.hpos
< 0)
27399 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27400 goto mark_cursor_off
;
27402 /* When the window is hscrolled, cursor hpos can legitimately be out
27403 of bounds, but we draw the cursor at the corresponding window
27404 margin in that case. */
27405 if (!cursor_row
->reversed_p
&& hpos
< 0)
27407 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27408 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27410 /* If the cursor is in the mouse face area, redisplay that when
27411 we clear the cursor. */
27412 if (! NILP (hlinfo
->mouse_face_window
)
27413 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27414 /* Don't redraw the cursor's spot in mouse face if it is at the
27415 end of a line (on a newline). The cursor appears there, but
27416 mouse highlighting does not. */
27417 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27418 mouse_face_here_p
= 1;
27420 /* Maybe clear the display under the cursor. */
27421 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27424 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27427 cursor_glyph
= get_phys_cursor_glyph (w
);
27428 if (cursor_glyph
== NULL
)
27429 goto mark_cursor_off
;
27431 width
= cursor_glyph
->pixel_width
;
27432 x
= w
->phys_cursor
.x
;
27438 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27439 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27440 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27443 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27446 /* Erase the cursor by redrawing the character underneath it. */
27447 if (mouse_face_here_p
)
27448 hl
= DRAW_MOUSE_FACE
;
27450 hl
= DRAW_NORMAL_TEXT
;
27451 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27454 w
->phys_cursor_on_p
= 0;
27455 w
->phys_cursor_type
= NO_CURSOR
;
27460 Display or clear cursor of window W. If ON is zero, clear the
27461 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27462 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27465 display_and_set_cursor (struct window
*w
, bool on
,
27466 int hpos
, int vpos
, int x
, int y
)
27468 struct frame
*f
= XFRAME (w
->frame
);
27469 int new_cursor_type
;
27470 int new_cursor_width
;
27472 struct glyph_row
*glyph_row
;
27473 struct glyph
*glyph
;
27475 /* This is pointless on invisible frames, and dangerous on garbaged
27476 windows and frames; in the latter case, the frame or window may
27477 be in the midst of changing its size, and x and y may be off the
27479 if (! FRAME_VISIBLE_P (f
)
27480 || FRAME_GARBAGED_P (f
)
27481 || vpos
>= w
->current_matrix
->nrows
27482 || hpos
>= w
->current_matrix
->matrix_w
)
27485 /* If cursor is off and we want it off, return quickly. */
27486 if (!on
&& !w
->phys_cursor_on_p
)
27489 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27490 /* If cursor row is not enabled, we don't really know where to
27491 display the cursor. */
27492 if (!glyph_row
->enabled_p
)
27494 w
->phys_cursor_on_p
= 0;
27499 if (!glyph_row
->exact_window_width_line_p
27500 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27501 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27503 eassert (input_blocked_p ());
27505 /* Set new_cursor_type to the cursor we want to be displayed. */
27506 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27507 &new_cursor_width
, &active_cursor
);
27509 /* If cursor is currently being shown and we don't want it to be or
27510 it is in the wrong place, or the cursor type is not what we want,
27512 if (w
->phys_cursor_on_p
27514 || w
->phys_cursor
.x
!= x
27515 || w
->phys_cursor
.y
!= y
27516 /* HPOS can be negative in R2L rows whose
27517 exact_window_width_line_p flag is set (i.e. their newline
27518 would "overflow into the fringe"). */
27520 || new_cursor_type
!= w
->phys_cursor_type
27521 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27522 && new_cursor_width
!= w
->phys_cursor_width
)))
27523 erase_phys_cursor (w
);
27525 /* Don't check phys_cursor_on_p here because that flag is only set
27526 to zero in some cases where we know that the cursor has been
27527 completely erased, to avoid the extra work of erasing the cursor
27528 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27529 still not be visible, or it has only been partly erased. */
27532 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27533 w
->phys_cursor_height
= glyph_row
->height
;
27535 /* Set phys_cursor_.* before x_draw_.* is called because some
27536 of them may need the information. */
27537 w
->phys_cursor
.x
= x
;
27538 w
->phys_cursor
.y
= glyph_row
->y
;
27539 w
->phys_cursor
.hpos
= hpos
;
27540 w
->phys_cursor
.vpos
= vpos
;
27543 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27544 new_cursor_type
, new_cursor_width
,
27545 on
, active_cursor
);
27549 /* Switch the display of W's cursor on or off, according to the value
27553 update_window_cursor (struct window
*w
, bool on
)
27555 /* Don't update cursor in windows whose frame is in the process
27556 of being deleted. */
27557 if (w
->current_matrix
)
27559 int hpos
= w
->phys_cursor
.hpos
;
27560 int vpos
= w
->phys_cursor
.vpos
;
27561 struct glyph_row
*row
;
27563 if (vpos
>= w
->current_matrix
->nrows
27564 || hpos
>= w
->current_matrix
->matrix_w
)
27567 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27569 /* When the window is hscrolled, cursor hpos can legitimately be
27570 out of bounds, but we draw the cursor at the corresponding
27571 window margin in that case. */
27572 if (!row
->reversed_p
&& hpos
< 0)
27574 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27575 hpos
= row
->used
[TEXT_AREA
] - 1;
27578 display_and_set_cursor (w
, on
, hpos
, vpos
,
27579 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27585 /* Call update_window_cursor with parameter ON_P on all leaf windows
27586 in the window tree rooted at W. */
27589 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27593 if (WINDOWP (w
->contents
))
27594 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27596 update_window_cursor (w
, on_p
);
27598 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27604 Display the cursor on window W, or clear it, according to ON_P.
27605 Don't change the cursor's position. */
27608 x_update_cursor (struct frame
*f
, bool on_p
)
27610 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27615 Clear the cursor of window W to background color, and mark the
27616 cursor as not shown. This is used when the text where the cursor
27617 is about to be rewritten. */
27620 x_clear_cursor (struct window
*w
)
27622 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27623 update_window_cursor (w
, 0);
27626 #endif /* HAVE_WINDOW_SYSTEM */
27628 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27631 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27632 int start_hpos
, int end_hpos
,
27633 enum draw_glyphs_face draw
)
27635 #ifdef HAVE_WINDOW_SYSTEM
27636 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27638 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27642 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27643 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27647 /* Display the active region described by mouse_face_* according to DRAW. */
27650 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27652 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27653 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27655 if (/* If window is in the process of being destroyed, don't bother
27657 w
->current_matrix
!= NULL
27658 /* Don't update mouse highlight if hidden. */
27659 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27660 /* Recognize when we are called to operate on rows that don't exist
27661 anymore. This can happen when a window is split. */
27662 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27664 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27665 struct glyph_row
*row
, *first
, *last
;
27667 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27668 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27670 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27672 int start_hpos
, end_hpos
, start_x
;
27674 /* For all but the first row, the highlight starts at column 0. */
27677 /* R2L rows have BEG and END in reversed order, but the
27678 screen drawing geometry is always left to right. So
27679 we need to mirror the beginning and end of the
27680 highlighted area in R2L rows. */
27681 if (!row
->reversed_p
)
27683 start_hpos
= hlinfo
->mouse_face_beg_col
;
27684 start_x
= hlinfo
->mouse_face_beg_x
;
27686 else if (row
== last
)
27688 start_hpos
= hlinfo
->mouse_face_end_col
;
27689 start_x
= hlinfo
->mouse_face_end_x
;
27697 else if (row
->reversed_p
&& row
== last
)
27699 start_hpos
= hlinfo
->mouse_face_end_col
;
27700 start_x
= hlinfo
->mouse_face_end_x
;
27710 if (!row
->reversed_p
)
27711 end_hpos
= hlinfo
->mouse_face_end_col
;
27712 else if (row
== first
)
27713 end_hpos
= hlinfo
->mouse_face_beg_col
;
27716 end_hpos
= row
->used
[TEXT_AREA
];
27717 if (draw
== DRAW_NORMAL_TEXT
)
27718 row
->fill_line_p
= 1; /* Clear to end of line */
27721 else if (row
->reversed_p
&& row
== first
)
27722 end_hpos
= hlinfo
->mouse_face_beg_col
;
27725 end_hpos
= row
->used
[TEXT_AREA
];
27726 if (draw
== DRAW_NORMAL_TEXT
)
27727 row
->fill_line_p
= 1; /* Clear to end of line */
27730 if (end_hpos
> start_hpos
)
27732 draw_row_with_mouse_face (w
, start_x
, row
,
27733 start_hpos
, end_hpos
, draw
);
27736 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27740 #ifdef HAVE_WINDOW_SYSTEM
27741 /* When we've written over the cursor, arrange for it to
27742 be displayed again. */
27743 if (FRAME_WINDOW_P (f
)
27744 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27746 int hpos
= w
->phys_cursor
.hpos
;
27748 /* When the window is hscrolled, cursor hpos can legitimately be
27749 out of bounds, but we draw the cursor at the corresponding
27750 window margin in that case. */
27751 if (!row
->reversed_p
&& hpos
< 0)
27753 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27754 hpos
= row
->used
[TEXT_AREA
] - 1;
27757 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27758 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27761 #endif /* HAVE_WINDOW_SYSTEM */
27764 #ifdef HAVE_WINDOW_SYSTEM
27765 /* Change the mouse cursor. */
27766 if (FRAME_WINDOW_P (f
))
27768 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27769 if (draw
== DRAW_NORMAL_TEXT
27770 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27771 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27774 if (draw
== DRAW_MOUSE_FACE
)
27775 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27777 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27779 #endif /* HAVE_WINDOW_SYSTEM */
27783 Clear out the mouse-highlighted active region.
27784 Redraw it un-highlighted first. Value is non-zero if mouse
27785 face was actually drawn unhighlighted. */
27788 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27792 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27794 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27798 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27799 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27800 hlinfo
->mouse_face_window
= Qnil
;
27801 hlinfo
->mouse_face_overlay
= Qnil
;
27805 /* Return true if the coordinates HPOS and VPOS on windows W are
27806 within the mouse face on that window. */
27808 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27810 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27812 /* Quickly resolve the easy cases. */
27813 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27814 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27816 if (vpos
< hlinfo
->mouse_face_beg_row
27817 || vpos
> hlinfo
->mouse_face_end_row
)
27819 if (vpos
> hlinfo
->mouse_face_beg_row
27820 && vpos
< hlinfo
->mouse_face_end_row
)
27823 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27825 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27827 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27830 else if ((vpos
== hlinfo
->mouse_face_beg_row
27831 && hpos
>= hlinfo
->mouse_face_beg_col
)
27832 || (vpos
== hlinfo
->mouse_face_end_row
27833 && hpos
< hlinfo
->mouse_face_end_col
))
27838 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27840 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27843 else if ((vpos
== hlinfo
->mouse_face_beg_row
27844 && hpos
<= hlinfo
->mouse_face_beg_col
)
27845 || (vpos
== hlinfo
->mouse_face_end_row
27846 && hpos
> hlinfo
->mouse_face_end_col
))
27854 True if physical cursor of window W is within mouse face. */
27857 cursor_in_mouse_face_p (struct window
*w
)
27859 int hpos
= w
->phys_cursor
.hpos
;
27860 int vpos
= w
->phys_cursor
.vpos
;
27861 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27863 /* When the window is hscrolled, cursor hpos can legitimately be out
27864 of bounds, but we draw the cursor at the corresponding window
27865 margin in that case. */
27866 if (!row
->reversed_p
&& hpos
< 0)
27868 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27869 hpos
= row
->used
[TEXT_AREA
] - 1;
27871 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27876 /* Find the glyph rows START_ROW and END_ROW of window W that display
27877 characters between buffer positions START_CHARPOS and END_CHARPOS
27878 (excluding END_CHARPOS). DISP_STRING is a display string that
27879 covers these buffer positions. This is similar to
27880 row_containing_pos, but is more accurate when bidi reordering makes
27881 buffer positions change non-linearly with glyph rows. */
27883 rows_from_pos_range (struct window
*w
,
27884 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27885 Lisp_Object disp_string
,
27886 struct glyph_row
**start
, struct glyph_row
**end
)
27888 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27889 int last_y
= window_text_bottom_y (w
);
27890 struct glyph_row
*row
;
27895 while (!first
->enabled_p
27896 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27899 /* Find the START row. */
27901 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27904 /* A row can potentially be the START row if the range of the
27905 characters it displays intersects the range
27906 [START_CHARPOS..END_CHARPOS). */
27907 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27908 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27909 /* See the commentary in row_containing_pos, for the
27910 explanation of the complicated way to check whether
27911 some position is beyond the end of the characters
27912 displayed by a row. */
27913 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27914 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27915 && !row
->ends_at_zv_p
27916 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27917 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27918 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27919 && !row
->ends_at_zv_p
27920 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27922 /* Found a candidate row. Now make sure at least one of the
27923 glyphs it displays has a charpos from the range
27924 [START_CHARPOS..END_CHARPOS).
27926 This is not obvious because bidi reordering could make
27927 buffer positions of a row be 1,2,3,102,101,100, and if we
27928 want to highlight characters in [50..60), we don't want
27929 this row, even though [50..60) does intersect [1..103),
27930 the range of character positions given by the row's start
27931 and end positions. */
27932 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27933 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27937 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27938 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27939 /* A glyph that comes from DISP_STRING is by
27940 definition to be highlighted. */
27941 || EQ (g
->object
, disp_string
))
27950 /* Find the END row. */
27952 /* If the last row is partially visible, start looking for END
27953 from that row, instead of starting from FIRST. */
27954 && !(row
->enabled_p
27955 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27957 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27959 struct glyph_row
*next
= row
+ 1;
27960 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27962 if (!next
->enabled_p
27963 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27964 /* The first row >= START whose range of displayed characters
27965 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27966 is the row END + 1. */
27967 || (start_charpos
< next_start
27968 && end_charpos
< next_start
)
27969 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27970 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27971 && !next
->ends_at_zv_p
27972 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27973 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27974 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27975 && !next
->ends_at_zv_p
27976 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27983 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27984 but none of the characters it displays are in the range, it is
27986 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27987 struct glyph
*s
= g
;
27988 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27992 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27993 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27994 /* If the buffer position of the first glyph in
27995 the row is equal to END_CHARPOS, it means
27996 the last character to be highlighted is the
27997 newline of ROW, and we must consider NEXT as
27999 || (((!next
->reversed_p
&& g
== s
)
28000 || (next
->reversed_p
&& g
== e
- 1))
28001 && (g
->charpos
== end_charpos
28002 /* Special case for when NEXT is an
28003 empty line at ZV. */
28004 || (g
->charpos
== -1
28005 && !row
->ends_at_zv_p
28006 && next_start
== end_charpos
)))))
28007 /* A glyph that comes from DISP_STRING is by
28008 definition to be highlighted. */
28009 || EQ (g
->object
, disp_string
))
28018 /* The first row that ends at ZV must be the last to be
28020 else if (next
->ends_at_zv_p
)
28029 /* This function sets the mouse_face_* elements of HLINFO, assuming
28030 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28031 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28032 for the overlay or run of text properties specifying the mouse
28033 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28034 before-string and after-string that must also be highlighted.
28035 DISP_STRING, if non-nil, is a display string that may cover some
28036 or all of the highlighted text. */
28039 mouse_face_from_buffer_pos (Lisp_Object window
,
28040 Mouse_HLInfo
*hlinfo
,
28041 ptrdiff_t mouse_charpos
,
28042 ptrdiff_t start_charpos
,
28043 ptrdiff_t end_charpos
,
28044 Lisp_Object before_string
,
28045 Lisp_Object after_string
,
28046 Lisp_Object disp_string
)
28048 struct window
*w
= XWINDOW (window
);
28049 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28050 struct glyph_row
*r1
, *r2
;
28051 struct glyph
*glyph
, *end
;
28052 ptrdiff_t ignore
, pos
;
28055 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28056 eassert (NILP (before_string
) || STRINGP (before_string
));
28057 eassert (NILP (after_string
) || STRINGP (after_string
));
28059 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28060 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28062 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28063 /* If the before-string or display-string contains newlines,
28064 rows_from_pos_range skips to its last row. Move back. */
28065 if (!NILP (before_string
) || !NILP (disp_string
))
28067 struct glyph_row
*prev
;
28068 while ((prev
= r1
- 1, prev
>= first
)
28069 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28070 && prev
->used
[TEXT_AREA
] > 0)
28072 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28073 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28074 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28076 || !(EQ (glyph
->object
, before_string
)
28077 || EQ (glyph
->object
, disp_string
)))
28084 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28085 hlinfo
->mouse_face_past_end
= 1;
28087 else if (!NILP (after_string
))
28089 /* If the after-string has newlines, advance to its last row. */
28090 struct glyph_row
*next
;
28091 struct glyph_row
*last
28092 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28094 for (next
= r2
+ 1;
28096 && next
->used
[TEXT_AREA
] > 0
28097 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28101 /* The rest of the display engine assumes that mouse_face_beg_row is
28102 either above mouse_face_end_row or identical to it. But with
28103 bidi-reordered continued lines, the row for START_CHARPOS could
28104 be below the row for END_CHARPOS. If so, swap the rows and store
28105 them in correct order. */
28108 struct glyph_row
*tem
= r2
;
28114 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28115 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28117 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28118 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28119 could be anywhere in the row and in any order. The strategy
28120 below is to find the leftmost and the rightmost glyph that
28121 belongs to either of these 3 strings, or whose position is
28122 between START_CHARPOS and END_CHARPOS, and highlight all the
28123 glyphs between those two. This may cover more than just the text
28124 between START_CHARPOS and END_CHARPOS if the range of characters
28125 strides the bidi level boundary, e.g. if the beginning is in R2L
28126 text while the end is in L2R text or vice versa. */
28127 if (!r1
->reversed_p
)
28129 /* This row is in a left to right paragraph. Scan it left to
28131 glyph
= r1
->glyphs
[TEXT_AREA
];
28132 end
= glyph
+ r1
->used
[TEXT_AREA
];
28135 /* Skip truncation glyphs at the start of the glyph row. */
28136 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28138 && INTEGERP (glyph
->object
)
28139 && glyph
->charpos
< 0;
28141 x
+= glyph
->pixel_width
;
28143 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28144 or DISP_STRING, and the first glyph from buffer whose
28145 position is between START_CHARPOS and END_CHARPOS. */
28147 && !INTEGERP (glyph
->object
)
28148 && !EQ (glyph
->object
, disp_string
)
28149 && !(BUFFERP (glyph
->object
)
28150 && (glyph
->charpos
>= start_charpos
28151 && glyph
->charpos
< end_charpos
));
28154 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28155 are present at buffer positions between START_CHARPOS and
28156 END_CHARPOS, or if they come from an overlay. */
28157 if (EQ (glyph
->object
, before_string
))
28159 pos
= string_buffer_position (before_string
,
28161 /* If pos == 0, it means before_string came from an
28162 overlay, not from a buffer position. */
28163 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28166 else if (EQ (glyph
->object
, after_string
))
28168 pos
= string_buffer_position (after_string
, end_charpos
);
28169 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28172 x
+= glyph
->pixel_width
;
28174 hlinfo
->mouse_face_beg_x
= x
;
28175 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28179 /* This row is in a right to left paragraph. Scan it right to
28183 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28184 glyph
= end
+ r1
->used
[TEXT_AREA
];
28186 /* Skip truncation glyphs at the start of the glyph row. */
28187 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28189 && INTEGERP (glyph
->object
)
28190 && glyph
->charpos
< 0;
28194 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28195 or DISP_STRING, and the first glyph from buffer whose
28196 position is between START_CHARPOS and END_CHARPOS. */
28198 && !INTEGERP (glyph
->object
)
28199 && !EQ (glyph
->object
, disp_string
)
28200 && !(BUFFERP (glyph
->object
)
28201 && (glyph
->charpos
>= start_charpos
28202 && glyph
->charpos
< end_charpos
));
28205 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28206 are present at buffer positions between START_CHARPOS and
28207 END_CHARPOS, or if they come from an overlay. */
28208 if (EQ (glyph
->object
, before_string
))
28210 pos
= string_buffer_position (before_string
, start_charpos
);
28211 /* If pos == 0, it means before_string came from an
28212 overlay, not from a buffer position. */
28213 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28216 else if (EQ (glyph
->object
, after_string
))
28218 pos
= string_buffer_position (after_string
, end_charpos
);
28219 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28224 glyph
++; /* first glyph to the right of the highlighted area */
28225 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28226 x
+= g
->pixel_width
;
28227 hlinfo
->mouse_face_beg_x
= x
;
28228 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28231 /* If the highlight ends in a different row, compute GLYPH and END
28232 for the end row. Otherwise, reuse the values computed above for
28233 the row where the highlight begins. */
28236 if (!r2
->reversed_p
)
28238 glyph
= r2
->glyphs
[TEXT_AREA
];
28239 end
= glyph
+ r2
->used
[TEXT_AREA
];
28244 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28245 glyph
= end
+ r2
->used
[TEXT_AREA
];
28249 if (!r2
->reversed_p
)
28251 /* Skip truncation and continuation glyphs near the end of the
28252 row, and also blanks and stretch glyphs inserted by
28253 extend_face_to_end_of_line. */
28255 && INTEGERP ((end
- 1)->object
))
28257 /* Scan the rest of the glyph row from the end, looking for the
28258 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28259 DISP_STRING, or whose position is between START_CHARPOS
28263 && !INTEGERP (end
->object
)
28264 && !EQ (end
->object
, disp_string
)
28265 && !(BUFFERP (end
->object
)
28266 && (end
->charpos
>= start_charpos
28267 && end
->charpos
< end_charpos
));
28270 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28271 are present at buffer positions between START_CHARPOS and
28272 END_CHARPOS, or if they come from an overlay. */
28273 if (EQ (end
->object
, before_string
))
28275 pos
= string_buffer_position (before_string
, start_charpos
);
28276 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28279 else if (EQ (end
->object
, after_string
))
28281 pos
= string_buffer_position (after_string
, end_charpos
);
28282 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28286 /* Find the X coordinate of the last glyph to be highlighted. */
28287 for (; glyph
<= end
; ++glyph
)
28288 x
+= glyph
->pixel_width
;
28290 hlinfo
->mouse_face_end_x
= x
;
28291 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28295 /* Skip truncation and continuation glyphs near the end of the
28296 row, and also blanks and stretch glyphs inserted by
28297 extend_face_to_end_of_line. */
28301 && INTEGERP (end
->object
))
28303 x
+= end
->pixel_width
;
28306 /* Scan the rest of the glyph row from the end, looking for the
28307 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28308 DISP_STRING, or whose position is between START_CHARPOS
28312 && !INTEGERP (end
->object
)
28313 && !EQ (end
->object
, disp_string
)
28314 && !(BUFFERP (end
->object
)
28315 && (end
->charpos
>= start_charpos
28316 && end
->charpos
< end_charpos
));
28319 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28320 are present at buffer positions between START_CHARPOS and
28321 END_CHARPOS, or if they come from an overlay. */
28322 if (EQ (end
->object
, before_string
))
28324 pos
= string_buffer_position (before_string
, start_charpos
);
28325 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28328 else if (EQ (end
->object
, after_string
))
28330 pos
= string_buffer_position (after_string
, end_charpos
);
28331 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28334 x
+= end
->pixel_width
;
28336 /* If we exited the above loop because we arrived at the last
28337 glyph of the row, and its buffer position is still not in
28338 range, it means the last character in range is the preceding
28339 newline. Bump the end column and x values to get past the
28342 && BUFFERP (end
->object
)
28343 && (end
->charpos
< start_charpos
28344 || end
->charpos
>= end_charpos
))
28346 x
+= end
->pixel_width
;
28349 hlinfo
->mouse_face_end_x
= x
;
28350 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28353 hlinfo
->mouse_face_window
= window
;
28354 hlinfo
->mouse_face_face_id
28355 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28357 !hlinfo
->mouse_face_hidden
, -1);
28358 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28361 /* The following function is not used anymore (replaced with
28362 mouse_face_from_string_pos), but I leave it here for the time
28363 being, in case someone would. */
28365 #if 0 /* not used */
28367 /* Find the position of the glyph for position POS in OBJECT in
28368 window W's current matrix, and return in *X, *Y the pixel
28369 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28371 RIGHT_P non-zero means return the position of the right edge of the
28372 glyph, RIGHT_P zero means return the left edge position.
28374 If no glyph for POS exists in the matrix, return the position of
28375 the glyph with the next smaller position that is in the matrix, if
28376 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28377 exists in the matrix, return the position of the glyph with the
28378 next larger position in OBJECT.
28380 Value is non-zero if a glyph was found. */
28383 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28384 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28386 int yb
= window_text_bottom_y (w
);
28387 struct glyph_row
*r
;
28388 struct glyph
*best_glyph
= NULL
;
28389 struct glyph_row
*best_row
= NULL
;
28392 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28393 r
->enabled_p
&& r
->y
< yb
;
28396 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28397 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28400 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28401 if (EQ (g
->object
, object
))
28403 if (g
->charpos
== pos
)
28410 else if (best_glyph
== NULL
28411 || ((eabs (g
->charpos
- pos
)
28412 < eabs (best_glyph
->charpos
- pos
))
28415 : g
->charpos
> pos
)))
28429 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28433 *x
+= best_glyph
->pixel_width
;
28438 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28441 return best_glyph
!= NULL
;
28443 #endif /* not used */
28445 /* Find the positions of the first and the last glyphs in window W's
28446 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28447 (assumed to be a string), and return in HLINFO's mouse_face_*
28448 members the pixel and column/row coordinates of those glyphs. */
28451 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28452 Lisp_Object object
,
28453 ptrdiff_t startpos
, ptrdiff_t endpos
)
28455 int yb
= window_text_bottom_y (w
);
28456 struct glyph_row
*r
;
28457 struct glyph
*g
, *e
;
28461 /* Find the glyph row with at least one position in the range
28462 [STARTPOS..ENDPOS), and the first glyph in that row whose
28463 position belongs to that range. */
28464 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28465 r
->enabled_p
&& r
->y
< yb
;
28468 if (!r
->reversed_p
)
28470 g
= r
->glyphs
[TEXT_AREA
];
28471 e
= g
+ r
->used
[TEXT_AREA
];
28472 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28473 if (EQ (g
->object
, object
)
28474 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28476 hlinfo
->mouse_face_beg_row
28477 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28478 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28479 hlinfo
->mouse_face_beg_x
= gx
;
28488 e
= r
->glyphs
[TEXT_AREA
];
28489 g
= e
+ r
->used
[TEXT_AREA
];
28490 for ( ; g
> e
; --g
)
28491 if (EQ ((g
-1)->object
, object
)
28492 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28494 hlinfo
->mouse_face_beg_row
28495 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28496 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28497 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28498 gx
+= g1
->pixel_width
;
28499 hlinfo
->mouse_face_beg_x
= gx
;
28511 /* Starting with the next row, look for the first row which does NOT
28512 include any glyphs whose positions are in the range. */
28513 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28515 g
= r
->glyphs
[TEXT_AREA
];
28516 e
= g
+ r
->used
[TEXT_AREA
];
28518 for ( ; g
< e
; ++g
)
28519 if (EQ (g
->object
, object
)
28520 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28529 /* The highlighted region ends on the previous row. */
28532 /* Set the end row. */
28533 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28535 /* Compute and set the end column and the end column's horizontal
28536 pixel coordinate. */
28537 if (!r
->reversed_p
)
28539 g
= r
->glyphs
[TEXT_AREA
];
28540 e
= g
+ r
->used
[TEXT_AREA
];
28541 for ( ; e
> g
; --e
)
28542 if (EQ ((e
-1)->object
, object
)
28543 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28545 hlinfo
->mouse_face_end_col
= e
- g
;
28547 for (gx
= r
->x
; g
< e
; ++g
)
28548 gx
+= g
->pixel_width
;
28549 hlinfo
->mouse_face_end_x
= gx
;
28553 e
= r
->glyphs
[TEXT_AREA
];
28554 g
= e
+ r
->used
[TEXT_AREA
];
28555 for (gx
= r
->x
; e
< g
; ++e
)
28557 if (EQ (e
->object
, object
)
28558 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28560 gx
+= e
->pixel_width
;
28562 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28563 hlinfo
->mouse_face_end_x
= gx
;
28567 #ifdef HAVE_WINDOW_SYSTEM
28569 /* See if position X, Y is within a hot-spot of an image. */
28572 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28574 if (!CONSP (hot_spot
))
28577 if (EQ (XCAR (hot_spot
), Qrect
))
28579 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28580 Lisp_Object rect
= XCDR (hot_spot
);
28584 if (!CONSP (XCAR (rect
)))
28586 if (!CONSP (XCDR (rect
)))
28588 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28590 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28592 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28594 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28598 else if (EQ (XCAR (hot_spot
), Qcircle
))
28600 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28601 Lisp_Object circ
= XCDR (hot_spot
);
28602 Lisp_Object lr
, lx0
, ly0
;
28604 && CONSP (XCAR (circ
))
28605 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28606 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28607 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28609 double r
= XFLOATINT (lr
);
28610 double dx
= XINT (lx0
) - x
;
28611 double dy
= XINT (ly0
) - y
;
28612 return (dx
* dx
+ dy
* dy
<= r
* r
);
28615 else if (EQ (XCAR (hot_spot
), Qpoly
))
28617 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28618 if (VECTORP (XCDR (hot_spot
)))
28620 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28621 Lisp_Object
*poly
= v
->contents
;
28622 ptrdiff_t n
= v
->header
.size
;
28625 Lisp_Object lx
, ly
;
28628 /* Need an even number of coordinates, and at least 3 edges. */
28629 if (n
< 6 || n
& 1)
28632 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28633 If count is odd, we are inside polygon. Pixels on edges
28634 may or may not be included depending on actual geometry of the
28636 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28637 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28639 x0
= XINT (lx
), y0
= XINT (ly
);
28640 for (i
= 0; i
< n
; i
+= 2)
28642 int x1
= x0
, y1
= y0
;
28643 if ((lx
= poly
[i
], !INTEGERP (lx
))
28644 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28646 x0
= XINT (lx
), y0
= XINT (ly
);
28648 /* Does this segment cross the X line? */
28656 if (y
> y0
&& y
> y1
)
28658 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28668 find_hot_spot (Lisp_Object map
, int x
, int y
)
28670 while (CONSP (map
))
28672 if (CONSP (XCAR (map
))
28673 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28681 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28683 doc
: /* Lookup in image map MAP coordinates X and Y.
28684 An image map is an alist where each element has the format (AREA ID PLIST).
28685 An AREA is specified as either a rectangle, a circle, or a polygon:
28686 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28687 pixel coordinates of the upper left and bottom right corners.
28688 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28689 and the radius of the circle; r may be a float or integer.
28690 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28691 vector describes one corner in the polygon.
28692 Returns the alist element for the first matching AREA in MAP. */)
28693 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28701 return find_hot_spot (map
,
28702 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28703 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28707 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28709 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28711 /* Do not change cursor shape while dragging mouse. */
28712 if (!NILP (do_mouse_tracking
))
28715 if (!NILP (pointer
))
28717 if (EQ (pointer
, Qarrow
))
28718 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28719 else if (EQ (pointer
, Qhand
))
28720 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28721 else if (EQ (pointer
, Qtext
))
28722 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28723 else if (EQ (pointer
, intern ("hdrag")))
28724 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28725 else if (EQ (pointer
, intern ("nhdrag")))
28726 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28727 #ifdef HAVE_X_WINDOWS
28728 else if (EQ (pointer
, intern ("vdrag")))
28729 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28731 else if (EQ (pointer
, intern ("hourglass")))
28732 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28733 else if (EQ (pointer
, Qmodeline
))
28734 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28736 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28739 if (cursor
!= No_Cursor
)
28740 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28743 #endif /* HAVE_WINDOW_SYSTEM */
28745 /* Take proper action when mouse has moved to the mode or header line
28746 or marginal area AREA of window W, x-position X and y-position Y.
28747 X is relative to the start of the text display area of W, so the
28748 width of bitmap areas and scroll bars must be subtracted to get a
28749 position relative to the start of the mode line. */
28752 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28753 enum window_part area
)
28755 struct window
*w
= XWINDOW (window
);
28756 struct frame
*f
= XFRAME (w
->frame
);
28757 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28758 #ifdef HAVE_WINDOW_SYSTEM
28759 Display_Info
*dpyinfo
;
28761 Cursor cursor
= No_Cursor
;
28762 Lisp_Object pointer
= Qnil
;
28763 int dx
, dy
, width
, height
;
28765 Lisp_Object string
, object
= Qnil
;
28766 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28768 Lisp_Object mouse_face
;
28769 int original_x_pixel
= x
;
28770 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28771 struct glyph_row
*row
IF_LINT (= 0);
28773 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28778 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28779 returns them in row/column units! */
28780 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28781 &object
, &dx
, &dy
, &width
, &height
);
28783 row
= (area
== ON_MODE_LINE
28784 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28785 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28787 /* Find the glyph under the mouse pointer. */
28788 if (row
->mode_line_p
&& row
->enabled_p
)
28790 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28791 end
= glyph
+ row
->used
[TEXT_AREA
];
28793 for (x0
= original_x_pixel
;
28794 glyph
< end
&& x0
>= glyph
->pixel_width
;
28796 x0
-= glyph
->pixel_width
;
28804 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28805 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28806 returns them in row/column units! */
28807 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28808 &object
, &dx
, &dy
, &width
, &height
);
28813 #ifdef HAVE_WINDOW_SYSTEM
28814 if (IMAGEP (object
))
28816 Lisp_Object image_map
, hotspot
;
28817 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28819 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28821 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28825 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28826 If so, we could look for mouse-enter, mouse-leave
28827 properties in PLIST (and do something...). */
28828 hotspot
= XCDR (hotspot
);
28829 if (CONSP (hotspot
)
28830 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28832 pointer
= Fplist_get (plist
, Qpointer
);
28833 if (NILP (pointer
))
28835 help
= Fplist_get (plist
, Qhelp_echo
);
28838 help_echo_string
= help
;
28839 XSETWINDOW (help_echo_window
, w
);
28840 help_echo_object
= w
->contents
;
28841 help_echo_pos
= charpos
;
28845 if (NILP (pointer
))
28846 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28848 #endif /* HAVE_WINDOW_SYSTEM */
28850 if (STRINGP (string
))
28851 pos
= make_number (charpos
);
28853 /* Set the help text and mouse pointer. If the mouse is on a part
28854 of the mode line without any text (e.g. past the right edge of
28855 the mode line text), use the default help text and pointer. */
28856 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28858 /* Arrange to display the help by setting the global variables
28859 help_echo_string, help_echo_object, and help_echo_pos. */
28862 if (STRINGP (string
))
28863 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28867 help_echo_string
= help
;
28868 XSETWINDOW (help_echo_window
, w
);
28869 help_echo_object
= string
;
28870 help_echo_pos
= charpos
;
28872 else if (area
== ON_MODE_LINE
)
28874 Lisp_Object default_help
28875 = buffer_local_value (Qmode_line_default_help_echo
,
28878 if (STRINGP (default_help
))
28880 help_echo_string
= default_help
;
28881 XSETWINDOW (help_echo_window
, w
);
28882 help_echo_object
= Qnil
;
28883 help_echo_pos
= -1;
28888 #ifdef HAVE_WINDOW_SYSTEM
28889 /* Change the mouse pointer according to what is under it. */
28890 if (FRAME_WINDOW_P (f
))
28892 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28894 || NILP (Vresize_mini_windows
));
28896 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28897 if (STRINGP (string
))
28899 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28901 if (NILP (pointer
))
28902 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28904 /* Change the mouse pointer according to what is under X/Y. */
28906 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28909 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28910 if (!KEYMAPP (map
))
28911 map
= Fget_text_property (pos
, Qkeymap
, string
);
28912 if (!KEYMAPP (map
) && draggable
)
28913 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28916 else if (draggable
)
28917 /* Default mode-line pointer. */
28918 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28923 /* Change the mouse face according to what is under X/Y. */
28924 if (STRINGP (string
))
28926 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28927 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28928 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28933 struct glyph
* tmp_glyph
;
28937 int total_pixel_width
;
28938 ptrdiff_t begpos
, endpos
, ignore
;
28942 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28943 Qmouse_face
, string
, Qnil
);
28949 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28951 endpos
= SCHARS (string
);
28955 /* Calculate the glyph position GPOS of GLYPH in the
28956 displayed string, relative to the beginning of the
28957 highlighted part of the string.
28959 Note: GPOS is different from CHARPOS. CHARPOS is the
28960 position of GLYPH in the internal string object. A mode
28961 line string format has structures which are converted to
28962 a flattened string by the Emacs Lisp interpreter. The
28963 internal string is an element of those structures. The
28964 displayed string is the flattened string. */
28965 tmp_glyph
= row_start_glyph
;
28966 while (tmp_glyph
< glyph
28967 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28968 && begpos
<= tmp_glyph
->charpos
28969 && tmp_glyph
->charpos
< endpos
)))
28971 gpos
= glyph
- tmp_glyph
;
28973 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28974 the highlighted part of the displayed string to which
28975 GLYPH belongs. Note: GSEQ_LENGTH is different from
28976 SCHARS (STRING), because the latter returns the length of
28977 the internal string. */
28978 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28980 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28981 && begpos
<= tmp_glyph
->charpos
28982 && tmp_glyph
->charpos
< endpos
));
28985 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28987 /* Calculate the total pixel width of all the glyphs between
28988 the beginning of the highlighted area and GLYPH. */
28989 total_pixel_width
= 0;
28990 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28991 total_pixel_width
+= tmp_glyph
->pixel_width
;
28993 /* Pre calculation of re-rendering position. Note: X is in
28994 column units here, after the call to mode_line_string or
28995 marginal_area_string. */
28997 vpos
= (area
== ON_MODE_LINE
28998 ? (w
->current_matrix
)->nrows
- 1
29001 /* If GLYPH's position is included in the region that is
29002 already drawn in mouse face, we have nothing to do. */
29003 if ( EQ (window
, hlinfo
->mouse_face_window
)
29004 && (!row
->reversed_p
29005 ? (hlinfo
->mouse_face_beg_col
<= hpos
29006 && hpos
< hlinfo
->mouse_face_end_col
)
29007 /* In R2L rows we swap BEG and END, see below. */
29008 : (hlinfo
->mouse_face_end_col
<= hpos
29009 && hpos
< hlinfo
->mouse_face_beg_col
))
29010 && hlinfo
->mouse_face_beg_row
== vpos
)
29013 if (clear_mouse_face (hlinfo
))
29014 cursor
= No_Cursor
;
29016 if (!row
->reversed_p
)
29018 hlinfo
->mouse_face_beg_col
= hpos
;
29019 hlinfo
->mouse_face_beg_x
= original_x_pixel
29020 - (total_pixel_width
+ dx
);
29021 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29022 hlinfo
->mouse_face_end_x
= 0;
29026 /* In R2L rows, show_mouse_face expects BEG and END
29027 coordinates to be swapped. */
29028 hlinfo
->mouse_face_end_col
= hpos
;
29029 hlinfo
->mouse_face_end_x
= original_x_pixel
29030 - (total_pixel_width
+ dx
);
29031 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29032 hlinfo
->mouse_face_beg_x
= 0;
29035 hlinfo
->mouse_face_beg_row
= vpos
;
29036 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29037 hlinfo
->mouse_face_past_end
= 0;
29038 hlinfo
->mouse_face_window
= window
;
29040 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29045 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29047 if (NILP (pointer
))
29050 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29051 clear_mouse_face (hlinfo
);
29053 #ifdef HAVE_WINDOW_SYSTEM
29054 if (FRAME_WINDOW_P (f
))
29055 define_frame_cursor1 (f
, cursor
, pointer
);
29061 Take proper action when the mouse has moved to position X, Y on
29062 frame F with regards to highlighting portions of display that have
29063 mouse-face properties. Also de-highlight portions of display where
29064 the mouse was before, set the mouse pointer shape as appropriate
29065 for the mouse coordinates, and activate help echo (tooltips).
29066 X and Y can be negative or out of range. */
29069 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29071 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29072 enum window_part part
= ON_NOTHING
;
29073 Lisp_Object window
;
29075 Cursor cursor
= No_Cursor
;
29076 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29079 /* When a menu is active, don't highlight because this looks odd. */
29080 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29081 if (popup_activated ())
29085 if (!f
->glyphs_initialized_p
29086 || f
->pointer_invisible
)
29089 hlinfo
->mouse_face_mouse_x
= x
;
29090 hlinfo
->mouse_face_mouse_y
= y
;
29091 hlinfo
->mouse_face_mouse_frame
= f
;
29093 if (hlinfo
->mouse_face_defer
)
29096 /* Which window is that in? */
29097 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29099 /* If displaying active text in another window, clear that. */
29100 if (! EQ (window
, hlinfo
->mouse_face_window
)
29101 /* Also clear if we move out of text area in same window. */
29102 || (!NILP (hlinfo
->mouse_face_window
)
29105 && part
!= ON_MODE_LINE
29106 && part
!= ON_HEADER_LINE
))
29107 clear_mouse_face (hlinfo
);
29109 /* Not on a window -> return. */
29110 if (!WINDOWP (window
))
29113 /* Reset help_echo_string. It will get recomputed below. */
29114 help_echo_string
= Qnil
;
29116 /* Convert to window-relative pixel coordinates. */
29117 w
= XWINDOW (window
);
29118 frame_to_window_pixel_xy (w
, &x
, &y
);
29120 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29121 /* Handle tool-bar window differently since it doesn't display a
29123 if (EQ (window
, f
->tool_bar_window
))
29125 note_tool_bar_highlight (f
, x
, y
);
29130 /* Mouse is on the mode, header line or margin? */
29131 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29132 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29134 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29136 #ifdef HAVE_WINDOW_SYSTEM
29137 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29139 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29140 /* Show non-text cursor (Bug#16647). */
29148 #ifdef HAVE_WINDOW_SYSTEM
29149 if (part
== ON_VERTICAL_BORDER
)
29151 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29152 help_echo_string
= build_string ("drag-mouse-1: resize");
29154 else if (part
== ON_RIGHT_DIVIDER
)
29156 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29157 help_echo_string
= build_string ("drag-mouse-1: resize");
29159 else if (part
== ON_BOTTOM_DIVIDER
)
29160 if (! WINDOW_BOTTOMMOST_P (w
)
29162 || NILP (Vresize_mini_windows
))
29164 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29165 help_echo_string
= build_string ("drag-mouse-1: resize");
29168 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29169 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29170 || part
== ON_VERTICAL_SCROLL_BAR
29171 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29172 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29174 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29177 /* Are we in a window whose display is up to date?
29178 And verify the buffer's text has not changed. */
29179 b
= XBUFFER (w
->contents
);
29180 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29182 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29184 struct glyph
*glyph
;
29185 Lisp_Object object
;
29186 Lisp_Object mouse_face
= Qnil
, position
;
29187 Lisp_Object
*overlay_vec
= NULL
;
29188 ptrdiff_t i
, noverlays
;
29189 struct buffer
*obuf
;
29190 ptrdiff_t obegv
, ozv
;
29193 /* Find the glyph under X/Y. */
29194 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29196 #ifdef HAVE_WINDOW_SYSTEM
29197 /* Look for :pointer property on image. */
29198 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29200 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29201 if (img
!= NULL
&& IMAGEP (img
->spec
))
29203 Lisp_Object image_map
, hotspot
;
29204 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29206 && (hotspot
= find_hot_spot (image_map
,
29207 glyph
->slice
.img
.x
+ dx
,
29208 glyph
->slice
.img
.y
+ dy
),
29210 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29214 /* Could check XCAR (hotspot) to see if we enter/leave
29216 If so, we could look for mouse-enter, mouse-leave
29217 properties in PLIST (and do something...). */
29218 hotspot
= XCDR (hotspot
);
29219 if (CONSP (hotspot
)
29220 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29222 pointer
= Fplist_get (plist
, Qpointer
);
29223 if (NILP (pointer
))
29225 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29226 if (!NILP (help_echo_string
))
29228 help_echo_window
= window
;
29229 help_echo_object
= glyph
->object
;
29230 help_echo_pos
= glyph
->charpos
;
29234 if (NILP (pointer
))
29235 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29238 #endif /* HAVE_WINDOW_SYSTEM */
29240 /* Clear mouse face if X/Y not over text. */
29242 || area
!= TEXT_AREA
29243 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29244 /* Glyph's OBJECT is an integer for glyphs inserted by the
29245 display engine for its internal purposes, like truncation
29246 and continuation glyphs and blanks beyond the end of
29247 line's text on text terminals. If we are over such a
29248 glyph, we are not over any text. */
29249 || INTEGERP (glyph
->object
)
29250 /* R2L rows have a stretch glyph at their front, which
29251 stands for no text, whereas L2R rows have no glyphs at
29252 all beyond the end of text. Treat such stretch glyphs
29253 like we do with NULL glyphs in L2R rows. */
29254 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29255 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29256 && glyph
->type
== STRETCH_GLYPH
29257 && glyph
->avoid_cursor_p
))
29259 if (clear_mouse_face (hlinfo
))
29260 cursor
= No_Cursor
;
29261 #ifdef HAVE_WINDOW_SYSTEM
29262 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29264 if (area
!= TEXT_AREA
)
29265 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29267 pointer
= Vvoid_text_area_pointer
;
29273 pos
= glyph
->charpos
;
29274 object
= glyph
->object
;
29275 if (!STRINGP (object
) && !BUFFERP (object
))
29278 /* If we get an out-of-range value, return now; avoid an error. */
29279 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29282 /* Make the window's buffer temporarily current for
29283 overlays_at and compute_char_face. */
29284 obuf
= current_buffer
;
29285 current_buffer
= b
;
29291 /* Is this char mouse-active or does it have help-echo? */
29292 position
= make_number (pos
);
29294 if (BUFFERP (object
))
29296 /* Put all the overlays we want in a vector in overlay_vec. */
29297 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29298 /* Sort overlays into increasing priority order. */
29299 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29304 if (NILP (Vmouse_highlight
))
29306 clear_mouse_face (hlinfo
);
29307 goto check_help_echo
;
29310 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29313 cursor
= No_Cursor
;
29315 /* Check mouse-face highlighting. */
29317 /* If there exists an overlay with mouse-face overlapping
29318 the one we are currently highlighting, we have to
29319 check if we enter the overlapping overlay, and then
29320 highlight only that. */
29321 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29322 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29324 /* Find the highest priority overlay with a mouse-face. */
29325 Lisp_Object overlay
= Qnil
;
29326 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29328 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29329 if (!NILP (mouse_face
))
29330 overlay
= overlay_vec
[i
];
29333 /* If we're highlighting the same overlay as before, there's
29334 no need to do that again. */
29335 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29336 goto check_help_echo
;
29337 hlinfo
->mouse_face_overlay
= overlay
;
29339 /* Clear the display of the old active region, if any. */
29340 if (clear_mouse_face (hlinfo
))
29341 cursor
= No_Cursor
;
29343 /* If no overlay applies, get a text property. */
29344 if (NILP (overlay
))
29345 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29347 /* Next, compute the bounds of the mouse highlighting and
29349 if (!NILP (mouse_face
) && STRINGP (object
))
29351 /* The mouse-highlighting comes from a display string
29352 with a mouse-face. */
29356 s
= Fprevious_single_property_change
29357 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29358 e
= Fnext_single_property_change
29359 (position
, Qmouse_face
, object
, Qnil
);
29361 s
= make_number (0);
29363 e
= make_number (SCHARS (object
));
29364 mouse_face_from_string_pos (w
, hlinfo
, object
,
29365 XINT (s
), XINT (e
));
29366 hlinfo
->mouse_face_past_end
= 0;
29367 hlinfo
->mouse_face_window
= window
;
29368 hlinfo
->mouse_face_face_id
29369 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29370 glyph
->face_id
, 1);
29371 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29372 cursor
= No_Cursor
;
29376 /* The mouse-highlighting, if any, comes from an overlay
29377 or text property in the buffer. */
29378 Lisp_Object buffer
IF_LINT (= Qnil
);
29379 Lisp_Object disp_string
IF_LINT (= Qnil
);
29381 if (STRINGP (object
))
29383 /* If we are on a display string with no mouse-face,
29384 check if the text under it has one. */
29385 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29386 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29387 pos
= string_buffer_position (object
, start
);
29390 mouse_face
= get_char_property_and_overlay
29391 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29392 buffer
= w
->contents
;
29393 disp_string
= object
;
29399 disp_string
= Qnil
;
29402 if (!NILP (mouse_face
))
29404 Lisp_Object before
, after
;
29405 Lisp_Object before_string
, after_string
;
29406 /* To correctly find the limits of mouse highlight
29407 in a bidi-reordered buffer, we must not use the
29408 optimization of limiting the search in
29409 previous-single-property-change and
29410 next-single-property-change, because
29411 rows_from_pos_range needs the real start and end
29412 positions to DTRT in this case. That's because
29413 the first row visible in a window does not
29414 necessarily display the character whose position
29415 is the smallest. */
29417 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29418 ? Fmarker_position (w
->start
)
29421 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29422 ? make_number (BUF_Z (XBUFFER (buffer
))
29423 - w
->window_end_pos
)
29426 if (NILP (overlay
))
29428 /* Handle the text property case. */
29429 before
= Fprevious_single_property_change
29430 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29431 after
= Fnext_single_property_change
29432 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29433 before_string
= after_string
= Qnil
;
29437 /* Handle the overlay case. */
29438 before
= Foverlay_start (overlay
);
29439 after
= Foverlay_end (overlay
);
29440 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29441 after_string
= Foverlay_get (overlay
, Qafter_string
);
29443 if (!STRINGP (before_string
)) before_string
= Qnil
;
29444 if (!STRINGP (after_string
)) after_string
= Qnil
;
29447 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29450 : XFASTINT (before
),
29452 ? BUF_Z (XBUFFER (buffer
))
29453 : XFASTINT (after
),
29454 before_string
, after_string
,
29456 cursor
= No_Cursor
;
29463 /* Look for a `help-echo' property. */
29464 if (NILP (help_echo_string
)) {
29465 Lisp_Object help
, overlay
;
29467 /* Check overlays first. */
29468 help
= overlay
= Qnil
;
29469 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29471 overlay
= overlay_vec
[i
];
29472 help
= Foverlay_get (overlay
, Qhelp_echo
);
29477 help_echo_string
= help
;
29478 help_echo_window
= window
;
29479 help_echo_object
= overlay
;
29480 help_echo_pos
= pos
;
29484 Lisp_Object obj
= glyph
->object
;
29485 ptrdiff_t charpos
= glyph
->charpos
;
29487 /* Try text properties. */
29490 && charpos
< SCHARS (obj
))
29492 help
= Fget_text_property (make_number (charpos
),
29496 /* If the string itself doesn't specify a help-echo,
29497 see if the buffer text ``under'' it does. */
29498 struct glyph_row
*r
29499 = MATRIX_ROW (w
->current_matrix
, vpos
);
29500 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29501 ptrdiff_t p
= string_buffer_position (obj
, start
);
29504 help
= Fget_char_property (make_number (p
),
29505 Qhelp_echo
, w
->contents
);
29514 else if (BUFFERP (obj
)
29517 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29522 help_echo_string
= help
;
29523 help_echo_window
= window
;
29524 help_echo_object
= obj
;
29525 help_echo_pos
= charpos
;
29530 #ifdef HAVE_WINDOW_SYSTEM
29531 /* Look for a `pointer' property. */
29532 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29534 /* Check overlays first. */
29535 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29536 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29538 if (NILP (pointer
))
29540 Lisp_Object obj
= glyph
->object
;
29541 ptrdiff_t charpos
= glyph
->charpos
;
29543 /* Try text properties. */
29546 && charpos
< SCHARS (obj
))
29548 pointer
= Fget_text_property (make_number (charpos
),
29550 if (NILP (pointer
))
29552 /* If the string itself doesn't specify a pointer,
29553 see if the buffer text ``under'' it does. */
29554 struct glyph_row
*r
29555 = MATRIX_ROW (w
->current_matrix
, vpos
);
29556 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29557 ptrdiff_t p
= string_buffer_position (obj
, start
);
29559 pointer
= Fget_char_property (make_number (p
),
29560 Qpointer
, w
->contents
);
29563 else if (BUFFERP (obj
)
29566 pointer
= Fget_text_property (make_number (charpos
),
29570 #endif /* HAVE_WINDOW_SYSTEM */
29574 current_buffer
= obuf
;
29579 #ifdef HAVE_WINDOW_SYSTEM
29580 if (FRAME_WINDOW_P (f
))
29581 define_frame_cursor1 (f
, cursor
, pointer
);
29583 /* This is here to prevent a compiler error, about "label at end of
29584 compound statement". */
29591 Clear any mouse-face on window W. This function is part of the
29592 redisplay interface, and is called from try_window_id and similar
29593 functions to ensure the mouse-highlight is off. */
29596 x_clear_window_mouse_face (struct window
*w
)
29598 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29599 Lisp_Object window
;
29602 XSETWINDOW (window
, w
);
29603 if (EQ (window
, hlinfo
->mouse_face_window
))
29604 clear_mouse_face (hlinfo
);
29610 Just discard the mouse face information for frame F, if any.
29611 This is used when the size of F is changed. */
29614 cancel_mouse_face (struct frame
*f
)
29616 Lisp_Object window
;
29617 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29619 window
= hlinfo
->mouse_face_window
;
29620 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29621 reset_mouse_highlight (hlinfo
);
29626 /***********************************************************************
29628 ***********************************************************************/
29630 #ifdef HAVE_WINDOW_SYSTEM
29632 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29633 which intersects rectangle R. R is in window-relative coordinates. */
29636 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29637 enum glyph_row_area area
)
29639 struct glyph
*first
= row
->glyphs
[area
];
29640 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29641 struct glyph
*last
;
29642 int first_x
, start_x
, x
;
29644 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29645 /* If row extends face to end of line write the whole line. */
29646 draw_glyphs (w
, 0, row
, area
,
29647 0, row
->used
[area
],
29648 DRAW_NORMAL_TEXT
, 0);
29651 /* Set START_X to the window-relative start position for drawing glyphs of
29652 AREA. The first glyph of the text area can be partially visible.
29653 The first glyphs of other areas cannot. */
29654 start_x
= window_box_left_offset (w
, area
);
29656 if (area
== TEXT_AREA
)
29659 /* Find the first glyph that must be redrawn. */
29661 && x
+ first
->pixel_width
< r
->x
)
29663 x
+= first
->pixel_width
;
29667 /* Find the last one. */
29671 && x
< r
->x
+ r
->width
)
29673 x
+= last
->pixel_width
;
29679 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29680 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29681 DRAW_NORMAL_TEXT
, 0);
29686 /* Redraw the parts of the glyph row ROW on window W intersecting
29687 rectangle R. R is in window-relative coordinates. Value is
29688 non-zero if mouse-face was overwritten. */
29691 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29693 eassert (row
->enabled_p
);
29695 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29696 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29697 0, row
->used
[TEXT_AREA
],
29698 DRAW_NORMAL_TEXT
, 0);
29701 if (row
->used
[LEFT_MARGIN_AREA
])
29702 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29703 if (row
->used
[TEXT_AREA
])
29704 expose_area (w
, row
, r
, TEXT_AREA
);
29705 if (row
->used
[RIGHT_MARGIN_AREA
])
29706 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29707 draw_row_fringe_bitmaps (w
, row
);
29710 return row
->mouse_face_p
;
29714 /* Redraw those parts of glyphs rows during expose event handling that
29715 overlap other rows. Redrawing of an exposed line writes over parts
29716 of lines overlapping that exposed line; this function fixes that.
29718 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29719 row in W's current matrix that is exposed and overlaps other rows.
29720 LAST_OVERLAPPING_ROW is the last such row. */
29723 expose_overlaps (struct window
*w
,
29724 struct glyph_row
*first_overlapping_row
,
29725 struct glyph_row
*last_overlapping_row
,
29728 struct glyph_row
*row
;
29730 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29731 if (row
->overlapping_p
)
29733 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29736 if (row
->used
[LEFT_MARGIN_AREA
])
29737 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29739 if (row
->used
[TEXT_AREA
])
29740 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29742 if (row
->used
[RIGHT_MARGIN_AREA
])
29743 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29749 /* Return non-zero if W's cursor intersects rectangle R. */
29752 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29754 XRectangle cr
, result
;
29755 struct glyph
*cursor_glyph
;
29756 struct glyph_row
*row
;
29758 if (w
->phys_cursor
.vpos
>= 0
29759 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29760 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29762 && row
->cursor_in_fringe_p
)
29764 /* Cursor is in the fringe. */
29765 cr
.x
= window_box_right_offset (w
,
29766 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29767 ? RIGHT_MARGIN_AREA
29770 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29771 cr
.height
= row
->height
;
29772 return x_intersect_rectangles (&cr
, r
, &result
);
29775 cursor_glyph
= get_phys_cursor_glyph (w
);
29778 /* r is relative to W's box, but w->phys_cursor.x is relative
29779 to left edge of W's TEXT area. Adjust it. */
29780 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29781 cr
.y
= w
->phys_cursor
.y
;
29782 cr
.width
= cursor_glyph
->pixel_width
;
29783 cr
.height
= w
->phys_cursor_height
;
29784 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29785 I assume the effect is the same -- and this is portable. */
29786 return x_intersect_rectangles (&cr
, r
, &result
);
29788 /* If we don't understand the format, pretend we're not in the hot-spot. */
29794 Draw a vertical window border to the right of window W if W doesn't
29795 have vertical scroll bars. */
29798 x_draw_vertical_border (struct window
*w
)
29800 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29802 /* We could do better, if we knew what type of scroll-bar the adjacent
29803 windows (on either side) have... But we don't :-(
29804 However, I think this works ok. ++KFS 2003-04-25 */
29806 /* Redraw borders between horizontally adjacent windows. Don't
29807 do it for frames with vertical scroll bars because either the
29808 right scroll bar of a window, or the left scroll bar of its
29809 neighbor will suffice as a border. */
29810 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29813 /* Note: It is necessary to redraw both the left and the right
29814 borders, for when only this single window W is being
29816 if (!WINDOW_RIGHTMOST_P (w
)
29817 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29819 int x0
, x1
, y0
, y1
;
29821 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29824 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29827 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29830 if (!WINDOW_LEFTMOST_P (w
)
29831 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29833 int x0
, x1
, y0
, y1
;
29835 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29838 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29841 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29846 /* Draw window dividers for window W. */
29849 x_draw_right_divider (struct window
*w
)
29851 struct frame
*f
= WINDOW_XFRAME (w
);
29853 if (w
->mini
|| w
->pseudo_window_p
)
29855 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29857 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29858 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29859 int y0
= WINDOW_TOP_EDGE_Y (w
);
29860 /* The bottom divider prevails. */
29861 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29863 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29868 x_draw_bottom_divider (struct window
*w
)
29870 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29872 if (w
->mini
|| w
->pseudo_window_p
)
29874 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29876 int x0
= WINDOW_LEFT_EDGE_X (w
);
29877 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29878 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29879 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29881 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29885 /* Redraw the part of window W intersection rectangle FR. Pixel
29886 coordinates in FR are frame-relative. Call this function with
29887 input blocked. Value is non-zero if the exposure overwrites
29891 expose_window (struct window
*w
, XRectangle
*fr
)
29893 struct frame
*f
= XFRAME (w
->frame
);
29895 int mouse_face_overwritten_p
= 0;
29897 /* If window is not yet fully initialized, do nothing. This can
29898 happen when toolkit scroll bars are used and a window is split.
29899 Reconfiguring the scroll bar will generate an expose for a newly
29901 if (w
->current_matrix
== NULL
)
29904 /* When we're currently updating the window, display and current
29905 matrix usually don't agree. Arrange for a thorough display
29907 if (w
->must_be_updated_p
)
29909 SET_FRAME_GARBAGED (f
);
29913 /* Frame-relative pixel rectangle of W. */
29914 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29915 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29916 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29917 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29919 if (x_intersect_rectangles (fr
, &wr
, &r
))
29921 int yb
= window_text_bottom_y (w
);
29922 struct glyph_row
*row
;
29923 int cursor_cleared_p
, phys_cursor_on_p
;
29924 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29926 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29927 r
.x
, r
.y
, r
.width
, r
.height
));
29929 /* Convert to window coordinates. */
29930 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29931 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29933 /* Turn off the cursor. */
29934 if (!w
->pseudo_window_p
29935 && phys_cursor_in_rect_p (w
, &r
))
29937 x_clear_cursor (w
);
29938 cursor_cleared_p
= 1;
29941 cursor_cleared_p
= 0;
29943 /* If the row containing the cursor extends face to end of line,
29944 then expose_area might overwrite the cursor outside the
29945 rectangle and thus notice_overwritten_cursor might clear
29946 w->phys_cursor_on_p. We remember the original value and
29947 check later if it is changed. */
29948 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29950 /* Update lines intersecting rectangle R. */
29951 first_overlapping_row
= last_overlapping_row
= NULL
;
29952 for (row
= w
->current_matrix
->rows
;
29957 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29959 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29960 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29961 || (r
.y
>= y0
&& r
.y
< y1
)
29962 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29964 /* A header line may be overlapping, but there is no need
29965 to fix overlapping areas for them. KFS 2005-02-12 */
29966 if (row
->overlapping_p
&& !row
->mode_line_p
)
29968 if (first_overlapping_row
== NULL
)
29969 first_overlapping_row
= row
;
29970 last_overlapping_row
= row
;
29974 if (expose_line (w
, row
, &r
))
29975 mouse_face_overwritten_p
= 1;
29978 else if (row
->overlapping_p
)
29980 /* We must redraw a row overlapping the exposed area. */
29982 ? y0
+ row
->phys_height
> r
.y
29983 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29985 if (first_overlapping_row
== NULL
)
29986 first_overlapping_row
= row
;
29987 last_overlapping_row
= row
;
29995 /* Display the mode line if there is one. */
29996 if (WINDOW_WANTS_MODELINE_P (w
)
29997 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29999 && row
->y
< r
.y
+ r
.height
)
30001 if (expose_line (w
, row
, &r
))
30002 mouse_face_overwritten_p
= 1;
30005 if (!w
->pseudo_window_p
)
30007 /* Fix the display of overlapping rows. */
30008 if (first_overlapping_row
)
30009 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30012 /* Draw border between windows. */
30013 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30014 x_draw_right_divider (w
);
30016 x_draw_vertical_border (w
);
30018 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30019 x_draw_bottom_divider (w
);
30021 /* Turn the cursor on again. */
30022 if (cursor_cleared_p
30023 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30024 update_window_cursor (w
, 1);
30028 return mouse_face_overwritten_p
;
30033 /* Redraw (parts) of all windows in the window tree rooted at W that
30034 intersect R. R contains frame pixel coordinates. Value is
30035 non-zero if the exposure overwrites mouse-face. */
30038 expose_window_tree (struct window
*w
, XRectangle
*r
)
30040 struct frame
*f
= XFRAME (w
->frame
);
30041 int mouse_face_overwritten_p
= 0;
30043 while (w
&& !FRAME_GARBAGED_P (f
))
30045 if (WINDOWP (w
->contents
))
30046 mouse_face_overwritten_p
30047 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30049 mouse_face_overwritten_p
|= expose_window (w
, r
);
30051 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30054 return mouse_face_overwritten_p
;
30059 Redisplay an exposed area of frame F. X and Y are the upper-left
30060 corner of the exposed rectangle. W and H are width and height of
30061 the exposed area. All are pixel values. W or H zero means redraw
30062 the entire frame. */
30065 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30068 int mouse_face_overwritten_p
= 0;
30070 TRACE ((stderr
, "expose_frame "));
30072 /* No need to redraw if frame will be redrawn soon. */
30073 if (FRAME_GARBAGED_P (f
))
30075 TRACE ((stderr
, " garbaged\n"));
30079 /* If basic faces haven't been realized yet, there is no point in
30080 trying to redraw anything. This can happen when we get an expose
30081 event while Emacs is starting, e.g. by moving another window. */
30082 if (FRAME_FACE_CACHE (f
) == NULL
30083 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30085 TRACE ((stderr
, " no faces\n"));
30089 if (w
== 0 || h
== 0)
30092 r
.width
= FRAME_TEXT_WIDTH (f
);
30093 r
.height
= FRAME_TEXT_HEIGHT (f
);
30094 /** r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f); **/
30095 /** r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f); **/
30105 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30106 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30108 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30109 if (WINDOWP (f
->tool_bar_window
))
30110 mouse_face_overwritten_p
30111 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30114 #ifdef HAVE_X_WINDOWS
30116 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30117 if (WINDOWP (f
->menu_bar_window
))
30118 mouse_face_overwritten_p
30119 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30120 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30124 /* Some window managers support a focus-follows-mouse style with
30125 delayed raising of frames. Imagine a partially obscured frame,
30126 and moving the mouse into partially obscured mouse-face on that
30127 frame. The visible part of the mouse-face will be highlighted,
30128 then the WM raises the obscured frame. With at least one WM, KDE
30129 2.1, Emacs is not getting any event for the raising of the frame
30130 (even tried with SubstructureRedirectMask), only Expose events.
30131 These expose events will draw text normally, i.e. not
30132 highlighted. Which means we must redo the highlight here.
30133 Subsume it under ``we love X''. --gerd 2001-08-15 */
30134 /* Included in Windows version because Windows most likely does not
30135 do the right thing if any third party tool offers
30136 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30137 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30139 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30140 if (f
== hlinfo
->mouse_face_mouse_frame
)
30142 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30143 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30144 clear_mouse_face (hlinfo
);
30145 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30152 Determine the intersection of two rectangles R1 and R2. Return
30153 the intersection in *RESULT. Value is non-zero if RESULT is not
30157 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30159 XRectangle
*left
, *right
;
30160 XRectangle
*upper
, *lower
;
30161 int intersection_p
= 0;
30163 /* Rearrange so that R1 is the left-most rectangle. */
30165 left
= r1
, right
= r2
;
30167 left
= r2
, right
= r1
;
30169 /* X0 of the intersection is right.x0, if this is inside R1,
30170 otherwise there is no intersection. */
30171 if (right
->x
<= left
->x
+ left
->width
)
30173 result
->x
= right
->x
;
30175 /* The right end of the intersection is the minimum of
30176 the right ends of left and right. */
30177 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30180 /* Same game for Y. */
30182 upper
= r1
, lower
= r2
;
30184 upper
= r2
, lower
= r1
;
30186 /* The upper end of the intersection is lower.y0, if this is inside
30187 of upper. Otherwise, there is no intersection. */
30188 if (lower
->y
<= upper
->y
+ upper
->height
)
30190 result
->y
= lower
->y
;
30192 /* The lower end of the intersection is the minimum of the lower
30193 ends of upper and lower. */
30194 result
->height
= (min (lower
->y
+ lower
->height
,
30195 upper
->y
+ upper
->height
)
30197 intersection_p
= 1;
30201 return intersection_p
;
30204 #endif /* HAVE_WINDOW_SYSTEM */
30207 /***********************************************************************
30209 ***********************************************************************/
30212 syms_of_xdisp (void)
30214 Vwith_echo_area_save_vector
= Qnil
;
30215 staticpro (&Vwith_echo_area_save_vector
);
30217 Vmessage_stack
= Qnil
;
30218 staticpro (&Vmessage_stack
);
30220 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30221 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30223 message_dolog_marker1
= Fmake_marker ();
30224 staticpro (&message_dolog_marker1
);
30225 message_dolog_marker2
= Fmake_marker ();
30226 staticpro (&message_dolog_marker2
);
30227 message_dolog_marker3
= Fmake_marker ();
30228 staticpro (&message_dolog_marker3
);
30231 defsubr (&Sdump_frame_glyph_matrix
);
30232 defsubr (&Sdump_glyph_matrix
);
30233 defsubr (&Sdump_glyph_row
);
30234 defsubr (&Sdump_tool_bar_row
);
30235 defsubr (&Strace_redisplay
);
30236 defsubr (&Strace_to_stderr
);
30238 #ifdef HAVE_WINDOW_SYSTEM
30239 defsubr (&Stool_bar_height
);
30240 defsubr (&Slookup_image_map
);
30242 defsubr (&Sline_pixel_height
);
30243 defsubr (&Sformat_mode_line
);
30244 defsubr (&Sinvisible_p
);
30245 defsubr (&Scurrent_bidi_paragraph_direction
);
30246 defsubr (&Swindow_text_pixel_size
);
30247 defsubr (&Smove_point_visually
);
30249 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30250 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30251 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30252 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30253 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30254 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30255 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30256 DEFSYM (Qeval
, "eval");
30257 DEFSYM (QCdata
, ":data");
30258 DEFSYM (Qdisplay
, "display");
30259 DEFSYM (Qspace_width
, "space-width");
30260 DEFSYM (Qraise
, "raise");
30261 DEFSYM (Qslice
, "slice");
30262 DEFSYM (Qspace
, "space");
30263 DEFSYM (Qmargin
, "margin");
30264 DEFSYM (Qpointer
, "pointer");
30265 DEFSYM (Qleft_margin
, "left-margin");
30266 DEFSYM (Qright_margin
, "right-margin");
30267 DEFSYM (Qcenter
, "center");
30268 DEFSYM (Qline_height
, "line-height");
30269 DEFSYM (QCalign_to
, ":align-to");
30270 DEFSYM (QCrelative_width
, ":relative-width");
30271 DEFSYM (QCrelative_height
, ":relative-height");
30272 DEFSYM (QCeval
, ":eval");
30273 DEFSYM (QCpropertize
, ":propertize");
30274 DEFSYM (QCfile
, ":file");
30275 DEFSYM (Qfontified
, "fontified");
30276 DEFSYM (Qfontification_functions
, "fontification-functions");
30277 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30278 DEFSYM (Qescape_glyph
, "escape-glyph");
30279 DEFSYM (Qnobreak_space
, "nobreak-space");
30280 DEFSYM (Qimage
, "image");
30281 DEFSYM (Qtext
, "text");
30282 DEFSYM (Qboth
, "both");
30283 DEFSYM (Qboth_horiz
, "both-horiz");
30284 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30285 DEFSYM (QCmap
, ":map");
30286 DEFSYM (QCpointer
, ":pointer");
30287 DEFSYM (Qrect
, "rect");
30288 DEFSYM (Qcircle
, "circle");
30289 DEFSYM (Qpoly
, "poly");
30290 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30291 DEFSYM (Qgrow_only
, "grow-only");
30292 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30293 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30294 DEFSYM (Qposition
, "position");
30295 DEFSYM (Qbuffer_position
, "buffer-position");
30296 DEFSYM (Qobject
, "object");
30297 DEFSYM (Qbar
, "bar");
30298 DEFSYM (Qhbar
, "hbar");
30299 DEFSYM (Qbox
, "box");
30300 DEFSYM (Qhollow
, "hollow");
30301 DEFSYM (Qhand
, "hand");
30302 DEFSYM (Qarrow
, "arrow");
30303 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30305 list_of_error
= list1 (list2 (intern_c_string ("error"),
30306 intern_c_string ("void-variable")));
30307 staticpro (&list_of_error
);
30309 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30310 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30311 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30312 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30314 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30315 staticpro (&echo_buffer
[0]);
30316 staticpro (&echo_buffer
[1]);
30318 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30319 staticpro (&echo_area_buffer
[0]);
30320 staticpro (&echo_area_buffer
[1]);
30322 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30323 staticpro (&Vmessages_buffer_name
);
30325 mode_line_proptrans_alist
= Qnil
;
30326 staticpro (&mode_line_proptrans_alist
);
30327 mode_line_string_list
= Qnil
;
30328 staticpro (&mode_line_string_list
);
30329 mode_line_string_face
= Qnil
;
30330 staticpro (&mode_line_string_face
);
30331 mode_line_string_face_prop
= Qnil
;
30332 staticpro (&mode_line_string_face_prop
);
30333 Vmode_line_unwind_vector
= Qnil
;
30334 staticpro (&Vmode_line_unwind_vector
);
30336 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30338 help_echo_string
= Qnil
;
30339 staticpro (&help_echo_string
);
30340 help_echo_object
= Qnil
;
30341 staticpro (&help_echo_object
);
30342 help_echo_window
= Qnil
;
30343 staticpro (&help_echo_window
);
30344 previous_help_echo_string
= Qnil
;
30345 staticpro (&previous_help_echo_string
);
30346 help_echo_pos
= -1;
30348 DEFSYM (Qright_to_left
, "right-to-left");
30349 DEFSYM (Qleft_to_right
, "left-to-right");
30351 #ifdef HAVE_WINDOW_SYSTEM
30352 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30353 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30354 For example, if a block cursor is over a tab, it will be drawn as
30355 wide as that tab on the display. */);
30356 x_stretch_cursor_p
= 0;
30359 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30360 doc
: /* Non-nil means highlight trailing whitespace.
30361 The face used for trailing whitespace is `trailing-whitespace'. */);
30362 Vshow_trailing_whitespace
= Qnil
;
30364 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30365 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30366 If the value is t, Emacs highlights non-ASCII chars which have the
30367 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30368 or `escape-glyph' face respectively.
30370 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30371 U+2011 (non-breaking hyphen) are affected.
30373 Any other non-nil value means to display these characters as a escape
30374 glyph followed by an ordinary space or hyphen.
30376 A value of nil means no special handling of these characters. */);
30377 Vnobreak_char_display
= Qt
;
30379 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30380 doc
: /* The pointer shape to show in void text areas.
30381 A value of nil means to show the text pointer. Other options are
30382 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30384 Vvoid_text_area_pointer
= Qarrow
;
30386 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30387 doc
: /* Non-nil means don't actually do any redisplay.
30388 This is used for internal purposes. */);
30389 Vinhibit_redisplay
= Qnil
;
30391 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30392 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30393 Vglobal_mode_string
= Qnil
;
30395 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30396 doc
: /* Marker for where to display an arrow on top of the buffer text.
30397 This must be the beginning of a line in order to work.
30398 See also `overlay-arrow-string'. */);
30399 Voverlay_arrow_position
= Qnil
;
30401 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30402 doc
: /* String to display as an arrow in non-window frames.
30403 See also `overlay-arrow-position'. */);
30404 Voverlay_arrow_string
= build_pure_c_string ("=>");
30406 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30407 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30408 The symbols on this list are examined during redisplay to determine
30409 where to display overlay arrows. */);
30410 Voverlay_arrow_variable_list
30411 = list1 (intern_c_string ("overlay-arrow-position"));
30413 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30414 doc
: /* The number of lines to try scrolling a window by when point moves out.
30415 If that fails to bring point back on frame, point is centered instead.
30416 If this is zero, point is always centered after it moves off frame.
30417 If you want scrolling to always be a line at a time, you should set
30418 `scroll-conservatively' to a large value rather than set this to 1. */);
30420 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30421 doc
: /* Scroll up to this many lines, to bring point back on screen.
30422 If point moves off-screen, redisplay will scroll by up to
30423 `scroll-conservatively' lines in order to bring point just barely
30424 onto the screen again. If that cannot be done, then redisplay
30425 recenters point as usual.
30427 If the value is greater than 100, redisplay will never recenter point,
30428 but will always scroll just enough text to bring point into view, even
30429 if you move far away.
30431 A value of zero means always recenter point if it moves off screen. */);
30432 scroll_conservatively
= 0;
30434 DEFVAR_INT ("scroll-margin", scroll_margin
,
30435 doc
: /* Number of lines of margin at the top and bottom of a window.
30436 Recenter the window whenever point gets within this many lines
30437 of the top or bottom of the window. */);
30440 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30441 doc
: /* Pixels per inch value for non-window system displays.
30442 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30443 Vdisplay_pixels_per_inch
= make_float (72.0);
30446 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30449 DEFVAR_LISP ("truncate-partial-width-windows",
30450 Vtruncate_partial_width_windows
,
30451 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30452 For an integer value, truncate lines in each window narrower than the
30453 full frame width, provided the window width is less than that integer;
30454 otherwise, respect the value of `truncate-lines'.
30456 For any other non-nil value, truncate lines in all windows that do
30457 not span the full frame width.
30459 A value of nil means to respect the value of `truncate-lines'.
30461 If `word-wrap' is enabled, you might want to reduce this. */);
30462 Vtruncate_partial_width_windows
= make_number (50);
30464 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30465 doc
: /* Maximum buffer size for which line number should be displayed.
30466 If the buffer is bigger than this, the line number does not appear
30467 in the mode line. A value of nil means no limit. */);
30468 Vline_number_display_limit
= Qnil
;
30470 DEFVAR_INT ("line-number-display-limit-width",
30471 line_number_display_limit_width
,
30472 doc
: /* Maximum line width (in characters) for line number display.
30473 If the average length of the lines near point is bigger than this, then the
30474 line number may be omitted from the mode line. */);
30475 line_number_display_limit_width
= 200;
30477 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30478 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30479 highlight_nonselected_windows
= 0;
30481 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30482 doc
: /* Non-nil if more than one frame is visible on this display.
30483 Minibuffer-only frames don't count, but iconified frames do.
30484 This variable is not guaranteed to be accurate except while processing
30485 `frame-title-format' and `icon-title-format'. */);
30487 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30488 doc
: /* Template for displaying the title bar of visible frames.
30489 \(Assuming the window manager supports this feature.)
30491 This variable has the same structure as `mode-line-format', except that
30492 the %c and %l constructs are ignored. It is used only on frames for
30493 which no explicit name has been set \(see `modify-frame-parameters'). */);
30495 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30496 doc
: /* Template for displaying the title bar of an iconified frame.
30497 \(Assuming the window manager supports this feature.)
30498 This variable has the same structure as `mode-line-format' (which see),
30499 and is used only on frames for which no explicit name has been set
30500 \(see `modify-frame-parameters'). */);
30502 = Vframe_title_format
30503 = listn (CONSTYPE_PURE
, 3,
30504 intern_c_string ("multiple-frames"),
30505 build_pure_c_string ("%b"),
30506 listn (CONSTYPE_PURE
, 4,
30507 empty_unibyte_string
,
30508 intern_c_string ("invocation-name"),
30509 build_pure_c_string ("@"),
30510 intern_c_string ("system-name")));
30512 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30513 doc
: /* Maximum number of lines to keep in the message log buffer.
30514 If nil, disable message logging. If t, log messages but don't truncate
30515 the buffer when it becomes large. */);
30516 Vmessage_log_max
= make_number (1000);
30518 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30519 doc
: /* Functions called before redisplay, if window sizes have changed.
30520 The value should be a list of functions that take one argument.
30521 Just before redisplay, for each frame, if any of its windows have changed
30522 size since the last redisplay, or have been split or deleted,
30523 all the functions in the list are called, with the frame as argument. */);
30524 Vwindow_size_change_functions
= Qnil
;
30526 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30527 doc
: /* List of functions to call before redisplaying a window with scrolling.
30528 Each function is called with two arguments, the window and its new
30529 display-start position. Note that these functions are also called by
30530 `set-window-buffer'. Also note that the value of `window-end' is not
30531 valid when these functions are called.
30533 Warning: Do not use this feature to alter the way the window
30534 is scrolled. It is not designed for that, and such use probably won't
30536 Vwindow_scroll_functions
= Qnil
;
30538 DEFVAR_LISP ("window-text-change-functions",
30539 Vwindow_text_change_functions
,
30540 doc
: /* Functions to call in redisplay when text in the window might change. */);
30541 Vwindow_text_change_functions
= Qnil
;
30543 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30544 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30545 Each function is called with two arguments, the window and the end trigger value.
30546 See `set-window-redisplay-end-trigger'. */);
30547 Vredisplay_end_trigger_functions
= Qnil
;
30549 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30550 doc
: /* Non-nil means autoselect window with mouse pointer.
30551 If nil, do not autoselect windows.
30552 A positive number means delay autoselection by that many seconds: a
30553 window is autoselected only after the mouse has remained in that
30554 window for the duration of the delay.
30555 A negative number has a similar effect, but causes windows to be
30556 autoselected only after the mouse has stopped moving. \(Because of
30557 the way Emacs compares mouse events, you will occasionally wait twice
30558 that time before the window gets selected.\)
30559 Any other value means to autoselect window instantaneously when the
30560 mouse pointer enters it.
30562 Autoselection selects the minibuffer only if it is active, and never
30563 unselects the minibuffer if it is active.
30565 When customizing this variable make sure that the actual value of
30566 `focus-follows-mouse' matches the behavior of your window manager. */);
30567 Vmouse_autoselect_window
= Qnil
;
30569 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30570 doc
: /* Non-nil means automatically resize tool-bars.
30571 This dynamically changes the tool-bar's height to the minimum height
30572 that is needed to make all tool-bar items visible.
30573 If value is `grow-only', the tool-bar's height is only increased
30574 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30575 Vauto_resize_tool_bars
= Qt
;
30577 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30578 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30579 auto_raise_tool_bar_buttons_p
= 1;
30581 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30582 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30583 make_cursor_line_fully_visible_p
= 1;
30585 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30586 doc
: /* Border below tool-bar in pixels.
30587 If an integer, use it as the height of the border.
30588 If it is one of `internal-border-width' or `border-width', use the
30589 value of the corresponding frame parameter.
30590 Otherwise, no border is added below the tool-bar. */);
30591 Vtool_bar_border
= Qinternal_border_width
;
30593 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30594 doc
: /* Margin around tool-bar buttons in pixels.
30595 If an integer, use that for both horizontal and vertical margins.
30596 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30597 HORZ specifying the horizontal margin, and VERT specifying the
30598 vertical margin. */);
30599 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30601 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30602 doc
: /* Relief thickness of tool-bar buttons. */);
30603 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30605 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30606 doc
: /* Tool bar style to use.
30608 image - show images only
30609 text - show text only
30610 both - show both, text below image
30611 both-horiz - show text to the right of the image
30612 text-image-horiz - show text to the left of the image
30613 any other - use system default or image if no system default.
30615 This variable only affects the GTK+ toolkit version of Emacs. */);
30616 Vtool_bar_style
= Qnil
;
30618 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30619 doc
: /* Maximum number of characters a label can have to be shown.
30620 The tool bar style must also show labels for this to have any effect, see
30621 `tool-bar-style'. */);
30622 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30624 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30625 doc
: /* List of functions to call to fontify regions of text.
30626 Each function is called with one argument POS. Functions must
30627 fontify a region starting at POS in the current buffer, and give
30628 fontified regions the property `fontified'. */);
30629 Vfontification_functions
= Qnil
;
30630 Fmake_variable_buffer_local (Qfontification_functions
);
30632 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30633 unibyte_display_via_language_environment
,
30634 doc
: /* Non-nil means display unibyte text according to language environment.
30635 Specifically, this means that raw bytes in the range 160-255 decimal
30636 are displayed by converting them to the equivalent multibyte characters
30637 according to the current language environment. As a result, they are
30638 displayed according to the current fontset.
30640 Note that this variable affects only how these bytes are displayed,
30641 but does not change the fact they are interpreted as raw bytes. */);
30642 unibyte_display_via_language_environment
= 0;
30644 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30645 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30646 If a float, it specifies a fraction of the mini-window frame's height.
30647 If an integer, it specifies a number of lines. */);
30648 Vmax_mini_window_height
= make_float (0.25);
30650 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30651 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30652 A value of nil means don't automatically resize mini-windows.
30653 A value of t means resize them to fit the text displayed in them.
30654 A value of `grow-only', the default, means let mini-windows grow only;
30655 they return to their normal size when the minibuffer is closed, or the
30656 echo area becomes empty. */);
30657 Vresize_mini_windows
= Qgrow_only
;
30659 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30660 doc
: /* Alist specifying how to blink the cursor off.
30661 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30662 `cursor-type' frame-parameter or variable equals ON-STATE,
30663 comparing using `equal', Emacs uses OFF-STATE to specify
30664 how to blink it off. ON-STATE and OFF-STATE are values for
30665 the `cursor-type' frame parameter.
30667 If a frame's ON-STATE has no entry in this list,
30668 the frame's other specifications determine how to blink the cursor off. */);
30669 Vblink_cursor_alist
= Qnil
;
30671 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30672 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30673 If non-nil, windows are automatically scrolled horizontally to make
30674 point visible. */);
30675 automatic_hscrolling_p
= 1;
30676 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30678 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30679 doc
: /* How many columns away from the window edge point is allowed to get
30680 before automatic hscrolling will horizontally scroll the window. */);
30681 hscroll_margin
= 5;
30683 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30684 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30685 When point is less than `hscroll-margin' columns from the window
30686 edge, automatic hscrolling will scroll the window by the amount of columns
30687 determined by this variable. If its value is a positive integer, scroll that
30688 many columns. If it's a positive floating-point number, it specifies the
30689 fraction of the window's width to scroll. If it's nil or zero, point will be
30690 centered horizontally after the scroll. Any other value, including negative
30691 numbers, are treated as if the value were zero.
30693 Automatic hscrolling always moves point outside the scroll margin, so if
30694 point was more than scroll step columns inside the margin, the window will
30695 scroll more than the value given by the scroll step.
30697 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30698 and `scroll-right' overrides this variable's effect. */);
30699 Vhscroll_step
= make_number (0);
30701 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30702 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30703 Bind this around calls to `message' to let it take effect. */);
30704 message_truncate_lines
= 0;
30706 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30707 doc
: /* Normal hook run to update the menu bar definitions.
30708 Redisplay runs this hook before it redisplays the menu bar.
30709 This is used to update menus such as Buffers, whose contents depend on
30711 Vmenu_bar_update_hook
= Qnil
;
30713 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30714 doc
: /* Frame for which we are updating a menu.
30715 The enable predicate for a menu binding should check this variable. */);
30716 Vmenu_updating_frame
= Qnil
;
30718 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30719 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30720 inhibit_menubar_update
= 0;
30722 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30723 doc
: /* Prefix prepended to all continuation lines at display time.
30724 The value may be a string, an image, or a stretch-glyph; it is
30725 interpreted in the same way as the value of a `display' text property.
30727 This variable is overridden by any `wrap-prefix' text or overlay
30730 To add a prefix to non-continuation lines, use `line-prefix'. */);
30731 Vwrap_prefix
= Qnil
;
30732 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30733 Fmake_variable_buffer_local (Qwrap_prefix
);
30735 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30736 doc
: /* Prefix prepended to all non-continuation lines at display time.
30737 The value may be a string, an image, or a stretch-glyph; it is
30738 interpreted in the same way as the value of a `display' text property.
30740 This variable is overridden by any `line-prefix' text or overlay
30743 To add a prefix to continuation lines, use `wrap-prefix'. */);
30744 Vline_prefix
= Qnil
;
30745 DEFSYM (Qline_prefix
, "line-prefix");
30746 Fmake_variable_buffer_local (Qline_prefix
);
30748 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30749 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30750 inhibit_eval_during_redisplay
= 0;
30752 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30753 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30754 inhibit_free_realized_faces
= 0;
30757 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30758 doc
: /* Inhibit try_window_id display optimization. */);
30759 inhibit_try_window_id
= 0;
30761 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30762 doc
: /* Inhibit try_window_reusing display optimization. */);
30763 inhibit_try_window_reusing
= 0;
30765 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30766 doc
: /* Inhibit try_cursor_movement display optimization. */);
30767 inhibit_try_cursor_movement
= 0;
30768 #endif /* GLYPH_DEBUG */
30770 DEFVAR_INT ("overline-margin", overline_margin
,
30771 doc
: /* Space between overline and text, in pixels.
30772 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30773 margin to the character height. */);
30774 overline_margin
= 2;
30776 DEFVAR_INT ("underline-minimum-offset",
30777 underline_minimum_offset
,
30778 doc
: /* Minimum distance between baseline and underline.
30779 This can improve legibility of underlined text at small font sizes,
30780 particularly when using variable `x-use-underline-position-properties'
30781 with fonts that specify an UNDERLINE_POSITION relatively close to the
30782 baseline. The default value is 1. */);
30783 underline_minimum_offset
= 1;
30785 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30786 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30787 This feature only works when on a window system that can change
30788 cursor shapes. */);
30789 display_hourglass_p
= 1;
30791 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30792 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30793 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30795 #ifdef HAVE_WINDOW_SYSTEM
30796 hourglass_atimer
= NULL
;
30797 hourglass_shown_p
= 0;
30798 #endif /* HAVE_WINDOW_SYSTEM */
30800 DEFSYM (Qglyphless_char
, "glyphless-char");
30801 DEFSYM (Qhex_code
, "hex-code");
30802 DEFSYM (Qempty_box
, "empty-box");
30803 DEFSYM (Qthin_space
, "thin-space");
30804 DEFSYM (Qzero_width
, "zero-width");
30806 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30807 doc
: /* Function run just before redisplay.
30808 It is called with one argument, which is the set of windows that are to
30809 be redisplayed. This set can be nil (meaning, only the selected window),
30810 or t (meaning all windows). */);
30811 Vpre_redisplay_function
= intern ("ignore");
30813 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30814 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30816 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30817 doc
: /* Char-table defining glyphless characters.
30818 Each element, if non-nil, should be one of the following:
30819 an ASCII acronym string: display this string in a box
30820 `hex-code': display the hexadecimal code of a character in a box
30821 `empty-box': display as an empty box
30822 `thin-space': display as 1-pixel width space
30823 `zero-width': don't display
30824 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30825 display method for graphical terminals and text terminals respectively.
30826 GRAPHICAL and TEXT should each have one of the values listed above.
30828 The char-table has one extra slot to control the display of a character for
30829 which no font is found. This slot only takes effect on graphical terminals.
30830 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30831 `thin-space'. The default is `empty-box'.
30833 If a character has a non-nil entry in an active display table, the
30834 display table takes effect; in this case, Emacs does not consult
30835 `glyphless-char-display' at all. */);
30836 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30837 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30840 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30841 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30842 Vdebug_on_message
= Qnil
;
30844 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30846 Vredisplay__all_windows_cause
30847 = Fmake_vector (make_number (100), make_number (0));
30849 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30851 Vredisplay__mode_lines_cause
30852 = Fmake_vector (make_number (100), make_number (0));
30856 /* Initialize this module when Emacs starts. */
30861 CHARPOS (this_line_start_pos
) = 0;
30863 if (!noninteractive
)
30865 struct window
*m
= XWINDOW (minibuf_window
);
30866 Lisp_Object frame
= m
->frame
;
30867 struct frame
*f
= XFRAME (frame
);
30868 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30869 struct window
*r
= XWINDOW (root
);
30872 echo_area_window
= minibuf_window
;
30874 r
->top_line
= FRAME_TOP_MARGIN (f
);
30875 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30876 r
->total_cols
= FRAME_COLS (f
);
30877 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30878 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30879 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30881 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
30882 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30883 m
->total_cols
= FRAME_COLS (f
);
30884 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30885 m
->total_lines
= 1;
30886 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30888 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30889 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30890 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30892 /* The default ellipsis glyphs `...'. */
30893 for (i
= 0; i
< 3; ++i
)
30894 default_invis_vector
[i
] = make_number ('.');
30898 /* Allocate the buffer for frame titles.
30899 Also used for `format-mode-line'. */
30901 mode_line_noprop_buf
= xmalloc (size
);
30902 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30903 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30904 mode_line_target
= MODE_LINE_DISPLAY
;
30907 help_echo_showing_p
= 0;
30910 #ifdef HAVE_WINDOW_SYSTEM
30912 /* Platform-independent portion of hourglass implementation. */
30914 /* Timer function of hourglass_atimer. */
30917 show_hourglass (struct atimer
*timer
)
30919 /* The timer implementation will cancel this timer automatically
30920 after this function has run. Set hourglass_atimer to null
30921 so that we know the timer doesn't have to be canceled. */
30922 hourglass_atimer
= NULL
;
30924 if (!hourglass_shown_p
)
30926 Lisp_Object tail
, frame
;
30930 FOR_EACH_FRAME (tail
, frame
)
30932 struct frame
*f
= XFRAME (frame
);
30934 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
30935 && FRAME_RIF (f
)->show_hourglass
)
30936 FRAME_RIF (f
)->show_hourglass (f
);
30939 hourglass_shown_p
= 1;
30944 /* Cancel a currently active hourglass timer, and start a new one. */
30947 start_hourglass (void)
30949 struct timespec delay
;
30951 cancel_hourglass ();
30953 if (INTEGERP (Vhourglass_delay
)
30954 && XINT (Vhourglass_delay
) > 0)
30955 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30956 TYPE_MAXIMUM (time_t)),
30958 else if (FLOATP (Vhourglass_delay
)
30959 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30960 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30962 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30964 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30965 show_hourglass
, NULL
);
30968 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30972 cancel_hourglass (void)
30974 if (hourglass_atimer
)
30976 cancel_atimer (hourglass_atimer
);
30977 hourglass_atimer
= NULL
;
30980 if (hourglass_shown_p
)
30982 Lisp_Object tail
, frame
;
30986 FOR_EACH_FRAME (tail
, frame
)
30988 struct frame
*f
= XFRAME (frame
);
30990 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
30991 && FRAME_RIF (f
)->hide_hourglass
)
30992 FRAME_RIF (f
)->hide_hourglass (f
);
30994 /* No cursors on non GUI frames - restore to stock arrow cursor. */
30995 else if (!FRAME_W32_P (f
))
30996 w32_arrow_cursor ();
31000 hourglass_shown_p
= 0;
31005 #endif /* HAVE_WINDOW_SYSTEM */