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 bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 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
);
1030 /* Return the pixel width of display area AREA of window W.
1031 ANY_AREA means return the total width of W, not including
1032 fringes to the left and right of the window. */
1035 window_box_width (struct window
*w
, enum glyph_row_area area
)
1037 int width
= w
->pixel_width
;
1039 if (!w
->pseudo_window_p
)
1041 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1042 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1044 if (area
== TEXT_AREA
)
1045 width
-= (WINDOW_MARGINS_WIDTH (w
)
1046 + WINDOW_FRINGES_WIDTH (w
));
1047 else if (area
== LEFT_MARGIN_AREA
)
1048 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1049 else if (area
== RIGHT_MARGIN_AREA
)
1050 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1053 /* With wide margins, fringes, etc. we might end up with a negative
1054 width, correct that here. */
1055 return max (0, width
);
1059 /* Return the pixel height of the display area of window W, not
1060 including mode lines of W, if any. */
1063 window_box_height (struct window
*w
)
1065 struct frame
*f
= XFRAME (w
->frame
);
1066 int height
= WINDOW_PIXEL_HEIGHT (w
);
1068 eassert (height
>= 0);
1070 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1072 /* Note: the code below that determines the mode-line/header-line
1073 height is essentially the same as that contained in the macro
1074 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1075 the appropriate glyph row has its `mode_line_p' flag set,
1076 and if it doesn't, uses estimate_mode_line_height instead. */
1078 if (WINDOW_WANTS_MODELINE_P (w
))
1080 struct glyph_row
*ml_row
1081 = (w
->current_matrix
&& w
->current_matrix
->rows
1082 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1084 if (ml_row
&& ml_row
->mode_line_p
)
1085 height
-= ml_row
->height
;
1087 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1090 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1092 struct glyph_row
*hl_row
1093 = (w
->current_matrix
&& w
->current_matrix
->rows
1094 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1096 if (hl_row
&& hl_row
->mode_line_p
)
1097 height
-= hl_row
->height
;
1099 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1102 /* With a very small font and a mode-line that's taller than
1103 default, we might end up with a negative height. */
1104 return max (0, height
);
1107 /* Return the window-relative coordinate of the left edge of display
1108 area AREA of window W. ANY_AREA means return the left edge of the
1109 whole window, to the right of the left fringe of W. */
1112 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1116 if (w
->pseudo_window_p
)
1119 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1121 if (area
== TEXT_AREA
)
1122 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1123 + window_box_width (w
, LEFT_MARGIN_AREA
));
1124 else if (area
== RIGHT_MARGIN_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
)
1127 + window_box_width (w
, TEXT_AREA
)
1128 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1130 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1131 else if (area
== LEFT_MARGIN_AREA
1132 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1133 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1135 /* Don't return more than the window's pixel width. */
1136 return min (x
, w
->pixel_width
);
1140 /* Return the window-relative coordinate of the right edge of display
1141 area AREA of window W. ANY_AREA means return the right edge of the
1142 whole window, to the left of the right fringe of W. */
1145 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1147 /* Don't return more than the window's pixel width. */
1148 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1152 /* Return the frame-relative coordinate of the left edge of display
1153 area AREA of window W. ANY_AREA means return the left edge of the
1154 whole window, to the right of the left fringe of W. */
1157 window_box_left (struct window
*w
, enum glyph_row_area area
)
1159 struct frame
*f
= XFRAME (w
->frame
);
1162 if (w
->pseudo_window_p
)
1163 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1165 x
= (WINDOW_LEFT_EDGE_X (w
)
1166 + window_box_left_offset (w
, area
));
1172 /* Return the frame-relative coordinate of the right edge of display
1173 area AREA of window W. ANY_AREA means return the right edge of the
1174 whole window, to the left of the right fringe of W. */
1177 window_box_right (struct window
*w
, enum glyph_row_area area
)
1179 return window_box_left (w
, area
) + window_box_width (w
, area
);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. ANY_AREA means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1190 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1191 int *box_y
, int *box_width
, int *box_height
)
1194 *box_width
= window_box_width (w
, area
);
1196 *box_height
= window_box_height (w
);
1198 *box_x
= window_box_left (w
, area
);
1201 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1202 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1203 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1207 #ifdef HAVE_WINDOW_SYSTEM
1209 /* Get the bounding box of the display area AREA of window W, without
1210 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1211 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1212 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1213 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1217 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1218 int *bottom_right_x
, int *bottom_right_y
)
1220 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1221 bottom_right_x
, bottom_right_y
);
1222 *bottom_right_x
+= *top_left_x
;
1223 *bottom_right_y
+= *top_left_y
;
1226 #endif /* HAVE_WINDOW_SYSTEM */
1228 /***********************************************************************
1230 ***********************************************************************/
1232 /* Return the bottom y-position of the line the iterator IT is in.
1233 This can modify IT's settings. */
1236 line_bottom_y (struct it
*it
)
1238 int line_height
= it
->max_ascent
+ it
->max_descent
;
1239 int line_top_y
= it
->current_y
;
1241 if (line_height
== 0)
1244 line_height
= last_height
;
1245 else if (IT_CHARPOS (*it
) < ZV
)
1247 move_it_by_lines (it
, 1);
1248 line_height
= (it
->max_ascent
|| it
->max_descent
1249 ? it
->max_ascent
+ it
->max_descent
1254 struct glyph_row
*row
= it
->glyph_row
;
1256 /* Use the default character height. */
1257 it
->glyph_row
= NULL
;
1258 it
->what
= IT_CHARACTER
;
1261 PRODUCE_GLYPHS (it
);
1262 line_height
= it
->ascent
+ it
->descent
;
1263 it
->glyph_row
= row
;
1267 return line_top_y
+ line_height
;
1270 DEFUN ("line-pixel-height", Fline_pixel_height
,
1271 Sline_pixel_height
, 0, 0, 0,
1272 doc
: /* Return height in pixels of text line in the selected window.
1274 Value is the height in pixels of the line at point. */)
1279 struct window
*w
= XWINDOW (selected_window
);
1280 struct buffer
*old_buffer
= NULL
;
1283 if (XBUFFER (w
->contents
) != current_buffer
)
1285 old_buffer
= current_buffer
;
1286 set_buffer_internal_1 (XBUFFER (w
->contents
));
1288 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1289 start_display (&it
, w
, pt
);
1290 it
.vpos
= it
.current_y
= 0;
1292 result
= make_number (line_bottom_y (&it
));
1294 set_buffer_internal_1 (old_buffer
);
1299 /* Return the default pixel height of text lines in window W. The
1300 value is the canonical height of the W frame's default font, plus
1301 any extra space required by the line-spacing variable or frame
1304 Implementation note: this ignores any line-spacing text properties
1305 put on the newline characters. This is because those properties
1306 only affect the _screen_ line ending in the newline (i.e., in a
1307 continued line, only the last screen line will be affected), which
1308 means only a small number of lines in a buffer can ever use this
1309 feature. Since this function is used to compute the default pixel
1310 equivalent of text lines in a window, we can safely ignore those
1311 few lines. For the same reasons, we ignore the line-height
1314 default_line_pixel_height (struct window
*w
)
1316 struct frame
*f
= WINDOW_XFRAME (w
);
1317 int height
= FRAME_LINE_HEIGHT (f
);
1319 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1321 struct buffer
*b
= XBUFFER (w
->contents
);
1322 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1325 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1328 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1329 height
+= XFASTINT (val
);
1330 else if (FLOATP (val
))
1332 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1339 height
+= f
->extra_line_spacing
;
1345 /* Subroutine of pos_visible_p below. Extracts a display string, if
1346 any, from the display spec given as its argument. */
1348 string_from_display_spec (Lisp_Object spec
)
1352 while (CONSP (spec
))
1354 if (STRINGP (XCAR (spec
)))
1359 else if (VECTORP (spec
))
1363 for (i
= 0; i
< ASIZE (spec
); i
++)
1365 if (STRINGP (AREF (spec
, i
)))
1366 return AREF (spec
, i
);
1375 /* Limit insanely large values of W->hscroll on frame F to the largest
1376 value that will still prevent first_visible_x and last_visible_x of
1377 'struct it' from overflowing an int. */
1379 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1381 ptrdiff_t window_hscroll
= w
->hscroll
;
1382 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1383 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1385 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1386 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1388 return window_hscroll
;
1391 /* Return 1 if position CHARPOS is visible in window W.
1392 CHARPOS < 0 means return info about WINDOW_END position.
1393 If visible, set *X and *Y to pixel coordinates of top left corner.
1394 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1395 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1398 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1399 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1402 void *itdata
= bidi_shelve_cache ();
1403 struct text_pos top
;
1405 struct buffer
*old_buffer
= NULL
;
1407 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1410 if (XBUFFER (w
->contents
) != current_buffer
)
1412 old_buffer
= current_buffer
;
1413 set_buffer_internal_1 (XBUFFER (w
->contents
));
1416 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1417 /* Scrolling a minibuffer window via scroll bar when the echo area
1418 shows long text sometimes resets the minibuffer contents behind
1420 if (CHARPOS (top
) > ZV
)
1421 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1423 /* Compute exact mode line heights. */
1424 if (WINDOW_WANTS_MODELINE_P (w
))
1426 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1427 BVAR (current_buffer
, mode_line_format
));
1429 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1430 w
->header_line_height
1431 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1432 BVAR (current_buffer
, header_line_format
));
1434 start_display (&it
, w
, top
);
1435 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1436 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1439 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1440 && IT_CHARPOS (it
) >= charpos
)
1441 /* When scanning backwards under bidi iteration, move_it_to
1442 stops at or _before_ CHARPOS, because it stops at or to
1443 the _right_ of the character at CHARPOS. */
1444 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1445 && IT_CHARPOS (it
) <= charpos
)))
1447 /* We have reached CHARPOS, or passed it. How the call to
1448 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1449 or covered by a display property, move_it_to stops at the end
1450 of the invisible text, to the right of CHARPOS. (ii) If
1451 CHARPOS is in a display vector, move_it_to stops on its last
1453 int top_x
= it
.current_x
;
1454 int top_y
= it
.current_y
;
1455 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1458 void *save_it_data
= NULL
;
1460 /* Calling line_bottom_y may change it.method, it.position, etc. */
1461 SAVE_IT (save_it
, it
, save_it_data
);
1463 bottom_y
= line_bottom_y (&it
);
1464 if (top_y
< window_top_y
)
1465 visible_p
= bottom_y
> window_top_y
;
1466 else if (top_y
< it
.last_visible_y
)
1468 if (bottom_y
>= it
.last_visible_y
1469 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1470 && IT_CHARPOS (it
) < charpos
)
1472 /* When the last line of the window is scanned backwards
1473 under bidi iteration, we could be duped into thinking
1474 that we have passed CHARPOS, when in fact move_it_to
1475 simply stopped short of CHARPOS because it reached
1476 last_visible_y. To see if that's what happened, we call
1477 move_it_to again with a slightly larger vertical limit,
1478 and see if it actually moved vertically; if it did, we
1479 didn't really reach CHARPOS, which is beyond window end. */
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
)
1490 RESTORE_IT (&it
, &save_it
, save_it_data
);
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_LINES (f
))
1961 pix_y
= FRAME_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 r
.width
-= s
->x
- r
.x
;
2180 r
.width
= min (r
.width
, glyph
->pixel_width
);
2182 /* If r.y is below window bottom, ensure that we still see a cursor. */
2183 height
= min (glyph
->ascent
+ glyph
->descent
,
2184 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2185 max_y
= window_text_bottom_y (s
->w
) - height
;
2186 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2187 if (s
->ybase
- glyph
->ascent
> max_y
)
2194 /* Don't draw cursor glyph taller than our actual glyph. */
2195 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2196 if (height
< r
.height
)
2198 max_y
= r
.y
+ r
.height
;
2199 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2200 r
.height
= min (max_y
- r
.y
, height
);
2207 XRectangle r_save
= r
;
2209 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2213 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2214 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2216 #ifdef CONVERT_FROM_XRECT
2217 CONVERT_FROM_XRECT (r
, *rects
);
2225 /* If we are processing overlapping and allowed to return
2226 multiple clipping rectangles, we exclude the row of the glyph
2227 string from the clipping rectangle. This is to avoid drawing
2228 the same text on the environment with anti-aliasing. */
2229 #ifdef CONVERT_FROM_XRECT
2232 XRectangle
*rs
= rects
;
2234 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2236 if (s
->for_overlaps
& OVERLAPS_PRED
)
2239 if (r
.y
+ r
.height
> row_y
)
2242 rs
[i
].height
= row_y
- r
.y
;
2248 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2251 if (r
.y
< row_y
+ s
->row
->visible_height
)
2253 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2255 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2256 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2265 #ifdef CONVERT_FROM_XRECT
2266 for (i
= 0; i
< n
; i
++)
2267 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2274 Return in *NR the clipping rectangle for glyph string S. */
2277 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2279 get_glyph_string_clip_rects (s
, nr
, 1);
2284 Return the position and height of the phys cursor in window W.
2285 Set w->phys_cursor_width to width of phys cursor.
2289 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2290 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2292 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2293 int x
, y
, wd
, h
, h0
, y0
;
2295 /* Compute the width of the rectangle to draw. If on a stretch
2296 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2297 rectangle as wide as the glyph, but use a canonical character
2299 wd
= glyph
->pixel_width
- 1;
2300 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2304 x
= w
->phys_cursor
.x
;
2311 if (glyph
->type
== STRETCH_GLYPH
2312 && !x_stretch_cursor_p
)
2313 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2314 w
->phys_cursor_width
= wd
;
2316 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2318 /* If y is below window bottom, ensure that we still see a cursor. */
2319 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2321 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2322 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2324 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2327 h
= max (h
- (y0
- y
) + 1, h0
);
2332 y0
= window_text_bottom_y (w
) - h0
;
2340 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2341 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2346 * Remember which glyph the mouse is over.
2350 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2354 struct glyph_row
*r
, *gr
, *end_row
;
2355 enum window_part part
;
2356 enum glyph_row_area area
;
2357 int x
, y
, width
, height
;
2359 /* Try to determine frame pixel position and size of the glyph under
2360 frame pixel coordinates X/Y on frame F. */
2362 if (window_resize_pixelwise
)
2367 else if (!f
->glyphs_initialized_p
2368 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2371 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2372 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2376 w
= XWINDOW (window
);
2377 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2378 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2380 x
= window_relative_x_coord (w
, part
, gx
);
2381 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2383 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2384 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2386 if (w
->pseudo_window_p
)
2389 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2395 case ON_LEFT_MARGIN
:
2396 area
= LEFT_MARGIN_AREA
;
2399 case ON_RIGHT_MARGIN
:
2400 area
= RIGHT_MARGIN_AREA
;
2403 case ON_HEADER_LINE
:
2405 gr
= (part
== ON_HEADER_LINE
2406 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2407 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2410 goto text_glyph_row_found
;
2417 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2418 if (r
->y
+ r
->height
> y
)
2424 text_glyph_row_found
:
2427 struct glyph
*g
= gr
->glyphs
[area
];
2428 struct glyph
*end
= g
+ gr
->used
[area
];
2430 height
= gr
->height
;
2431 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2432 if (gx
+ g
->pixel_width
> x
)
2437 if (g
->type
== IMAGE_GLYPH
)
2439 /* Don't remember when mouse is over image, as
2440 image may have hot-spots. */
2441 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2444 width
= g
->pixel_width
;
2448 /* Use nominal char spacing at end of line. */
2450 gx
+= (x
/ width
) * width
;
2453 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2455 gx
+= window_box_left_offset (w
, area
);
2456 /* Don't expand over the modeline to make sure the vertical
2457 drag cursor is shown early enough. */
2458 height
= min (height
,
2459 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2464 /* Use nominal line height at end of window. */
2465 gx
= (x
/ width
) * width
;
2467 gy
+= (y
/ height
) * height
;
2468 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2469 /* See comment above. */
2470 height
= min (height
,
2471 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2475 case ON_LEFT_FRINGE
:
2476 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2477 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2478 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2479 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2482 case ON_RIGHT_FRINGE
:
2483 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2484 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2485 : window_box_right_offset (w
, TEXT_AREA
));
2486 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2487 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2488 && !WINDOW_RIGHTMOST_P (w
))
2489 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2490 /* Make sure the vertical border can get her own glyph to the
2491 right of the one we build here. */
2492 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2494 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2496 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2500 case ON_VERTICAL_BORDER
:
2501 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2505 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2507 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2508 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2509 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2511 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2515 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2516 if (r
->y
+ r
->height
> y
)
2523 height
= gr
->height
;
2526 /* Use nominal line height at end of window. */
2528 gy
+= (y
/ height
) * height
;
2532 case ON_RIGHT_DIVIDER
:
2533 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2534 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2536 /* The bottom divider prevails. */
2537 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2540 case ON_BOTTOM_DIVIDER
:
2542 width
= WINDOW_PIXEL_WIDTH (w
);
2543 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2544 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2550 /* If there is no glyph under the mouse, then we divide the screen
2551 into a grid of the smallest glyph in the frame, and use that
2554 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2555 round down even for negative values. */
2561 gx
= (gx
/ width
) * width
;
2562 gy
= (gy
/ height
) * height
;
2568 gx
+= WINDOW_LEFT_EDGE_X (w
);
2569 gy
+= WINDOW_TOP_EDGE_Y (w
);
2572 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2574 /* Visible feedback for debugging. */
2577 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2578 f
->output_data
.x
->normal_gc
,
2579 gx
, gy
, width
, height
);
2585 #endif /* HAVE_WINDOW_SYSTEM */
2588 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2591 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2592 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2594 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2597 /***********************************************************************
2598 Lisp form evaluation
2599 ***********************************************************************/
2601 /* Error handler for safe_eval and safe_call. */
2604 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2606 add_to_log ("Error during redisplay: %S signaled %S",
2607 Flist (nargs
, args
), arg
);
2611 /* Call function FUNC with the rest of NARGS - 1 arguments
2612 following. Return the result, or nil if something went
2613 wrong. Prevent redisplay during the evaluation. */
2616 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2620 if (inhibit_eval_during_redisplay
)
2625 ptrdiff_t count
= SPECPDL_INDEX ();
2626 struct gcpro gcpro1
;
2627 Lisp_Object
*args
= alloca (nargs
* word_size
);
2630 for (i
= 1; i
< nargs
; i
++)
2631 args
[i
] = va_arg (ap
, Lisp_Object
);
2634 gcpro1
.nvars
= nargs
;
2635 specbind (Qinhibit_redisplay
, Qt
);
2637 specbind (Qinhibit_quit
, Qt
);
2638 /* Use Qt to ensure debugger does not run,
2639 so there is no possibility of wanting to redisplay. */
2640 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2643 val
= unbind_to (count
, val
);
2650 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2655 va_start (ap
, func
);
2656 retval
= safe__call (false, nargs
, func
, ap
);
2661 /* Call function FN with one argument ARG.
2662 Return the result, or nil if something went wrong. */
2665 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2667 return safe_call (2, fn
, arg
);
2671 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2677 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2682 static Lisp_Object Qeval
;
2685 safe_eval (Lisp_Object sexpr
)
2687 return safe__call1 (false, Qeval
, sexpr
);
2691 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2693 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2696 /* Call function FN with two arguments ARG1 and ARG2.
2697 Return the result, or nil if something went wrong. */
2700 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2702 return safe_call (3, fn
, arg1
, arg2
);
2707 /***********************************************************************
2709 ***********************************************************************/
2713 /* Define CHECK_IT to perform sanity checks on iterators.
2714 This is for debugging. It is too slow to do unconditionally. */
2717 check_it (struct it
*it
)
2719 if (it
->method
== GET_FROM_STRING
)
2721 eassert (STRINGP (it
->string
));
2722 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2726 eassert (IT_STRING_CHARPOS (*it
) < 0);
2727 if (it
->method
== GET_FROM_BUFFER
)
2729 /* Check that character and byte positions agree. */
2730 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2735 eassert (it
->current
.dpvec_index
>= 0);
2737 eassert (it
->current
.dpvec_index
< 0);
2740 #define CHECK_IT(IT) check_it ((IT))
2744 #define CHECK_IT(IT) (void) 0
2749 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2751 /* Check that the window end of window W is what we expect it
2752 to be---the last row in the current matrix displaying text. */
2755 check_window_end (struct window
*w
)
2757 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2759 struct glyph_row
*row
;
2760 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2762 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2763 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2767 #define CHECK_WINDOW_END(W) check_window_end ((W))
2771 #define CHECK_WINDOW_END(W) (void) 0
2773 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2775 /***********************************************************************
2776 Iterator initialization
2777 ***********************************************************************/
2779 /* Initialize IT for displaying current_buffer in window W, starting
2780 at character position CHARPOS. CHARPOS < 0 means that no buffer
2781 position is specified which is useful when the iterator is assigned
2782 a position later. BYTEPOS is the byte position corresponding to
2785 If ROW is not null, calls to produce_glyphs with IT as parameter
2786 will produce glyphs in that row.
2788 BASE_FACE_ID is the id of a base face to use. It must be one of
2789 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2790 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2791 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2793 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2794 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2795 will be initialized to use the corresponding mode line glyph row of
2796 the desired matrix of W. */
2799 init_iterator (struct it
*it
, struct window
*w
,
2800 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2801 struct glyph_row
*row
, enum face_id base_face_id
)
2803 enum face_id remapped_base_face_id
= base_face_id
;
2805 /* Some precondition checks. */
2806 eassert (w
!= NULL
&& it
!= NULL
);
2807 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2810 /* If face attributes have been changed since the last redisplay,
2811 free realized faces now because they depend on face definitions
2812 that might have changed. Don't free faces while there might be
2813 desired matrices pending which reference these faces. */
2814 if (face_change_count
&& !inhibit_free_realized_faces
)
2816 face_change_count
= 0;
2817 free_all_realized_faces (Qnil
);
2820 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2821 if (! NILP (Vface_remapping_alist
))
2822 remapped_base_face_id
2823 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2825 /* Use one of the mode line rows of W's desired matrix if
2829 if (base_face_id
== MODE_LINE_FACE_ID
2830 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2831 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2832 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2833 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2837 memset (it
, 0, sizeof *it
);
2838 it
->current
.overlay_string_index
= -1;
2839 it
->current
.dpvec_index
= -1;
2840 it
->base_face_id
= remapped_base_face_id
;
2842 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2843 it
->paragraph_embedding
= L2R
;
2844 it
->bidi_it
.string
.lstring
= Qnil
;
2845 it
->bidi_it
.string
.s
= NULL
;
2846 it
->bidi_it
.string
.bufpos
= 0;
2849 /* The window in which we iterate over current_buffer: */
2850 XSETWINDOW (it
->window
, w
);
2852 it
->f
= XFRAME (w
->frame
);
2856 /* Extra space between lines (on window systems only). */
2857 if (base_face_id
== DEFAULT_FACE_ID
2858 && FRAME_WINDOW_P (it
->f
))
2860 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2861 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2862 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2863 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2864 * FRAME_LINE_HEIGHT (it
->f
));
2865 else if (it
->f
->extra_line_spacing
> 0)
2866 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2867 it
->max_extra_line_spacing
= 0;
2870 /* If realized faces have been removed, e.g. because of face
2871 attribute changes of named faces, recompute them. When running
2872 in batch mode, the face cache of the initial frame is null. If
2873 we happen to get called, make a dummy face cache. */
2874 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2875 init_frame_faces (it
->f
);
2876 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2877 recompute_basic_faces (it
->f
);
2879 /* Current value of the `slice', `space-width', and 'height' properties. */
2880 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2881 it
->space_width
= Qnil
;
2882 it
->font_height
= Qnil
;
2883 it
->override_ascent
= -1;
2885 /* Are control characters displayed as `^C'? */
2886 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2888 /* -1 means everything between a CR and the following line end
2889 is invisible. >0 means lines indented more than this value are
2891 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2893 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2895 : (!NILP (BVAR (current_buffer
, selective_display
))
2897 it
->selective_display_ellipsis_p
2898 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2900 /* Display table to use. */
2901 it
->dp
= window_display_table (w
);
2903 /* Are multibyte characters enabled in current_buffer? */
2904 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2906 /* Get the position at which the redisplay_end_trigger hook should
2907 be run, if it is to be run at all. */
2908 if (MARKERP (w
->redisplay_end_trigger
)
2909 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2910 it
->redisplay_end_trigger_charpos
2911 = marker_position (w
->redisplay_end_trigger
);
2912 else if (INTEGERP (w
->redisplay_end_trigger
))
2913 it
->redisplay_end_trigger_charpos
2914 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2917 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2919 /* Are lines in the display truncated? */
2920 if (base_face_id
!= DEFAULT_FACE_ID
2922 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2923 && ((!NILP (Vtruncate_partial_width_windows
)
2924 && !INTEGERP (Vtruncate_partial_width_windows
))
2925 || (INTEGERP (Vtruncate_partial_width_windows
)
2926 /* PXW: Shall we do something about this? */
2927 && (WINDOW_TOTAL_COLS (it
->w
)
2928 < XINT (Vtruncate_partial_width_windows
))))))
2929 it
->line_wrap
= TRUNCATE
;
2930 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2931 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2932 ? WINDOW_WRAP
: WORD_WRAP
;
2934 it
->line_wrap
= TRUNCATE
;
2936 /* Get dimensions of truncation and continuation glyphs. These are
2937 displayed as fringe bitmaps under X, but we need them for such
2938 frames when the fringes are turned off. But leave the dimensions
2939 zero for tooltip frames, as these glyphs look ugly there and also
2940 sabotage calculations of tooltip dimensions in x-show-tip. */
2941 #ifdef HAVE_WINDOW_SYSTEM
2942 if (!(FRAME_WINDOW_P (it
->f
)
2943 && FRAMEP (tip_frame
)
2944 && it
->f
== XFRAME (tip_frame
)))
2947 if (it
->line_wrap
== TRUNCATE
)
2949 /* We will need the truncation glyph. */
2950 eassert (it
->glyph_row
== NULL
);
2951 produce_special_glyphs (it
, IT_TRUNCATION
);
2952 it
->truncation_pixel_width
= it
->pixel_width
;
2956 /* We will need the continuation glyph. */
2957 eassert (it
->glyph_row
== NULL
);
2958 produce_special_glyphs (it
, IT_CONTINUATION
);
2959 it
->continuation_pixel_width
= it
->pixel_width
;
2963 /* Reset these values to zero because the produce_special_glyphs
2964 above has changed them. */
2965 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2966 it
->phys_ascent
= it
->phys_descent
= 0;
2968 /* Set this after getting the dimensions of truncation and
2969 continuation glyphs, so that we don't produce glyphs when calling
2970 produce_special_glyphs, above. */
2971 it
->glyph_row
= row
;
2972 it
->area
= TEXT_AREA
;
2974 /* Forget any previous info about this row being reversed. */
2976 it
->glyph_row
->reversed_p
= 0;
2978 /* Get the dimensions of the display area. The display area
2979 consists of the visible window area plus a horizontally scrolled
2980 part to the left of the window. All x-values are relative to the
2981 start of this total display area. */
2982 if (base_face_id
!= DEFAULT_FACE_ID
)
2984 /* Mode lines, menu bar in terminal frames. */
2985 it
->first_visible_x
= 0;
2986 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2991 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2992 it
->last_visible_x
= (it
->first_visible_x
2993 + window_box_width (w
, TEXT_AREA
));
2995 /* If we truncate lines, leave room for the truncation glyph(s) at
2996 the right margin. Otherwise, leave room for the continuation
2997 glyph(s). Done only if the window has no right fringe. */
2998 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
3000 if (it
->line_wrap
== TRUNCATE
)
3001 it
->last_visible_x
-= it
->truncation_pixel_width
;
3003 it
->last_visible_x
-= it
->continuation_pixel_width
;
3006 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3007 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3010 /* Leave room for a border glyph. */
3011 if (!FRAME_WINDOW_P (it
->f
)
3012 && !WINDOW_RIGHTMOST_P (it
->w
))
3013 it
->last_visible_x
-= 1;
3015 it
->last_visible_y
= window_text_bottom_y (w
);
3017 /* For mode lines and alike, arrange for the first glyph having a
3018 left box line if the face specifies a box. */
3019 if (base_face_id
!= DEFAULT_FACE_ID
)
3023 it
->face_id
= remapped_base_face_id
;
3025 /* If we have a boxed mode line, make the first character appear
3026 with a left box line. */
3027 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3028 if (face
&& face
->box
!= FACE_NO_BOX
)
3029 it
->start_of_box_run_p
= true;
3032 /* If a buffer position was specified, set the iterator there,
3033 getting overlays and face properties from that position. */
3034 if (charpos
>= BUF_BEG (current_buffer
))
3036 it
->stop_charpos
= charpos
;
3037 it
->end_charpos
= ZV
;
3038 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3039 IT_CHARPOS (*it
) = charpos
;
3040 IT_BYTEPOS (*it
) = bytepos
;
3042 /* We will rely on `reseat' to set this up properly, via
3043 handle_face_prop. */
3044 it
->face_id
= it
->base_face_id
;
3046 it
->start
= it
->current
;
3047 /* Do we need to reorder bidirectional text? Not if this is a
3048 unibyte buffer: by definition, none of the single-byte
3049 characters are strong R2L, so no reordering is needed. And
3050 bidi.c doesn't support unibyte buffers anyway. Also, don't
3051 reorder while we are loading loadup.el, since the tables of
3052 character properties needed for reordering are not yet
3056 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3059 /* If we are to reorder bidirectional text, init the bidi
3063 /* Since we don't know at this point whether there will be
3064 any R2L lines in the window, we reserve space for
3065 truncation/continuation glyphs even if only the left
3066 fringe is absent. */
3067 if (base_face_id
== DEFAULT_FACE_ID
3068 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
3069 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
3071 if (it
->line_wrap
== TRUNCATE
)
3072 it
->last_visible_x
-= it
->truncation_pixel_width
;
3074 it
->last_visible_x
-= it
->continuation_pixel_width
;
3076 /* Note the paragraph direction that this buffer wants to
3078 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3080 it
->paragraph_embedding
= L2R
;
3081 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3083 it
->paragraph_embedding
= R2L
;
3085 it
->paragraph_embedding
= NEUTRAL_DIR
;
3086 bidi_unshelve_cache (NULL
, 0);
3087 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3091 /* Compute faces etc. */
3092 reseat (it
, it
->current
.pos
, 1);
3099 /* Initialize IT for the display of window W with window start POS. */
3102 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3104 struct glyph_row
*row
;
3105 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3107 row
= w
->desired_matrix
->rows
+ first_vpos
;
3108 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3109 it
->first_vpos
= first_vpos
;
3111 /* Don't reseat to previous visible line start if current start
3112 position is in a string or image. */
3113 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3115 int start_at_line_beg_p
;
3116 int first_y
= it
->current_y
;
3118 /* If window start is not at a line start, skip forward to POS to
3119 get the correct continuation lines width. */
3120 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3121 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3122 if (!start_at_line_beg_p
)
3126 reseat_at_previous_visible_line_start (it
);
3127 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3129 new_x
= it
->current_x
+ it
->pixel_width
;
3131 /* If lines are continued, this line may end in the middle
3132 of a multi-glyph character (e.g. a control character
3133 displayed as \003, or in the middle of an overlay
3134 string). In this case move_it_to above will not have
3135 taken us to the start of the continuation line but to the
3136 end of the continued line. */
3137 if (it
->current_x
> 0
3138 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3139 && (/* And glyph doesn't fit on the line. */
3140 new_x
> it
->last_visible_x
3141 /* Or it fits exactly and we're on a window
3143 || (new_x
== it
->last_visible_x
3144 && FRAME_WINDOW_P (it
->f
)
3145 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3146 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3147 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3149 if ((it
->current
.dpvec_index
>= 0
3150 || it
->current
.overlay_string_index
>= 0)
3151 /* If we are on a newline from a display vector or
3152 overlay string, then we are already at the end of
3153 a screen line; no need to go to the next line in
3154 that case, as this line is not really continued.
3155 (If we do go to the next line, C-e will not DTRT.) */
3158 set_iterator_to_next (it
, 1);
3159 move_it_in_display_line_to (it
, -1, -1, 0);
3162 it
->continuation_lines_width
+= it
->current_x
;
3164 /* If the character at POS is displayed via a display
3165 vector, move_it_to above stops at the final glyph of
3166 IT->dpvec. To make the caller redisplay that character
3167 again (a.k.a. start at POS), we need to reset the
3168 dpvec_index to the beginning of IT->dpvec. */
3169 else if (it
->current
.dpvec_index
>= 0)
3170 it
->current
.dpvec_index
= 0;
3172 /* We're starting a new display line, not affected by the
3173 height of the continued line, so clear the appropriate
3174 fields in the iterator structure. */
3175 it
->max_ascent
= it
->max_descent
= 0;
3176 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3178 it
->current_y
= first_y
;
3180 it
->current_x
= it
->hpos
= 0;
3186 /* Return 1 if POS is a position in ellipses displayed for invisible
3187 text. W is the window we display, for text property lookup. */
3190 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3192 Lisp_Object prop
, window
;
3194 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3196 /* If POS specifies a position in a display vector, this might
3197 be for an ellipsis displayed for invisible text. We won't
3198 get the iterator set up for delivering that ellipsis unless
3199 we make sure that it gets aware of the invisible text. */
3200 if (pos
->dpvec_index
>= 0
3201 && pos
->overlay_string_index
< 0
3202 && CHARPOS (pos
->string_pos
) < 0
3204 && (XSETWINDOW (window
, w
),
3205 prop
= Fget_char_property (make_number (charpos
),
3206 Qinvisible
, window
),
3207 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3209 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3211 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3218 /* Initialize IT for stepping through current_buffer in window W,
3219 starting at position POS that includes overlay string and display
3220 vector/ control character translation position information. Value
3221 is zero if there are overlay strings with newlines at POS. */
3224 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3226 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3227 int i
, overlay_strings_with_newlines
= 0;
3229 /* If POS specifies a position in a display vector, this might
3230 be for an ellipsis displayed for invisible text. We won't
3231 get the iterator set up for delivering that ellipsis unless
3232 we make sure that it gets aware of the invisible text. */
3233 if (in_ellipses_for_invisible_text_p (pos
, w
))
3239 /* Keep in mind: the call to reseat in init_iterator skips invisible
3240 text, so we might end up at a position different from POS. This
3241 is only a problem when POS is a row start after a newline and an
3242 overlay starts there with an after-string, and the overlay has an
3243 invisible property. Since we don't skip invisible text in
3244 display_line and elsewhere immediately after consuming the
3245 newline before the row start, such a POS will not be in a string,
3246 but the call to init_iterator below will move us to the
3248 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3250 /* This only scans the current chunk -- it should scan all chunks.
3251 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3252 to 16 in 22.1 to make this a lesser problem. */
3253 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3255 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3256 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3258 while (s
< e
&& *s
!= '\n')
3263 overlay_strings_with_newlines
= 1;
3268 /* If position is within an overlay string, set up IT to the right
3270 if (pos
->overlay_string_index
>= 0)
3274 /* If the first overlay string happens to have a `display'
3275 property for an image, the iterator will be set up for that
3276 image, and we have to undo that setup first before we can
3277 correct the overlay string index. */
3278 if (it
->method
== GET_FROM_IMAGE
)
3281 /* We already have the first chunk of overlay strings in
3282 IT->overlay_strings. Load more until the one for
3283 pos->overlay_string_index is in IT->overlay_strings. */
3284 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3286 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3287 it
->current
.overlay_string_index
= 0;
3290 load_overlay_strings (it
, 0);
3291 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3295 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3296 relative_index
= (it
->current
.overlay_string_index
3297 % OVERLAY_STRING_CHUNK_SIZE
);
3298 it
->string
= it
->overlay_strings
[relative_index
];
3299 eassert (STRINGP (it
->string
));
3300 it
->current
.string_pos
= pos
->string_pos
;
3301 it
->method
= GET_FROM_STRING
;
3302 it
->end_charpos
= SCHARS (it
->string
);
3303 /* Set up the bidi iterator for this overlay string. */
3306 it
->bidi_it
.string
.lstring
= it
->string
;
3307 it
->bidi_it
.string
.s
= NULL
;
3308 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3309 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3310 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3311 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3312 it
->bidi_it
.w
= it
->w
;
3313 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3314 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3316 /* Synchronize the state of the bidi iterator with
3317 pos->string_pos. For any string position other than
3318 zero, this will be done automagically when we resume
3319 iteration over the string and get_visually_first_element
3320 is called. But if string_pos is zero, and the string is
3321 to be reordered for display, we need to resync manually,
3322 since it could be that the iteration state recorded in
3323 pos ended at string_pos of 0 moving backwards in string. */
3324 if (CHARPOS (pos
->string_pos
) == 0)
3326 get_visually_first_element (it
);
3327 if (IT_STRING_CHARPOS (*it
) != 0)
3330 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3331 bidi_move_to_visually_next (&it
->bidi_it
);
3332 } while (it
->bidi_it
.charpos
!= 0);
3334 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3335 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3339 if (CHARPOS (pos
->string_pos
) >= 0)
3341 /* Recorded position is not in an overlay string, but in another
3342 string. This can only be a string from a `display' property.
3343 IT should already be filled with that string. */
3344 it
->current
.string_pos
= pos
->string_pos
;
3345 eassert (STRINGP (it
->string
));
3347 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3348 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3351 /* Restore position in display vector translations, control
3352 character translations or ellipses. */
3353 if (pos
->dpvec_index
>= 0)
3355 if (it
->dpvec
== NULL
)
3356 get_next_display_element (it
);
3357 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3358 it
->current
.dpvec_index
= pos
->dpvec_index
;
3362 return !overlay_strings_with_newlines
;
3366 /* Initialize IT for stepping through current_buffer in window W
3367 starting at ROW->start. */
3370 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3372 init_from_display_pos (it
, w
, &row
->start
);
3373 it
->start
= row
->start
;
3374 it
->continuation_lines_width
= row
->continuation_lines_width
;
3379 /* Initialize IT for stepping through current_buffer in window W
3380 starting in the line following ROW, i.e. starting at ROW->end.
3381 Value is zero if there are overlay strings with newlines at ROW's
3385 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3389 if (init_from_display_pos (it
, w
, &row
->end
))
3391 if (row
->continued_p
)
3392 it
->continuation_lines_width
3393 = row
->continuation_lines_width
+ row
->pixel_width
;
3404 /***********************************************************************
3406 ***********************************************************************/
3408 /* Called when IT reaches IT->stop_charpos. Handle text property and
3409 overlay changes. Set IT->stop_charpos to the next position where
3413 handle_stop (struct it
*it
)
3415 enum prop_handled handled
;
3416 int handle_overlay_change_p
;
3420 it
->current
.dpvec_index
= -1;
3421 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3422 it
->ignore_overlay_strings_at_pos_p
= 0;
3425 /* Use face of preceding text for ellipsis (if invisible) */
3426 if (it
->selective_display_ellipsis_p
)
3427 it
->saved_face_id
= it
->face_id
;
3429 /* Here's the description of the semantics of, and the logic behind,
3430 the various HANDLED_* statuses:
3432 HANDLED_NORMALLY means the handler did its job, and the loop
3433 should proceed to calling the next handler in order.
3435 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3436 change in the properties and overlays at current position, so the
3437 loop should be restarted, to re-invoke the handlers that were
3438 already called. This happens when fontification-functions were
3439 called by handle_fontified_prop, and actually fontified
3440 something. Another case where HANDLED_RECOMPUTE_PROPS is
3441 returned is when we discover overlay strings that need to be
3442 displayed right away. The loop below will continue for as long
3443 as the status is HANDLED_RECOMPUTE_PROPS.
3445 HANDLED_RETURN means return immediately to the caller, to
3446 continue iteration without calling any further handlers. This is
3447 used when we need to act on some property right away, for example
3448 when we need to display the ellipsis or a replacing display
3449 property, such as display string or image.
3451 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3452 consumed, and the handler switched to the next overlay string.
3453 This signals the loop below to refrain from looking for more
3454 overlays before all the overlay strings of the current overlay
3457 Some of the handlers called by the loop push the iterator state
3458 onto the stack (see 'push_it'), and arrange for the iteration to
3459 continue with another object, such as an image, a display string,
3460 or an overlay string. In most such cases, it->stop_charpos is
3461 set to the first character of the string, so that when the
3462 iteration resumes, this function will immediately be called
3463 again, to examine the properties at the beginning of the string.
3465 When a display or overlay string is exhausted, the iterator state
3466 is popped (see 'pop_it'), and iteration continues with the
3467 previous object. Again, in many such cases this function is
3468 called again to find the next position where properties might
3473 handled
= HANDLED_NORMALLY
;
3475 /* Call text property handlers. */
3476 for (p
= it_props
; p
->handler
; ++p
)
3478 handled
= p
->handler (it
);
3480 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3482 else if (handled
== HANDLED_RETURN
)
3484 /* We still want to show before and after strings from
3485 overlays even if the actual buffer text is replaced. */
3486 if (!handle_overlay_change_p
3488 /* Don't call get_overlay_strings_1 if we already
3489 have overlay strings loaded, because doing so
3490 will load them again and push the iterator state
3491 onto the stack one more time, which is not
3492 expected by the rest of the code that processes
3494 || (it
->current
.overlay_string_index
< 0
3495 ? !get_overlay_strings_1 (it
, 0, 0)
3499 setup_for_ellipsis (it
, 0);
3500 /* When handling a display spec, we might load an
3501 empty string. In that case, discard it here. We
3502 used to discard it in handle_single_display_spec,
3503 but that causes get_overlay_strings_1, above, to
3504 ignore overlay strings that we must check. */
3505 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3509 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3513 it
->ignore_overlay_strings_at_pos_p
= true;
3514 it
->string_from_display_prop_p
= 0;
3515 it
->from_disp_prop_p
= 0;
3516 handle_overlay_change_p
= 0;
3518 handled
= HANDLED_RECOMPUTE_PROPS
;
3521 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3522 handle_overlay_change_p
= 0;
3525 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3527 /* Don't check for overlay strings below when set to deliver
3528 characters from a display vector. */
3529 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3530 handle_overlay_change_p
= 0;
3532 /* Handle overlay changes.
3533 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3534 if it finds overlays. */
3535 if (handle_overlay_change_p
)
3536 handled
= handle_overlay_change (it
);
3541 setup_for_ellipsis (it
, 0);
3545 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3547 /* Determine where to stop next. */
3548 if (handled
== HANDLED_NORMALLY
)
3549 compute_stop_pos (it
);
3553 /* Compute IT->stop_charpos from text property and overlay change
3554 information for IT's current position. */
3557 compute_stop_pos (struct it
*it
)
3559 register INTERVAL iv
, next_iv
;
3560 Lisp_Object object
, limit
, position
;
3561 ptrdiff_t charpos
, bytepos
;
3563 if (STRINGP (it
->string
))
3565 /* Strings are usually short, so don't limit the search for
3567 it
->stop_charpos
= it
->end_charpos
;
3568 object
= it
->string
;
3570 charpos
= IT_STRING_CHARPOS (*it
);
3571 bytepos
= IT_STRING_BYTEPOS (*it
);
3577 /* If end_charpos is out of range for some reason, such as a
3578 misbehaving display function, rationalize it (Bug#5984). */
3579 if (it
->end_charpos
> ZV
)
3580 it
->end_charpos
= ZV
;
3581 it
->stop_charpos
= it
->end_charpos
;
3583 /* If next overlay change is in front of the current stop pos
3584 (which is IT->end_charpos), stop there. Note: value of
3585 next_overlay_change is point-max if no overlay change
3587 charpos
= IT_CHARPOS (*it
);
3588 bytepos
= IT_BYTEPOS (*it
);
3589 pos
= next_overlay_change (charpos
);
3590 if (pos
< it
->stop_charpos
)
3591 it
->stop_charpos
= pos
;
3593 /* Set up variables for computing the stop position from text
3594 property changes. */
3595 XSETBUFFER (object
, current_buffer
);
3596 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3599 /* Get the interval containing IT's position. Value is a null
3600 interval if there isn't such an interval. */
3601 position
= make_number (charpos
);
3602 iv
= validate_interval_range (object
, &position
, &position
, 0);
3605 Lisp_Object values_here
[LAST_PROP_IDX
];
3608 /* Get properties here. */
3609 for (p
= it_props
; p
->handler
; ++p
)
3610 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3612 /* Look for an interval following iv that has different
3614 for (next_iv
= next_interval (iv
);
3617 || XFASTINT (limit
) > next_iv
->position
));
3618 next_iv
= next_interval (next_iv
))
3620 for (p
= it_props
; p
->handler
; ++p
)
3622 Lisp_Object new_value
;
3624 new_value
= textget (next_iv
->plist
, *p
->name
);
3625 if (!EQ (values_here
[p
->idx
], new_value
))
3635 if (INTEGERP (limit
)
3636 && next_iv
->position
>= XFASTINT (limit
))
3637 /* No text property change up to limit. */
3638 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3640 /* Text properties change in next_iv. */
3641 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3645 if (it
->cmp_it
.id
< 0)
3647 ptrdiff_t stoppos
= it
->end_charpos
;
3649 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3651 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3652 stoppos
, it
->string
);
3655 eassert (STRINGP (it
->string
)
3656 || (it
->stop_charpos
>= BEGV
3657 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3661 /* Return the position of the next overlay change after POS in
3662 current_buffer. Value is point-max if no overlay change
3663 follows. This is like `next-overlay-change' but doesn't use
3667 next_overlay_change (ptrdiff_t pos
)
3669 ptrdiff_t i
, noverlays
;
3671 Lisp_Object
*overlays
;
3673 /* Get all overlays at the given position. */
3674 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3676 /* If any of these overlays ends before endpos,
3677 use its ending point instead. */
3678 for (i
= 0; i
< noverlays
; ++i
)
3683 oend
= OVERLAY_END (overlays
[i
]);
3684 oendpos
= OVERLAY_POSITION (oend
);
3685 endpos
= min (endpos
, oendpos
);
3691 /* How many characters forward to search for a display property or
3692 display string. Searching too far forward makes the bidi display
3693 sluggish, especially in small windows. */
3694 #define MAX_DISP_SCAN 250
3696 /* Return the character position of a display string at or after
3697 position specified by POSITION. If no display string exists at or
3698 after POSITION, return ZV. A display string is either an overlay
3699 with `display' property whose value is a string, or a `display'
3700 text property whose value is a string. STRING is data about the
3701 string to iterate; if STRING->lstring is nil, we are iterating a
3702 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3703 on a GUI frame. DISP_PROP is set to zero if we searched
3704 MAX_DISP_SCAN characters forward without finding any display
3705 strings, non-zero otherwise. It is set to 2 if the display string
3706 uses any kind of `(space ...)' spec that will produce a stretch of
3707 white space in the text area. */
3709 compute_display_string_pos (struct text_pos
*position
,
3710 struct bidi_string_data
*string
,
3712 int frame_window_p
, int *disp_prop
)
3714 /* OBJECT = nil means current buffer. */
3715 Lisp_Object object
, object1
;
3716 Lisp_Object pos
, spec
, limpos
;
3717 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3718 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3719 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3720 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3722 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3723 struct text_pos tpos
;
3726 if (string
&& STRINGP (string
->lstring
))
3727 object1
= object
= string
->lstring
;
3728 else if (w
&& !string_p
)
3730 XSETWINDOW (object
, w
);
3734 object1
= object
= Qnil
;
3739 /* We don't support display properties whose values are strings
3740 that have display string properties. */
3741 || string
->from_disp_str
3742 /* C strings cannot have display properties. */
3743 || (string
->s
&& !STRINGP (object
)))
3749 /* If the character at CHARPOS is where the display string begins,
3751 pos
= make_number (charpos
);
3752 if (STRINGP (object
))
3753 bufpos
= string
->bufpos
;
3757 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3759 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3762 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3770 /* Look forward for the first character with a `display' property
3771 that will replace the underlying text when displayed. */
3772 limpos
= make_number (lim
);
3774 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3775 CHARPOS (tpos
) = XFASTINT (pos
);
3776 if (CHARPOS (tpos
) >= lim
)
3781 if (STRINGP (object
))
3782 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3784 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3785 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3786 if (!STRINGP (object
))
3787 bufpos
= CHARPOS (tpos
);
3788 } while (NILP (spec
)
3789 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3790 bufpos
, frame_window_p
)));
3794 return CHARPOS (tpos
);
3797 /* Return the character position of the end of the display string that
3798 started at CHARPOS. If there's no display string at CHARPOS,
3799 return -1. A display string is either an overlay with `display'
3800 property whose value is a string or a `display' text property whose
3801 value is a string. */
3803 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3805 /* OBJECT = nil means current buffer. */
3806 Lisp_Object object
=
3807 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3808 Lisp_Object pos
= make_number (charpos
);
3810 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3812 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3815 /* It could happen that the display property or overlay was removed
3816 since we found it in compute_display_string_pos above. One way
3817 this can happen is if JIT font-lock was called (through
3818 handle_fontified_prop), and jit-lock-functions remove text
3819 properties or overlays from the portion of buffer that includes
3820 CHARPOS. Muse mode is known to do that, for example. In this
3821 case, we return -1 to the caller, to signal that no display
3822 string is actually present at CHARPOS. See bidi_fetch_char for
3823 how this is handled.
3825 An alternative would be to never look for display properties past
3826 it->stop_charpos. But neither compute_display_string_pos nor
3827 bidi_fetch_char that calls it know or care where the next
3829 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3832 /* Look forward for the first character where the `display' property
3834 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3836 return XFASTINT (pos
);
3841 /***********************************************************************
3843 ***********************************************************************/
3845 /* Handle changes in the `fontified' property of the current buffer by
3846 calling hook functions from Qfontification_functions to fontify
3849 static enum prop_handled
3850 handle_fontified_prop (struct it
*it
)
3852 Lisp_Object prop
, pos
;
3853 enum prop_handled handled
= HANDLED_NORMALLY
;
3855 if (!NILP (Vmemory_full
))
3858 /* Get the value of the `fontified' property at IT's current buffer
3859 position. (The `fontified' property doesn't have a special
3860 meaning in strings.) If the value is nil, call functions from
3861 Qfontification_functions. */
3862 if (!STRINGP (it
->string
)
3864 && !NILP (Vfontification_functions
)
3865 && !NILP (Vrun_hooks
)
3866 && (pos
= make_number (IT_CHARPOS (*it
)),
3867 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3868 /* Ignore the special cased nil value always present at EOB since
3869 no amount of fontifying will be able to change it. */
3870 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3872 ptrdiff_t count
= SPECPDL_INDEX ();
3874 struct buffer
*obuf
= current_buffer
;
3875 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3876 bool old_clip_changed
= current_buffer
->clip_changed
;
3878 val
= Vfontification_functions
;
3879 specbind (Qfontification_functions
, Qnil
);
3881 eassert (it
->end_charpos
== ZV
);
3883 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3884 safe_call1 (val
, pos
);
3887 Lisp_Object fns
, fn
;
3888 struct gcpro gcpro1
, gcpro2
;
3893 for (; CONSP (val
); val
= XCDR (val
))
3899 /* A value of t indicates this hook has a local
3900 binding; it means to run the global binding too.
3901 In a global value, t should not occur. If it
3902 does, we must ignore it to avoid an endless
3904 for (fns
= Fdefault_value (Qfontification_functions
);
3910 safe_call1 (fn
, pos
);
3914 safe_call1 (fn
, pos
);
3920 unbind_to (count
, Qnil
);
3922 /* Fontification functions routinely call `save-restriction'.
3923 Normally, this tags clip_changed, which can confuse redisplay
3924 (see discussion in Bug#6671). Since we don't perform any
3925 special handling of fontification changes in the case where
3926 `save-restriction' isn't called, there's no point doing so in
3927 this case either. So, if the buffer's restrictions are
3928 actually left unchanged, reset clip_changed. */
3929 if (obuf
== current_buffer
)
3931 if (begv
== BEGV
&& zv
== ZV
)
3932 current_buffer
->clip_changed
= old_clip_changed
;
3934 /* There isn't much we can reasonably do to protect against
3935 misbehaving fontification, but here's a fig leaf. */
3936 else if (BUFFER_LIVE_P (obuf
))
3937 set_buffer_internal_1 (obuf
);
3939 /* The fontification code may have added/removed text.
3940 It could do even a lot worse, but let's at least protect against
3941 the most obvious case where only the text past `pos' gets changed',
3942 as is/was done in grep.el where some escapes sequences are turned
3943 into face properties (bug#7876). */
3944 it
->end_charpos
= ZV
;
3946 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3947 something. This avoids an endless loop if they failed to
3948 fontify the text for which reason ever. */
3949 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3950 handled
= HANDLED_RECOMPUTE_PROPS
;
3958 /***********************************************************************
3960 ***********************************************************************/
3962 /* Set up iterator IT from face properties at its current position.
3963 Called from handle_stop. */
3965 static enum prop_handled
3966 handle_face_prop (struct it
*it
)
3969 ptrdiff_t next_stop
;
3971 if (!STRINGP (it
->string
))
3974 = face_at_buffer_position (it
->w
,
3978 + TEXT_PROP_DISTANCE_LIMIT
),
3979 0, it
->base_face_id
);
3981 /* Is this a start of a run of characters with box face?
3982 Caveat: this can be called for a freshly initialized
3983 iterator; face_id is -1 in this case. We know that the new
3984 face will not change until limit, i.e. if the new face has a
3985 box, all characters up to limit will have one. But, as
3986 usual, we don't know whether limit is really the end. */
3987 if (new_face_id
!= it
->face_id
)
3989 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3990 /* If it->face_id is -1, old_face below will be NULL, see
3991 the definition of FACE_FROM_ID. This will happen if this
3992 is the initial call that gets the face. */
3993 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3995 /* If the value of face_id of the iterator is -1, we have to
3996 look in front of IT's position and see whether there is a
3997 face there that's different from new_face_id. */
3998 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4000 int prev_face_id
= face_before_it_pos (it
);
4002 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4005 /* If the new face has a box, but the old face does not,
4006 this is the start of a run of characters with box face,
4007 i.e. this character has a shadow on the left side. */
4008 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4009 && (old_face
== NULL
|| !old_face
->box
));
4010 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4018 Lisp_Object from_overlay
4019 = (it
->current
.overlay_string_index
>= 0
4020 ? it
->string_overlays
[it
->current
.overlay_string_index
4021 % OVERLAY_STRING_CHUNK_SIZE
]
4024 /* See if we got to this string directly or indirectly from
4025 an overlay property. That includes the before-string or
4026 after-string of an overlay, strings in display properties
4027 provided by an overlay, their text properties, etc.
4029 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4030 if (! NILP (from_overlay
))
4031 for (i
= it
->sp
- 1; i
>= 0; i
--)
4033 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4035 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4036 % OVERLAY_STRING_CHUNK_SIZE
];
4037 else if (! NILP (it
->stack
[i
].from_overlay
))
4038 from_overlay
= it
->stack
[i
].from_overlay
;
4040 if (!NILP (from_overlay
))
4044 if (! NILP (from_overlay
))
4046 bufpos
= IT_CHARPOS (*it
);
4047 /* For a string from an overlay, the base face depends
4048 only on text properties and ignores overlays. */
4050 = face_for_overlay_string (it
->w
,
4054 + TEXT_PROP_DISTANCE_LIMIT
),
4062 /* For strings from a `display' property, use the face at
4063 IT's current buffer position as the base face to merge
4064 with, so that overlay strings appear in the same face as
4065 surrounding text, unless they specify their own faces.
4066 For strings from wrap-prefix and line-prefix properties,
4067 use the default face, possibly remapped via
4068 Vface_remapping_alist. */
4069 /* Note that the fact that we use the face at _buffer_
4070 position means that a 'display' property on an overlay
4071 string will not inherit the face of that overlay string,
4072 but will instead revert to the face of buffer text
4073 covered by the overlay. This is visible, e.g., when the
4074 overlay specifies a box face, but neither the buffer nor
4075 the display string do. This sounds like a design bug,
4076 but Emacs always did that since v21.1, so changing that
4077 might be a big deal. */
4078 base_face_id
= it
->string_from_prefix_prop_p
4079 ? (!NILP (Vface_remapping_alist
)
4080 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4082 : underlying_face_id (it
);
4085 new_face_id
= face_at_string_position (it
->w
,
4087 IT_STRING_CHARPOS (*it
),
4092 /* Is this a start of a run of characters with box? Caveat:
4093 this can be called for a freshly allocated iterator; face_id
4094 is -1 is this case. We know that the new face will not
4095 change until the next check pos, i.e. if the new face has a
4096 box, all characters up to that position will have a
4097 box. But, as usual, we don't know whether that position
4098 is really the end. */
4099 if (new_face_id
!= it
->face_id
)
4101 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4102 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4104 /* If new face has a box but old face hasn't, this is the
4105 start of a run of characters with box, i.e. it has a
4106 shadow on the left side. */
4107 it
->start_of_box_run_p
4108 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4109 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4113 it
->face_id
= new_face_id
;
4114 return HANDLED_NORMALLY
;
4118 /* Return the ID of the face ``underlying'' IT's current position,
4119 which is in a string. If the iterator is associated with a
4120 buffer, return the face at IT's current buffer position.
4121 Otherwise, use the iterator's base_face_id. */
4124 underlying_face_id (struct it
*it
)
4126 int face_id
= it
->base_face_id
, i
;
4128 eassert (STRINGP (it
->string
));
4130 for (i
= it
->sp
- 1; i
>= 0; --i
)
4131 if (NILP (it
->stack
[i
].string
))
4132 face_id
= it
->stack
[i
].face_id
;
4138 /* Compute the face one character before or after the current position
4139 of IT, in the visual order. BEFORE_P non-zero means get the face
4140 in front (to the left in L2R paragraphs, to the right in R2L
4141 paragraphs) of IT's screen position. Value is the ID of the face. */
4144 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4147 ptrdiff_t next_check_charpos
;
4149 void *it_copy_data
= NULL
;
4151 eassert (it
->s
== NULL
);
4153 if (STRINGP (it
->string
))
4155 ptrdiff_t bufpos
, charpos
;
4158 /* No face change past the end of the string (for the case
4159 we are padding with spaces). No face change before the
4161 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4162 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4167 /* Set charpos to the position before or after IT's current
4168 position, in the logical order, which in the non-bidi
4169 case is the same as the visual order. */
4171 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4172 else if (it
->what
== IT_COMPOSITION
)
4173 /* For composition, we must check the character after the
4175 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4177 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4183 /* With bidi iteration, the character before the current
4184 in the visual order cannot be found by simple
4185 iteration, because "reverse" reordering is not
4186 supported. Instead, we need to use the move_it_*
4187 family of functions. */
4188 /* Ignore face changes before the first visible
4189 character on this display line. */
4190 if (it
->current_x
<= it
->first_visible_x
)
4192 SAVE_IT (it_copy
, *it
, it_copy_data
);
4193 /* Implementation note: Since move_it_in_display_line
4194 works in the iterator geometry, and thinks the first
4195 character is always the leftmost, even in R2L lines,
4196 we don't need to distinguish between the R2L and L2R
4198 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4199 it_copy
.current_x
- 1, MOVE_TO_X
);
4200 charpos
= IT_STRING_CHARPOS (it_copy
);
4201 RESTORE_IT (it
, it
, it_copy_data
);
4205 /* Set charpos to the string position of the character
4206 that comes after IT's current position in the visual
4208 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4212 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4214 charpos
= it_copy
.bidi_it
.charpos
;
4217 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4219 if (it
->current
.overlay_string_index
>= 0)
4220 bufpos
= IT_CHARPOS (*it
);
4224 base_face_id
= underlying_face_id (it
);
4226 /* Get the face for ASCII, or unibyte. */
4227 face_id
= face_at_string_position (it
->w
,
4231 &next_check_charpos
,
4234 /* Correct the face for charsets different from ASCII. Do it
4235 for the multibyte case only. The face returned above is
4236 suitable for unibyte text if IT->string is unibyte. */
4237 if (STRING_MULTIBYTE (it
->string
))
4239 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4240 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4242 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4244 c
= string_char_and_length (p
, &len
);
4245 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4250 struct text_pos pos
;
4252 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4253 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4256 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4257 pos
= it
->current
.pos
;
4262 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4265 if (it
->what
== IT_COMPOSITION
)
4267 /* For composition, we must check the position after
4269 pos
.charpos
+= it
->cmp_it
.nchars
;
4270 pos
.bytepos
+= it
->len
;
4273 INC_TEXT_POS (pos
, it
->multibyte_p
);
4280 /* With bidi iteration, the character before the current
4281 in the visual order cannot be found by simple
4282 iteration, because "reverse" reordering is not
4283 supported. Instead, we need to use the move_it_*
4284 family of functions. */
4285 /* Ignore face changes before the first visible
4286 character on this display line. */
4287 if (it
->current_x
<= it
->first_visible_x
)
4289 SAVE_IT (it_copy
, *it
, it_copy_data
);
4290 /* Implementation note: Since move_it_in_display_line
4291 works in the iterator geometry, and thinks the first
4292 character is always the leftmost, even in R2L lines,
4293 we don't need to distinguish between the R2L and L2R
4295 move_it_in_display_line (&it_copy
, ZV
,
4296 it_copy
.current_x
- 1, MOVE_TO_X
);
4297 pos
= it_copy
.current
.pos
;
4298 RESTORE_IT (it
, it
, it_copy_data
);
4302 /* Set charpos to the buffer position of the character
4303 that comes after IT's current position in the visual
4305 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4309 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4312 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4315 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4317 /* Determine face for CHARSET_ASCII, or unibyte. */
4318 face_id
= face_at_buffer_position (it
->w
,
4320 &next_check_charpos
,
4323 /* Correct the face for charsets different from ASCII. Do it
4324 for the multibyte case only. The face returned above is
4325 suitable for unibyte text if current_buffer is unibyte. */
4326 if (it
->multibyte_p
)
4328 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4329 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4330 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4339 /***********************************************************************
4341 ***********************************************************************/
4343 /* Set up iterator IT from invisible properties at its current
4344 position. Called from handle_stop. */
4346 static enum prop_handled
4347 handle_invisible_prop (struct it
*it
)
4349 enum prop_handled handled
= HANDLED_NORMALLY
;
4353 if (STRINGP (it
->string
))
4355 Lisp_Object end_charpos
, limit
, charpos
;
4357 /* Get the value of the invisible text property at the
4358 current position. Value will be nil if there is no such
4360 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4361 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4362 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4364 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4366 /* Record whether we have to display an ellipsis for the
4368 int display_ellipsis_p
= (invis_p
== 2);
4369 ptrdiff_t len
, endpos
;
4371 handled
= HANDLED_RECOMPUTE_PROPS
;
4373 /* Get the position at which the next visible text can be
4374 found in IT->string, if any. */
4375 endpos
= len
= SCHARS (it
->string
);
4376 XSETINT (limit
, len
);
4379 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4381 if (INTEGERP (end_charpos
))
4383 endpos
= XFASTINT (end_charpos
);
4384 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4385 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4387 display_ellipsis_p
= true;
4390 while (invis_p
&& endpos
< len
);
4392 if (display_ellipsis_p
)
4393 it
->ellipsis_p
= true;
4397 /* Text at END_CHARPOS is visible. Move IT there. */
4398 struct text_pos old
;
4401 old
= it
->current
.string_pos
;
4402 oldpos
= CHARPOS (old
);
4405 if (it
->bidi_it
.first_elt
4406 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4407 bidi_paragraph_init (it
->paragraph_embedding
,
4409 /* Bidi-iterate out of the invisible text. */
4412 bidi_move_to_visually_next (&it
->bidi_it
);
4414 while (oldpos
<= it
->bidi_it
.charpos
4415 && it
->bidi_it
.charpos
< endpos
);
4417 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4418 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4419 if (IT_CHARPOS (*it
) >= endpos
)
4420 it
->prev_stop
= endpos
;
4424 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4425 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4430 /* The rest of the string is invisible. If this is an
4431 overlay string, proceed with the next overlay string
4432 or whatever comes and return a character from there. */
4433 if (it
->current
.overlay_string_index
>= 0
4434 && !display_ellipsis_p
)
4436 next_overlay_string (it
);
4437 /* Don't check for overlay strings when we just
4438 finished processing them. */
4439 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4443 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4444 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4451 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4452 Lisp_Object pos
, overlay
;
4454 /* First of all, is there invisible text at this position? */
4455 tem
= start_charpos
= IT_CHARPOS (*it
);
4456 pos
= make_number (tem
);
4457 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4459 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4461 /* If we are on invisible text, skip over it. */
4462 if (invis_p
&& start_charpos
< it
->end_charpos
)
4464 /* Record whether we have to display an ellipsis for the
4466 int display_ellipsis_p
= invis_p
== 2;
4468 handled
= HANDLED_RECOMPUTE_PROPS
;
4470 /* Loop skipping over invisible text. The loop is left at
4471 ZV or with IT on the first char being visible again. */
4474 /* Try to skip some invisible text. Return value is the
4475 position reached which can be equal to where we start
4476 if there is nothing invisible there. This skips both
4477 over invisible text properties and overlays with
4478 invisible property. */
4479 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4481 /* If we skipped nothing at all we weren't at invisible
4482 text in the first place. If everything to the end of
4483 the buffer was skipped, end the loop. */
4484 if (newpos
== tem
|| newpos
>= ZV
)
4488 /* We skipped some characters but not necessarily
4489 all there are. Check if we ended up on visible
4490 text. Fget_char_property returns the property of
4491 the char before the given position, i.e. if we
4492 get invis_p = 0, this means that the char at
4493 newpos is visible. */
4494 pos
= make_number (newpos
);
4495 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4496 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4499 /* If we ended up on invisible text, proceed to
4500 skip starting with next_stop. */
4504 /* If there are adjacent invisible texts, don't lose the
4505 second one's ellipsis. */
4507 display_ellipsis_p
= true;
4511 /* The position newpos is now either ZV or on visible text. */
4514 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4516 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4518 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4520 /* If the invisible text ends on a newline or on a
4521 character after a newline, we can avoid the costly,
4522 character by character, bidi iteration to NEWPOS, and
4523 instead simply reseat the iterator there. That's
4524 because all bidi reordering information is tossed at
4525 the newline. This is a big win for modes that hide
4526 complete lines, like Outline, Org, etc. */
4527 if (on_newline
|| after_newline
)
4529 struct text_pos tpos
;
4530 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4532 SET_TEXT_POS (tpos
, newpos
, bpos
);
4533 reseat_1 (it
, tpos
, 0);
4534 /* If we reseat on a newline/ZV, we need to prep the
4535 bidi iterator for advancing to the next character
4536 after the newline/EOB, keeping the current paragraph
4537 direction (so that PRODUCE_GLYPHS does TRT wrt
4538 prepending/appending glyphs to a glyph row). */
4541 it
->bidi_it
.first_elt
= 0;
4542 it
->bidi_it
.paragraph_dir
= pdir
;
4543 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4544 it
->bidi_it
.nchars
= 1;
4545 it
->bidi_it
.ch_len
= 1;
4548 else /* Must use the slow method. */
4550 /* With bidi iteration, the region of invisible text
4551 could start and/or end in the middle of a
4552 non-base embedding level. Therefore, we need to
4553 skip invisible text using the bidi iterator,
4554 starting at IT's current position, until we find
4555 ourselves outside of the invisible text.
4556 Skipping invisible text _after_ bidi iteration
4557 avoids affecting the visual order of the
4558 displayed text when invisible properties are
4559 added or removed. */
4560 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4562 /* If we were `reseat'ed to a new paragraph,
4563 determine the paragraph base direction. We
4564 need to do it now because
4565 next_element_from_buffer may not have a
4566 chance to do it, if we are going to skip any
4567 text at the beginning, which resets the
4569 bidi_paragraph_init (it
->paragraph_embedding
,
4574 bidi_move_to_visually_next (&it
->bidi_it
);
4576 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4577 && it
->bidi_it
.charpos
< newpos
);
4578 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4579 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4580 /* If we overstepped NEWPOS, record its position in
4581 the iterator, so that we skip invisible text if
4582 later the bidi iteration lands us in the
4583 invisible region again. */
4584 if (IT_CHARPOS (*it
) >= newpos
)
4585 it
->prev_stop
= newpos
;
4590 IT_CHARPOS (*it
) = newpos
;
4591 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4594 /* If there are before-strings at the start of invisible
4595 text, and the text is invisible because of a text
4596 property, arrange to show before-strings because 20.x did
4597 it that way. (If the text is invisible because of an
4598 overlay property instead of a text property, this is
4599 already handled in the overlay code.) */
4601 && get_overlay_strings (it
, it
->stop_charpos
))
4603 handled
= HANDLED_RECOMPUTE_PROPS
;
4606 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4607 /* The call to get_overlay_strings above recomputes
4608 it->stop_charpos, but it only considers changes
4609 in properties and overlays beyond iterator's
4610 current position. This causes us to miss changes
4611 that happen exactly where the invisible property
4612 ended. So we play it safe here and force the
4613 iterator to check for potential stop positions
4614 immediately after the invisible text. Note that
4615 if get_overlay_strings returns non-zero, it
4616 normally also pushed the iterator stack, so we
4617 need to update the stop position in the slot
4618 below the current one. */
4619 it
->stack
[it
->sp
- 1].stop_charpos
4620 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4623 else if (display_ellipsis_p
)
4625 /* Make sure that the glyphs of the ellipsis will get
4626 correct `charpos' values. If we would not update
4627 it->position here, the glyphs would belong to the
4628 last visible character _before_ the invisible
4629 text, which confuses `set_cursor_from_row'.
4631 We use the last invisible position instead of the
4632 first because this way the cursor is always drawn on
4633 the first "." of the ellipsis, whenever PT is inside
4634 the invisible text. Otherwise the cursor would be
4635 placed _after_ the ellipsis when the point is after the
4636 first invisible character. */
4637 if (!STRINGP (it
->object
))
4639 it
->position
.charpos
= newpos
- 1;
4640 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4642 it
->ellipsis_p
= true;
4643 /* Let the ellipsis display before
4644 considering any properties of the following char.
4645 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4646 handled
= HANDLED_RETURN
;
4655 /* Make iterator IT return `...' next.
4656 Replaces LEN characters from buffer. */
4659 setup_for_ellipsis (struct it
*it
, int len
)
4661 /* Use the display table definition for `...'. Invalid glyphs
4662 will be handled by the method returning elements from dpvec. */
4663 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4665 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4666 it
->dpvec
= v
->contents
;
4667 it
->dpend
= v
->contents
+ v
->header
.size
;
4671 /* Default `...'. */
4672 it
->dpvec
= default_invis_vector
;
4673 it
->dpend
= default_invis_vector
+ 3;
4676 it
->dpvec_char_len
= len
;
4677 it
->current
.dpvec_index
= 0;
4678 it
->dpvec_face_id
= -1;
4680 /* Remember the current face id in case glyphs specify faces.
4681 IT's face is restored in set_iterator_to_next.
4682 saved_face_id was set to preceding char's face in handle_stop. */
4683 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4684 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4686 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4687 it
->ellipsis_p
= true;
4692 /***********************************************************************
4694 ***********************************************************************/
4696 /* Set up iterator IT from `display' property at its current position.
4697 Called from handle_stop.
4698 We return HANDLED_RETURN if some part of the display property
4699 overrides the display of the buffer text itself.
4700 Otherwise we return HANDLED_NORMALLY. */
4702 static enum prop_handled
4703 handle_display_prop (struct it
*it
)
4705 Lisp_Object propval
, object
, overlay
;
4706 struct text_pos
*position
;
4708 /* Nonzero if some property replaces the display of the text itself. */
4709 int display_replaced_p
= 0;
4711 if (STRINGP (it
->string
))
4713 object
= it
->string
;
4714 position
= &it
->current
.string_pos
;
4715 bufpos
= CHARPOS (it
->current
.pos
);
4719 XSETWINDOW (object
, it
->w
);
4720 position
= &it
->current
.pos
;
4721 bufpos
= CHARPOS (*position
);
4724 /* Reset those iterator values set from display property values. */
4725 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4726 it
->space_width
= Qnil
;
4727 it
->font_height
= Qnil
;
4730 /* We don't support recursive `display' properties, i.e. string
4731 values that have a string `display' property, that have a string
4732 `display' property etc. */
4733 if (!it
->string_from_display_prop_p
)
4734 it
->area
= TEXT_AREA
;
4736 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4737 Qdisplay
, object
, &overlay
);
4739 return HANDLED_NORMALLY
;
4740 /* Now OVERLAY is the overlay that gave us this property, or nil
4741 if it was a text property. */
4743 if (!STRINGP (it
->string
))
4744 object
= it
->w
->contents
;
4746 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4748 FRAME_WINDOW_P (it
->f
));
4750 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4753 /* Subroutine of handle_display_prop. Returns non-zero if the display
4754 specification in SPEC is a replacing specification, i.e. it would
4755 replace the text covered by `display' property with something else,
4756 such as an image or a display string. If SPEC includes any kind or
4757 `(space ...) specification, the value is 2; this is used by
4758 compute_display_string_pos, which see.
4760 See handle_single_display_spec for documentation of arguments.
4761 frame_window_p is non-zero if the window being redisplayed is on a
4762 GUI frame; this argument is used only if IT is NULL, see below.
4764 IT can be NULL, if this is called by the bidi reordering code
4765 through compute_display_string_pos, which see. In that case, this
4766 function only examines SPEC, but does not otherwise "handle" it, in
4767 the sense that it doesn't set up members of IT from the display
4770 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4771 Lisp_Object overlay
, struct text_pos
*position
,
4772 ptrdiff_t bufpos
, int frame_window_p
)
4774 int replacing_p
= 0;
4778 /* Simple specifications. */
4779 && !EQ (XCAR (spec
), Qimage
)
4780 && !EQ (XCAR (spec
), Qspace
)
4781 && !EQ (XCAR (spec
), Qwhen
)
4782 && !EQ (XCAR (spec
), Qslice
)
4783 && !EQ (XCAR (spec
), Qspace_width
)
4784 && !EQ (XCAR (spec
), Qheight
)
4785 && !EQ (XCAR (spec
), Qraise
)
4786 /* Marginal area specifications. */
4787 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4788 && !EQ (XCAR (spec
), Qleft_fringe
)
4789 && !EQ (XCAR (spec
), Qright_fringe
)
4790 && !NILP (XCAR (spec
)))
4792 for (; CONSP (spec
); spec
= XCDR (spec
))
4794 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4795 overlay
, position
, bufpos
,
4796 replacing_p
, frame_window_p
)))
4799 /* If some text in a string is replaced, `position' no
4800 longer points to the position of `object'. */
4801 if (!it
|| STRINGP (object
))
4806 else if (VECTORP (spec
))
4809 for (i
= 0; i
< ASIZE (spec
); ++i
)
4810 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4811 overlay
, position
, bufpos
,
4812 replacing_p
, frame_window_p
)))
4815 /* If some text in a string is replaced, `position' no
4816 longer points to the position of `object'. */
4817 if (!it
|| STRINGP (object
))
4823 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4824 position
, bufpos
, 0,
4832 /* Value is the position of the end of the `display' property starting
4833 at START_POS in OBJECT. */
4835 static struct text_pos
4836 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4839 struct text_pos end_pos
;
4841 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4842 Qdisplay
, object
, Qnil
);
4843 CHARPOS (end_pos
) = XFASTINT (end
);
4844 if (STRINGP (object
))
4845 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4847 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4853 /* Set up IT from a single `display' property specification SPEC. OBJECT
4854 is the object in which the `display' property was found. *POSITION
4855 is the position in OBJECT at which the `display' property was found.
4856 BUFPOS is the buffer position of OBJECT (different from POSITION if
4857 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4858 previously saw a display specification which already replaced text
4859 display with something else, for example an image; we ignore such
4860 properties after the first one has been processed.
4862 OVERLAY is the overlay this `display' property came from,
4863 or nil if it was a text property.
4865 If SPEC is a `space' or `image' specification, and in some other
4866 cases too, set *POSITION to the position where the `display'
4869 If IT is NULL, only examine the property specification in SPEC, but
4870 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4871 is intended to be displayed in a window on a GUI frame.
4873 Value is non-zero if something was found which replaces the display
4874 of buffer or string text. */
4877 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4878 Lisp_Object overlay
, struct text_pos
*position
,
4879 ptrdiff_t bufpos
, int display_replaced_p
,
4883 Lisp_Object location
, value
;
4884 struct text_pos start_pos
= *position
;
4887 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4888 If the result is non-nil, use VALUE instead of SPEC. */
4890 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4899 if (!NILP (form
) && !EQ (form
, Qt
))
4901 ptrdiff_t count
= SPECPDL_INDEX ();
4902 struct gcpro gcpro1
;
4904 /* Bind `object' to the object having the `display' property, a
4905 buffer or string. Bind `position' to the position in the
4906 object where the property was found, and `buffer-position'
4907 to the current position in the buffer. */
4910 XSETBUFFER (object
, current_buffer
);
4911 specbind (Qobject
, object
);
4912 specbind (Qposition
, make_number (CHARPOS (*position
)));
4913 specbind (Qbuffer_position
, make_number (bufpos
));
4915 form
= safe_eval (form
);
4917 unbind_to (count
, Qnil
);
4923 /* Handle `(height HEIGHT)' specifications. */
4925 && EQ (XCAR (spec
), Qheight
)
4926 && CONSP (XCDR (spec
)))
4930 if (!FRAME_WINDOW_P (it
->f
))
4933 it
->font_height
= XCAR (XCDR (spec
));
4934 if (!NILP (it
->font_height
))
4936 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4937 int new_height
= -1;
4939 if (CONSP (it
->font_height
)
4940 && (EQ (XCAR (it
->font_height
), Qplus
)
4941 || EQ (XCAR (it
->font_height
), Qminus
))
4942 && CONSP (XCDR (it
->font_height
))
4943 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4945 /* `(+ N)' or `(- N)' where N is an integer. */
4946 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4947 if (EQ (XCAR (it
->font_height
), Qplus
))
4949 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4951 else if (FUNCTIONP (it
->font_height
))
4953 /* Call function with current height as argument.
4954 Value is the new height. */
4956 height
= safe_call1 (it
->font_height
,
4957 face
->lface
[LFACE_HEIGHT_INDEX
]);
4958 if (NUMBERP (height
))
4959 new_height
= XFLOATINT (height
);
4961 else if (NUMBERP (it
->font_height
))
4963 /* Value is a multiple of the canonical char height. */
4966 f
= FACE_FROM_ID (it
->f
,
4967 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4968 new_height
= (XFLOATINT (it
->font_height
)
4969 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4973 /* Evaluate IT->font_height with `height' bound to the
4974 current specified height to get the new height. */
4975 ptrdiff_t count
= SPECPDL_INDEX ();
4977 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4978 value
= safe_eval (it
->font_height
);
4979 unbind_to (count
, Qnil
);
4981 if (NUMBERP (value
))
4982 new_height
= XFLOATINT (value
);
4986 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4993 /* Handle `(space-width WIDTH)'. */
4995 && EQ (XCAR (spec
), Qspace_width
)
4996 && CONSP (XCDR (spec
)))
5000 if (!FRAME_WINDOW_P (it
->f
))
5003 value
= XCAR (XCDR (spec
));
5004 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5005 it
->space_width
= value
;
5011 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5013 && EQ (XCAR (spec
), Qslice
))
5019 if (!FRAME_WINDOW_P (it
->f
))
5022 if (tem
= XCDR (spec
), CONSP (tem
))
5024 it
->slice
.x
= XCAR (tem
);
5025 if (tem
= XCDR (tem
), CONSP (tem
))
5027 it
->slice
.y
= XCAR (tem
);
5028 if (tem
= XCDR (tem
), CONSP (tem
))
5030 it
->slice
.width
= XCAR (tem
);
5031 if (tem
= XCDR (tem
), CONSP (tem
))
5032 it
->slice
.height
= XCAR (tem
);
5041 /* Handle `(raise FACTOR)'. */
5043 && EQ (XCAR (spec
), Qraise
)
5044 && CONSP (XCDR (spec
)))
5048 if (!FRAME_WINDOW_P (it
->f
))
5051 #ifdef HAVE_WINDOW_SYSTEM
5052 value
= XCAR (XCDR (spec
));
5053 if (NUMBERP (value
))
5055 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5056 it
->voffset
= - (XFLOATINT (value
)
5057 * (FONT_HEIGHT (face
->font
)));
5059 #endif /* HAVE_WINDOW_SYSTEM */
5065 /* Don't handle the other kinds of display specifications
5066 inside a string that we got from a `display' property. */
5067 if (it
&& it
->string_from_display_prop_p
)
5070 /* Characters having this form of property are not displayed, so
5071 we have to find the end of the property. */
5074 start_pos
= *position
;
5075 *position
= display_prop_end (it
, object
, start_pos
);
5079 /* Stop the scan at that end position--we assume that all
5080 text properties change there. */
5082 it
->stop_charpos
= position
->charpos
;
5084 /* Handle `(left-fringe BITMAP [FACE])'
5085 and `(right-fringe BITMAP [FACE])'. */
5087 && (EQ (XCAR (spec
), Qleft_fringe
)
5088 || EQ (XCAR (spec
), Qright_fringe
))
5089 && CONSP (XCDR (spec
)))
5095 if (!FRAME_WINDOW_P (it
->f
))
5096 /* If we return here, POSITION has been advanced
5097 across the text with this property. */
5099 /* Synchronize the bidi iterator with POSITION. This is
5100 needed because we are not going to push the iterator
5101 on behalf of this display property, so there will be
5102 no pop_it call to do this synchronization for us. */
5105 it
->position
= *position
;
5106 iterate_out_of_display_property (it
);
5107 *position
= it
->position
;
5112 else if (!frame_window_p
)
5115 #ifdef HAVE_WINDOW_SYSTEM
5116 value
= XCAR (XCDR (spec
));
5117 if (!SYMBOLP (value
)
5118 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5119 /* If we return here, POSITION has been advanced
5120 across the text with this property. */
5122 if (it
&& it
->bidi_p
)
5124 it
->position
= *position
;
5125 iterate_out_of_display_property (it
);
5126 *position
= it
->position
;
5133 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5135 if (CONSP (XCDR (XCDR (spec
))))
5137 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5138 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5144 /* Save current settings of IT so that we can restore them
5145 when we are finished with the glyph property value. */
5146 push_it (it
, position
);
5148 it
->area
= TEXT_AREA
;
5149 it
->what
= IT_IMAGE
;
5150 it
->image_id
= -1; /* no image */
5151 it
->position
= start_pos
;
5152 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5153 it
->method
= GET_FROM_IMAGE
;
5154 it
->from_overlay
= Qnil
;
5155 it
->face_id
= face_id
;
5156 it
->from_disp_prop_p
= true;
5158 /* Say that we haven't consumed the characters with
5159 `display' property yet. The call to pop_it in
5160 set_iterator_to_next will clean this up. */
5161 *position
= start_pos
;
5163 if (EQ (XCAR (spec
), Qleft_fringe
))
5165 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5166 it
->left_user_fringe_face_id
= face_id
;
5170 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5171 it
->right_user_fringe_face_id
= face_id
;
5174 #endif /* HAVE_WINDOW_SYSTEM */
5178 /* Prepare to handle `((margin left-margin) ...)',
5179 `((margin right-margin) ...)' and `((margin nil) ...)'
5180 prefixes for display specifications. */
5181 location
= Qunbound
;
5182 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5186 value
= XCDR (spec
);
5188 value
= XCAR (value
);
5191 if (EQ (XCAR (tem
), Qmargin
)
5192 && (tem
= XCDR (tem
),
5193 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5195 || EQ (tem
, Qleft_margin
)
5196 || EQ (tem
, Qright_margin
))))
5200 if (EQ (location
, Qunbound
))
5206 /* After this point, VALUE is the property after any
5207 margin prefix has been stripped. It must be a string,
5208 an image specification, or `(space ...)'.
5210 LOCATION specifies where to display: `left-margin',
5211 `right-margin' or nil. */
5213 valid_p
= (STRINGP (value
)
5214 #ifdef HAVE_WINDOW_SYSTEM
5215 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5216 && valid_image_p (value
))
5217 #endif /* not HAVE_WINDOW_SYSTEM */
5218 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5220 if (valid_p
&& !display_replaced_p
)
5226 /* Callers need to know whether the display spec is any kind
5227 of `(space ...)' spec that is about to affect text-area
5229 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5234 /* Save current settings of IT so that we can restore them
5235 when we are finished with the glyph property value. */
5236 push_it (it
, position
);
5237 it
->from_overlay
= overlay
;
5238 it
->from_disp_prop_p
= true;
5240 if (NILP (location
))
5241 it
->area
= TEXT_AREA
;
5242 else if (EQ (location
, Qleft_margin
))
5243 it
->area
= LEFT_MARGIN_AREA
;
5245 it
->area
= RIGHT_MARGIN_AREA
;
5247 if (STRINGP (value
))
5250 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5251 it
->current
.overlay_string_index
= -1;
5252 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5253 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5254 it
->method
= GET_FROM_STRING
;
5255 it
->stop_charpos
= 0;
5257 it
->base_level_stop
= 0;
5258 it
->string_from_display_prop_p
= true;
5259 /* Say that we haven't consumed the characters with
5260 `display' property yet. The call to pop_it in
5261 set_iterator_to_next will clean this up. */
5262 if (BUFFERP (object
))
5263 *position
= start_pos
;
5265 /* Force paragraph direction to be that of the parent
5266 object. If the parent object's paragraph direction is
5267 not yet determined, default to L2R. */
5268 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5269 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5271 it
->paragraph_embedding
= L2R
;
5273 /* Set up the bidi iterator for this display string. */
5276 it
->bidi_it
.string
.lstring
= it
->string
;
5277 it
->bidi_it
.string
.s
= NULL
;
5278 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5279 it
->bidi_it
.string
.bufpos
= bufpos
;
5280 it
->bidi_it
.string
.from_disp_str
= 1;
5281 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5282 it
->bidi_it
.w
= it
->w
;
5283 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5286 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5288 it
->method
= GET_FROM_STRETCH
;
5290 *position
= it
->position
= start_pos
;
5291 retval
= 1 + (it
->area
== TEXT_AREA
);
5293 #ifdef HAVE_WINDOW_SYSTEM
5296 it
->what
= IT_IMAGE
;
5297 it
->image_id
= lookup_image (it
->f
, value
);
5298 it
->position
= start_pos
;
5299 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5300 it
->method
= GET_FROM_IMAGE
;
5302 /* Say that we haven't consumed the characters with
5303 `display' property yet. The call to pop_it in
5304 set_iterator_to_next will clean this up. */
5305 *position
= start_pos
;
5307 #endif /* HAVE_WINDOW_SYSTEM */
5312 /* Invalid property or property not supported. Restore
5313 POSITION to what it was before. */
5314 *position
= start_pos
;
5318 /* Check if PROP is a display property value whose text should be
5319 treated as intangible. OVERLAY is the overlay from which PROP
5320 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5321 specify the buffer position covered by PROP. */
5324 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5325 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5327 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5328 struct text_pos position
;
5330 SET_TEXT_POS (position
, charpos
, bytepos
);
5331 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5332 &position
, charpos
, frame_window_p
);
5336 /* Return 1 if PROP is a display sub-property value containing STRING.
5338 Implementation note: this and the following function are really
5339 special cases of handle_display_spec and
5340 handle_single_display_spec, and should ideally use the same code.
5341 Until they do, these two pairs must be consistent and must be
5342 modified in sync. */
5345 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5347 if (EQ (string
, prop
))
5350 /* Skip over `when FORM'. */
5351 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5356 /* Actually, the condition following `when' should be eval'ed,
5357 like handle_single_display_spec does, and we should return
5358 zero if it evaluates to nil. However, this function is
5359 called only when the buffer was already displayed and some
5360 glyph in the glyph matrix was found to come from a display
5361 string. Therefore, the condition was already evaluated, and
5362 the result was non-nil, otherwise the display string wouldn't
5363 have been displayed and we would have never been called for
5364 this property. Thus, we can skip the evaluation and assume
5365 its result is non-nil. */
5370 /* Skip over `margin LOCATION'. */
5371 if (EQ (XCAR (prop
), Qmargin
))
5382 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5386 /* Return 1 if STRING appears in the `display' property PROP. */
5389 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5392 && !EQ (XCAR (prop
), Qwhen
)
5393 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5395 /* A list of sub-properties. */
5396 while (CONSP (prop
))
5398 if (single_display_spec_string_p (XCAR (prop
), string
))
5403 else if (VECTORP (prop
))
5405 /* A vector of sub-properties. */
5407 for (i
= 0; i
< ASIZE (prop
); ++i
)
5408 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5412 return single_display_spec_string_p (prop
, string
);
5417 /* Look for STRING in overlays and text properties in the current
5418 buffer, between character positions FROM and TO (excluding TO).
5419 BACK_P non-zero means look back (in this case, TO is supposed to be
5421 Value is the first character position where STRING was found, or
5422 zero if it wasn't found before hitting TO.
5424 This function may only use code that doesn't eval because it is
5425 called asynchronously from note_mouse_highlight. */
5428 string_buffer_position_lim (Lisp_Object string
,
5429 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5431 Lisp_Object limit
, prop
, pos
;
5434 pos
= make_number (max (from
, BEGV
));
5436 if (!back_p
) /* looking forward */
5438 limit
= make_number (min (to
, ZV
));
5439 while (!found
&& !EQ (pos
, limit
))
5441 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5442 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5445 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5449 else /* looking back */
5451 limit
= make_number (max (to
, BEGV
));
5452 while (!found
&& !EQ (pos
, limit
))
5454 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5455 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5458 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5463 return found
? XINT (pos
) : 0;
5466 /* Determine which buffer position in current buffer STRING comes from.
5467 AROUND_CHARPOS is an approximate position where it could come from.
5468 Value is the buffer position or 0 if it couldn't be determined.
5470 This function is necessary because we don't record buffer positions
5471 in glyphs generated from strings (to keep struct glyph small).
5472 This function may only use code that doesn't eval because it is
5473 called asynchronously from note_mouse_highlight. */
5476 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5478 const int MAX_DISTANCE
= 1000;
5479 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5480 around_charpos
+ MAX_DISTANCE
,
5484 found
= string_buffer_position_lim (string
, around_charpos
,
5485 around_charpos
- MAX_DISTANCE
, 1);
5491 /***********************************************************************
5492 `composition' property
5493 ***********************************************************************/
5495 /* Set up iterator IT from `composition' property at its current
5496 position. Called from handle_stop. */
5498 static enum prop_handled
5499 handle_composition_prop (struct it
*it
)
5501 Lisp_Object prop
, string
;
5502 ptrdiff_t pos
, pos_byte
, start
, end
;
5504 if (STRINGP (it
->string
))
5508 pos
= IT_STRING_CHARPOS (*it
);
5509 pos_byte
= IT_STRING_BYTEPOS (*it
);
5510 string
= it
->string
;
5511 s
= SDATA (string
) + pos_byte
;
5512 it
->c
= STRING_CHAR (s
);
5516 pos
= IT_CHARPOS (*it
);
5517 pos_byte
= IT_BYTEPOS (*it
);
5519 it
->c
= FETCH_CHAR (pos_byte
);
5522 /* If there's a valid composition and point is not inside of the
5523 composition (in the case that the composition is from the current
5524 buffer), draw a glyph composed from the composition components. */
5525 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5526 && composition_valid_p (start
, end
, prop
)
5527 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5530 /* As we can't handle this situation (perhaps font-lock added
5531 a new composition), we just return here hoping that next
5532 redisplay will detect this composition much earlier. */
5533 return HANDLED_NORMALLY
;
5536 if (STRINGP (it
->string
))
5537 pos_byte
= string_char_to_byte (it
->string
, start
);
5539 pos_byte
= CHAR_TO_BYTE (start
);
5541 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5544 if (it
->cmp_it
.id
>= 0)
5547 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5548 it
->cmp_it
.nglyphs
= -1;
5552 return HANDLED_NORMALLY
;
5557 /***********************************************************************
5559 ***********************************************************************/
5561 /* The following structure is used to record overlay strings for
5562 later sorting in load_overlay_strings. */
5564 struct overlay_entry
5566 Lisp_Object overlay
;
5573 /* Set up iterator IT from overlay strings at its current position.
5574 Called from handle_stop. */
5576 static enum prop_handled
5577 handle_overlay_change (struct it
*it
)
5579 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5580 return HANDLED_RECOMPUTE_PROPS
;
5582 return HANDLED_NORMALLY
;
5586 /* Set up the next overlay string for delivery by IT, if there is an
5587 overlay string to deliver. Called by set_iterator_to_next when the
5588 end of the current overlay string is reached. If there are more
5589 overlay strings to display, IT->string and
5590 IT->current.overlay_string_index are set appropriately here.
5591 Otherwise IT->string is set to nil. */
5594 next_overlay_string (struct it
*it
)
5596 ++it
->current
.overlay_string_index
;
5597 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5599 /* No more overlay strings. Restore IT's settings to what
5600 they were before overlay strings were processed, and
5601 continue to deliver from current_buffer. */
5603 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5606 || (NILP (it
->string
)
5607 && it
->method
== GET_FROM_BUFFER
5608 && it
->stop_charpos
>= BEGV
5609 && it
->stop_charpos
<= it
->end_charpos
));
5610 it
->current
.overlay_string_index
= -1;
5611 it
->n_overlay_strings
= 0;
5612 it
->overlay_strings_charpos
= -1;
5613 /* If there's an empty display string on the stack, pop the
5614 stack, to resync the bidi iterator with IT's position. Such
5615 empty strings are pushed onto the stack in
5616 get_overlay_strings_1. */
5617 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5620 /* If we're at the end of the buffer, record that we have
5621 processed the overlay strings there already, so that
5622 next_element_from_buffer doesn't try it again. */
5623 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5624 it
->overlay_strings_at_end_processed_p
= true;
5628 /* There are more overlay strings to process. If
5629 IT->current.overlay_string_index has advanced to a position
5630 where we must load IT->overlay_strings with more strings, do
5631 it. We must load at the IT->overlay_strings_charpos where
5632 IT->n_overlay_strings was originally computed; when invisible
5633 text is present, this might not be IT_CHARPOS (Bug#7016). */
5634 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5636 if (it
->current
.overlay_string_index
&& i
== 0)
5637 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5639 /* Initialize IT to deliver display elements from the overlay
5641 it
->string
= it
->overlay_strings
[i
];
5642 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5643 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5644 it
->method
= GET_FROM_STRING
;
5645 it
->stop_charpos
= 0;
5646 it
->end_charpos
= SCHARS (it
->string
);
5647 if (it
->cmp_it
.stop_pos
>= 0)
5648 it
->cmp_it
.stop_pos
= 0;
5650 it
->base_level_stop
= 0;
5652 /* Set up the bidi iterator for this overlay string. */
5655 it
->bidi_it
.string
.lstring
= it
->string
;
5656 it
->bidi_it
.string
.s
= NULL
;
5657 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5658 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5659 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5660 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5661 it
->bidi_it
.w
= it
->w
;
5662 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5670 /* Compare two overlay_entry structures E1 and E2. Used as a
5671 comparison function for qsort in load_overlay_strings. Overlay
5672 strings for the same position are sorted so that
5674 1. All after-strings come in front of before-strings, except
5675 when they come from the same overlay.
5677 2. Within after-strings, strings are sorted so that overlay strings
5678 from overlays with higher priorities come first.
5680 2. Within before-strings, strings are sorted so that overlay
5681 strings from overlays with higher priorities come last.
5683 Value is analogous to strcmp. */
5687 compare_overlay_entries (const void *e1
, const void *e2
)
5689 struct overlay_entry
const *entry1
= e1
;
5690 struct overlay_entry
const *entry2
= e2
;
5693 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5695 /* Let after-strings appear in front of before-strings if
5696 they come from different overlays. */
5697 if (EQ (entry1
->overlay
, entry2
->overlay
))
5698 result
= entry1
->after_string_p
? 1 : -1;
5700 result
= entry1
->after_string_p
? -1 : 1;
5702 else if (entry1
->priority
!= entry2
->priority
)
5704 if (entry1
->after_string_p
)
5705 /* After-strings sorted in order of decreasing priority. */
5706 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5708 /* Before-strings sorted in order of increasing priority. */
5709 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5718 /* Load the vector IT->overlay_strings with overlay strings from IT's
5719 current buffer position, or from CHARPOS if that is > 0. Set
5720 IT->n_overlays to the total number of overlay strings found.
5722 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5723 a time. On entry into load_overlay_strings,
5724 IT->current.overlay_string_index gives the number of overlay
5725 strings that have already been loaded by previous calls to this
5728 IT->add_overlay_start contains an additional overlay start
5729 position to consider for taking overlay strings from, if non-zero.
5730 This position comes into play when the overlay has an `invisible'
5731 property, and both before and after-strings. When we've skipped to
5732 the end of the overlay, because of its `invisible' property, we
5733 nevertheless want its before-string to appear.
5734 IT->add_overlay_start will contain the overlay start position
5737 Overlay strings are sorted so that after-string strings come in
5738 front of before-string strings. Within before and after-strings,
5739 strings are sorted by overlay priority. See also function
5740 compare_overlay_entries. */
5743 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5745 Lisp_Object overlay
, window
, str
, invisible
;
5746 struct Lisp_Overlay
*ov
;
5747 ptrdiff_t start
, end
;
5748 ptrdiff_t size
= 20;
5749 ptrdiff_t n
= 0, i
, j
;
5751 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5755 charpos
= IT_CHARPOS (*it
);
5757 /* Append the overlay string STRING of overlay OVERLAY to vector
5758 `entries' which has size `size' and currently contains `n'
5759 elements. AFTER_P non-zero means STRING is an after-string of
5761 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5764 Lisp_Object priority; \
5768 struct overlay_entry *old = entries; \
5769 SAFE_NALLOCA (entries, 2, size); \
5770 memcpy (entries, old, size * sizeof *entries); \
5774 entries[n].string = (STRING); \
5775 entries[n].overlay = (OVERLAY); \
5776 priority = Foverlay_get ((OVERLAY), Qpriority); \
5777 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5778 entries[n].after_string_p = (AFTER_P); \
5783 /* Process overlay before the overlay center. */
5784 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5786 XSETMISC (overlay
, ov
);
5787 eassert (OVERLAYP (overlay
));
5788 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5789 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5794 /* Skip this overlay if it doesn't start or end at IT's current
5796 if (end
!= charpos
&& start
!= charpos
)
5799 /* Skip this overlay if it doesn't apply to IT->w. */
5800 window
= Foverlay_get (overlay
, Qwindow
);
5801 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5804 /* If the text ``under'' the overlay is invisible, both before-
5805 and after-strings from this overlay are visible; start and
5806 end position are indistinguishable. */
5807 invisible
= Foverlay_get (overlay
, Qinvisible
);
5808 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5810 /* If overlay has a non-empty before-string, record it. */
5811 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5812 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5814 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5816 /* If overlay has a non-empty after-string, record it. */
5817 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5818 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5820 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5823 /* Process overlays after the overlay center. */
5824 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5826 XSETMISC (overlay
, ov
);
5827 eassert (OVERLAYP (overlay
));
5828 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5829 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5831 if (start
> charpos
)
5834 /* Skip this overlay if it doesn't start or end at IT's current
5836 if (end
!= charpos
&& start
!= charpos
)
5839 /* Skip this overlay if it doesn't apply to IT->w. */
5840 window
= Foverlay_get (overlay
, Qwindow
);
5841 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5844 /* If the text ``under'' the overlay is invisible, it has a zero
5845 dimension, and both before- and after-strings apply. */
5846 invisible
= Foverlay_get (overlay
, Qinvisible
);
5847 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5849 /* If overlay has a non-empty before-string, record it. */
5850 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5851 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5853 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5855 /* If overlay has a non-empty after-string, record it. */
5856 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5857 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5859 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5862 #undef RECORD_OVERLAY_STRING
5866 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5868 /* Record number of overlay strings, and where we computed it. */
5869 it
->n_overlay_strings
= n
;
5870 it
->overlay_strings_charpos
= charpos
;
5872 /* IT->current.overlay_string_index is the number of overlay strings
5873 that have already been consumed by IT. Copy some of the
5874 remaining overlay strings to IT->overlay_strings. */
5876 j
= it
->current
.overlay_string_index
;
5877 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5879 it
->overlay_strings
[i
] = entries
[j
].string
;
5880 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5888 /* Get the first chunk of overlay strings at IT's current buffer
5889 position, or at CHARPOS if that is > 0. Value is non-zero if at
5890 least one overlay string was found. */
5893 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5895 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5896 process. This fills IT->overlay_strings with strings, and sets
5897 IT->n_overlay_strings to the total number of strings to process.
5898 IT->pos.overlay_string_index has to be set temporarily to zero
5899 because load_overlay_strings needs this; it must be set to -1
5900 when no overlay strings are found because a zero value would
5901 indicate a position in the first overlay string. */
5902 it
->current
.overlay_string_index
= 0;
5903 load_overlay_strings (it
, charpos
);
5905 /* If we found overlay strings, set up IT to deliver display
5906 elements from the first one. Otherwise set up IT to deliver
5907 from current_buffer. */
5908 if (it
->n_overlay_strings
)
5910 /* Make sure we know settings in current_buffer, so that we can
5911 restore meaningful values when we're done with the overlay
5914 compute_stop_pos (it
);
5915 eassert (it
->face_id
>= 0);
5917 /* Save IT's settings. They are restored after all overlay
5918 strings have been processed. */
5919 eassert (!compute_stop_p
|| it
->sp
== 0);
5921 /* When called from handle_stop, there might be an empty display
5922 string loaded. In that case, don't bother saving it. But
5923 don't use this optimization with the bidi iterator, since we
5924 need the corresponding pop_it call to resync the bidi
5925 iterator's position with IT's position, after we are done
5926 with the overlay strings. (The corresponding call to pop_it
5927 in case of an empty display string is in
5928 next_overlay_string.) */
5930 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5933 /* Set up IT to deliver display elements from the first overlay
5935 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5936 it
->string
= it
->overlay_strings
[0];
5937 it
->from_overlay
= Qnil
;
5938 it
->stop_charpos
= 0;
5939 eassert (STRINGP (it
->string
));
5940 it
->end_charpos
= SCHARS (it
->string
);
5942 it
->base_level_stop
= 0;
5943 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5944 it
->method
= GET_FROM_STRING
;
5945 it
->from_disp_prop_p
= 0;
5947 /* Force paragraph direction to be that of the parent
5949 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5950 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5952 it
->paragraph_embedding
= L2R
;
5954 /* Set up the bidi iterator for this overlay string. */
5957 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5959 it
->bidi_it
.string
.lstring
= it
->string
;
5960 it
->bidi_it
.string
.s
= NULL
;
5961 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5962 it
->bidi_it
.string
.bufpos
= pos
;
5963 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5964 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5965 it
->bidi_it
.w
= it
->w
;
5966 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5971 it
->current
.overlay_string_index
= -1;
5976 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5979 it
->method
= GET_FROM_BUFFER
;
5981 (void) get_overlay_strings_1 (it
, charpos
, 1);
5985 /* Value is non-zero if we found at least one overlay string. */
5986 return STRINGP (it
->string
);
5991 /***********************************************************************
5992 Saving and restoring state
5993 ***********************************************************************/
5995 /* Save current settings of IT on IT->stack. Called, for example,
5996 before setting up IT for an overlay string, to be able to restore
5997 IT's settings to what they were after the overlay string has been
5998 processed. If POSITION is non-NULL, it is the position to save on
5999 the stack instead of IT->position. */
6002 push_it (struct it
*it
, struct text_pos
*position
)
6004 struct iterator_stack_entry
*p
;
6006 eassert (it
->sp
< IT_STACK_SIZE
);
6007 p
= it
->stack
+ it
->sp
;
6009 p
->stop_charpos
= it
->stop_charpos
;
6010 p
->prev_stop
= it
->prev_stop
;
6011 p
->base_level_stop
= it
->base_level_stop
;
6012 p
->cmp_it
= it
->cmp_it
;
6013 eassert (it
->face_id
>= 0);
6014 p
->face_id
= it
->face_id
;
6015 p
->string
= it
->string
;
6016 p
->method
= it
->method
;
6017 p
->from_overlay
= it
->from_overlay
;
6020 case GET_FROM_IMAGE
:
6021 p
->u
.image
.object
= it
->object
;
6022 p
->u
.image
.image_id
= it
->image_id
;
6023 p
->u
.image
.slice
= it
->slice
;
6025 case GET_FROM_STRETCH
:
6026 p
->u
.stretch
.object
= it
->object
;
6029 p
->position
= position
? *position
: it
->position
;
6030 p
->current
= it
->current
;
6031 p
->end_charpos
= it
->end_charpos
;
6032 p
->string_nchars
= it
->string_nchars
;
6034 p
->multibyte_p
= it
->multibyte_p
;
6035 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6036 p
->space_width
= it
->space_width
;
6037 p
->font_height
= it
->font_height
;
6038 p
->voffset
= it
->voffset
;
6039 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6040 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6041 p
->display_ellipsis_p
= 0;
6042 p
->line_wrap
= it
->line_wrap
;
6043 p
->bidi_p
= it
->bidi_p
;
6044 p
->paragraph_embedding
= it
->paragraph_embedding
;
6045 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6048 /* Save the state of the bidi iterator as well. */
6050 bidi_push_it (&it
->bidi_it
);
6054 iterate_out_of_display_property (struct it
*it
)
6056 int buffer_p
= !STRINGP (it
->string
);
6057 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6058 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6060 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6062 /* Maybe initialize paragraph direction. If we are at the beginning
6063 of a new paragraph, next_element_from_buffer may not have a
6064 chance to do that. */
6065 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6066 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6067 /* prev_stop can be zero, so check against BEGV as well. */
6068 while (it
->bidi_it
.charpos
>= bob
6069 && it
->prev_stop
<= it
->bidi_it
.charpos
6070 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6071 && it
->bidi_it
.charpos
< eob
)
6072 bidi_move_to_visually_next (&it
->bidi_it
);
6073 /* Record the stop_pos we just crossed, for when we cross it
6075 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6076 it
->prev_stop
= CHARPOS (it
->position
);
6077 /* If we ended up not where pop_it put us, resync IT's
6078 positional members with the bidi iterator. */
6079 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6080 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6082 it
->current
.pos
= it
->position
;
6084 it
->current
.string_pos
= it
->position
;
6087 /* Restore IT's settings from IT->stack. Called, for example, when no
6088 more overlay strings must be processed, and we return to delivering
6089 display elements from a buffer, or when the end of a string from a
6090 `display' property is reached and we return to delivering display
6091 elements from an overlay string, or from a buffer. */
6094 pop_it (struct it
*it
)
6096 struct iterator_stack_entry
*p
;
6097 int from_display_prop
= it
->from_disp_prop_p
;
6099 eassert (it
->sp
> 0);
6101 p
= it
->stack
+ it
->sp
;
6102 it
->stop_charpos
= p
->stop_charpos
;
6103 it
->prev_stop
= p
->prev_stop
;
6104 it
->base_level_stop
= p
->base_level_stop
;
6105 it
->cmp_it
= p
->cmp_it
;
6106 it
->face_id
= p
->face_id
;
6107 it
->current
= p
->current
;
6108 it
->position
= p
->position
;
6109 it
->string
= p
->string
;
6110 it
->from_overlay
= p
->from_overlay
;
6111 if (NILP (it
->string
))
6112 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6113 it
->method
= p
->method
;
6116 case GET_FROM_IMAGE
:
6117 it
->image_id
= p
->u
.image
.image_id
;
6118 it
->object
= p
->u
.image
.object
;
6119 it
->slice
= p
->u
.image
.slice
;
6121 case GET_FROM_STRETCH
:
6122 it
->object
= p
->u
.stretch
.object
;
6124 case GET_FROM_BUFFER
:
6125 it
->object
= it
->w
->contents
;
6127 case GET_FROM_STRING
:
6129 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6131 /* Restore the face_box_p flag, since it could have been
6132 overwritten by the face of the object that we just finished
6135 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6136 it
->object
= it
->string
;
6139 case GET_FROM_DISPLAY_VECTOR
:
6141 it
->method
= GET_FROM_C_STRING
;
6142 else if (STRINGP (it
->string
))
6143 it
->method
= GET_FROM_STRING
;
6146 it
->method
= GET_FROM_BUFFER
;
6147 it
->object
= it
->w
->contents
;
6150 it
->end_charpos
= p
->end_charpos
;
6151 it
->string_nchars
= p
->string_nchars
;
6153 it
->multibyte_p
= p
->multibyte_p
;
6154 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6155 it
->space_width
= p
->space_width
;
6156 it
->font_height
= p
->font_height
;
6157 it
->voffset
= p
->voffset
;
6158 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6159 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6160 it
->line_wrap
= p
->line_wrap
;
6161 it
->bidi_p
= p
->bidi_p
;
6162 it
->paragraph_embedding
= p
->paragraph_embedding
;
6163 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6166 bidi_pop_it (&it
->bidi_it
);
6167 /* Bidi-iterate until we get out of the portion of text, if any,
6168 covered by a `display' text property or by an overlay with
6169 `display' property. (We cannot just jump there, because the
6170 internal coherency of the bidi iterator state can not be
6171 preserved across such jumps.) We also must determine the
6172 paragraph base direction if the overlay we just processed is
6173 at the beginning of a new paragraph. */
6174 if (from_display_prop
6175 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6176 iterate_out_of_display_property (it
);
6178 eassert ((BUFFERP (it
->object
)
6179 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6180 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6181 || (STRINGP (it
->object
)
6182 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6183 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6184 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6190 /***********************************************************************
6192 ***********************************************************************/
6194 /* Set IT's current position to the previous line start. */
6197 back_to_previous_line_start (struct it
*it
)
6199 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6202 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6206 /* Move IT to the next line start.
6208 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6209 we skipped over part of the text (as opposed to moving the iterator
6210 continuously over the text). Otherwise, don't change the value
6213 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6214 iterator on the newline, if it was found.
6216 Newlines may come from buffer text, overlay strings, or strings
6217 displayed via the `display' property. That's the reason we can't
6218 simply use find_newline_no_quit.
6220 Note that this function may not skip over invisible text that is so
6221 because of text properties and immediately follows a newline. If
6222 it would, function reseat_at_next_visible_line_start, when called
6223 from set_iterator_to_next, would effectively make invisible
6224 characters following a newline part of the wrong glyph row, which
6225 leads to wrong cursor motion. */
6228 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6229 struct bidi_it
*bidi_it_prev
)
6231 ptrdiff_t old_selective
;
6232 int newline_found_p
, n
;
6233 const int MAX_NEWLINE_DISTANCE
= 500;
6235 /* If already on a newline, just consume it to avoid unintended
6236 skipping over invisible text below. */
6237 if (it
->what
== IT_CHARACTER
6239 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6241 if (it
->bidi_p
&& bidi_it_prev
)
6242 *bidi_it_prev
= it
->bidi_it
;
6243 set_iterator_to_next (it
, 0);
6248 /* Don't handle selective display in the following. It's (a)
6249 unnecessary because it's done by the caller, and (b) leads to an
6250 infinite recursion because next_element_from_ellipsis indirectly
6251 calls this function. */
6252 old_selective
= it
->selective
;
6255 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6256 from buffer text. */
6257 for (n
= newline_found_p
= 0;
6258 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6259 n
+= STRINGP (it
->string
) ? 0 : 1)
6261 if (!get_next_display_element (it
))
6263 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6264 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6265 *bidi_it_prev
= it
->bidi_it
;
6266 set_iterator_to_next (it
, 0);
6269 /* If we didn't find a newline near enough, see if we can use a
6271 if (!newline_found_p
)
6273 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6274 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6278 eassert (!STRINGP (it
->string
));
6280 /* If there isn't any `display' property in sight, and no
6281 overlays, we can just use the position of the newline in
6283 if (it
->stop_charpos
>= limit
6284 || ((pos
= Fnext_single_property_change (make_number (start
),
6286 make_number (limit
)),
6288 && next_overlay_change (start
) == ZV
))
6292 IT_CHARPOS (*it
) = limit
;
6293 IT_BYTEPOS (*it
) = bytepos
;
6297 struct bidi_it bprev
;
6299 /* Help bidi.c avoid expensive searches for display
6300 properties and overlays, by telling it that there are
6301 none up to `limit'. */
6302 if (it
->bidi_it
.disp_pos
< limit
)
6304 it
->bidi_it
.disp_pos
= limit
;
6305 it
->bidi_it
.disp_prop
= 0;
6308 bprev
= it
->bidi_it
;
6309 bidi_move_to_visually_next (&it
->bidi_it
);
6310 } while (it
->bidi_it
.charpos
!= limit
);
6311 IT_CHARPOS (*it
) = limit
;
6312 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6314 *bidi_it_prev
= bprev
;
6316 *skipped_p
= newline_found_p
= true;
6320 while (get_next_display_element (it
)
6321 && !newline_found_p
)
6323 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6324 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6325 *bidi_it_prev
= it
->bidi_it
;
6326 set_iterator_to_next (it
, 0);
6331 it
->selective
= old_selective
;
6332 return newline_found_p
;
6336 /* Set IT's current position to the previous visible line start. Skip
6337 invisible text that is so either due to text properties or due to
6338 selective display. Caution: this does not change IT->current_x and
6342 back_to_previous_visible_line_start (struct it
*it
)
6344 while (IT_CHARPOS (*it
) > BEGV
)
6346 back_to_previous_line_start (it
);
6348 if (IT_CHARPOS (*it
) <= BEGV
)
6351 /* If selective > 0, then lines indented more than its value are
6353 if (it
->selective
> 0
6354 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6358 /* Check the newline before point for invisibility. */
6361 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6362 Qinvisible
, it
->window
);
6363 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6367 if (IT_CHARPOS (*it
) <= BEGV
)
6372 void *it2data
= NULL
;
6375 Lisp_Object val
, overlay
;
6377 SAVE_IT (it2
, *it
, it2data
);
6379 /* If newline is part of a composition, continue from start of composition */
6380 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6381 && beg
< IT_CHARPOS (*it
))
6384 /* If newline is replaced by a display property, find start of overlay
6385 or interval and continue search from that point. */
6386 pos
= --IT_CHARPOS (it2
);
6389 bidi_unshelve_cache (NULL
, 0);
6390 it2
.string_from_display_prop_p
= 0;
6391 it2
.from_disp_prop_p
= 0;
6392 if (handle_display_prop (&it2
) == HANDLED_RETURN
6393 && !NILP (val
= get_char_property_and_overlay
6394 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6395 && (OVERLAYP (overlay
)
6396 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6397 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6399 RESTORE_IT (it
, it
, it2data
);
6403 /* Newline is not replaced by anything -- so we are done. */
6404 RESTORE_IT (it
, it
, it2data
);
6410 IT_CHARPOS (*it
) = beg
;
6411 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6415 it
->continuation_lines_width
= 0;
6417 eassert (IT_CHARPOS (*it
) >= BEGV
);
6418 eassert (IT_CHARPOS (*it
) == BEGV
6419 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6424 /* Reseat iterator IT at the previous visible line start. Skip
6425 invisible text that is so either due to text properties or due to
6426 selective display. At the end, update IT's overlay information,
6427 face information etc. */
6430 reseat_at_previous_visible_line_start (struct it
*it
)
6432 back_to_previous_visible_line_start (it
);
6433 reseat (it
, it
->current
.pos
, 1);
6438 /* Reseat iterator IT on the next visible line start in the current
6439 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6440 preceding the line start. Skip over invisible text that is so
6441 because of selective display. Compute faces, overlays etc at the
6442 new position. Note that this function does not skip over text that
6443 is invisible because of text properties. */
6446 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6448 int newline_found_p
, skipped_p
= 0;
6449 struct bidi_it bidi_it_prev
;
6451 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6453 /* Skip over lines that are invisible because they are indented
6454 more than the value of IT->selective. */
6455 if (it
->selective
> 0)
6456 while (IT_CHARPOS (*it
) < ZV
6457 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6460 eassert (IT_BYTEPOS (*it
) == BEGV
6461 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6463 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6466 /* Position on the newline if that's what's requested. */
6467 if (on_newline_p
&& newline_found_p
)
6469 if (STRINGP (it
->string
))
6471 if (IT_STRING_CHARPOS (*it
) > 0)
6475 --IT_STRING_CHARPOS (*it
);
6476 --IT_STRING_BYTEPOS (*it
);
6480 /* We need to restore the bidi iterator to the state
6481 it had on the newline, and resync the IT's
6482 position with that. */
6483 it
->bidi_it
= bidi_it_prev
;
6484 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6485 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6489 else if (IT_CHARPOS (*it
) > BEGV
)
6498 /* We need to restore the bidi iterator to the state it
6499 had on the newline and resync IT with that. */
6500 it
->bidi_it
= bidi_it_prev
;
6501 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6502 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6504 reseat (it
, it
->current
.pos
, 0);
6508 reseat (it
, it
->current
.pos
, 0);
6515 /***********************************************************************
6516 Changing an iterator's position
6517 ***********************************************************************/
6519 /* Change IT's current position to POS in current_buffer. If FORCE_P
6520 is non-zero, always check for text properties at the new position.
6521 Otherwise, text properties are only looked up if POS >=
6522 IT->check_charpos of a property. */
6525 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6527 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6529 reseat_1 (it
, pos
, 0);
6531 /* Determine where to check text properties. Avoid doing it
6532 where possible because text property lookup is very expensive. */
6534 || CHARPOS (pos
) > it
->stop_charpos
6535 || CHARPOS (pos
) < original_pos
)
6539 /* For bidi iteration, we need to prime prev_stop and
6540 base_level_stop with our best estimations. */
6541 /* Implementation note: Of course, POS is not necessarily a
6542 stop position, so assigning prev_pos to it is a lie; we
6543 should have called compute_stop_backwards. However, if
6544 the current buffer does not include any R2L characters,
6545 that call would be a waste of cycles, because the
6546 iterator will never move back, and thus never cross this
6547 "fake" stop position. So we delay that backward search
6548 until the time we really need it, in next_element_from_buffer. */
6549 if (CHARPOS (pos
) != it
->prev_stop
)
6550 it
->prev_stop
= CHARPOS (pos
);
6551 if (CHARPOS (pos
) < it
->base_level_stop
)
6552 it
->base_level_stop
= 0; /* meaning it's unknown */
6558 it
->prev_stop
= it
->base_level_stop
= 0;
6567 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6568 IT->stop_pos to POS, also. */
6571 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6573 /* Don't call this function when scanning a C string. */
6574 eassert (it
->s
== NULL
);
6576 /* POS must be a reasonable value. */
6577 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6579 it
->current
.pos
= it
->position
= pos
;
6580 it
->end_charpos
= ZV
;
6582 it
->current
.dpvec_index
= -1;
6583 it
->current
.overlay_string_index
= -1;
6584 IT_STRING_CHARPOS (*it
) = -1;
6585 IT_STRING_BYTEPOS (*it
) = -1;
6587 it
->method
= GET_FROM_BUFFER
;
6588 it
->object
= it
->w
->contents
;
6589 it
->area
= TEXT_AREA
;
6590 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6592 it
->string_from_display_prop_p
= 0;
6593 it
->string_from_prefix_prop_p
= 0;
6595 it
->from_disp_prop_p
= 0;
6596 it
->face_before_selective_p
= 0;
6599 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6601 bidi_unshelve_cache (NULL
, 0);
6602 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6603 it
->bidi_it
.string
.s
= NULL
;
6604 it
->bidi_it
.string
.lstring
= Qnil
;
6605 it
->bidi_it
.string
.bufpos
= 0;
6606 it
->bidi_it
.string
.from_disp_str
= 0;
6607 it
->bidi_it
.string
.unibyte
= 0;
6608 it
->bidi_it
.w
= it
->w
;
6613 it
->stop_charpos
= CHARPOS (pos
);
6614 it
->base_level_stop
= CHARPOS (pos
);
6616 /* This make the information stored in it->cmp_it invalidate. */
6621 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6622 If S is non-null, it is a C string to iterate over. Otherwise,
6623 STRING gives a Lisp string to iterate over.
6625 If PRECISION > 0, don't return more then PRECISION number of
6626 characters from the string.
6628 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6629 characters have been returned. FIELD_WIDTH < 0 means an infinite
6632 MULTIBYTE = 0 means disable processing of multibyte characters,
6633 MULTIBYTE > 0 means enable it,
6634 MULTIBYTE < 0 means use IT->multibyte_p.
6636 IT must be initialized via a prior call to init_iterator before
6637 calling this function. */
6640 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6641 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6644 /* No text property checks performed by default, but see below. */
6645 it
->stop_charpos
= -1;
6647 /* Set iterator position and end position. */
6648 memset (&it
->current
, 0, sizeof it
->current
);
6649 it
->current
.overlay_string_index
= -1;
6650 it
->current
.dpvec_index
= -1;
6651 eassert (charpos
>= 0);
6653 /* If STRING is specified, use its multibyteness, otherwise use the
6654 setting of MULTIBYTE, if specified. */
6656 it
->multibyte_p
= multibyte
> 0;
6658 /* Bidirectional reordering of strings is controlled by the default
6659 value of bidi-display-reordering. Don't try to reorder while
6660 loading loadup.el, as the necessary character property tables are
6661 not yet available. */
6664 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6668 eassert (STRINGP (string
));
6669 it
->string
= string
;
6671 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6672 it
->method
= GET_FROM_STRING
;
6673 it
->current
.string_pos
= string_pos (charpos
, string
);
6677 it
->bidi_it
.string
.lstring
= string
;
6678 it
->bidi_it
.string
.s
= NULL
;
6679 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6680 it
->bidi_it
.string
.bufpos
= 0;
6681 it
->bidi_it
.string
.from_disp_str
= 0;
6682 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6683 it
->bidi_it
.w
= it
->w
;
6684 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6685 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6690 it
->s
= (const unsigned char *) s
;
6693 /* Note that we use IT->current.pos, not it->current.string_pos,
6694 for displaying C strings. */
6695 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6696 if (it
->multibyte_p
)
6698 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6699 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6703 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6704 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6709 it
->bidi_it
.string
.lstring
= Qnil
;
6710 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6711 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6712 it
->bidi_it
.string
.bufpos
= 0;
6713 it
->bidi_it
.string
.from_disp_str
= 0;
6714 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6715 it
->bidi_it
.w
= it
->w
;
6716 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6719 it
->method
= GET_FROM_C_STRING
;
6722 /* PRECISION > 0 means don't return more than PRECISION characters
6724 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6726 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6728 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6731 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6732 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6733 FIELD_WIDTH < 0 means infinite field width. This is useful for
6734 padding with `-' at the end of a mode line. */
6735 if (field_width
< 0)
6736 field_width
= INFINITY
;
6737 /* Implementation note: We deliberately don't enlarge
6738 it->bidi_it.string.schars here to fit it->end_charpos, because
6739 the bidi iterator cannot produce characters out of thin air. */
6740 if (field_width
> it
->end_charpos
- charpos
)
6741 it
->end_charpos
= charpos
+ field_width
;
6743 /* Use the standard display table for displaying strings. */
6744 if (DISP_TABLE_P (Vstandard_display_table
))
6745 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6747 it
->stop_charpos
= charpos
;
6748 it
->prev_stop
= charpos
;
6749 it
->base_level_stop
= 0;
6752 it
->bidi_it
.first_elt
= 1;
6753 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6754 it
->bidi_it
.disp_pos
= -1;
6756 if (s
== NULL
&& it
->multibyte_p
)
6758 ptrdiff_t endpos
= SCHARS (it
->string
);
6759 if (endpos
> it
->end_charpos
)
6760 endpos
= it
->end_charpos
;
6761 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6769 /***********************************************************************
6771 ***********************************************************************/
6773 /* Map enum it_method value to corresponding next_element_from_* function. */
6775 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6777 next_element_from_buffer
,
6778 next_element_from_display_vector
,
6779 next_element_from_string
,
6780 next_element_from_c_string
,
6781 next_element_from_image
,
6782 next_element_from_stretch
6785 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6788 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6789 (possibly with the following characters). */
6791 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6792 ((IT)->cmp_it.id >= 0 \
6793 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6794 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6795 END_CHARPOS, (IT)->w, \
6796 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6800 /* Lookup the char-table Vglyphless_char_display for character C (-1
6801 if we want information for no-font case), and return the display
6802 method symbol. By side-effect, update it->what and
6803 it->glyphless_method. This function is called from
6804 get_next_display_element for each character element, and from
6805 x_produce_glyphs when no suitable font was found. */
6808 lookup_glyphless_char_display (int c
, struct it
*it
)
6810 Lisp_Object glyphless_method
= Qnil
;
6812 if (CHAR_TABLE_P (Vglyphless_char_display
)
6813 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6817 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6818 if (CONSP (glyphless_method
))
6819 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6820 ? XCAR (glyphless_method
)
6821 : XCDR (glyphless_method
);
6824 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6828 if (NILP (glyphless_method
))
6831 /* The default is to display the character by a proper font. */
6833 /* The default for the no-font case is to display an empty box. */
6834 glyphless_method
= Qempty_box
;
6836 if (EQ (glyphless_method
, Qzero_width
))
6839 return glyphless_method
;
6840 /* This method can't be used for the no-font case. */
6841 glyphless_method
= Qempty_box
;
6843 if (EQ (glyphless_method
, Qthin_space
))
6844 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6845 else if (EQ (glyphless_method
, Qempty_box
))
6846 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6847 else if (EQ (glyphless_method
, Qhex_code
))
6848 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6849 else if (STRINGP (glyphless_method
))
6850 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6853 /* Invalid value. We use the default method. */
6854 glyphless_method
= Qnil
;
6857 it
->what
= IT_GLYPHLESS
;
6858 return glyphless_method
;
6861 /* Merge escape glyph face and cache the result. */
6863 static struct frame
*last_escape_glyph_frame
= NULL
;
6864 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6865 static int last_escape_glyph_merged_face_id
= 0;
6868 merge_escape_glyph_face (struct it
*it
)
6872 if (it
->f
== last_escape_glyph_frame
6873 && it
->face_id
== last_escape_glyph_face_id
)
6874 face_id
= last_escape_glyph_merged_face_id
;
6877 /* Merge the `escape-glyph' face into the current face. */
6878 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6879 last_escape_glyph_frame
= it
->f
;
6880 last_escape_glyph_face_id
= it
->face_id
;
6881 last_escape_glyph_merged_face_id
= face_id
;
6886 /* Likewise for glyphless glyph face. */
6888 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6889 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6890 static int last_glyphless_glyph_merged_face_id
= 0;
6893 merge_glyphless_glyph_face (struct it
*it
)
6897 if (it
->f
== last_glyphless_glyph_frame
6898 && it
->face_id
== last_glyphless_glyph_face_id
)
6899 face_id
= last_glyphless_glyph_merged_face_id
;
6902 /* Merge the `glyphless-char' face into the current face. */
6903 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6904 last_glyphless_glyph_frame
= it
->f
;
6905 last_glyphless_glyph_face_id
= it
->face_id
;
6906 last_glyphless_glyph_merged_face_id
= face_id
;
6911 /* Load IT's display element fields with information about the next
6912 display element from the current position of IT. Value is zero if
6913 end of buffer (or C string) is reached. */
6916 get_next_display_element (struct it
*it
)
6918 /* Non-zero means that we found a display element. Zero means that
6919 we hit the end of what we iterate over. Performance note: the
6920 function pointer `method' used here turns out to be faster than
6921 using a sequence of if-statements. */
6925 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6927 if (it
->what
== IT_CHARACTER
)
6929 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6930 and only if (a) the resolved directionality of that character
6932 /* FIXME: Do we need an exception for characters from display
6934 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6935 it
->c
= bidi_mirror_char (it
->c
);
6936 /* Map via display table or translate control characters.
6937 IT->c, IT->len etc. have been set to the next character by
6938 the function call above. If we have a display table, and it
6939 contains an entry for IT->c, translate it. Don't do this if
6940 IT->c itself comes from a display table, otherwise we could
6941 end up in an infinite recursion. (An alternative could be to
6942 count the recursion depth of this function and signal an
6943 error when a certain maximum depth is reached.) Is it worth
6945 if (success_p
&& it
->dpvec
== NULL
)
6948 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6949 int nonascii_space_p
= 0;
6950 int nonascii_hyphen_p
= 0;
6951 int c
= it
->c
; /* This is the character to display. */
6953 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6955 eassert (SINGLE_BYTE_CHAR_P (c
));
6956 if (unibyte_display_via_language_environment
)
6958 c
= DECODE_CHAR (unibyte
, c
);
6960 c
= BYTE8_TO_CHAR (it
->c
);
6963 c
= BYTE8_TO_CHAR (it
->c
);
6967 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6970 struct Lisp_Vector
*v
= XVECTOR (dv
);
6972 /* Return the first character from the display table
6973 entry, if not empty. If empty, don't display the
6974 current character. */
6977 it
->dpvec_char_len
= it
->len
;
6978 it
->dpvec
= v
->contents
;
6979 it
->dpend
= v
->contents
+ v
->header
.size
;
6980 it
->current
.dpvec_index
= 0;
6981 it
->dpvec_face_id
= -1;
6982 it
->saved_face_id
= it
->face_id
;
6983 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6988 set_iterator_to_next (it
, 0);
6993 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6995 if (it
->what
== IT_GLYPHLESS
)
6997 /* Don't display this character. */
6998 set_iterator_to_next (it
, 0);
7002 /* If `nobreak-char-display' is non-nil, we display
7003 non-ASCII spaces and hyphens specially. */
7004 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7007 nonascii_space_p
= true;
7008 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7009 nonascii_hyphen_p
= true;
7012 /* Translate control characters into `\003' or `^C' form.
7013 Control characters coming from a display table entry are
7014 currently not translated because we use IT->dpvec to hold
7015 the translation. This could easily be changed but I
7016 don't believe that it is worth doing.
7018 The characters handled by `nobreak-char-display' must be
7021 Non-printable characters and raw-byte characters are also
7022 translated to octal form. */
7023 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7024 ? (it
->area
!= TEXT_AREA
7025 /* In mode line, treat \n, \t like other crl chars. */
7028 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7029 || (c
!= '\n' && c
!= '\t'))
7031 || nonascii_hyphen_p
7033 || ! CHAR_PRINTABLE_P (c
))))
7035 /* C is a control character, non-ASCII space/hyphen,
7036 raw-byte, or a non-printable character which must be
7037 displayed either as '\003' or as `^C' where the '\\'
7038 and '^' can be defined in the display table. Fill
7039 IT->ctl_chars with glyphs for what we have to
7040 display. Then, set IT->dpvec to these glyphs. */
7047 /* Handle control characters with ^. */
7049 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7053 g
= '^'; /* default glyph for Control */
7054 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7056 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7058 g
= GLYPH_CODE_CHAR (gc
);
7059 lface_id
= GLYPH_CODE_FACE (gc
);
7063 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7064 : merge_escape_glyph_face (it
));
7066 XSETINT (it
->ctl_chars
[0], g
);
7067 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7069 goto display_control
;
7072 /* Handle non-ascii space in the mode where it only gets
7075 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7077 /* Merge `nobreak-space' into the current face. */
7078 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7080 XSETINT (it
->ctl_chars
[0], ' ');
7082 goto display_control
;
7085 /* Handle sequences that start with the "escape glyph". */
7087 /* the default escape glyph is \. */
7088 escape_glyph
= '\\';
7091 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7093 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7094 lface_id
= GLYPH_CODE_FACE (gc
);
7098 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7099 : merge_escape_glyph_face (it
));
7101 /* Draw non-ASCII hyphen with just highlighting: */
7103 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7105 XSETINT (it
->ctl_chars
[0], '-');
7107 goto display_control
;
7110 /* Draw non-ASCII space/hyphen with escape glyph: */
7112 if (nonascii_space_p
|| nonascii_hyphen_p
)
7114 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7115 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7117 goto display_control
;
7124 if (CHAR_BYTE8_P (c
))
7125 /* Display \200 instead of \17777600. */
7126 c
= CHAR_TO_BYTE8 (c
);
7127 len
= sprintf (str
, "%03o", c
);
7129 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7130 for (i
= 0; i
< len
; i
++)
7131 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7136 /* Set up IT->dpvec and return first character from it. */
7137 it
->dpvec_char_len
= it
->len
;
7138 it
->dpvec
= it
->ctl_chars
;
7139 it
->dpend
= it
->dpvec
+ ctl_len
;
7140 it
->current
.dpvec_index
= 0;
7141 it
->dpvec_face_id
= face_id
;
7142 it
->saved_face_id
= it
->face_id
;
7143 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7147 it
->char_to_display
= c
;
7151 it
->char_to_display
= it
->c
;
7155 #ifdef HAVE_WINDOW_SYSTEM
7156 /* Adjust face id for a multibyte character. There are no multibyte
7157 character in unibyte text. */
7158 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7161 && FRAME_WINDOW_P (it
->f
))
7163 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7165 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7167 /* Automatic composition with glyph-string. */
7168 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7170 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7174 ptrdiff_t pos
= (it
->s
? -1
7175 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7176 : IT_CHARPOS (*it
));
7179 if (it
->what
== IT_CHARACTER
)
7180 c
= it
->char_to_display
;
7183 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7187 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7188 /* TAB in a composition means display glyphs with
7189 padding space on the left or right. */
7190 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7193 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7196 #endif /* HAVE_WINDOW_SYSTEM */
7199 /* Is this character the last one of a run of characters with
7200 box? If yes, set IT->end_of_box_run_p to 1. */
7204 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7206 int face_id
= underlying_face_id (it
);
7207 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7211 if (face
->box
== FACE_NO_BOX
)
7213 /* If the box comes from face properties in a
7214 display string, check faces in that string. */
7215 int string_face_id
= face_after_it_pos (it
);
7216 it
->end_of_box_run_p
7217 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7220 /* Otherwise, the box comes from the underlying face.
7221 If this is the last string character displayed, check
7222 the next buffer location. */
7223 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7224 /* n_overlay_strings is unreliable unless
7225 overlay_string_index is non-negative. */
7226 && ((it
->current
.overlay_string_index
>= 0
7227 && (it
->current
.overlay_string_index
7228 == it
->n_overlay_strings
- 1))
7229 /* A string from display property. */
7230 || it
->from_disp_prop_p
))
7234 struct text_pos pos
= it
->current
.pos
;
7236 /* For a string from a display property, the next
7237 buffer position is stored in the 'position'
7238 member of the iteration stack slot below the
7239 current one, see handle_single_display_spec. By
7240 contrast, it->current.pos was is not yet updated
7241 to point to that buffer position; that will
7242 happen in pop_it, after we finish displaying the
7243 current string. Note that we already checked
7244 above that it->sp is positive, so subtracting one
7246 if (it
->from_disp_prop_p
)
7247 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7249 INC_TEXT_POS (pos
, it
->multibyte_p
);
7251 if (CHARPOS (pos
) >= ZV
)
7252 it
->end_of_box_run_p
= true;
7255 next_face_id
= face_at_buffer_position
7256 (it
->w
, CHARPOS (pos
), &ignore
,
7257 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7258 it
->end_of_box_run_p
7259 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7265 /* next_element_from_display_vector sets this flag according to
7266 faces of the display vector glyphs, see there. */
7267 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7269 int face_id
= face_after_it_pos (it
);
7270 it
->end_of_box_run_p
7271 = (face_id
!= it
->face_id
7272 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7275 /* If we reached the end of the object we've been iterating (e.g., a
7276 display string or an overlay string), and there's something on
7277 IT->stack, proceed with what's on the stack. It doesn't make
7278 sense to return zero if there's unprocessed stuff on the stack,
7279 because otherwise that stuff will never be displayed. */
7280 if (!success_p
&& it
->sp
> 0)
7282 set_iterator_to_next (it
, 0);
7283 success_p
= get_next_display_element (it
);
7286 /* Value is 0 if end of buffer or string reached. */
7291 /* Move IT to the next display element.
7293 RESEAT_P non-zero means if called on a newline in buffer text,
7294 skip to the next visible line start.
7296 Functions get_next_display_element and set_iterator_to_next are
7297 separate because I find this arrangement easier to handle than a
7298 get_next_display_element function that also increments IT's
7299 position. The way it is we can first look at an iterator's current
7300 display element, decide whether it fits on a line, and if it does,
7301 increment the iterator position. The other way around we probably
7302 would either need a flag indicating whether the iterator has to be
7303 incremented the next time, or we would have to implement a
7304 decrement position function which would not be easy to write. */
7307 set_iterator_to_next (struct it
*it
, int reseat_p
)
7309 /* Reset flags indicating start and end of a sequence of characters
7310 with box. Reset them at the start of this function because
7311 moving the iterator to a new position might set them. */
7312 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7316 case GET_FROM_BUFFER
:
7317 /* The current display element of IT is a character from
7318 current_buffer. Advance in the buffer, and maybe skip over
7319 invisible lines that are so because of selective display. */
7320 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7321 reseat_at_next_visible_line_start (it
, 0);
7322 else if (it
->cmp_it
.id
>= 0)
7324 /* We are currently getting glyphs from a composition. */
7329 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7330 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7331 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7333 it
->cmp_it
.from
= it
->cmp_it
.to
;
7338 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7340 it
->end_charpos
, Qnil
);
7343 else if (! it
->cmp_it
.reversed_p
)
7345 /* Composition created while scanning forward. */
7346 /* Update IT's char/byte positions to point to the first
7347 character of the next grapheme cluster, or to the
7348 character visually after the current composition. */
7349 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7350 bidi_move_to_visually_next (&it
->bidi_it
);
7351 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7352 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7354 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7356 /* Proceed to the next grapheme cluster. */
7357 it
->cmp_it
.from
= it
->cmp_it
.to
;
7361 /* No more grapheme clusters in this composition.
7362 Find the next stop position. */
7363 ptrdiff_t stop
= it
->end_charpos
;
7364 if (it
->bidi_it
.scan_dir
< 0)
7365 /* Now we are scanning backward and don't know
7368 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7369 IT_BYTEPOS (*it
), stop
, Qnil
);
7374 /* Composition created while scanning backward. */
7375 /* Update IT's char/byte positions to point to the last
7376 character of the previous grapheme cluster, or the
7377 character visually after the current composition. */
7378 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7379 bidi_move_to_visually_next (&it
->bidi_it
);
7380 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7381 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7382 if (it
->cmp_it
.from
> 0)
7384 /* Proceed to the previous grapheme cluster. */
7385 it
->cmp_it
.to
= it
->cmp_it
.from
;
7389 /* No more grapheme clusters in this composition.
7390 Find the next stop position. */
7391 ptrdiff_t stop
= it
->end_charpos
;
7392 if (it
->bidi_it
.scan_dir
< 0)
7393 /* Now we are scanning backward and don't know
7396 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7397 IT_BYTEPOS (*it
), stop
, Qnil
);
7403 eassert (it
->len
!= 0);
7407 IT_BYTEPOS (*it
) += it
->len
;
7408 IT_CHARPOS (*it
) += 1;
7412 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7413 /* If this is a new paragraph, determine its base
7414 direction (a.k.a. its base embedding level). */
7415 if (it
->bidi_it
.new_paragraph
)
7416 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7417 bidi_move_to_visually_next (&it
->bidi_it
);
7418 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7419 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7420 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7422 /* As the scan direction was changed, we must
7423 re-compute the stop position for composition. */
7424 ptrdiff_t stop
= it
->end_charpos
;
7425 if (it
->bidi_it
.scan_dir
< 0)
7427 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7428 IT_BYTEPOS (*it
), stop
, Qnil
);
7431 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7435 case GET_FROM_C_STRING
:
7436 /* Current display element of IT is from a C string. */
7438 /* If the string position is beyond string's end, it means
7439 next_element_from_c_string is padding the string with
7440 blanks, in which case we bypass the bidi iterator,
7441 because it cannot deal with such virtual characters. */
7442 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7444 IT_BYTEPOS (*it
) += it
->len
;
7445 IT_CHARPOS (*it
) += 1;
7449 bidi_move_to_visually_next (&it
->bidi_it
);
7450 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7451 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7455 case GET_FROM_DISPLAY_VECTOR
:
7456 /* Current display element of IT is from a display table entry.
7457 Advance in the display table definition. Reset it to null if
7458 end reached, and continue with characters from buffers/
7460 ++it
->current
.dpvec_index
;
7462 /* Restore face of the iterator to what they were before the
7463 display vector entry (these entries may contain faces). */
7464 it
->face_id
= it
->saved_face_id
;
7466 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7468 int recheck_faces
= it
->ellipsis_p
;
7471 it
->method
= GET_FROM_C_STRING
;
7472 else if (STRINGP (it
->string
))
7473 it
->method
= GET_FROM_STRING
;
7476 it
->method
= GET_FROM_BUFFER
;
7477 it
->object
= it
->w
->contents
;
7481 it
->current
.dpvec_index
= -1;
7483 /* Skip over characters which were displayed via IT->dpvec. */
7484 if (it
->dpvec_char_len
< 0)
7485 reseat_at_next_visible_line_start (it
, 1);
7486 else if (it
->dpvec_char_len
> 0)
7488 if (it
->method
== GET_FROM_STRING
7489 && it
->current
.overlay_string_index
>= 0
7490 && it
->n_overlay_strings
> 0)
7491 it
->ignore_overlay_strings_at_pos_p
= true;
7492 it
->len
= it
->dpvec_char_len
;
7493 set_iterator_to_next (it
, reseat_p
);
7496 /* Maybe recheck faces after display vector. */
7498 it
->stop_charpos
= IT_CHARPOS (*it
);
7502 case GET_FROM_STRING
:
7503 /* Current display element is a character from a Lisp string. */
7504 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7505 /* Don't advance past string end. These conditions are true
7506 when set_iterator_to_next is called at the end of
7507 get_next_display_element, in which case the Lisp string is
7508 already exhausted, and all we want is pop the iterator
7510 if (it
->current
.overlay_string_index
>= 0)
7512 /* This is an overlay string, so there's no padding with
7513 spaces, and the number of characters in the string is
7514 where the string ends. */
7515 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7516 goto consider_string_end
;
7520 /* Not an overlay string. There could be padding, so test
7521 against it->end_charpos. */
7522 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7523 goto consider_string_end
;
7525 if (it
->cmp_it
.id
>= 0)
7531 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7532 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7533 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7534 it
->cmp_it
.from
= it
->cmp_it
.to
;
7538 composition_compute_stop_pos (&it
->cmp_it
,
7539 IT_STRING_CHARPOS (*it
),
7540 IT_STRING_BYTEPOS (*it
),
7541 it
->end_charpos
, it
->string
);
7544 else if (! it
->cmp_it
.reversed_p
)
7546 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7547 bidi_move_to_visually_next (&it
->bidi_it
);
7548 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7549 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7551 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7552 it
->cmp_it
.from
= it
->cmp_it
.to
;
7555 ptrdiff_t stop
= it
->end_charpos
;
7556 if (it
->bidi_it
.scan_dir
< 0)
7558 composition_compute_stop_pos (&it
->cmp_it
,
7559 IT_STRING_CHARPOS (*it
),
7560 IT_STRING_BYTEPOS (*it
), stop
,
7566 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7567 bidi_move_to_visually_next (&it
->bidi_it
);
7568 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7569 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7570 if (it
->cmp_it
.from
> 0)
7571 it
->cmp_it
.to
= it
->cmp_it
.from
;
7574 ptrdiff_t stop
= it
->end_charpos
;
7575 if (it
->bidi_it
.scan_dir
< 0)
7577 composition_compute_stop_pos (&it
->cmp_it
,
7578 IT_STRING_CHARPOS (*it
),
7579 IT_STRING_BYTEPOS (*it
), stop
,
7587 /* If the string position is beyond string's end, it
7588 means next_element_from_string is padding the string
7589 with blanks, in which case we bypass the bidi
7590 iterator, because it cannot deal with such virtual
7592 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7594 IT_STRING_BYTEPOS (*it
) += it
->len
;
7595 IT_STRING_CHARPOS (*it
) += 1;
7599 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7601 bidi_move_to_visually_next (&it
->bidi_it
);
7602 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7603 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7604 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7606 ptrdiff_t stop
= it
->end_charpos
;
7608 if (it
->bidi_it
.scan_dir
< 0)
7610 composition_compute_stop_pos (&it
->cmp_it
,
7611 IT_STRING_CHARPOS (*it
),
7612 IT_STRING_BYTEPOS (*it
), stop
,
7618 consider_string_end
:
7620 if (it
->current
.overlay_string_index
>= 0)
7622 /* IT->string is an overlay string. Advance to the
7623 next, if there is one. */
7624 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7627 next_overlay_string (it
);
7629 setup_for_ellipsis (it
, 0);
7634 /* IT->string is not an overlay string. If we reached
7635 its end, and there is something on IT->stack, proceed
7636 with what is on the stack. This can be either another
7637 string, this time an overlay string, or a buffer. */
7638 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7642 if (it
->method
== GET_FROM_STRING
)
7643 goto consider_string_end
;
7648 case GET_FROM_IMAGE
:
7649 case GET_FROM_STRETCH
:
7650 /* The position etc with which we have to proceed are on
7651 the stack. The position may be at the end of a string,
7652 if the `display' property takes up the whole string. */
7653 eassert (it
->sp
> 0);
7655 if (it
->method
== GET_FROM_STRING
)
7656 goto consider_string_end
;
7660 /* There are no other methods defined, so this should be a bug. */
7664 eassert (it
->method
!= GET_FROM_STRING
7665 || (STRINGP (it
->string
)
7666 && IT_STRING_CHARPOS (*it
) >= 0));
7669 /* Load IT's display element fields with information about the next
7670 display element which comes from a display table entry or from the
7671 result of translating a control character to one of the forms `^C'
7674 IT->dpvec holds the glyphs to return as characters.
7675 IT->saved_face_id holds the face id before the display vector--it
7676 is restored into IT->face_id in set_iterator_to_next. */
7679 next_element_from_display_vector (struct it
*it
)
7682 int prev_face_id
= it
->face_id
;
7686 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7688 it
->face_id
= it
->saved_face_id
;
7690 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7691 That seemed totally bogus - so I changed it... */
7692 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7694 if (GLYPH_CODE_P (gc
))
7696 struct face
*this_face
, *prev_face
, *next_face
;
7698 it
->c
= GLYPH_CODE_CHAR (gc
);
7699 it
->len
= CHAR_BYTES (it
->c
);
7701 /* The entry may contain a face id to use. Such a face id is
7702 the id of a Lisp face, not a realized face. A face id of
7703 zero means no face is specified. */
7704 if (it
->dpvec_face_id
>= 0)
7705 it
->face_id
= it
->dpvec_face_id
;
7708 int lface_id
= GLYPH_CODE_FACE (gc
);
7710 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7714 /* Glyphs in the display vector could have the box face, so we
7715 need to set the related flags in the iterator, as
7717 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7718 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7720 /* Is this character the first character of a box-face run? */
7721 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7723 || prev_face
->box
== FACE_NO_BOX
));
7725 /* For the last character of the box-face run, we need to look
7726 either at the next glyph from the display vector, or at the
7727 face we saw before the display vector. */
7728 next_face_id
= it
->saved_face_id
;
7729 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7731 if (it
->dpvec_face_id
>= 0)
7732 next_face_id
= it
->dpvec_face_id
;
7736 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7739 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7743 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7744 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7746 || next_face
->box
== FACE_NO_BOX
));
7747 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7750 /* Display table entry is invalid. Return a space. */
7751 it
->c
= ' ', it
->len
= 1;
7753 /* Don't change position and object of the iterator here. They are
7754 still the values of the character that had this display table
7755 entry or was translated, and that's what we want. */
7756 it
->what
= IT_CHARACTER
;
7760 /* Get the first element of string/buffer in the visual order, after
7761 being reseated to a new position in a string or a buffer. */
7763 get_visually_first_element (struct it
*it
)
7765 int string_p
= STRINGP (it
->string
) || it
->s
;
7766 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7767 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7769 if (STRINGP (it
->string
))
7771 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7772 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7776 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7777 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7780 if (it
->bidi_it
.charpos
== eob
)
7782 /* Nothing to do, but reset the FIRST_ELT flag, like
7783 bidi_paragraph_init does, because we are not going to
7785 it
->bidi_it
.first_elt
= 0;
7787 else if (it
->bidi_it
.charpos
== bob
7789 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7790 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7792 /* If we are at the beginning of a line/string, we can produce
7793 the next element right away. */
7794 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7795 bidi_move_to_visually_next (&it
->bidi_it
);
7799 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7801 /* We need to prime the bidi iterator starting at the line's or
7802 string's beginning, before we will be able to produce the
7805 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7807 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7808 IT_BYTEPOS (*it
), -1,
7809 &it
->bidi_it
.bytepos
);
7810 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7813 /* Now return to buffer/string position where we were asked
7814 to get the next display element, and produce that. */
7815 bidi_move_to_visually_next (&it
->bidi_it
);
7817 while (it
->bidi_it
.bytepos
!= orig_bytepos
7818 && it
->bidi_it
.charpos
< eob
);
7821 /* Adjust IT's position information to where we ended up. */
7822 if (STRINGP (it
->string
))
7824 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7825 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7829 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7830 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7833 if (STRINGP (it
->string
) || !it
->s
)
7835 ptrdiff_t stop
, charpos
, bytepos
;
7837 if (STRINGP (it
->string
))
7840 stop
= SCHARS (it
->string
);
7841 if (stop
> it
->end_charpos
)
7842 stop
= it
->end_charpos
;
7843 charpos
= IT_STRING_CHARPOS (*it
);
7844 bytepos
= IT_STRING_BYTEPOS (*it
);
7848 stop
= it
->end_charpos
;
7849 charpos
= IT_CHARPOS (*it
);
7850 bytepos
= IT_BYTEPOS (*it
);
7852 if (it
->bidi_it
.scan_dir
< 0)
7854 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7859 /* Load IT with the next display element from Lisp string IT->string.
7860 IT->current.string_pos is the current position within the string.
7861 If IT->current.overlay_string_index >= 0, the Lisp string is an
7865 next_element_from_string (struct it
*it
)
7867 struct text_pos position
;
7869 eassert (STRINGP (it
->string
));
7870 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7871 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7872 position
= it
->current
.string_pos
;
7874 /* With bidi reordering, the character to display might not be the
7875 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7876 that we were reseat()ed to a new string, whose paragraph
7877 direction is not known. */
7878 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7880 get_visually_first_element (it
);
7881 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7884 /* Time to check for invisible text? */
7885 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7887 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7890 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7891 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7893 /* With bidi non-linear iteration, we could find
7894 ourselves far beyond the last computed stop_charpos,
7895 with several other stop positions in between that we
7896 missed. Scan them all now, in buffer's logical
7897 order, until we find and handle the last stop_charpos
7898 that precedes our current position. */
7899 handle_stop_backwards (it
, it
->stop_charpos
);
7900 return GET_NEXT_DISPLAY_ELEMENT (it
);
7906 /* Take note of the stop position we just moved
7907 across, for when we will move back across it. */
7908 it
->prev_stop
= it
->stop_charpos
;
7909 /* If we are at base paragraph embedding level, take
7910 note of the last stop position seen at this
7912 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7913 it
->base_level_stop
= it
->stop_charpos
;
7917 /* Since a handler may have changed IT->method, we must
7919 return GET_NEXT_DISPLAY_ELEMENT (it
);
7923 /* If we are before prev_stop, we may have overstepped
7924 on our way backwards a stop_pos, and if so, we need
7925 to handle that stop_pos. */
7926 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7927 /* We can sometimes back up for reasons that have nothing
7928 to do with bidi reordering. E.g., compositions. The
7929 code below is only needed when we are above the base
7930 embedding level, so test for that explicitly. */
7931 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7933 /* If we lost track of base_level_stop, we have no better
7934 place for handle_stop_backwards to start from than string
7935 beginning. This happens, e.g., when we were reseated to
7936 the previous screenful of text by vertical-motion. */
7937 if (it
->base_level_stop
<= 0
7938 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7939 it
->base_level_stop
= 0;
7940 handle_stop_backwards (it
, it
->base_level_stop
);
7941 return GET_NEXT_DISPLAY_ELEMENT (it
);
7945 if (it
->current
.overlay_string_index
>= 0)
7947 /* Get the next character from an overlay string. In overlay
7948 strings, there is no field width or padding with spaces to
7950 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7955 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7956 IT_STRING_BYTEPOS (*it
),
7957 it
->bidi_it
.scan_dir
< 0
7959 : SCHARS (it
->string
))
7960 && next_element_from_composition (it
))
7964 else if (STRING_MULTIBYTE (it
->string
))
7966 const unsigned char *s
= (SDATA (it
->string
)
7967 + IT_STRING_BYTEPOS (*it
));
7968 it
->c
= string_char_and_length (s
, &it
->len
);
7972 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7978 /* Get the next character from a Lisp string that is not an
7979 overlay string. Such strings come from the mode line, for
7980 example. We may have to pad with spaces, or truncate the
7981 string. See also next_element_from_c_string. */
7982 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7987 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7989 /* Pad with spaces. */
7990 it
->c
= ' ', it
->len
= 1;
7991 CHARPOS (position
) = BYTEPOS (position
) = -1;
7993 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7994 IT_STRING_BYTEPOS (*it
),
7995 it
->bidi_it
.scan_dir
< 0
7997 : it
->string_nchars
)
7998 && next_element_from_composition (it
))
8002 else if (STRING_MULTIBYTE (it
->string
))
8004 const unsigned char *s
= (SDATA (it
->string
)
8005 + IT_STRING_BYTEPOS (*it
));
8006 it
->c
= string_char_and_length (s
, &it
->len
);
8010 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8015 /* Record what we have and where it came from. */
8016 it
->what
= IT_CHARACTER
;
8017 it
->object
= it
->string
;
8018 it
->position
= position
;
8023 /* Load IT with next display element from C string IT->s.
8024 IT->string_nchars is the maximum number of characters to return
8025 from the string. IT->end_charpos may be greater than
8026 IT->string_nchars when this function is called, in which case we
8027 may have to return padding spaces. Value is zero if end of string
8028 reached, including padding spaces. */
8031 next_element_from_c_string (struct it
*it
)
8033 bool success_p
= true;
8036 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8037 it
->what
= IT_CHARACTER
;
8038 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8041 /* With bidi reordering, the character to display might not be the
8042 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8043 we were reseated to a new string, whose paragraph direction is
8045 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8046 get_visually_first_element (it
);
8048 /* IT's position can be greater than IT->string_nchars in case a
8049 field width or precision has been specified when the iterator was
8051 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8053 /* End of the game. */
8057 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8059 /* Pad with spaces. */
8060 it
->c
= ' ', it
->len
= 1;
8061 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8063 else if (it
->multibyte_p
)
8064 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8066 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8072 /* Set up IT to return characters from an ellipsis, if appropriate.
8073 The definition of the ellipsis glyphs may come from a display table
8074 entry. This function fills IT with the first glyph from the
8075 ellipsis if an ellipsis is to be displayed. */
8078 next_element_from_ellipsis (struct it
*it
)
8080 if (it
->selective_display_ellipsis_p
)
8081 setup_for_ellipsis (it
, it
->len
);
8084 /* The face at the current position may be different from the
8085 face we find after the invisible text. Remember what it
8086 was in IT->saved_face_id, and signal that it's there by
8087 setting face_before_selective_p. */
8088 it
->saved_face_id
= it
->face_id
;
8089 it
->method
= GET_FROM_BUFFER
;
8090 it
->object
= it
->w
->contents
;
8091 reseat_at_next_visible_line_start (it
, 1);
8092 it
->face_before_selective_p
= true;
8095 return GET_NEXT_DISPLAY_ELEMENT (it
);
8099 /* Deliver an image display element. The iterator IT is already
8100 filled with image information (done in handle_display_prop). Value
8105 next_element_from_image (struct it
*it
)
8107 it
->what
= IT_IMAGE
;
8108 it
->ignore_overlay_strings_at_pos_p
= 0;
8113 /* Fill iterator IT with next display element from a stretch glyph
8114 property. IT->object is the value of the text property. Value is
8118 next_element_from_stretch (struct it
*it
)
8120 it
->what
= IT_STRETCH
;
8124 /* Scan backwards from IT's current position until we find a stop
8125 position, or until BEGV. This is called when we find ourself
8126 before both the last known prev_stop and base_level_stop while
8127 reordering bidirectional text. */
8130 compute_stop_pos_backwards (struct it
*it
)
8132 const int SCAN_BACK_LIMIT
= 1000;
8133 struct text_pos pos
;
8134 struct display_pos save_current
= it
->current
;
8135 struct text_pos save_position
= it
->position
;
8136 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8137 ptrdiff_t where_we_are
= charpos
;
8138 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8139 ptrdiff_t save_end_pos
= it
->end_charpos
;
8141 eassert (NILP (it
->string
) && !it
->s
);
8142 eassert (it
->bidi_p
);
8146 it
->end_charpos
= min (charpos
+ 1, ZV
);
8147 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8148 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8149 reseat_1 (it
, pos
, 0);
8150 compute_stop_pos (it
);
8151 /* We must advance forward, right? */
8152 if (it
->stop_charpos
<= charpos
)
8155 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8157 if (it
->stop_charpos
<= where_we_are
)
8158 it
->prev_stop
= it
->stop_charpos
;
8160 it
->prev_stop
= BEGV
;
8162 it
->current
= save_current
;
8163 it
->position
= save_position
;
8164 it
->stop_charpos
= save_stop_pos
;
8165 it
->end_charpos
= save_end_pos
;
8168 /* Scan forward from CHARPOS in the current buffer/string, until we
8169 find a stop position > current IT's position. Then handle the stop
8170 position before that. This is called when we bump into a stop
8171 position while reordering bidirectional text. CHARPOS should be
8172 the last previously processed stop_pos (or BEGV/0, if none were
8173 processed yet) whose position is less that IT's current
8177 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8179 int bufp
= !STRINGP (it
->string
);
8180 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8181 struct display_pos save_current
= it
->current
;
8182 struct text_pos save_position
= it
->position
;
8183 struct text_pos pos1
;
8184 ptrdiff_t next_stop
;
8186 /* Scan in strict logical order. */
8187 eassert (it
->bidi_p
);
8191 it
->prev_stop
= charpos
;
8194 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8195 reseat_1 (it
, pos1
, 0);
8198 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8199 compute_stop_pos (it
);
8200 /* We must advance forward, right? */
8201 if (it
->stop_charpos
<= it
->prev_stop
)
8203 charpos
= it
->stop_charpos
;
8205 while (charpos
<= where_we_are
);
8208 it
->current
= save_current
;
8209 it
->position
= save_position
;
8210 next_stop
= it
->stop_charpos
;
8211 it
->stop_charpos
= it
->prev_stop
;
8213 it
->stop_charpos
= next_stop
;
8216 /* Load IT with the next display element from current_buffer. Value
8217 is zero if end of buffer reached. IT->stop_charpos is the next
8218 position at which to stop and check for text properties or buffer
8222 next_element_from_buffer (struct it
*it
)
8224 bool success_p
= true;
8226 eassert (IT_CHARPOS (*it
) >= BEGV
);
8227 eassert (NILP (it
->string
) && !it
->s
);
8228 eassert (!it
->bidi_p
8229 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8230 && it
->bidi_it
.string
.s
== NULL
));
8232 /* With bidi reordering, the character to display might not be the
8233 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8234 we were reseat()ed to a new buffer position, which is potentially
8235 a different paragraph. */
8236 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8238 get_visually_first_element (it
);
8239 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8242 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8244 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8246 int overlay_strings_follow_p
;
8248 /* End of the game, except when overlay strings follow that
8249 haven't been returned yet. */
8250 if (it
->overlay_strings_at_end_processed_p
)
8251 overlay_strings_follow_p
= 0;
8254 it
->overlay_strings_at_end_processed_p
= true;
8255 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8258 if (overlay_strings_follow_p
)
8259 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8263 it
->position
= it
->current
.pos
;
8267 else if (!(!it
->bidi_p
8268 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8269 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8271 /* With bidi non-linear iteration, we could find ourselves
8272 far beyond the last computed stop_charpos, with several
8273 other stop positions in between that we missed. Scan
8274 them all now, in buffer's logical order, until we find
8275 and handle the last stop_charpos that precedes our
8276 current position. */
8277 handle_stop_backwards (it
, it
->stop_charpos
);
8278 return GET_NEXT_DISPLAY_ELEMENT (it
);
8284 /* Take note of the stop position we just moved across,
8285 for when we will move back across it. */
8286 it
->prev_stop
= it
->stop_charpos
;
8287 /* If we are at base paragraph embedding level, take
8288 note of the last stop position seen at this
8290 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8291 it
->base_level_stop
= it
->stop_charpos
;
8294 return GET_NEXT_DISPLAY_ELEMENT (it
);
8298 /* If we are before prev_stop, we may have overstepped on
8299 our way backwards a stop_pos, and if so, we need to
8300 handle that stop_pos. */
8301 && IT_CHARPOS (*it
) < it
->prev_stop
8302 /* We can sometimes back up for reasons that have nothing
8303 to do with bidi reordering. E.g., compositions. The
8304 code below is only needed when we are above the base
8305 embedding level, so test for that explicitly. */
8306 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8308 if (it
->base_level_stop
<= 0
8309 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8311 /* If we lost track of base_level_stop, we need to find
8312 prev_stop by looking backwards. This happens, e.g., when
8313 we were reseated to the previous screenful of text by
8315 it
->base_level_stop
= BEGV
;
8316 compute_stop_pos_backwards (it
);
8317 handle_stop_backwards (it
, it
->prev_stop
);
8320 handle_stop_backwards (it
, it
->base_level_stop
);
8321 return GET_NEXT_DISPLAY_ELEMENT (it
);
8325 /* No face changes, overlays etc. in sight, so just return a
8326 character from current_buffer. */
8330 /* Maybe run the redisplay end trigger hook. Performance note:
8331 This doesn't seem to cost measurable time. */
8332 if (it
->redisplay_end_trigger_charpos
8334 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8335 run_redisplay_end_trigger_hook (it
);
8337 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8338 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8340 && next_element_from_composition (it
))
8345 /* Get the next character, maybe multibyte. */
8346 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8347 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
8348 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8350 it
->c
= *p
, it
->len
= 1;
8352 /* Record what we have and where it came from. */
8353 it
->what
= IT_CHARACTER
;
8354 it
->object
= it
->w
->contents
;
8355 it
->position
= it
->current
.pos
;
8357 /* Normally we return the character found above, except when we
8358 really want to return an ellipsis for selective display. */
8363 /* A value of selective > 0 means hide lines indented more
8364 than that number of columns. */
8365 if (it
->selective
> 0
8366 && IT_CHARPOS (*it
) + 1 < ZV
8367 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8368 IT_BYTEPOS (*it
) + 1,
8371 success_p
= next_element_from_ellipsis (it
);
8372 it
->dpvec_char_len
= -1;
8375 else if (it
->c
== '\r' && it
->selective
== -1)
8377 /* A value of selective == -1 means that everything from the
8378 CR to the end of the line is invisible, with maybe an
8379 ellipsis displayed for it. */
8380 success_p
= next_element_from_ellipsis (it
);
8381 it
->dpvec_char_len
= -1;
8386 /* Value is zero if end of buffer reached. */
8387 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8392 /* Run the redisplay end trigger hook for IT. */
8395 run_redisplay_end_trigger_hook (struct it
*it
)
8397 Lisp_Object args
[3];
8399 /* IT->glyph_row should be non-null, i.e. we should be actually
8400 displaying something, or otherwise we should not run the hook. */
8401 eassert (it
->glyph_row
);
8403 /* Set up hook arguments. */
8404 args
[0] = Qredisplay_end_trigger_functions
;
8405 args
[1] = it
->window
;
8406 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8407 it
->redisplay_end_trigger_charpos
= 0;
8409 /* Since we are *trying* to run these functions, don't try to run
8410 them again, even if they get an error. */
8411 wset_redisplay_end_trigger (it
->w
, Qnil
);
8412 Frun_hook_with_args (3, args
);
8414 /* Notice if it changed the face of the character we are on. */
8415 handle_face_prop (it
);
8419 /* Deliver a composition display element. Unlike the other
8420 next_element_from_XXX, this function is not registered in the array
8421 get_next_element[]. It is called from next_element_from_buffer and
8422 next_element_from_string when necessary. */
8425 next_element_from_composition (struct it
*it
)
8427 it
->what
= IT_COMPOSITION
;
8428 it
->len
= it
->cmp_it
.nbytes
;
8429 if (STRINGP (it
->string
))
8433 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8434 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8437 it
->position
= it
->current
.string_pos
;
8438 it
->object
= it
->string
;
8439 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8440 IT_STRING_BYTEPOS (*it
), it
->string
);
8446 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8447 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8450 if (it
->bidi_it
.new_paragraph
)
8451 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8452 /* Resync the bidi iterator with IT's new position.
8453 FIXME: this doesn't support bidirectional text. */
8454 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8455 bidi_move_to_visually_next (&it
->bidi_it
);
8459 it
->position
= it
->current
.pos
;
8460 it
->object
= it
->w
->contents
;
8461 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8462 IT_BYTEPOS (*it
), Qnil
);
8469 /***********************************************************************
8470 Moving an iterator without producing glyphs
8471 ***********************************************************************/
8473 /* Check if iterator is at a position corresponding to a valid buffer
8474 position after some move_it_ call. */
8476 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8477 ((it)->method == GET_FROM_STRING \
8478 ? IT_STRING_CHARPOS (*it) == 0 \
8482 /* Move iterator IT to a specified buffer or X position within one
8483 line on the display without producing glyphs.
8485 OP should be a bit mask including some or all of these bits:
8486 MOVE_TO_X: Stop upon reaching x-position TO_X.
8487 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8488 Regardless of OP's value, stop upon reaching the end of the display line.
8490 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8491 This means, in particular, that TO_X includes window's horizontal
8494 The return value has several possible values that
8495 say what condition caused the scan to stop:
8497 MOVE_POS_MATCH_OR_ZV
8498 - when TO_POS or ZV was reached.
8501 -when TO_X was reached before TO_POS or ZV were reached.
8504 - when we reached the end of the display area and the line must
8508 - when we reached the end of the display area and the line is
8512 - when we stopped at a line end, i.e. a newline or a CR and selective
8515 static enum move_it_result
8516 move_it_in_display_line_to (struct it
*it
,
8517 ptrdiff_t to_charpos
, int to_x
,
8518 enum move_operation_enum op
)
8520 enum move_it_result result
= MOVE_UNDEFINED
;
8521 struct glyph_row
*saved_glyph_row
;
8522 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8523 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8524 void *ppos_data
= NULL
;
8526 enum it_method prev_method
= it
->method
;
8527 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8528 int saw_smaller_pos
= prev_pos
< to_charpos
;
8530 /* Don't produce glyphs in produce_glyphs. */
8531 saved_glyph_row
= it
->glyph_row
;
8532 it
->glyph_row
= NULL
;
8534 /* Use wrap_it to save a copy of IT wherever a word wrap could
8535 occur. Use atpos_it to save a copy of IT at the desired buffer
8536 position, if found, so that we can scan ahead and check if the
8537 word later overshoots the window edge. Use atx_it similarly, for
8543 /* Use ppos_it under bidi reordering to save a copy of IT for the
8544 initial position. We restore that position in IT when we have
8545 scanned the entire display line without finding a match for
8546 TO_CHARPOS and all the character positions are greater than
8547 TO_CHARPOS. We then restart the scan from the initial position,
8548 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8549 the closest to TO_CHARPOS. */
8552 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8554 SAVE_IT (ppos_it
, *it
, ppos_data
);
8555 closest_pos
= IT_CHARPOS (*it
);
8561 #define BUFFER_POS_REACHED_P() \
8562 ((op & MOVE_TO_POS) != 0 \
8563 && BUFFERP (it->object) \
8564 && (IT_CHARPOS (*it) == to_charpos \
8566 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8567 && IT_CHARPOS (*it) > to_charpos) \
8568 || (it->what == IT_COMPOSITION \
8569 && ((IT_CHARPOS (*it) > to_charpos \
8570 && to_charpos >= it->cmp_it.charpos) \
8571 || (IT_CHARPOS (*it) < to_charpos \
8572 && to_charpos <= it->cmp_it.charpos)))) \
8573 && (it->method == GET_FROM_BUFFER \
8574 || (it->method == GET_FROM_DISPLAY_VECTOR \
8575 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8577 /* If there's a line-/wrap-prefix, handle it. */
8578 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8579 && it
->current_y
< it
->last_visible_y
)
8580 handle_line_prefix (it
);
8582 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8583 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8587 int x
, i
, ascent
= 0, descent
= 0;
8589 /* Utility macro to reset an iterator with x, ascent, and descent. */
8590 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8591 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8592 (IT)->max_descent = descent)
8594 /* Stop if we move beyond TO_CHARPOS (after an image or a
8595 display string or stretch glyph). */
8596 if ((op
& MOVE_TO_POS
) != 0
8597 && BUFFERP (it
->object
)
8598 && it
->method
== GET_FROM_BUFFER
8600 /* When the iterator is at base embedding level, we
8601 are guaranteed that characters are delivered for
8602 display in strictly increasing order of their
8603 buffer positions. */
8604 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8605 && IT_CHARPOS (*it
) > to_charpos
)
8607 && (prev_method
== GET_FROM_IMAGE
8608 || prev_method
== GET_FROM_STRETCH
8609 || prev_method
== GET_FROM_STRING
)
8610 /* Passed TO_CHARPOS from left to right. */
8611 && ((prev_pos
< to_charpos
8612 && IT_CHARPOS (*it
) > to_charpos
)
8613 /* Passed TO_CHARPOS from right to left. */
8614 || (prev_pos
> to_charpos
8615 && IT_CHARPOS (*it
) < to_charpos
)))))
8617 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8619 result
= MOVE_POS_MATCH_OR_ZV
;
8622 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8623 /* If wrap_it is valid, the current position might be in a
8624 word that is wrapped. So, save the iterator in
8625 atpos_it and continue to see if wrapping happens. */
8626 SAVE_IT (atpos_it
, *it
, atpos_data
);
8629 /* Stop when ZV reached.
8630 We used to stop here when TO_CHARPOS reached as well, but that is
8631 too soon if this glyph does not fit on this line. So we handle it
8632 explicitly below. */
8633 if (!get_next_display_element (it
))
8635 result
= MOVE_POS_MATCH_OR_ZV
;
8639 if (it
->line_wrap
== TRUNCATE
)
8641 if (BUFFER_POS_REACHED_P ())
8643 result
= MOVE_POS_MATCH_OR_ZV
;
8649 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8651 if (IT_DISPLAYING_WHITESPACE (it
))
8655 /* We have reached a glyph that follows one or more
8656 whitespace characters. If the position is
8657 already found, we are done. */
8658 if (atpos_it
.sp
>= 0)
8660 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8661 result
= MOVE_POS_MATCH_OR_ZV
;
8666 RESTORE_IT (it
, &atx_it
, atx_data
);
8667 result
= MOVE_X_REACHED
;
8670 /* Otherwise, we can wrap here. */
8671 SAVE_IT (wrap_it
, *it
, wrap_data
);
8677 /* Remember the line height for the current line, in case
8678 the next element doesn't fit on the line. */
8679 ascent
= it
->max_ascent
;
8680 descent
= it
->max_descent
;
8682 /* The call to produce_glyphs will get the metrics of the
8683 display element IT is loaded with. Record the x-position
8684 before this display element, in case it doesn't fit on the
8688 PRODUCE_GLYPHS (it
);
8690 if (it
->area
!= TEXT_AREA
)
8692 prev_method
= it
->method
;
8693 if (it
->method
== GET_FROM_BUFFER
)
8694 prev_pos
= IT_CHARPOS (*it
);
8695 set_iterator_to_next (it
, 1);
8696 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8697 SET_TEXT_POS (this_line_min_pos
,
8698 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8700 && (op
& MOVE_TO_POS
)
8701 && IT_CHARPOS (*it
) > to_charpos
8702 && IT_CHARPOS (*it
) < closest_pos
)
8703 closest_pos
= IT_CHARPOS (*it
);
8707 /* The number of glyphs we get back in IT->nglyphs will normally
8708 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8709 character on a terminal frame, or (iii) a line end. For the
8710 second case, IT->nglyphs - 1 padding glyphs will be present.
8711 (On X frames, there is only one glyph produced for a
8712 composite character.)
8714 The behavior implemented below means, for continuation lines,
8715 that as many spaces of a TAB as fit on the current line are
8716 displayed there. For terminal frames, as many glyphs of a
8717 multi-glyph character are displayed in the current line, too.
8718 This is what the old redisplay code did, and we keep it that
8719 way. Under X, the whole shape of a complex character must
8720 fit on the line or it will be completely displayed in the
8723 Note that both for tabs and padding glyphs, all glyphs have
8727 /* More than one glyph or glyph doesn't fit on line. All
8728 glyphs have the same width. */
8729 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8731 int x_before_this_char
= x
;
8732 int hpos_before_this_char
= it
->hpos
;
8734 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8736 new_x
= x
+ single_glyph_width
;
8738 /* We want to leave anything reaching TO_X to the caller. */
8739 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8741 if (BUFFER_POS_REACHED_P ())
8743 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8744 goto buffer_pos_reached
;
8745 if (atpos_it
.sp
< 0)
8747 SAVE_IT (atpos_it
, *it
, atpos_data
);
8748 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8753 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8756 result
= MOVE_X_REACHED
;
8761 SAVE_IT (atx_it
, *it
, atx_data
);
8762 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8767 if (/* Lines are continued. */
8768 it
->line_wrap
!= TRUNCATE
8769 && (/* And glyph doesn't fit on the line. */
8770 new_x
> it
->last_visible_x
8771 /* Or it fits exactly and we're on a window
8773 || (new_x
== it
->last_visible_x
8774 && FRAME_WINDOW_P (it
->f
)
8775 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8776 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8777 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8779 if (/* IT->hpos == 0 means the very first glyph
8780 doesn't fit on the line, e.g. a wide image. */
8782 || (new_x
== it
->last_visible_x
8783 && FRAME_WINDOW_P (it
->f
)
8784 /* When word-wrap is ON and we have a valid
8785 wrap point, we don't allow the last glyph
8786 to "just barely fit" on the line. */
8787 && (it
->line_wrap
!= WORD_WRAP
8788 || wrap_it
.sp
< 0)))
8791 it
->current_x
= new_x
;
8793 /* The character's last glyph just barely fits
8795 if (i
== it
->nglyphs
- 1)
8797 /* If this is the destination position,
8798 return a position *before* it in this row,
8799 now that we know it fits in this row. */
8800 if (BUFFER_POS_REACHED_P ())
8802 if (it
->line_wrap
!= WORD_WRAP
8805 it
->hpos
= hpos_before_this_char
;
8806 it
->current_x
= x_before_this_char
;
8807 result
= MOVE_POS_MATCH_OR_ZV
;
8810 if (it
->line_wrap
== WORD_WRAP
8813 SAVE_IT (atpos_it
, *it
, atpos_data
);
8814 atpos_it
.current_x
= x_before_this_char
;
8815 atpos_it
.hpos
= hpos_before_this_char
;
8819 prev_method
= it
->method
;
8820 if (it
->method
== GET_FROM_BUFFER
)
8821 prev_pos
= IT_CHARPOS (*it
);
8822 set_iterator_to_next (it
, 1);
8823 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8824 SET_TEXT_POS (this_line_min_pos
,
8825 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8826 /* On graphical terminals, newlines may
8827 "overflow" into the fringe if
8828 overflow-newline-into-fringe is non-nil.
8829 On text terminals, and on graphical
8830 terminals with no right margin, newlines
8831 may overflow into the last glyph on the
8833 if (!FRAME_WINDOW_P (it
->f
)
8835 && it
->bidi_it
.paragraph_dir
== R2L
)
8836 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8837 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8838 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8840 if (!get_next_display_element (it
))
8842 result
= MOVE_POS_MATCH_OR_ZV
;
8845 if (BUFFER_POS_REACHED_P ())
8847 if (ITERATOR_AT_END_OF_LINE_P (it
))
8848 result
= MOVE_POS_MATCH_OR_ZV
;
8850 result
= MOVE_LINE_CONTINUED
;
8853 if (ITERATOR_AT_END_OF_LINE_P (it
)
8854 && (it
->line_wrap
!= WORD_WRAP
8857 result
= MOVE_NEWLINE_OR_CR
;
8864 IT_RESET_X_ASCENT_DESCENT (it
);
8866 if (wrap_it
.sp
>= 0)
8868 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8873 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8875 result
= MOVE_LINE_CONTINUED
;
8879 if (BUFFER_POS_REACHED_P ())
8881 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8882 goto buffer_pos_reached
;
8883 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8885 SAVE_IT (atpos_it
, *it
, atpos_data
);
8886 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8890 if (new_x
> it
->first_visible_x
)
8892 /* Glyph is visible. Increment number of glyphs that
8893 would be displayed. */
8898 if (result
!= MOVE_UNDEFINED
)
8901 else if (BUFFER_POS_REACHED_P ())
8904 IT_RESET_X_ASCENT_DESCENT (it
);
8905 result
= MOVE_POS_MATCH_OR_ZV
;
8908 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8910 /* Stop when TO_X specified and reached. This check is
8911 necessary here because of lines consisting of a line end,
8912 only. The line end will not produce any glyphs and we
8913 would never get MOVE_X_REACHED. */
8914 eassert (it
->nglyphs
== 0);
8915 result
= MOVE_X_REACHED
;
8919 /* Is this a line end? If yes, we're done. */
8920 if (ITERATOR_AT_END_OF_LINE_P (it
))
8922 /* If we are past TO_CHARPOS, but never saw any character
8923 positions smaller than TO_CHARPOS, return
8924 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8926 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8928 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8930 if (closest_pos
< ZV
)
8932 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8933 /* Don't recurse if closest_pos is equal to
8934 to_charpos, since we have just tried that. */
8935 if (closest_pos
!= to_charpos
)
8936 move_it_in_display_line_to (it
, closest_pos
, -1,
8938 result
= MOVE_POS_MATCH_OR_ZV
;
8941 goto buffer_pos_reached
;
8943 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8944 && IT_CHARPOS (*it
) > to_charpos
)
8945 goto buffer_pos_reached
;
8947 result
= MOVE_NEWLINE_OR_CR
;
8950 result
= MOVE_NEWLINE_OR_CR
;
8954 prev_method
= it
->method
;
8955 if (it
->method
== GET_FROM_BUFFER
)
8956 prev_pos
= IT_CHARPOS (*it
);
8957 /* The current display element has been consumed. Advance
8959 set_iterator_to_next (it
, 1);
8960 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8961 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8962 if (IT_CHARPOS (*it
) < to_charpos
)
8963 saw_smaller_pos
= 1;
8965 && (op
& MOVE_TO_POS
)
8966 && IT_CHARPOS (*it
) >= to_charpos
8967 && IT_CHARPOS (*it
) < closest_pos
)
8968 closest_pos
= IT_CHARPOS (*it
);
8970 /* Stop if lines are truncated and IT's current x-position is
8971 past the right edge of the window now. */
8972 if (it
->line_wrap
== TRUNCATE
8973 && it
->current_x
>= it
->last_visible_x
)
8975 if (!FRAME_WINDOW_P (it
->f
)
8976 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8977 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8978 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8979 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8983 if ((at_eob_p
= !get_next_display_element (it
))
8984 || BUFFER_POS_REACHED_P ()
8985 /* If we are past TO_CHARPOS, but never saw any
8986 character positions smaller than TO_CHARPOS,
8987 return MOVE_POS_MATCH_OR_ZV, like the
8988 unidirectional display did. */
8989 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8991 && IT_CHARPOS (*it
) > to_charpos
))
8994 && !BUFFER_POS_REACHED_P ()
8995 && !at_eob_p
&& closest_pos
< ZV
)
8997 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8998 if (closest_pos
!= to_charpos
)
8999 move_it_in_display_line_to (it
, closest_pos
, -1,
9002 result
= MOVE_POS_MATCH_OR_ZV
;
9005 if (ITERATOR_AT_END_OF_LINE_P (it
))
9007 result
= MOVE_NEWLINE_OR_CR
;
9011 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9013 && IT_CHARPOS (*it
) > to_charpos
)
9015 if (closest_pos
< ZV
)
9017 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9018 if (closest_pos
!= to_charpos
)
9019 move_it_in_display_line_to (it
, closest_pos
, -1,
9022 result
= MOVE_POS_MATCH_OR_ZV
;
9025 result
= MOVE_LINE_TRUNCATED
;
9028 #undef IT_RESET_X_ASCENT_DESCENT
9031 #undef BUFFER_POS_REACHED_P
9033 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9034 restore the saved iterator. */
9035 if (atpos_it
.sp
>= 0)
9036 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9037 else if (atx_it
.sp
>= 0)
9038 RESTORE_IT (it
, &atx_it
, atx_data
);
9043 bidi_unshelve_cache (atpos_data
, 1);
9045 bidi_unshelve_cache (atx_data
, 1);
9047 bidi_unshelve_cache (wrap_data
, 1);
9049 bidi_unshelve_cache (ppos_data
, 1);
9051 /* Restore the iterator settings altered at the beginning of this
9053 it
->glyph_row
= saved_glyph_row
;
9057 /* For external use. */
9059 move_it_in_display_line (struct it
*it
,
9060 ptrdiff_t to_charpos
, int to_x
,
9061 enum move_operation_enum op
)
9063 if (it
->line_wrap
== WORD_WRAP
9064 && (op
& MOVE_TO_X
))
9067 void *save_data
= NULL
;
9070 SAVE_IT (save_it
, *it
, save_data
);
9071 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9072 /* When word-wrap is on, TO_X may lie past the end
9073 of a wrapped line. Then it->current is the
9074 character on the next line, so backtrack to the
9075 space before the wrap point. */
9076 if (skip
== MOVE_LINE_CONTINUED
)
9078 int prev_x
= max (it
->current_x
- 1, 0);
9079 RESTORE_IT (it
, &save_it
, save_data
);
9080 move_it_in_display_line_to
9081 (it
, -1, prev_x
, MOVE_TO_X
);
9084 bidi_unshelve_cache (save_data
, 1);
9087 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9091 /* Move IT forward until it satisfies one or more of the criteria in
9092 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9094 OP is a bit-mask that specifies where to stop, and in particular,
9095 which of those four position arguments makes a difference. See the
9096 description of enum move_operation_enum.
9098 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9099 screen line, this function will set IT to the next position that is
9100 displayed to the right of TO_CHARPOS on the screen.
9102 Return the maximum pixel length of any line scanned but never more
9103 than it.last_visible_x. */
9106 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9108 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9109 int line_height
, line_start_x
= 0, reached
= 0;
9110 int max_current_x
= 0;
9111 void *backup_data
= NULL
;
9115 if (op
& MOVE_TO_VPOS
)
9117 /* If no TO_CHARPOS and no TO_X specified, stop at the
9118 start of the line TO_VPOS. */
9119 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9121 if (it
->vpos
== to_vpos
)
9127 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9131 /* TO_VPOS >= 0 means stop at TO_X in the line at
9132 TO_VPOS, or at TO_POS, whichever comes first. */
9133 if (it
->vpos
== to_vpos
)
9139 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9141 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9146 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9148 /* We have reached TO_X but not in the line we want. */
9149 skip
= move_it_in_display_line_to (it
, to_charpos
,
9151 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9159 else if (op
& MOVE_TO_Y
)
9161 struct it it_backup
;
9163 if (it
->line_wrap
== WORD_WRAP
)
9164 SAVE_IT (it_backup
, *it
, backup_data
);
9166 /* TO_Y specified means stop at TO_X in the line containing
9167 TO_Y---or at TO_CHARPOS if this is reached first. The
9168 problem is that we can't really tell whether the line
9169 contains TO_Y before we have completely scanned it, and
9170 this may skip past TO_X. What we do is to first scan to
9173 If TO_X is not specified, use a TO_X of zero. The reason
9174 is to make the outcome of this function more predictable.
9175 If we didn't use TO_X == 0, we would stop at the end of
9176 the line which is probably not what a caller would expect
9178 skip
= move_it_in_display_line_to
9179 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9180 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9182 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9183 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9185 else if (skip
== MOVE_X_REACHED
)
9187 /* If TO_X was reached, we want to know whether TO_Y is
9188 in the line. We know this is the case if the already
9189 scanned glyphs make the line tall enough. Otherwise,
9190 we must check by scanning the rest of the line. */
9191 line_height
= it
->max_ascent
+ it
->max_descent
;
9192 if (to_y
>= it
->current_y
9193 && to_y
< it
->current_y
+ line_height
)
9198 SAVE_IT (it_backup
, *it
, backup_data
);
9199 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9200 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9202 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9203 line_height
= it
->max_ascent
+ it
->max_descent
;
9204 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9206 if (to_y
>= it
->current_y
9207 && to_y
< it
->current_y
+ line_height
)
9209 /* If TO_Y is in this line and TO_X was reached
9210 above, we scanned too far. We have to restore
9211 IT's settings to the ones before skipping. But
9212 keep the more accurate values of max_ascent and
9213 max_descent we've found while skipping the rest
9214 of the line, for the sake of callers, such as
9215 pos_visible_p, that need to know the line
9217 int max_ascent
= it
->max_ascent
;
9218 int max_descent
= it
->max_descent
;
9220 RESTORE_IT (it
, &it_backup
, backup_data
);
9221 it
->max_ascent
= max_ascent
;
9222 it
->max_descent
= max_descent
;
9228 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9234 /* Check whether TO_Y is in this line. */
9235 line_height
= it
->max_ascent
+ it
->max_descent
;
9236 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9238 if (to_y
>= it
->current_y
9239 && to_y
< it
->current_y
+ line_height
)
9241 if (to_y
> it
->current_y
)
9242 max_current_x
= max (it
->current_x
, max_current_x
);
9244 /* When word-wrap is on, TO_X may lie past the end
9245 of a wrapped line. Then it->current is the
9246 character on the next line, so backtrack to the
9247 space before the wrap point. */
9248 if (skip
== MOVE_LINE_CONTINUED
9249 && it
->line_wrap
== WORD_WRAP
)
9251 int prev_x
= max (it
->current_x
- 1, 0);
9252 RESTORE_IT (it
, &it_backup
, backup_data
);
9253 skip
= move_it_in_display_line_to
9254 (it
, -1, prev_x
, MOVE_TO_X
);
9263 max_current_x
= max (it
->current_x
, max_current_x
);
9267 else if (BUFFERP (it
->object
)
9268 && (it
->method
== GET_FROM_BUFFER
9269 || it
->method
== GET_FROM_STRETCH
)
9270 && IT_CHARPOS (*it
) >= to_charpos
9271 /* Under bidi iteration, a call to set_iterator_to_next
9272 can scan far beyond to_charpos if the initial
9273 portion of the next line needs to be reordered. In
9274 that case, give move_it_in_display_line_to another
9277 && it
->bidi_it
.scan_dir
== -1))
9278 skip
= MOVE_POS_MATCH_OR_ZV
;
9280 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9284 case MOVE_POS_MATCH_OR_ZV
:
9285 max_current_x
= max (it
->current_x
, max_current_x
);
9289 case MOVE_NEWLINE_OR_CR
:
9290 max_current_x
= max (it
->current_x
, max_current_x
);
9291 set_iterator_to_next (it
, 1);
9292 it
->continuation_lines_width
= 0;
9295 case MOVE_LINE_TRUNCATED
:
9296 max_current_x
= it
->last_visible_x
;
9297 it
->continuation_lines_width
= 0;
9298 reseat_at_next_visible_line_start (it
, 0);
9299 if ((op
& MOVE_TO_POS
) != 0
9300 && IT_CHARPOS (*it
) > to_charpos
)
9307 case MOVE_LINE_CONTINUED
:
9308 max_current_x
= it
->last_visible_x
;
9309 /* For continued lines ending in a tab, some of the glyphs
9310 associated with the tab are displayed on the current
9311 line. Since it->current_x does not include these glyphs,
9312 we use it->last_visible_x instead. */
9315 it
->continuation_lines_width
+= it
->last_visible_x
;
9316 /* When moving by vpos, ensure that the iterator really
9317 advances to the next line (bug#847, bug#969). Fixme:
9318 do we need to do this in other circumstances? */
9319 if (it
->current_x
!= it
->last_visible_x
9320 && (op
& MOVE_TO_VPOS
)
9321 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9323 line_start_x
= it
->current_x
+ it
->pixel_width
9324 - it
->last_visible_x
;
9325 if (FRAME_WINDOW_P (it
->f
))
9327 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9328 struct font
*face_font
= face
->font
;
9330 /* When display_line produces a continued line
9331 that ends in a TAB, it skips a tab stop that
9332 is closer than the font's space character
9333 width (see x_produce_glyphs where it produces
9334 the stretch glyph which represents a TAB).
9335 We need to reproduce the same logic here. */
9336 eassert (face_font
);
9339 if (line_start_x
< face_font
->space_width
)
9341 += it
->tab_width
* face_font
->space_width
;
9344 set_iterator_to_next (it
, 0);
9348 it
->continuation_lines_width
+= it
->current_x
;
9355 /* Reset/increment for the next run. */
9356 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9357 it
->current_x
= line_start_x
;
9360 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9362 last_height
= it
->max_ascent
+ it
->max_descent
;
9363 it
->max_ascent
= it
->max_descent
= 0;
9368 /* On text terminals, we may stop at the end of a line in the middle
9369 of a multi-character glyph. If the glyph itself is continued,
9370 i.e. it is actually displayed on the next line, don't treat this
9371 stopping point as valid; move to the next line instead (unless
9372 that brings us offscreen). */
9373 if (!FRAME_WINDOW_P (it
->f
)
9375 && IT_CHARPOS (*it
) == to_charpos
9376 && it
->what
== IT_CHARACTER
9378 && it
->line_wrap
== WINDOW_WRAP
9379 && it
->current_x
== it
->last_visible_x
- 1
9382 && it
->vpos
< it
->w
->window_end_vpos
)
9384 it
->continuation_lines_width
+= it
->current_x
;
9385 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9386 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9388 last_height
= it
->max_ascent
+ it
->max_descent
;
9392 bidi_unshelve_cache (backup_data
, 1);
9394 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9396 return max_current_x
;
9400 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9402 If DY > 0, move IT backward at least that many pixels. DY = 0
9403 means move IT backward to the preceding line start or BEGV. This
9404 function may move over more than DY pixels if IT->current_y - DY
9405 ends up in the middle of a line; in this case IT->current_y will be
9406 set to the top of the line moved to. */
9409 move_it_vertically_backward (struct it
*it
, int dy
)
9413 void *it2data
= NULL
, *it3data
= NULL
;
9414 ptrdiff_t start_pos
;
9416 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9417 ptrdiff_t pos_limit
;
9422 start_pos
= IT_CHARPOS (*it
);
9424 /* Estimate how many newlines we must move back. */
9425 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9426 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9429 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9431 /* Set the iterator's position that many lines back. But don't go
9432 back more than NLINES full screen lines -- this wins a day with
9433 buffers which have very long lines. */
9434 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9435 back_to_previous_visible_line_start (it
);
9437 /* Reseat the iterator here. When moving backward, we don't want
9438 reseat to skip forward over invisible text, set up the iterator
9439 to deliver from overlay strings at the new position etc. So,
9440 use reseat_1 here. */
9441 reseat_1 (it
, it
->current
.pos
, 1);
9443 /* We are now surely at a line start. */
9444 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9445 reordering is in effect. */
9446 it
->continuation_lines_width
= 0;
9448 /* Move forward and see what y-distance we moved. First move to the
9449 start of the next line so that we get its height. We need this
9450 height to be able to tell whether we reached the specified
9452 SAVE_IT (it2
, *it
, it2data
);
9453 it2
.max_ascent
= it2
.max_descent
= 0;
9456 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9457 MOVE_TO_POS
| MOVE_TO_VPOS
);
9459 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9460 /* If we are in a display string which starts at START_POS,
9461 and that display string includes a newline, and we are
9462 right after that newline (i.e. at the beginning of a
9463 display line), exit the loop, because otherwise we will
9464 infloop, since move_it_to will see that it is already at
9465 START_POS and will not move. */
9466 || (it2
.method
== GET_FROM_STRING
9467 && IT_CHARPOS (it2
) == start_pos
9468 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9469 eassert (IT_CHARPOS (*it
) >= BEGV
);
9470 SAVE_IT (it3
, it2
, it3data
);
9472 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9473 eassert (IT_CHARPOS (*it
) >= BEGV
);
9474 /* H is the actual vertical distance from the position in *IT
9475 and the starting position. */
9476 h
= it2
.current_y
- it
->current_y
;
9477 /* NLINES is the distance in number of lines. */
9478 nlines
= it2
.vpos
- it
->vpos
;
9480 /* Correct IT's y and vpos position
9481 so that they are relative to the starting point. */
9487 /* DY == 0 means move to the start of the screen line. The
9488 value of nlines is > 0 if continuation lines were involved,
9489 or if the original IT position was at start of a line. */
9490 RESTORE_IT (it
, it
, it2data
);
9492 move_it_by_lines (it
, nlines
);
9493 /* The above code moves us to some position NLINES down,
9494 usually to its first glyph (leftmost in an L2R line), but
9495 that's not necessarily the start of the line, under bidi
9496 reordering. We want to get to the character position
9497 that is immediately after the newline of the previous
9500 && !it
->continuation_lines_width
9501 && !STRINGP (it
->string
)
9502 && IT_CHARPOS (*it
) > BEGV
9503 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9505 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9508 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9509 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9511 bidi_unshelve_cache (it3data
, 1);
9515 /* The y-position we try to reach, relative to *IT.
9516 Note that H has been subtracted in front of the if-statement. */
9517 int target_y
= it
->current_y
+ h
- dy
;
9518 int y0
= it3
.current_y
;
9522 RESTORE_IT (&it3
, &it3
, it3data
);
9523 y1
= line_bottom_y (&it3
);
9524 line_height
= y1
- y0
;
9525 RESTORE_IT (it
, it
, it2data
);
9526 /* If we did not reach target_y, try to move further backward if
9527 we can. If we moved too far backward, try to move forward. */
9528 if (target_y
< it
->current_y
9529 /* This is heuristic. In a window that's 3 lines high, with
9530 a line height of 13 pixels each, recentering with point
9531 on the bottom line will try to move -39/2 = 19 pixels
9532 backward. Try to avoid moving into the first line. */
9533 && (it
->current_y
- target_y
9534 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9535 && IT_CHARPOS (*it
) > BEGV
)
9537 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9538 target_y
- it
->current_y
));
9539 dy
= it
->current_y
- target_y
;
9540 goto move_further_back
;
9542 else if (target_y
>= it
->current_y
+ line_height
9543 && IT_CHARPOS (*it
) < ZV
)
9545 /* Should move forward by at least one line, maybe more.
9547 Note: Calling move_it_by_lines can be expensive on
9548 terminal frames, where compute_motion is used (via
9549 vmotion) to do the job, when there are very long lines
9550 and truncate-lines is nil. That's the reason for
9551 treating terminal frames specially here. */
9553 if (!FRAME_WINDOW_P (it
->f
))
9554 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9559 move_it_by_lines (it
, 1);
9561 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9568 /* Move IT by a specified amount of pixel lines DY. DY negative means
9569 move backwards. DY = 0 means move to start of screen line. At the
9570 end, IT will be on the start of a screen line. */
9573 move_it_vertically (struct it
*it
, int dy
)
9576 move_it_vertically_backward (it
, -dy
);
9579 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9580 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9581 MOVE_TO_POS
| MOVE_TO_Y
);
9582 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9584 /* If buffer ends in ZV without a newline, move to the start of
9585 the line to satisfy the post-condition. */
9586 if (IT_CHARPOS (*it
) == ZV
9588 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9589 move_it_by_lines (it
, 0);
9594 /* Move iterator IT past the end of the text line it is in. */
9597 move_it_past_eol (struct it
*it
)
9599 enum move_it_result rc
;
9601 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9602 if (rc
== MOVE_NEWLINE_OR_CR
)
9603 set_iterator_to_next (it
, 0);
9607 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9608 negative means move up. DVPOS == 0 means move to the start of the
9611 Optimization idea: If we would know that IT->f doesn't use
9612 a face with proportional font, we could be faster for
9613 truncate-lines nil. */
9616 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9619 /* The commented-out optimization uses vmotion on terminals. This
9620 gives bad results, because elements like it->what, on which
9621 callers such as pos_visible_p rely, aren't updated. */
9622 /* struct position pos;
9623 if (!FRAME_WINDOW_P (it->f))
9625 struct text_pos textpos;
9627 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9628 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9629 reseat (it, textpos, 1);
9630 it->vpos += pos.vpos;
9631 it->current_y += pos.vpos;
9637 /* DVPOS == 0 means move to the start of the screen line. */
9638 move_it_vertically_backward (it
, 0);
9639 /* Let next call to line_bottom_y calculate real line height. */
9644 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9645 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9647 /* Only move to the next buffer position if we ended up in a
9648 string from display property, not in an overlay string
9649 (before-string or after-string). That is because the
9650 latter don't conceal the underlying buffer position, so
9651 we can ask to move the iterator to the exact position we
9652 are interested in. Note that, even if we are already at
9653 IT_CHARPOS (*it), the call below is not a no-op, as it
9654 will detect that we are at the end of the string, pop the
9655 iterator, and compute it->current_x and it->hpos
9657 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9658 -1, -1, -1, MOVE_TO_POS
);
9664 void *it2data
= NULL
;
9665 ptrdiff_t start_charpos
, i
;
9667 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9668 bool hit_pos_limit
= false;
9669 ptrdiff_t pos_limit
;
9671 /* Start at the beginning of the screen line containing IT's
9672 position. This may actually move vertically backwards,
9673 in case of overlays, so adjust dvpos accordingly. */
9675 move_it_vertically_backward (it
, 0);
9678 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9679 screen lines, and reseat the iterator there. */
9680 start_charpos
= IT_CHARPOS (*it
);
9681 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9684 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9686 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9687 back_to_previous_visible_line_start (it
);
9688 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9689 hit_pos_limit
= true;
9690 reseat (it
, it
->current
.pos
, 1);
9692 /* Move further back if we end up in a string or an image. */
9693 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9695 /* First try to move to start of display line. */
9697 move_it_vertically_backward (it
, 0);
9699 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9701 /* If start of line is still in string or image,
9702 move further back. */
9703 back_to_previous_visible_line_start (it
);
9704 reseat (it
, it
->current
.pos
, 1);
9708 it
->current_x
= it
->hpos
= 0;
9710 /* Above call may have moved too far if continuation lines
9711 are involved. Scan forward and see if it did. */
9712 SAVE_IT (it2
, *it
, it2data
);
9713 it2
.vpos
= it2
.current_y
= 0;
9714 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9715 it
->vpos
-= it2
.vpos
;
9716 it
->current_y
-= it2
.current_y
;
9717 it
->current_x
= it
->hpos
= 0;
9719 /* If we moved too far back, move IT some lines forward. */
9720 if (it2
.vpos
> -dvpos
)
9722 int delta
= it2
.vpos
+ dvpos
;
9724 RESTORE_IT (&it2
, &it2
, it2data
);
9725 SAVE_IT (it2
, *it
, it2data
);
9726 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9727 /* Move back again if we got too far ahead. */
9728 if (IT_CHARPOS (*it
) >= start_charpos
)
9729 RESTORE_IT (it
, &it2
, it2data
);
9731 bidi_unshelve_cache (it2data
, 1);
9733 else if (hit_pos_limit
&& pos_limit
> BEGV
9734 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9736 /* If we hit the limit, but still didn't make it far enough
9737 back, that means there's a display string with a newline
9738 covering a large chunk of text, and that caused
9739 back_to_previous_visible_line_start try to go too far.
9740 Punish those who commit such atrocities by going back
9741 until we've reached DVPOS, after lifting the limit, which
9742 could make it slow for very long lines. "If it hurts,
9745 RESTORE_IT (it
, it
, it2data
);
9746 for (i
= -dvpos
; i
> 0; --i
)
9748 back_to_previous_visible_line_start (it
);
9753 RESTORE_IT (it
, it
, it2data
);
9757 /* Return true if IT points into the middle of a display vector. */
9760 in_display_vector_p (struct it
*it
)
9762 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9763 && it
->current
.dpvec_index
> 0
9764 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9767 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9768 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9769 WINDOW must be a live window and defaults to the selected one. The
9770 return value is a cons of the maximum pixel-width of any text line and
9771 the maximum pixel-height of all text lines.
9773 The optional argument FROM, if non-nil, specifies the first text
9774 position and defaults to the minimum accessible position of the buffer.
9775 If FROM is t, use the minimum accessible position that is not a newline
9776 character. TO, if non-nil, specifies the last text position and
9777 defaults to the maximum accessible position of the buffer. If TO is t,
9778 use the maximum accessible position that is not a newline character.
9780 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9781 width that can be returned. X-LIMIT nil or omitted, means to use the
9782 pixel-width of WINDOW's body; use this if you do not intend to change
9783 the width of WINDOW. Use the maximum width WINDOW may assume if you
9784 intend to change WINDOW's width. In any case, text whose x-coordinate
9785 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9786 can take some time, it's always a good idea to make this argument as
9787 small as possible; in particular, if the buffer contains long lines that
9788 shall be truncated anyway.
9790 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9791 height that can be returned. Text lines whose y-coordinate is beyond
9792 Y-LIMIT are ignored. Since calculating the text height of a large
9793 buffer can take some time, it makes sense to specify this argument if
9794 the size of the buffer is unknown.
9796 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9797 include the height of the mode- or header-line of WINDOW in the return
9798 value. If it is either the symbol `mode-line' or `header-line', include
9799 only the height of that line, if present, in the return value. If t,
9800 include the height of both, if present, in the return value. */)
9801 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9802 Lisp_Object mode_and_header_line
)
9804 struct window
*w
= decode_live_window (window
);
9808 struct buffer
*old_buffer
= NULL
;
9809 ptrdiff_t start
, end
, pos
;
9810 struct text_pos startp
;
9811 void *itdata
= NULL
;
9812 int c
, max_y
= -1, x
= 0, y
= 0;
9818 if (b
!= current_buffer
)
9820 old_buffer
= current_buffer
;
9821 set_buffer_internal (b
);
9826 else if (EQ (from
, Qt
))
9829 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9830 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9832 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9837 CHECK_NUMBER_COERCE_MARKER (from
);
9838 start
= min (max (XINT (from
), BEGV
), ZV
);
9843 else if (EQ (to
, Qt
))
9846 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9847 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9849 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9854 CHECK_NUMBER_COERCE_MARKER (to
);
9855 end
= max (start
, min (XINT (to
), ZV
));
9858 if (!NILP (y_limit
))
9860 CHECK_NUMBER (y_limit
);
9861 max_y
= min (XINT (y_limit
), INT_MAX
);
9864 itdata
= bidi_shelve_cache ();
9865 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9866 start_display (&it
, w
, startp
);
9869 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9872 CHECK_NUMBER (x_limit
);
9873 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9874 /* Actually, we never want move_it_to stop at to_x. But to make
9875 sure that move_it_in_display_line_to always moves far enough,
9876 we set it to INT_MAX and specify MOVE_TO_X. */
9877 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9878 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9881 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9883 if (!EQ (mode_and_header_line
, Qheader_line
)
9884 && !EQ (mode_and_header_line
, Qt
))
9885 /* Do not count the header-line which was counted automatically by
9887 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9889 if (EQ (mode_and_header_line
, Qmode_line
)
9890 || EQ (mode_and_header_line
, Qt
))
9891 /* Do count the mode-line which is not included automatically by
9893 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9895 bidi_unshelve_cache (itdata
, 0);
9898 set_buffer_internal (old_buffer
);
9900 return Fcons (make_number (x
), make_number (y
));
9903 /***********************************************************************
9905 ***********************************************************************/
9908 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9912 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9914 Lisp_Object args
[3];
9915 Lisp_Object msg
, fmt
;
9918 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9922 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9924 args
[0] = fmt
= build_string (format
);
9927 msg
= Fformat (3, args
);
9929 len
= SBYTES (msg
) + 1;
9930 buffer
= SAFE_ALLOCA (len
);
9931 memcpy (buffer
, SDATA (msg
), len
);
9933 message_dolog (buffer
, len
- 1, 1, 0);
9940 /* Output a newline in the *Messages* buffer if "needs" one. */
9943 message_log_maybe_newline (void)
9945 if (message_log_need_newline
)
9946 message_dolog ("", 0, 1, 0);
9950 /* Add a string M of length NBYTES to the message log, optionally
9951 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9952 true, means interpret the contents of M as multibyte. This
9953 function calls low-level routines in order to bypass text property
9954 hooks, etc. which might not be safe to run.
9956 This may GC (insert may run before/after change hooks),
9957 so the buffer M must NOT point to a Lisp string. */
9960 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9962 const unsigned char *msg
= (const unsigned char *) m
;
9964 if (!NILP (Vmemory_full
))
9967 if (!NILP (Vmessage_log_max
))
9969 struct buffer
*oldbuf
;
9970 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9971 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9972 ptrdiff_t point_at_end
= 0;
9973 ptrdiff_t zv_at_end
= 0;
9974 Lisp_Object old_deactivate_mark
;
9975 struct gcpro gcpro1
;
9977 old_deactivate_mark
= Vdeactivate_mark
;
9978 oldbuf
= current_buffer
;
9980 /* Ensure the Messages buffer exists, and switch to it.
9981 If we created it, set the major-mode. */
9984 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9986 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9989 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9990 call0 (intern ("messages-buffer-mode"));
9993 bset_undo_list (current_buffer
, Qt
);
9994 bset_cache_long_scans (current_buffer
, Qnil
);
9996 oldpoint
= message_dolog_marker1
;
9997 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9998 oldbegv
= message_dolog_marker2
;
9999 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10000 oldzv
= message_dolog_marker3
;
10001 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10002 GCPRO1 (old_deactivate_mark
);
10010 BEGV_BYTE
= BEG_BYTE
;
10013 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10015 /* Insert the string--maybe converting multibyte to single byte
10016 or vice versa, so that all the text fits the buffer. */
10018 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10024 /* Convert a multibyte string to single-byte
10025 for the *Message* buffer. */
10026 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10028 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10029 work
[0] = (ASCII_CHAR_P (c
)
10031 : multibyte_char_to_unibyte (c
));
10032 insert_1_both (work
, 1, 1, 1, 0, 0);
10035 else if (! multibyte
10036 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10040 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10041 /* Convert a single-byte string to multibyte
10042 for the *Message* buffer. */
10043 for (i
= 0; i
< nbytes
; i
++)
10046 MAKE_CHAR_MULTIBYTE (c
);
10047 char_bytes
= CHAR_STRING (c
, str
);
10048 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10052 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10056 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10059 insert_1_both ("\n", 1, 1, 1, 0, 0);
10061 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10063 this_bol_byte
= PT_BYTE
;
10065 /* See if this line duplicates the previous one.
10066 If so, combine duplicates. */
10067 if (this_bol
> BEG
)
10069 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10071 prev_bol_byte
= PT_BYTE
;
10073 dups
= message_log_check_duplicate (prev_bol_byte
,
10077 del_range_both (prev_bol
, prev_bol_byte
,
10078 this_bol
, this_bol_byte
, 0);
10081 char dupstr
[sizeof " [ times]"
10082 + INT_STRLEN_BOUND (printmax_t
)];
10084 /* If you change this format, don't forget to also
10085 change message_log_check_duplicate. */
10086 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10087 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10088 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10093 /* If we have more than the desired maximum number of lines
10094 in the *Messages* buffer now, delete the oldest ones.
10095 This is safe because we don't have undo in this buffer. */
10097 if (NATNUMP (Vmessage_log_max
))
10099 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10100 -XFASTINT (Vmessage_log_max
) - 1, 0);
10101 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10104 BEGV
= marker_position (oldbegv
);
10105 BEGV_BYTE
= marker_byte_position (oldbegv
);
10114 ZV
= marker_position (oldzv
);
10115 ZV_BYTE
= marker_byte_position (oldzv
);
10119 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10121 /* We can't do Fgoto_char (oldpoint) because it will run some
10123 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10124 marker_byte_position (oldpoint
));
10127 unchain_marker (XMARKER (oldpoint
));
10128 unchain_marker (XMARKER (oldbegv
));
10129 unchain_marker (XMARKER (oldzv
));
10131 /* We called insert_1_both above with its 5th argument (PREPARE)
10132 zero, which prevents insert_1_both from calling
10133 prepare_to_modify_buffer, which in turns prevents us from
10134 incrementing windows_or_buffers_changed even if *Messages* is
10135 shown in some window. So we must manually set
10136 windows_or_buffers_changed here to make up for that. */
10137 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10138 bset_redisplay (current_buffer
);
10140 set_buffer_internal (oldbuf
);
10142 message_log_need_newline
= !nlflag
;
10143 Vdeactivate_mark
= old_deactivate_mark
;
10148 /* We are at the end of the buffer after just having inserted a newline.
10149 (Note: We depend on the fact we won't be crossing the gap.)
10150 Check to see if the most recent message looks a lot like the previous one.
10151 Return 0 if different, 1 if the new one should just replace it, or a
10152 value N > 1 if we should also append " [N times]". */
10155 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10158 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10160 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10161 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10163 for (i
= 0; i
< len
; i
++)
10165 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10167 if (p1
[i
] != p2
[i
])
10173 if (*p1
++ == ' ' && *p1
++ == '[')
10176 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10177 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10184 /* Display an echo area message M with a specified length of NBYTES
10185 bytes. The string may include null characters. If M is not a
10186 string, clear out any existing message, and let the mini-buffer
10189 This function cancels echoing. */
10192 message3 (Lisp_Object m
)
10194 struct gcpro gcpro1
;
10197 clear_message (true, true);
10200 /* First flush out any partial line written with print. */
10201 message_log_maybe_newline ();
10204 ptrdiff_t nbytes
= SBYTES (m
);
10205 bool multibyte
= STRING_MULTIBYTE (m
);
10207 char *buffer
= SAFE_ALLOCA (nbytes
);
10208 memcpy (buffer
, SDATA (m
), nbytes
);
10209 message_dolog (buffer
, nbytes
, 1, multibyte
);
10212 message3_nolog (m
);
10218 /* The non-logging version of message3.
10219 This does not cancel echoing, because it is used for echoing.
10220 Perhaps we need to make a separate function for echoing
10221 and make this cancel echoing. */
10224 message3_nolog (Lisp_Object m
)
10226 struct frame
*sf
= SELECTED_FRAME ();
10228 if (FRAME_INITIAL_P (sf
))
10230 if (noninteractive_need_newline
)
10231 putc ('\n', stderr
);
10232 noninteractive_need_newline
= 0;
10235 Lisp_Object s
= ENCODE_SYSTEM (m
);
10237 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10239 if (cursor_in_echo_area
== 0)
10240 fprintf (stderr
, "\n");
10243 /* Error messages get reported properly by cmd_error, so this must be just an
10244 informative message; if the frame hasn't really been initialized yet, just
10246 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10248 /* Get the frame containing the mini-buffer
10249 that the selected frame is using. */
10250 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10251 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10252 struct frame
*f
= XFRAME (frame
);
10254 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10255 Fmake_frame_visible (frame
);
10257 if (STRINGP (m
) && SCHARS (m
) > 0)
10260 if (minibuffer_auto_raise
)
10261 Fraise_frame (frame
);
10262 /* Assume we are not echoing.
10263 (If we are, echo_now will override this.) */
10264 echo_message_buffer
= Qnil
;
10267 clear_message (true, true);
10269 do_pending_window_change (0);
10270 echo_area_display (1);
10271 do_pending_window_change (0);
10272 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10273 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10278 /* Display a null-terminated echo area message M. If M is 0, clear
10279 out any existing message, and let the mini-buffer text show through.
10281 The buffer M must continue to exist until after the echo area gets
10282 cleared or some other message gets displayed there. Do not pass
10283 text that is stored in a Lisp string. Do not pass text in a buffer
10284 that was alloca'd. */
10287 message1 (const char *m
)
10289 message3 (m
? build_unibyte_string (m
) : Qnil
);
10293 /* The non-logging counterpart of message1. */
10296 message1_nolog (const char *m
)
10298 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10301 /* Display a message M which contains a single %s
10302 which gets replaced with STRING. */
10305 message_with_string (const char *m
, Lisp_Object string
, int log
)
10307 CHECK_STRING (string
);
10309 if (noninteractive
)
10313 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10314 String whose data pointer might be passed to us in M. So
10315 we use a local copy. */
10316 char *fmt
= xstrdup (m
);
10318 if (noninteractive_need_newline
)
10319 putc ('\n', stderr
);
10320 noninteractive_need_newline
= 0;
10321 fprintf (stderr
, fmt
, SDATA (ENCODE_SYSTEM (string
)));
10322 if (!cursor_in_echo_area
)
10323 fprintf (stderr
, "\n");
10328 else if (INTERACTIVE
)
10330 /* The frame whose minibuffer we're going to display the message on.
10331 It may be larger than the selected frame, so we need
10332 to use its buffer, not the selected frame's buffer. */
10333 Lisp_Object mini_window
;
10334 struct frame
*f
, *sf
= SELECTED_FRAME ();
10336 /* Get the frame containing the minibuffer
10337 that the selected frame is using. */
10338 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10339 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10341 /* Error messages get reported properly by cmd_error, so this must be
10342 just an informative message; if the frame hasn't really been
10343 initialized yet, just toss it. */
10344 if (f
->glyphs_initialized_p
)
10346 Lisp_Object args
[2], msg
;
10347 struct gcpro gcpro1
, gcpro2
;
10349 args
[0] = build_string (m
);
10350 args
[1] = msg
= string
;
10351 GCPRO2 (args
[0], msg
);
10354 msg
= Fformat (2, args
);
10359 message3_nolog (msg
);
10363 /* Print should start at the beginning of the message
10364 buffer next time. */
10365 message_buf_print
= 0;
10371 /* Dump an informative message to the minibuf. If M is 0, clear out
10372 any existing message, and let the mini-buffer text show through. */
10375 vmessage (const char *m
, va_list ap
)
10377 if (noninteractive
)
10381 if (noninteractive_need_newline
)
10382 putc ('\n', stderr
);
10383 noninteractive_need_newline
= 0;
10384 vfprintf (stderr
, m
, ap
);
10385 if (cursor_in_echo_area
== 0)
10386 fprintf (stderr
, "\n");
10390 else if (INTERACTIVE
)
10392 /* The frame whose mini-buffer we're going to display the message
10393 on. It may be larger than the selected frame, so we need to
10394 use its buffer, not the selected frame's buffer. */
10395 Lisp_Object mini_window
;
10396 struct frame
*f
, *sf
= SELECTED_FRAME ();
10398 /* Get the frame containing the mini-buffer
10399 that the selected frame is using. */
10400 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10401 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10403 /* Error messages get reported properly by cmd_error, so this must be
10404 just an informative message; if the frame hasn't really been
10405 initialized yet, just toss it. */
10406 if (f
->glyphs_initialized_p
)
10411 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10412 char *message_buf
= alloca (maxsize
+ 1);
10414 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10416 message3 (make_string (message_buf
, len
));
10421 /* Print should start at the beginning of the message
10422 buffer next time. */
10423 message_buf_print
= 0;
10429 message (const char *m
, ...)
10439 /* The non-logging version of message. */
10442 message_nolog (const char *m
, ...)
10444 Lisp_Object old_log_max
;
10447 old_log_max
= Vmessage_log_max
;
10448 Vmessage_log_max
= Qnil
;
10450 Vmessage_log_max
= old_log_max
;
10456 /* Display the current message in the current mini-buffer. This is
10457 only called from error handlers in process.c, and is not time
10461 update_echo_area (void)
10463 if (!NILP (echo_area_buffer
[0]))
10465 Lisp_Object string
;
10466 string
= Fcurrent_message ();
10472 /* Make sure echo area buffers in `echo_buffers' are live.
10473 If they aren't, make new ones. */
10476 ensure_echo_area_buffers (void)
10480 for (i
= 0; i
< 2; ++i
)
10481 if (!BUFFERP (echo_buffer
[i
])
10482 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10485 Lisp_Object old_buffer
;
10488 old_buffer
= echo_buffer
[i
];
10489 echo_buffer
[i
] = Fget_buffer_create
10490 (make_formatted_string (name
, " *Echo Area %d*", i
));
10491 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10492 /* to force word wrap in echo area -
10493 it was decided to postpone this*/
10494 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10496 for (j
= 0; j
< 2; ++j
)
10497 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10498 echo_area_buffer
[j
] = echo_buffer
[i
];
10503 /* Call FN with args A1..A2 with either the current or last displayed
10504 echo_area_buffer as current buffer.
10506 WHICH zero means use the current message buffer
10507 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10508 from echo_buffer[] and clear it.
10510 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10511 suitable buffer from echo_buffer[] and clear it.
10513 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10514 that the current message becomes the last displayed one, make
10515 choose a suitable buffer for echo_area_buffer[0], and clear it.
10517 Value is what FN returns. */
10520 with_echo_area_buffer (struct window
*w
, int which
,
10521 int (*fn
) (ptrdiff_t, Lisp_Object
),
10522 ptrdiff_t a1
, Lisp_Object a2
)
10524 Lisp_Object buffer
;
10525 int this_one
, the_other
, clear_buffer_p
, rc
;
10526 ptrdiff_t count
= SPECPDL_INDEX ();
10528 /* If buffers aren't live, make new ones. */
10529 ensure_echo_area_buffers ();
10531 clear_buffer_p
= 0;
10534 this_one
= 0, the_other
= 1;
10535 else if (which
> 0)
10536 this_one
= 1, the_other
= 0;
10539 this_one
= 0, the_other
= 1;
10540 clear_buffer_p
= true;
10542 /* We need a fresh one in case the current echo buffer equals
10543 the one containing the last displayed echo area message. */
10544 if (!NILP (echo_area_buffer
[this_one
])
10545 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10546 echo_area_buffer
[this_one
] = Qnil
;
10549 /* Choose a suitable buffer from echo_buffer[] is we don't
10551 if (NILP (echo_area_buffer
[this_one
]))
10553 echo_area_buffer
[this_one
]
10554 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10555 ? echo_buffer
[the_other
]
10556 : echo_buffer
[this_one
]);
10557 clear_buffer_p
= true;
10560 buffer
= echo_area_buffer
[this_one
];
10562 /* Don't get confused by reusing the buffer used for echoing
10563 for a different purpose. */
10564 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10567 record_unwind_protect (unwind_with_echo_area_buffer
,
10568 with_echo_area_buffer_unwind_data (w
));
10570 /* Make the echo area buffer current. Note that for display
10571 purposes, it is not necessary that the displayed window's buffer
10572 == current_buffer, except for text property lookup. So, let's
10573 only set that buffer temporarily here without doing a full
10574 Fset_window_buffer. We must also change w->pointm, though,
10575 because otherwise an assertions in unshow_buffer fails, and Emacs
10577 set_buffer_internal_1 (XBUFFER (buffer
));
10580 wset_buffer (w
, buffer
);
10581 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10584 bset_undo_list (current_buffer
, Qt
);
10585 bset_read_only (current_buffer
, Qnil
);
10586 specbind (Qinhibit_read_only
, Qt
);
10587 specbind (Qinhibit_modification_hooks
, Qt
);
10589 if (clear_buffer_p
&& Z
> BEG
)
10590 del_range (BEG
, Z
);
10592 eassert (BEGV
>= BEG
);
10593 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10597 eassert (BEGV
>= BEG
);
10598 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10600 unbind_to (count
, Qnil
);
10605 /* Save state that should be preserved around the call to the function
10606 FN called in with_echo_area_buffer. */
10609 with_echo_area_buffer_unwind_data (struct window
*w
)
10612 Lisp_Object vector
, tmp
;
10614 /* Reduce consing by keeping one vector in
10615 Vwith_echo_area_save_vector. */
10616 vector
= Vwith_echo_area_save_vector
;
10617 Vwith_echo_area_save_vector
= Qnil
;
10620 vector
= Fmake_vector (make_number (9), Qnil
);
10622 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10623 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10624 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10628 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10629 ASET (vector
, i
, w
->contents
); ++i
;
10630 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10631 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10632 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10633 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10638 for (; i
< end
; ++i
)
10639 ASET (vector
, i
, Qnil
);
10642 eassert (i
== ASIZE (vector
));
10647 /* Restore global state from VECTOR which was created by
10648 with_echo_area_buffer_unwind_data. */
10651 unwind_with_echo_area_buffer (Lisp_Object vector
)
10653 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10654 Vdeactivate_mark
= AREF (vector
, 1);
10655 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10657 if (WINDOWP (AREF (vector
, 3)))
10660 Lisp_Object buffer
;
10662 w
= XWINDOW (AREF (vector
, 3));
10663 buffer
= AREF (vector
, 4);
10665 wset_buffer (w
, buffer
);
10666 set_marker_both (w
->pointm
, buffer
,
10667 XFASTINT (AREF (vector
, 5)),
10668 XFASTINT (AREF (vector
, 6)));
10669 set_marker_both (w
->start
, buffer
,
10670 XFASTINT (AREF (vector
, 7)),
10671 XFASTINT (AREF (vector
, 8)));
10674 Vwith_echo_area_save_vector
= vector
;
10678 /* Set up the echo area for use by print functions. MULTIBYTE_P
10679 non-zero means we will print multibyte. */
10682 setup_echo_area_for_printing (int multibyte_p
)
10684 /* If we can't find an echo area any more, exit. */
10685 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10686 Fkill_emacs (Qnil
);
10688 ensure_echo_area_buffers ();
10690 if (!message_buf_print
)
10692 /* A message has been output since the last time we printed.
10693 Choose a fresh echo area buffer. */
10694 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10695 echo_area_buffer
[0] = echo_buffer
[1];
10697 echo_area_buffer
[0] = echo_buffer
[0];
10699 /* Switch to that buffer and clear it. */
10700 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10701 bset_truncate_lines (current_buffer
, Qnil
);
10705 ptrdiff_t count
= SPECPDL_INDEX ();
10706 specbind (Qinhibit_read_only
, Qt
);
10707 /* Note that undo recording is always disabled. */
10708 del_range (BEG
, Z
);
10709 unbind_to (count
, Qnil
);
10711 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10713 /* Set up the buffer for the multibyteness we need. */
10715 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10716 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10718 /* Raise the frame containing the echo area. */
10719 if (minibuffer_auto_raise
)
10721 struct frame
*sf
= SELECTED_FRAME ();
10722 Lisp_Object mini_window
;
10723 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10724 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10727 message_log_maybe_newline ();
10728 message_buf_print
= 1;
10732 if (NILP (echo_area_buffer
[0]))
10734 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10735 echo_area_buffer
[0] = echo_buffer
[1];
10737 echo_area_buffer
[0] = echo_buffer
[0];
10740 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10742 /* Someone switched buffers between print requests. */
10743 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10744 bset_truncate_lines (current_buffer
, Qnil
);
10750 /* Display an echo area message in window W. Value is non-zero if W's
10751 height is changed. If display_last_displayed_message_p is
10752 non-zero, display the message that was last displayed, otherwise
10753 display the current message. */
10756 display_echo_area (struct window
*w
)
10758 int i
, no_message_p
, window_height_changed_p
;
10760 /* Temporarily disable garbage collections while displaying the echo
10761 area. This is done because a GC can print a message itself.
10762 That message would modify the echo area buffer's contents while a
10763 redisplay of the buffer is going on, and seriously confuse
10765 ptrdiff_t count
= inhibit_garbage_collection ();
10767 /* If there is no message, we must call display_echo_area_1
10768 nevertheless because it resizes the window. But we will have to
10769 reset the echo_area_buffer in question to nil at the end because
10770 with_echo_area_buffer will sets it to an empty buffer. */
10771 i
= display_last_displayed_message_p
? 1 : 0;
10772 no_message_p
= NILP (echo_area_buffer
[i
]);
10774 window_height_changed_p
10775 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10776 display_echo_area_1
,
10777 (intptr_t) w
, Qnil
);
10780 echo_area_buffer
[i
] = Qnil
;
10782 unbind_to (count
, Qnil
);
10783 return window_height_changed_p
;
10787 /* Helper for display_echo_area. Display the current buffer which
10788 contains the current echo area message in window W, a mini-window,
10789 a pointer to which is passed in A1. A2..A4 are currently not used.
10790 Change the height of W so that all of the message is displayed.
10791 Value is non-zero if height of W was changed. */
10794 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10797 struct window
*w
= (struct window
*) i1
;
10798 Lisp_Object window
;
10799 struct text_pos start
;
10800 int window_height_changed_p
= 0;
10802 /* Do this before displaying, so that we have a large enough glyph
10803 matrix for the display. If we can't get enough space for the
10804 whole text, display the last N lines. That works by setting w->start. */
10805 window_height_changed_p
= resize_mini_window (w
, 0);
10807 /* Use the starting position chosen by resize_mini_window. */
10808 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10811 clear_glyph_matrix (w
->desired_matrix
);
10812 XSETWINDOW (window
, w
);
10813 try_window (window
, start
, 0);
10815 return window_height_changed_p
;
10819 /* Resize the echo area window to exactly the size needed for the
10820 currently displayed message, if there is one. If a mini-buffer
10821 is active, don't shrink it. */
10824 resize_echo_area_exactly (void)
10826 if (BUFFERP (echo_area_buffer
[0])
10827 && WINDOWP (echo_area_window
))
10829 struct window
*w
= XWINDOW (echo_area_window
);
10830 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10831 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10832 (intptr_t) w
, resize_exactly
);
10835 windows_or_buffers_changed
= 42;
10836 update_mode_lines
= 30;
10837 redisplay_internal ();
10843 /* Callback function for with_echo_area_buffer, when used from
10844 resize_echo_area_exactly. A1 contains a pointer to the window to
10845 resize, EXACTLY non-nil means resize the mini-window exactly to the
10846 size of the text displayed. A3 and A4 are not used. Value is what
10847 resize_mini_window returns. */
10850 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10853 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10857 /* Resize mini-window W to fit the size of its contents. EXACT_P
10858 means size the window exactly to the size needed. Otherwise, it's
10859 only enlarged until W's buffer is empty.
10861 Set W->start to the right place to begin display. If the whole
10862 contents fit, start at the beginning. Otherwise, start so as
10863 to make the end of the contents appear. This is particularly
10864 important for y-or-n-p, but seems desirable generally.
10866 Value is non-zero if the window height has been changed. */
10869 resize_mini_window (struct window
*w
, int exact_p
)
10871 struct frame
*f
= XFRAME (w
->frame
);
10872 int window_height_changed_p
= 0;
10874 eassert (MINI_WINDOW_P (w
));
10876 /* By default, start display at the beginning. */
10877 set_marker_both (w
->start
, w
->contents
,
10878 BUF_BEGV (XBUFFER (w
->contents
)),
10879 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10881 /* Don't resize windows while redisplaying a window; it would
10882 confuse redisplay functions when the size of the window they are
10883 displaying changes from under them. Such a resizing can happen,
10884 for instance, when which-func prints a long message while
10885 we are running fontification-functions. We're running these
10886 functions with safe_call which binds inhibit-redisplay to t. */
10887 if (!NILP (Vinhibit_redisplay
))
10890 /* Nil means don't try to resize. */
10891 if (NILP (Vresize_mini_windows
)
10892 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10895 if (!FRAME_MINIBUF_ONLY_P (f
))
10898 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10899 + WINDOW_PIXEL_HEIGHT (w
));
10900 int unit
= FRAME_LINE_HEIGHT (f
);
10901 int height
, max_height
;
10902 struct text_pos start
;
10903 struct buffer
*old_current_buffer
= NULL
;
10905 if (current_buffer
!= XBUFFER (w
->contents
))
10907 old_current_buffer
= current_buffer
;
10908 set_buffer_internal (XBUFFER (w
->contents
));
10911 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10913 /* Compute the max. number of lines specified by the user. */
10914 if (FLOATP (Vmax_mini_window_height
))
10915 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10916 else if (INTEGERP (Vmax_mini_window_height
))
10917 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10919 max_height
= total_height
/ 4;
10921 /* Correct that max. height if it's bogus. */
10922 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10924 /* Find out the height of the text in the window. */
10925 if (it
.line_wrap
== TRUNCATE
)
10930 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10931 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10932 height
= it
.current_y
+ last_height
;
10934 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10935 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10938 /* Compute a suitable window start. */
10939 if (height
> max_height
)
10941 height
= (max_height
/ unit
) * unit
;
10942 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10943 move_it_vertically_backward (&it
, height
- unit
);
10944 start
= it
.current
.pos
;
10947 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10948 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10950 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10952 /* Let it grow only, until we display an empty message, in which
10953 case the window shrinks again. */
10954 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10956 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10958 FRAME_WINDOWS_FROZEN (f
) = 1;
10959 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10960 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10962 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10963 && (exact_p
|| BEGV
== ZV
))
10965 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10967 FRAME_WINDOWS_FROZEN (f
) = 0;
10968 shrink_mini_window (w
, 1);
10969 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10974 /* Always resize to exact size needed. */
10975 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10977 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10979 FRAME_WINDOWS_FROZEN (f
) = 1;
10980 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10981 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10983 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10985 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10987 FRAME_WINDOWS_FROZEN (f
) = 0;
10988 shrink_mini_window (w
, 1);
10992 FRAME_WINDOWS_FROZEN (f
) = 1;
10993 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10996 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11000 if (old_current_buffer
)
11001 set_buffer_internal (old_current_buffer
);
11004 return window_height_changed_p
;
11008 /* Value is the current message, a string, or nil if there is no
11009 current message. */
11012 current_message (void)
11016 if (!BUFFERP (echo_area_buffer
[0]))
11020 with_echo_area_buffer (0, 0, current_message_1
,
11021 (intptr_t) &msg
, Qnil
);
11023 echo_area_buffer
[0] = Qnil
;
11031 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11034 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11037 *msg
= make_buffer_string (BEG
, Z
, 1);
11044 /* Push the current message on Vmessage_stack for later restoration
11045 by restore_message. Value is non-zero if the current message isn't
11046 empty. This is a relatively infrequent operation, so it's not
11047 worth optimizing. */
11050 push_message (void)
11052 Lisp_Object msg
= current_message ();
11053 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11054 return STRINGP (msg
);
11058 /* Restore message display from the top of Vmessage_stack. */
11061 restore_message (void)
11063 eassert (CONSP (Vmessage_stack
));
11064 message3_nolog (XCAR (Vmessage_stack
));
11068 /* Handler for unwind-protect calling pop_message. */
11071 pop_message_unwind (void)
11073 /* Pop the top-most entry off Vmessage_stack. */
11074 eassert (CONSP (Vmessage_stack
));
11075 Vmessage_stack
= XCDR (Vmessage_stack
);
11079 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11080 exits. If the stack is not empty, we have a missing pop_message
11084 check_message_stack (void)
11086 if (!NILP (Vmessage_stack
))
11091 /* Truncate to NCHARS what will be displayed in the echo area the next
11092 time we display it---but don't redisplay it now. */
11095 truncate_echo_area (ptrdiff_t nchars
)
11098 echo_area_buffer
[0] = Qnil
;
11099 else if (!noninteractive
11101 && !NILP (echo_area_buffer
[0]))
11103 struct frame
*sf
= SELECTED_FRAME ();
11104 /* Error messages get reported properly by cmd_error, so this must be
11105 just an informative message; if the frame hasn't really been
11106 initialized yet, just toss it. */
11107 if (sf
->glyphs_initialized_p
)
11108 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11113 /* Helper function for truncate_echo_area. Truncate the current
11114 message to at most NCHARS characters. */
11117 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11119 if (BEG
+ nchars
< Z
)
11120 del_range (BEG
+ nchars
, Z
);
11122 echo_area_buffer
[0] = Qnil
;
11126 /* Set the current message to STRING. */
11129 set_message (Lisp_Object string
)
11131 eassert (STRINGP (string
));
11133 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11135 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11136 message_buf_print
= 0;
11137 help_echo_showing_p
= 0;
11139 if (STRINGP (Vdebug_on_message
)
11140 && STRINGP (string
)
11141 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11142 call_debugger (list2 (Qerror
, string
));
11146 /* Helper function for set_message. First argument is ignored and second
11147 argument has the same meaning as for set_message.
11148 This function is called with the echo area buffer being current. */
11151 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11153 eassert (STRINGP (string
));
11155 /* Change multibyteness of the echo buffer appropriately. */
11156 if (message_enable_multibyte
11157 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11158 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11160 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11161 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11162 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11164 /* Insert new message at BEG. */
11165 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11167 /* This function takes care of single/multibyte conversion.
11168 We just have to ensure that the echo area buffer has the right
11169 setting of enable_multibyte_characters. */
11170 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11176 /* Clear messages. CURRENT_P non-zero means clear the current
11177 message. LAST_DISPLAYED_P non-zero means clear the message
11181 clear_message (bool current_p
, bool last_displayed_p
)
11185 echo_area_buffer
[0] = Qnil
;
11186 message_cleared_p
= true;
11189 if (last_displayed_p
)
11190 echo_area_buffer
[1] = Qnil
;
11192 message_buf_print
= 0;
11195 /* Clear garbaged frames.
11197 This function is used where the old redisplay called
11198 redraw_garbaged_frames which in turn called redraw_frame which in
11199 turn called clear_frame. The call to clear_frame was a source of
11200 flickering. I believe a clear_frame is not necessary. It should
11201 suffice in the new redisplay to invalidate all current matrices,
11202 and ensure a complete redisplay of all windows. */
11205 clear_garbaged_frames (void)
11207 if (frame_garbaged
)
11209 Lisp_Object tail
, frame
;
11211 FOR_EACH_FRAME (tail
, frame
)
11213 struct frame
*f
= XFRAME (frame
);
11215 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11220 clear_current_matrices (f
);
11221 fset_redisplay (f
);
11222 f
->garbaged
= false;
11223 f
->resized_p
= false;
11227 frame_garbaged
= false;
11232 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11233 is non-zero update selected_frame. Value is non-zero if the
11234 mini-windows height has been changed. */
11237 echo_area_display (int update_frame_p
)
11239 Lisp_Object mini_window
;
11242 int window_height_changed_p
= 0;
11243 struct frame
*sf
= SELECTED_FRAME ();
11245 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11246 w
= XWINDOW (mini_window
);
11247 f
= XFRAME (WINDOW_FRAME (w
));
11249 /* Don't display if frame is invisible or not yet initialized. */
11250 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11253 #ifdef HAVE_WINDOW_SYSTEM
11254 /* When Emacs starts, selected_frame may be the initial terminal
11255 frame. If we let this through, a message would be displayed on
11257 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11259 #endif /* HAVE_WINDOW_SYSTEM */
11261 /* Redraw garbaged frames. */
11262 clear_garbaged_frames ();
11264 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11266 echo_area_window
= mini_window
;
11267 window_height_changed_p
= display_echo_area (w
);
11268 w
->must_be_updated_p
= true;
11270 /* Update the display, unless called from redisplay_internal.
11271 Also don't update the screen during redisplay itself. The
11272 update will happen at the end of redisplay, and an update
11273 here could cause confusion. */
11274 if (update_frame_p
&& !redisplaying_p
)
11278 /* If the display update has been interrupted by pending
11279 input, update mode lines in the frame. Due to the
11280 pending input, it might have been that redisplay hasn't
11281 been called, so that mode lines above the echo area are
11282 garbaged. This looks odd, so we prevent it here. */
11283 if (!display_completed
)
11284 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11286 if (window_height_changed_p
11287 /* Don't do this if Emacs is shutting down. Redisplay
11288 needs to run hooks. */
11289 && !NILP (Vrun_hooks
))
11291 /* Must update other windows. Likewise as in other
11292 cases, don't let this update be interrupted by
11294 ptrdiff_t count
= SPECPDL_INDEX ();
11295 specbind (Qredisplay_dont_pause
, Qt
);
11296 windows_or_buffers_changed
= 44;
11297 redisplay_internal ();
11298 unbind_to (count
, Qnil
);
11300 else if (FRAME_WINDOW_P (f
) && n
== 0)
11302 /* Window configuration is the same as before.
11303 Can do with a display update of the echo area,
11304 unless we displayed some mode lines. */
11305 update_single_window (w
, 1);
11309 update_frame (f
, 1, 1);
11311 /* If cursor is in the echo area, make sure that the next
11312 redisplay displays the minibuffer, so that the cursor will
11313 be replaced with what the minibuffer wants. */
11314 if (cursor_in_echo_area
)
11315 wset_redisplay (XWINDOW (mini_window
));
11318 else if (!EQ (mini_window
, selected_window
))
11319 wset_redisplay (XWINDOW (mini_window
));
11321 /* Last displayed message is now the current message. */
11322 echo_area_buffer
[1] = echo_area_buffer
[0];
11323 /* Inform read_char that we're not echoing. */
11324 echo_message_buffer
= Qnil
;
11326 /* Prevent redisplay optimization in redisplay_internal by resetting
11327 this_line_start_pos. This is done because the mini-buffer now
11328 displays the message instead of its buffer text. */
11329 if (EQ (mini_window
, selected_window
))
11330 CHARPOS (this_line_start_pos
) = 0;
11332 return window_height_changed_p
;
11335 /* Nonzero if W's buffer was changed but not saved. */
11338 window_buffer_changed (struct window
*w
)
11340 struct buffer
*b
= XBUFFER (w
->contents
);
11342 eassert (BUFFER_LIVE_P (b
));
11344 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11347 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11350 mode_line_update_needed (struct window
*w
)
11352 return (w
->column_number_displayed
!= -1
11353 && !(PT
== w
->last_point
&& !window_outdated (w
))
11354 && (w
->column_number_displayed
!= current_column ()));
11357 /* Nonzero if window start of W is frozen and may not be changed during
11361 window_frozen_p (struct window
*w
)
11363 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11365 Lisp_Object window
;
11367 XSETWINDOW (window
, w
);
11368 if (MINI_WINDOW_P (w
))
11370 else if (EQ (window
, selected_window
))
11372 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11373 && EQ (window
, Vminibuf_scroll_window
))
11374 /* This special window can't be frozen too. */
11382 /***********************************************************************
11383 Mode Lines and Frame Titles
11384 ***********************************************************************/
11386 /* A buffer for constructing non-propertized mode-line strings and
11387 frame titles in it; allocated from the heap in init_xdisp and
11388 resized as needed in store_mode_line_noprop_char. */
11390 static char *mode_line_noprop_buf
;
11392 /* The buffer's end, and a current output position in it. */
11394 static char *mode_line_noprop_buf_end
;
11395 static char *mode_line_noprop_ptr
;
11397 #define MODE_LINE_NOPROP_LEN(start) \
11398 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11401 MODE_LINE_DISPLAY
= 0,
11405 } mode_line_target
;
11407 /* Alist that caches the results of :propertize.
11408 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11409 static Lisp_Object mode_line_proptrans_alist
;
11411 /* List of strings making up the mode-line. */
11412 static Lisp_Object mode_line_string_list
;
11414 /* Base face property when building propertized mode line string. */
11415 static Lisp_Object mode_line_string_face
;
11416 static Lisp_Object mode_line_string_face_prop
;
11419 /* Unwind data for mode line strings */
11421 static Lisp_Object Vmode_line_unwind_vector
;
11424 format_mode_line_unwind_data (struct frame
*target_frame
,
11425 struct buffer
*obuf
,
11427 int save_proptrans
)
11429 Lisp_Object vector
, tmp
;
11431 /* Reduce consing by keeping one vector in
11432 Vwith_echo_area_save_vector. */
11433 vector
= Vmode_line_unwind_vector
;
11434 Vmode_line_unwind_vector
= Qnil
;
11437 vector
= Fmake_vector (make_number (10), Qnil
);
11439 ASET (vector
, 0, make_number (mode_line_target
));
11440 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11441 ASET (vector
, 2, mode_line_string_list
);
11442 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11443 ASET (vector
, 4, mode_line_string_face
);
11444 ASET (vector
, 5, mode_line_string_face_prop
);
11447 XSETBUFFER (tmp
, obuf
);
11450 ASET (vector
, 6, tmp
);
11451 ASET (vector
, 7, owin
);
11454 /* Similarly to `with-selected-window', if the operation selects
11455 a window on another frame, we must restore that frame's
11456 selected window, and (for a tty) the top-frame. */
11457 ASET (vector
, 8, target_frame
->selected_window
);
11458 if (FRAME_TERMCAP_P (target_frame
))
11459 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11466 unwind_format_mode_line (Lisp_Object vector
)
11468 Lisp_Object old_window
= AREF (vector
, 7);
11469 Lisp_Object target_frame_window
= AREF (vector
, 8);
11470 Lisp_Object old_top_frame
= AREF (vector
, 9);
11472 mode_line_target
= XINT (AREF (vector
, 0));
11473 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11474 mode_line_string_list
= AREF (vector
, 2);
11475 if (! EQ (AREF (vector
, 3), Qt
))
11476 mode_line_proptrans_alist
= AREF (vector
, 3);
11477 mode_line_string_face
= AREF (vector
, 4);
11478 mode_line_string_face_prop
= AREF (vector
, 5);
11480 /* Select window before buffer, since it may change the buffer. */
11481 if (!NILP (old_window
))
11483 /* If the operation that we are unwinding had selected a window
11484 on a different frame, reset its frame-selected-window. For a
11485 text terminal, reset its top-frame if necessary. */
11486 if (!NILP (target_frame_window
))
11489 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11491 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11492 Fselect_window (target_frame_window
, Qt
);
11494 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11495 Fselect_frame (old_top_frame
, Qt
);
11498 Fselect_window (old_window
, Qt
);
11501 if (!NILP (AREF (vector
, 6)))
11503 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11504 ASET (vector
, 6, Qnil
);
11507 Vmode_line_unwind_vector
= vector
;
11511 /* Store a single character C for the frame title in mode_line_noprop_buf.
11512 Re-allocate mode_line_noprop_buf if necessary. */
11515 store_mode_line_noprop_char (char c
)
11517 /* If output position has reached the end of the allocated buffer,
11518 increase the buffer's size. */
11519 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11521 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11522 ptrdiff_t size
= len
;
11523 mode_line_noprop_buf
=
11524 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11525 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11526 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11529 *mode_line_noprop_ptr
++ = c
;
11533 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11534 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11535 characters that yield more columns than PRECISION; PRECISION <= 0
11536 means copy the whole string. Pad with spaces until FIELD_WIDTH
11537 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11538 pad. Called from display_mode_element when it is used to build a
11542 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11544 const unsigned char *str
= (const unsigned char *) string
;
11546 ptrdiff_t dummy
, nbytes
;
11548 /* Copy at most PRECISION chars from STR. */
11549 nbytes
= strlen (string
);
11550 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11552 store_mode_line_noprop_char (*str
++);
11554 /* Fill up with spaces until FIELD_WIDTH reached. */
11555 while (field_width
> 0
11556 && n
< field_width
)
11558 store_mode_line_noprop_char (' ');
11565 /***********************************************************************
11567 ***********************************************************************/
11569 #ifdef HAVE_WINDOW_SYSTEM
11571 /* Set the title of FRAME, if it has changed. The title format is
11572 Vicon_title_format if FRAME is iconified, otherwise it is
11573 frame_title_format. */
11576 x_consider_frame_title (Lisp_Object frame
)
11578 struct frame
*f
= XFRAME (frame
);
11580 if (FRAME_WINDOW_P (f
)
11581 || FRAME_MINIBUF_ONLY_P (f
)
11582 || f
->explicit_name
)
11584 /* Do we have more than one visible frame on this X display? */
11585 Lisp_Object tail
, other_frame
, fmt
;
11586 ptrdiff_t title_start
;
11590 ptrdiff_t count
= SPECPDL_INDEX ();
11592 FOR_EACH_FRAME (tail
, other_frame
)
11594 struct frame
*tf
= XFRAME (other_frame
);
11597 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11598 && !FRAME_MINIBUF_ONLY_P (tf
)
11599 && !EQ (other_frame
, tip_frame
)
11600 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11604 /* Set global variable indicating that multiple frames exist. */
11605 multiple_frames
= CONSP (tail
);
11607 /* Switch to the buffer of selected window of the frame. Set up
11608 mode_line_target so that display_mode_element will output into
11609 mode_line_noprop_buf; then display the title. */
11610 record_unwind_protect (unwind_format_mode_line
,
11611 format_mode_line_unwind_data
11612 (f
, current_buffer
, selected_window
, 0));
11614 Fselect_window (f
->selected_window
, Qt
);
11615 set_buffer_internal_1
11616 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11617 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11619 mode_line_target
= MODE_LINE_TITLE
;
11620 title_start
= MODE_LINE_NOPROP_LEN (0);
11621 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11622 NULL
, DEFAULT_FACE_ID
);
11623 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11624 len
= MODE_LINE_NOPROP_LEN (title_start
);
11625 title
= mode_line_noprop_buf
+ title_start
;
11626 unbind_to (count
, Qnil
);
11628 /* Set the title only if it's changed. This avoids consing in
11629 the common case where it hasn't. (If it turns out that we've
11630 already wasted too much time by walking through the list with
11631 display_mode_element, then we might need to optimize at a
11632 higher level than this.) */
11633 if (! STRINGP (f
->name
)
11634 || SBYTES (f
->name
) != len
11635 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11636 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11640 #endif /* not HAVE_WINDOW_SYSTEM */
11643 /***********************************************************************
11645 ***********************************************************************/
11647 /* Non-zero if we will not redisplay all visible windows. */
11648 #define REDISPLAY_SOME_P() \
11649 ((windows_or_buffers_changed == 0 \
11650 || windows_or_buffers_changed == REDISPLAY_SOME) \
11651 && (update_mode_lines == 0 \
11652 || update_mode_lines == REDISPLAY_SOME))
11654 /* Prepare for redisplay by updating menu-bar item lists when
11655 appropriate. This can call eval. */
11658 prepare_menu_bars (void)
11660 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11661 bool some_windows
= REDISPLAY_SOME_P ();
11662 struct gcpro gcpro1
, gcpro2
;
11663 Lisp_Object tooltip_frame
;
11665 #ifdef HAVE_WINDOW_SYSTEM
11666 tooltip_frame
= tip_frame
;
11668 tooltip_frame
= Qnil
;
11671 if (FUNCTIONP (Vpre_redisplay_function
))
11673 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11674 if (all_windows
&& some_windows
)
11676 Lisp_Object ws
= window_list ();
11677 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11679 Lisp_Object
this = XCAR (ws
);
11680 struct window
*w
= XWINDOW (this);
11682 || XFRAME (w
->frame
)->redisplay
11683 || XBUFFER (w
->contents
)->text
->redisplay
)
11685 windows
= Fcons (this, windows
);
11689 safe__call1 (true, Vpre_redisplay_function
, windows
);
11692 /* Update all frame titles based on their buffer names, etc. We do
11693 this before the menu bars so that the buffer-menu will show the
11694 up-to-date frame titles. */
11695 #ifdef HAVE_WINDOW_SYSTEM
11698 Lisp_Object tail
, frame
;
11700 FOR_EACH_FRAME (tail
, frame
)
11702 struct frame
*f
= XFRAME (frame
);
11703 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11707 && !XBUFFER (w
->contents
)->text
->redisplay
)
11710 if (!EQ (frame
, tooltip_frame
)
11711 && (FRAME_ICONIFIED_P (f
)
11712 || FRAME_VISIBLE_P (f
) == 1
11713 /* Exclude TTY frames that are obscured because they
11714 are not the top frame on their console. This is
11715 because x_consider_frame_title actually switches
11716 to the frame, which for TTY frames means it is
11717 marked as garbaged, and will be completely
11718 redrawn on the next redisplay cycle. This causes
11719 TTY frames to be completely redrawn, when there
11720 are more than one of them, even though nothing
11721 should be changed on display. */
11722 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11723 x_consider_frame_title (frame
);
11726 #endif /* HAVE_WINDOW_SYSTEM */
11728 /* Update the menu bar item lists, if appropriate. This has to be
11729 done before any actual redisplay or generation of display lines. */
11733 Lisp_Object tail
, frame
;
11734 ptrdiff_t count
= SPECPDL_INDEX ();
11735 /* 1 means that update_menu_bar has run its hooks
11736 so any further calls to update_menu_bar shouldn't do so again. */
11737 int menu_bar_hooks_run
= 0;
11739 record_unwind_save_match_data ();
11741 FOR_EACH_FRAME (tail
, frame
)
11743 struct frame
*f
= XFRAME (frame
);
11744 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11746 /* Ignore tooltip frame. */
11747 if (EQ (frame
, tooltip_frame
))
11753 && !XBUFFER (w
->contents
)->text
->redisplay
)
11756 /* If a window on this frame changed size, report that to
11757 the user and clear the size-change flag. */
11758 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11760 Lisp_Object functions
;
11762 /* Clear flag first in case we get an error below. */
11763 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11764 functions
= Vwindow_size_change_functions
;
11765 GCPRO2 (tail
, functions
);
11767 while (CONSP (functions
))
11769 if (!EQ (XCAR (functions
), Qt
))
11770 call1 (XCAR (functions
), frame
);
11771 functions
= XCDR (functions
);
11777 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11778 #ifdef HAVE_WINDOW_SYSTEM
11779 update_tool_bar (f
, 0);
11782 if (windows_or_buffers_changed
11785 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11790 unbind_to (count
, Qnil
);
11794 struct frame
*sf
= SELECTED_FRAME ();
11795 update_menu_bar (sf
, 1, 0);
11796 #ifdef HAVE_WINDOW_SYSTEM
11797 update_tool_bar (sf
, 1);
11803 /* Update the menu bar item list for frame F. This has to be done
11804 before we start to fill in any display lines, because it can call
11807 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11809 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11810 already ran the menu bar hooks for this redisplay, so there
11811 is no need to run them again. The return value is the
11812 updated value of this flag, to pass to the next call. */
11815 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11817 Lisp_Object window
;
11818 register struct window
*w
;
11820 /* If called recursively during a menu update, do nothing. This can
11821 happen when, for instance, an activate-menubar-hook causes a
11823 if (inhibit_menubar_update
)
11826 window
= FRAME_SELECTED_WINDOW (f
);
11827 w
= XWINDOW (window
);
11829 if (FRAME_WINDOW_P (f
)
11831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11832 || defined (HAVE_NS) || defined (USE_GTK)
11833 FRAME_EXTERNAL_MENU_BAR (f
)
11835 FRAME_MENU_BAR_LINES (f
) > 0
11837 : FRAME_MENU_BAR_LINES (f
) > 0)
11839 /* If the user has switched buffers or windows, we need to
11840 recompute to reflect the new bindings. But we'll
11841 recompute when update_mode_lines is set too; that means
11842 that people can use force-mode-line-update to request
11843 that the menu bar be recomputed. The adverse effect on
11844 the rest of the redisplay algorithm is about the same as
11845 windows_or_buffers_changed anyway. */
11846 if (windows_or_buffers_changed
11847 /* This used to test w->update_mode_line, but we believe
11848 there is no need to recompute the menu in that case. */
11849 || update_mode_lines
11850 || window_buffer_changed (w
))
11852 struct buffer
*prev
= current_buffer
;
11853 ptrdiff_t count
= SPECPDL_INDEX ();
11855 specbind (Qinhibit_menubar_update
, Qt
);
11857 set_buffer_internal_1 (XBUFFER (w
->contents
));
11858 if (save_match_data
)
11859 record_unwind_save_match_data ();
11860 if (NILP (Voverriding_local_map_menu_flag
))
11862 specbind (Qoverriding_terminal_local_map
, Qnil
);
11863 specbind (Qoverriding_local_map
, Qnil
);
11868 /* Run the Lucid hook. */
11869 safe_run_hooks (Qactivate_menubar_hook
);
11871 /* If it has changed current-menubar from previous value,
11872 really recompute the menu-bar from the value. */
11873 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11874 call0 (Qrecompute_lucid_menubar
);
11876 safe_run_hooks (Qmenu_bar_update_hook
);
11881 XSETFRAME (Vmenu_updating_frame
, f
);
11882 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11884 /* Redisplay the menu bar in case we changed it. */
11885 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11886 || defined (HAVE_NS) || defined (USE_GTK)
11887 if (FRAME_WINDOW_P (f
))
11889 #if defined (HAVE_NS)
11890 /* All frames on Mac OS share the same menubar. So only
11891 the selected frame should be allowed to set it. */
11892 if (f
== SELECTED_FRAME ())
11894 set_frame_menubar (f
, 0, 0);
11897 /* On a terminal screen, the menu bar is an ordinary screen
11898 line, and this makes it get updated. */
11899 w
->update_mode_line
= 1;
11900 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11901 /* In the non-toolkit version, the menu bar is an ordinary screen
11902 line, and this makes it get updated. */
11903 w
->update_mode_line
= 1;
11904 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11906 unbind_to (count
, Qnil
);
11907 set_buffer_internal_1 (prev
);
11914 /***********************************************************************
11916 ***********************************************************************/
11918 #ifdef HAVE_WINDOW_SYSTEM
11920 /* Tool-bar item index of the item on which a mouse button was pressed
11923 int last_tool_bar_item
;
11925 /* Select `frame' temporarily without running all the code in
11927 FIXME: Maybe do_switch_frame should be trimmed down similarly
11928 when `norecord' is set. */
11930 fast_set_selected_frame (Lisp_Object frame
)
11932 if (!EQ (selected_frame
, frame
))
11934 selected_frame
= frame
;
11935 selected_window
= XFRAME (frame
)->selected_window
;
11939 /* Update the tool-bar item list for frame F. This has to be done
11940 before we start to fill in any display lines. Called from
11941 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11942 and restore it here. */
11945 update_tool_bar (struct frame
*f
, int save_match_data
)
11947 #if defined (USE_GTK) || defined (HAVE_NS)
11948 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11950 int do_update
= (WINDOWP (f
->tool_bar_window
)
11951 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11956 Lisp_Object window
;
11959 window
= FRAME_SELECTED_WINDOW (f
);
11960 w
= XWINDOW (window
);
11962 /* If the user has switched buffers or windows, we need to
11963 recompute to reflect the new bindings. But we'll
11964 recompute when update_mode_lines is set too; that means
11965 that people can use force-mode-line-update to request
11966 that the menu bar be recomputed. The adverse effect on
11967 the rest of the redisplay algorithm is about the same as
11968 windows_or_buffers_changed anyway. */
11969 if (windows_or_buffers_changed
11970 || w
->update_mode_line
11971 || update_mode_lines
11972 || window_buffer_changed (w
))
11974 struct buffer
*prev
= current_buffer
;
11975 ptrdiff_t count
= SPECPDL_INDEX ();
11976 Lisp_Object frame
, new_tool_bar
;
11977 int new_n_tool_bar
;
11978 struct gcpro gcpro1
;
11980 /* Set current_buffer to the buffer of the selected
11981 window of the frame, so that we get the right local
11983 set_buffer_internal_1 (XBUFFER (w
->contents
));
11985 /* Save match data, if we must. */
11986 if (save_match_data
)
11987 record_unwind_save_match_data ();
11989 /* Make sure that we don't accidentally use bogus keymaps. */
11990 if (NILP (Voverriding_local_map_menu_flag
))
11992 specbind (Qoverriding_terminal_local_map
, Qnil
);
11993 specbind (Qoverriding_local_map
, Qnil
);
11996 GCPRO1 (new_tool_bar
);
11998 /* We must temporarily set the selected frame to this frame
11999 before calling tool_bar_items, because the calculation of
12000 the tool-bar keymap uses the selected frame (see
12001 `tool-bar-make-keymap' in tool-bar.el). */
12002 eassert (EQ (selected_window
,
12003 /* Since we only explicitly preserve selected_frame,
12004 check that selected_window would be redundant. */
12005 XFRAME (selected_frame
)->selected_window
));
12006 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12007 XSETFRAME (frame
, f
);
12008 fast_set_selected_frame (frame
);
12010 /* Build desired tool-bar items from keymaps. */
12012 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12015 /* Redisplay the tool-bar if we changed it. */
12016 if (new_n_tool_bar
!= f
->n_tool_bar_items
12017 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12019 /* Redisplay that happens asynchronously due to an expose event
12020 may access f->tool_bar_items. Make sure we update both
12021 variables within BLOCK_INPUT so no such event interrupts. */
12023 fset_tool_bar_items (f
, new_tool_bar
);
12024 f
->n_tool_bar_items
= new_n_tool_bar
;
12025 w
->update_mode_line
= 1;
12031 unbind_to (count
, Qnil
);
12032 set_buffer_internal_1 (prev
);
12037 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12039 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12040 F's desired tool-bar contents. F->tool_bar_items must have
12041 been set up previously by calling prepare_menu_bars. */
12044 build_desired_tool_bar_string (struct frame
*f
)
12046 int i
, size
, size_needed
;
12047 struct gcpro gcpro1
, gcpro2
, gcpro3
;
12048 Lisp_Object image
, plist
, props
;
12050 image
= plist
= props
= Qnil
;
12051 GCPRO3 (image
, plist
, props
);
12053 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12054 Otherwise, make a new string. */
12056 /* The size of the string we might be able to reuse. */
12057 size
= (STRINGP (f
->desired_tool_bar_string
)
12058 ? SCHARS (f
->desired_tool_bar_string
)
12061 /* We need one space in the string for each image. */
12062 size_needed
= f
->n_tool_bar_items
;
12064 /* Reuse f->desired_tool_bar_string, if possible. */
12065 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12066 fset_desired_tool_bar_string
12067 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12070 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12071 Fremove_text_properties (make_number (0), make_number (size
),
12072 props
, f
->desired_tool_bar_string
);
12075 /* Put a `display' property on the string for the images to display,
12076 put a `menu_item' property on tool-bar items with a value that
12077 is the index of the item in F's tool-bar item vector. */
12078 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12080 #define PROP(IDX) \
12081 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12083 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12084 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12085 int hmargin
, vmargin
, relief
, idx
, end
;
12087 /* If image is a vector, choose the image according to the
12089 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12090 if (VECTORP (image
))
12094 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12095 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12098 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12099 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12101 eassert (ASIZE (image
) >= idx
);
12102 image
= AREF (image
, idx
);
12107 /* Ignore invalid image specifications. */
12108 if (!valid_image_p (image
))
12111 /* Display the tool-bar button pressed, or depressed. */
12112 plist
= Fcopy_sequence (XCDR (image
));
12114 /* Compute margin and relief to draw. */
12115 relief
= (tool_bar_button_relief
>= 0
12116 ? tool_bar_button_relief
12117 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12118 hmargin
= vmargin
= relief
;
12120 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12121 INT_MAX
- max (hmargin
, vmargin
)))
12123 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12124 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12126 else if (CONSP (Vtool_bar_button_margin
))
12128 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12129 INT_MAX
- hmargin
))
12130 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12132 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12133 INT_MAX
- vmargin
))
12134 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12137 if (auto_raise_tool_bar_buttons_p
)
12139 /* Add a `:relief' property to the image spec if the item is
12143 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12150 /* If image is selected, display it pressed, i.e. with a
12151 negative relief. If it's not selected, display it with a
12153 plist
= Fplist_put (plist
, QCrelief
,
12155 ? make_number (-relief
)
12156 : make_number (relief
)));
12161 /* Put a margin around the image. */
12162 if (hmargin
|| vmargin
)
12164 if (hmargin
== vmargin
)
12165 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12167 plist
= Fplist_put (plist
, QCmargin
,
12168 Fcons (make_number (hmargin
),
12169 make_number (vmargin
)));
12172 /* If button is not enabled, and we don't have special images
12173 for the disabled state, make the image appear disabled by
12174 applying an appropriate algorithm to it. */
12175 if (!enabled_p
&& idx
< 0)
12176 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12178 /* Put a `display' text property on the string for the image to
12179 display. Put a `menu-item' property on the string that gives
12180 the start of this item's properties in the tool-bar items
12182 image
= Fcons (Qimage
, plist
);
12183 props
= list4 (Qdisplay
, image
,
12184 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12186 /* Let the last image hide all remaining spaces in the tool bar
12187 string. The string can be longer than needed when we reuse a
12188 previous string. */
12189 if (i
+ 1 == f
->n_tool_bar_items
)
12190 end
= SCHARS (f
->desired_tool_bar_string
);
12193 Fadd_text_properties (make_number (i
), make_number (end
),
12194 props
, f
->desired_tool_bar_string
);
12202 /* Display one line of the tool-bar of frame IT->f.
12204 HEIGHT specifies the desired height of the tool-bar line.
12205 If the actual height of the glyph row is less than HEIGHT, the
12206 row's height is increased to HEIGHT, and the icons are centered
12207 vertically in the new height.
12209 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12210 count a final empty row in case the tool-bar width exactly matches
12215 display_tool_bar_line (struct it
*it
, int height
)
12217 struct glyph_row
*row
= it
->glyph_row
;
12218 int max_x
= it
->last_visible_x
;
12219 struct glyph
*last
;
12221 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12222 clear_glyph_row (row
);
12223 row
->enabled_p
= true;
12224 row
->y
= it
->current_y
;
12226 /* Note that this isn't made use of if the face hasn't a box,
12227 so there's no need to check the face here. */
12228 it
->start_of_box_run_p
= 1;
12230 while (it
->current_x
< max_x
)
12232 int x
, n_glyphs_before
, i
, nglyphs
;
12233 struct it it_before
;
12235 /* Get the next display element. */
12236 if (!get_next_display_element (it
))
12238 /* Don't count empty row if we are counting needed tool-bar lines. */
12239 if (height
< 0 && !it
->hpos
)
12244 /* Produce glyphs. */
12245 n_glyphs_before
= row
->used
[TEXT_AREA
];
12248 PRODUCE_GLYPHS (it
);
12250 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12252 x
= it_before
.current_x
;
12253 while (i
< nglyphs
)
12255 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12257 if (x
+ glyph
->pixel_width
> max_x
)
12259 /* Glyph doesn't fit on line. Backtrack. */
12260 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12262 /* If this is the only glyph on this line, it will never fit on the
12263 tool-bar, so skip it. But ensure there is at least one glyph,
12264 so we don't accidentally disable the tool-bar. */
12265 if (n_glyphs_before
== 0
12266 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12272 x
+= glyph
->pixel_width
;
12276 /* Stop at line end. */
12277 if (ITERATOR_AT_END_OF_LINE_P (it
))
12280 set_iterator_to_next (it
, 1);
12285 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12287 /* Use default face for the border below the tool bar.
12289 FIXME: When auto-resize-tool-bars is grow-only, there is
12290 no additional border below the possibly empty tool-bar lines.
12291 So to make the extra empty lines look "normal", we have to
12292 use the tool-bar face for the border too. */
12293 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12294 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12295 it
->face_id
= DEFAULT_FACE_ID
;
12297 extend_face_to_end_of_line (it
);
12298 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12299 last
->right_box_line_p
= 1;
12300 if (last
== row
->glyphs
[TEXT_AREA
])
12301 last
->left_box_line_p
= 1;
12303 /* Make line the desired height and center it vertically. */
12304 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12306 /* Don't add more than one line height. */
12307 height
%= FRAME_LINE_HEIGHT (it
->f
);
12308 it
->max_ascent
+= height
/ 2;
12309 it
->max_descent
+= (height
+ 1) / 2;
12312 compute_line_metrics (it
);
12314 /* If line is empty, make it occupy the rest of the tool-bar. */
12315 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12317 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12318 row
->visible_height
= row
->height
;
12319 row
->ascent
= row
->phys_ascent
= 0;
12320 row
->extra_line_spacing
= 0;
12323 row
->full_width_p
= 1;
12324 row
->continued_p
= 0;
12325 row
->truncated_on_left_p
= 0;
12326 row
->truncated_on_right_p
= 0;
12328 it
->current_x
= it
->hpos
= 0;
12329 it
->current_y
+= row
->height
;
12335 /* Max tool-bar height. Basically, this is what makes all other windows
12336 disappear when the frame gets too small. Rethink this! */
12338 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12339 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12341 /* Value is the number of pixels needed to make all tool-bar items of
12342 frame F visible. The actual number of glyph rows needed is
12343 returned in *N_ROWS if non-NULL. */
12346 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12348 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12350 /* tool_bar_height is called from redisplay_tool_bar after building
12351 the desired matrix, so use (unused) mode-line row as temporary row to
12352 avoid destroying the first tool-bar row. */
12353 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12355 /* Initialize an iterator for iteration over
12356 F->desired_tool_bar_string in the tool-bar window of frame F. */
12357 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12358 it
.first_visible_x
= 0;
12359 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12360 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12361 it
.paragraph_embedding
= L2R
;
12363 while (!ITERATOR_AT_END_P (&it
))
12365 clear_glyph_row (temp_row
);
12366 it
.glyph_row
= temp_row
;
12367 display_tool_bar_line (&it
, -1);
12369 clear_glyph_row (temp_row
);
12371 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12373 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12376 return it
.current_y
;
12378 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12381 #endif /* !USE_GTK && !HAVE_NS */
12383 #if defined USE_GTK || defined HAVE_NS
12384 EXFUN (Ftool_bar_height
, 2) ATTRIBUTE_CONST
;
12385 EXFUN (Ftool_bar_lines_needed
, 1) ATTRIBUTE_CONST
;
12388 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12390 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12391 If FRAME is nil or omitted, use the selected frame. Optional argument
12392 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12393 (Lisp_Object frame
, Lisp_Object pixelwise
)
12397 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12398 struct frame
*f
= decode_any_frame (frame
);
12400 if (WINDOWP (f
->tool_bar_window
)
12401 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12403 update_tool_bar (f
, 1);
12404 if (f
->n_tool_bar_items
)
12406 build_desired_tool_bar_string (f
);
12407 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12412 return make_number (height
);
12416 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12417 height should be changed. */
12420 redisplay_tool_bar (struct frame
*f
)
12422 #if defined (USE_GTK) || defined (HAVE_NS)
12424 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12425 update_frame_tool_bar (f
);
12428 #else /* !USE_GTK && !HAVE_NS */
12432 struct glyph_row
*row
;
12434 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12435 do anything. This means you must start with tool-bar-lines
12436 non-zero to get the auto-sizing effect. Or in other words, you
12437 can turn off tool-bars by specifying tool-bar-lines zero. */
12438 if (!WINDOWP (f
->tool_bar_window
)
12439 || (w
= XWINDOW (f
->tool_bar_window
),
12440 WINDOW_PIXEL_HEIGHT (w
) == 0))
12443 /* Set up an iterator for the tool-bar window. */
12444 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12445 it
.first_visible_x
= 0;
12446 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12447 row
= it
.glyph_row
;
12449 /* Build a string that represents the contents of the tool-bar. */
12450 build_desired_tool_bar_string (f
);
12451 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12452 /* FIXME: This should be controlled by a user option. But it
12453 doesn't make sense to have an R2L tool bar if the menu bar cannot
12454 be drawn also R2L, and making the menu bar R2L is tricky due
12455 toolkit-specific code that implements it. If an R2L tool bar is
12456 ever supported, display_tool_bar_line should also be augmented to
12457 call unproduce_glyphs like display_line and display_string
12459 it
.paragraph_embedding
= L2R
;
12461 if (f
->n_tool_bar_rows
== 0)
12463 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12465 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12468 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12469 / FRAME_LINE_HEIGHT (f
));
12471 XSETFRAME (frame
, f
);
12472 Fmodify_frame_parameters (frame
,
12473 list1 (Fcons (Qtool_bar_lines
,
12474 make_number (new_lines
))));
12475 /* Always do that now. */
12476 clear_glyph_matrix (w
->desired_matrix
);
12477 f
->fonts_changed
= 1;
12482 /* Display as many lines as needed to display all tool-bar items. */
12484 if (f
->n_tool_bar_rows
> 0)
12486 int border
, rows
, height
, extra
;
12488 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12489 border
= XINT (Vtool_bar_border
);
12490 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12491 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12492 else if (EQ (Vtool_bar_border
, Qborder_width
))
12493 border
= f
->border_width
;
12499 rows
= f
->n_tool_bar_rows
;
12500 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12501 extra
= it
.last_visible_y
- border
- height
* rows
;
12503 while (it
.current_y
< it
.last_visible_y
)
12506 if (extra
> 0 && rows
-- > 0)
12508 h
= (extra
+ rows
- 1) / rows
;
12511 display_tool_bar_line (&it
, height
+ h
);
12516 while (it
.current_y
< it
.last_visible_y
)
12517 display_tool_bar_line (&it
, 0);
12520 /* It doesn't make much sense to try scrolling in the tool-bar
12521 window, so don't do it. */
12522 w
->desired_matrix
->no_scrolling_p
= 1;
12523 w
->must_be_updated_p
= 1;
12525 if (!NILP (Vauto_resize_tool_bars
))
12527 /* Do we really allow the toolbar to occupy the whole frame? */
12528 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12529 int change_height_p
= 0;
12531 /* If we couldn't display everything, change the tool-bar's
12532 height if there is room for more. */
12533 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12534 && it
.current_y
< max_tool_bar_height
)
12535 change_height_p
= 1;
12537 /* We subtract 1 because display_tool_bar_line advances the
12538 glyph_row pointer before returning to its caller. We want to
12539 examine the last glyph row produced by
12540 display_tool_bar_line. */
12541 row
= it
.glyph_row
- 1;
12543 /* If there are blank lines at the end, except for a partially
12544 visible blank line at the end that is smaller than
12545 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12546 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12547 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12548 change_height_p
= 1;
12550 /* If row displays tool-bar items, but is partially visible,
12551 change the tool-bar's height. */
12552 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12553 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12554 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12555 change_height_p
= 1;
12557 /* Resize windows as needed by changing the `tool-bar-lines'
12558 frame parameter. */
12559 if (change_height_p
)
12563 int new_height
= tool_bar_height (f
, &nrows
, 1);
12565 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12566 && !f
->minimize_tool_bar_window_p
)
12567 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12568 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12569 f
->minimize_tool_bar_window_p
= 0;
12571 if (change_height_p
)
12573 /* Current size of the tool-bar window in canonical line
12575 int old_lines
= WINDOW_TOTAL_LINES (w
);
12576 /* Required size of the tool-bar window in canonical
12578 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12579 / FRAME_LINE_HEIGHT (f
));
12580 /* Maximum size of the tool-bar window in canonical line
12581 units that this frame can allow. */
12583 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12585 /* Don't try to change the tool-bar window size and set
12586 the fonts_changed flag unless really necessary. That
12587 flag causes redisplay to give up and retry
12588 redisplaying the frame from scratch, so setting it
12589 unnecessarily can lead to nasty redisplay loops. */
12590 if (new_lines
<= max_lines
12591 && eabs (new_lines
- old_lines
) >= 1)
12593 XSETFRAME (frame
, f
);
12594 Fmodify_frame_parameters (frame
,
12595 list1 (Fcons (Qtool_bar_lines
,
12596 make_number (new_lines
))));
12597 clear_glyph_matrix (w
->desired_matrix
);
12598 f
->n_tool_bar_rows
= nrows
;
12599 f
->fonts_changed
= 1;
12606 f
->minimize_tool_bar_window_p
= 0;
12609 #endif /* USE_GTK || HAVE_NS */
12612 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12614 /* Get information about the tool-bar item which is displayed in GLYPH
12615 on frame F. Return in *PROP_IDX the index where tool-bar item
12616 properties start in F->tool_bar_items. Value is zero if
12617 GLYPH doesn't display a tool-bar item. */
12620 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12626 /* This function can be called asynchronously, which means we must
12627 exclude any possibility that Fget_text_property signals an
12629 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12630 charpos
= max (0, charpos
);
12632 /* Get the text property `menu-item' at pos. The value of that
12633 property is the start index of this item's properties in
12634 F->tool_bar_items. */
12635 prop
= Fget_text_property (make_number (charpos
),
12636 Qmenu_item
, f
->current_tool_bar_string
);
12637 if (INTEGERP (prop
))
12639 *prop_idx
= XINT (prop
);
12649 /* Get information about the tool-bar item at position X/Y on frame F.
12650 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12651 the current matrix of the tool-bar window of F, or NULL if not
12652 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12653 item in F->tool_bar_items. Value is
12655 -1 if X/Y is not on a tool-bar item
12656 0 if X/Y is on the same item that was highlighted before.
12660 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12661 int *hpos
, int *vpos
, int *prop_idx
)
12663 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12664 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12667 /* Find the glyph under X/Y. */
12668 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12669 if (*glyph
== NULL
)
12672 /* Get the start of this tool-bar item's properties in
12673 f->tool_bar_items. */
12674 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12677 /* Is mouse on the highlighted item? */
12678 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12679 && *vpos
>= hlinfo
->mouse_face_beg_row
12680 && *vpos
<= hlinfo
->mouse_face_end_row
12681 && (*vpos
> hlinfo
->mouse_face_beg_row
12682 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12683 && (*vpos
< hlinfo
->mouse_face_end_row
12684 || *hpos
< hlinfo
->mouse_face_end_col
12685 || hlinfo
->mouse_face_past_end
))
12693 Handle mouse button event on the tool-bar of frame F, at
12694 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12695 0 for button release. MODIFIERS is event modifiers for button
12699 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12702 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12703 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12704 int hpos
, vpos
, prop_idx
;
12705 struct glyph
*glyph
;
12706 Lisp_Object enabled_p
;
12709 /* If not on the highlighted tool-bar item, and mouse-highlight is
12710 non-nil, return. This is so we generate the tool-bar button
12711 click only when the mouse button is released on the same item as
12712 where it was pressed. However, when mouse-highlight is disabled,
12713 generate the click when the button is released regardless of the
12714 highlight, since tool-bar items are not highlighted in that
12716 frame_to_window_pixel_xy (w
, &x
, &y
);
12717 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12719 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12722 /* When mouse-highlight is off, generate the click for the item
12723 where the button was pressed, disregarding where it was
12725 if (NILP (Vmouse_highlight
) && !down_p
)
12726 prop_idx
= last_tool_bar_item
;
12728 /* If item is disabled, do nothing. */
12729 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12730 if (NILP (enabled_p
))
12735 /* Show item in pressed state. */
12736 if (!NILP (Vmouse_highlight
))
12737 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12738 last_tool_bar_item
= prop_idx
;
12742 Lisp_Object key
, frame
;
12743 struct input_event event
;
12744 EVENT_INIT (event
);
12746 /* Show item in released state. */
12747 if (!NILP (Vmouse_highlight
))
12748 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12750 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12752 XSETFRAME (frame
, f
);
12753 event
.kind
= TOOL_BAR_EVENT
;
12754 event
.frame_or_window
= frame
;
12756 kbd_buffer_store_event (&event
);
12758 event
.kind
= TOOL_BAR_EVENT
;
12759 event
.frame_or_window
= frame
;
12761 event
.modifiers
= modifiers
;
12762 kbd_buffer_store_event (&event
);
12763 last_tool_bar_item
= -1;
12768 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12769 tool-bar window-relative coordinates X/Y. Called from
12770 note_mouse_highlight. */
12773 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12775 Lisp_Object window
= f
->tool_bar_window
;
12776 struct window
*w
= XWINDOW (window
);
12777 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12778 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12780 struct glyph
*glyph
;
12781 struct glyph_row
*row
;
12783 Lisp_Object enabled_p
;
12785 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12786 int mouse_down_p
, rc
;
12788 /* Function note_mouse_highlight is called with negative X/Y
12789 values when mouse moves outside of the frame. */
12790 if (x
<= 0 || y
<= 0)
12792 clear_mouse_face (hlinfo
);
12796 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12799 /* Not on tool-bar item. */
12800 clear_mouse_face (hlinfo
);
12804 /* On same tool-bar item as before. */
12805 goto set_help_echo
;
12807 clear_mouse_face (hlinfo
);
12809 /* Mouse is down, but on different tool-bar item? */
12810 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12811 && f
== dpyinfo
->last_mouse_frame
);
12814 && last_tool_bar_item
!= prop_idx
)
12817 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12819 /* If tool-bar item is not enabled, don't highlight it. */
12820 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12821 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12823 /* Compute the x-position of the glyph. In front and past the
12824 image is a space. We include this in the highlighted area. */
12825 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12826 for (i
= x
= 0; i
< hpos
; ++i
)
12827 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12829 /* Record this as the current active region. */
12830 hlinfo
->mouse_face_beg_col
= hpos
;
12831 hlinfo
->mouse_face_beg_row
= vpos
;
12832 hlinfo
->mouse_face_beg_x
= x
;
12833 hlinfo
->mouse_face_past_end
= 0;
12835 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12836 hlinfo
->mouse_face_end_row
= vpos
;
12837 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12838 hlinfo
->mouse_face_window
= window
;
12839 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12841 /* Display it as active. */
12842 show_mouse_face (hlinfo
, draw
);
12847 /* Set help_echo_string to a help string to display for this tool-bar item.
12848 XTread_socket does the rest. */
12849 help_echo_object
= help_echo_window
= Qnil
;
12850 help_echo_pos
= -1;
12851 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12852 if (NILP (help_echo_string
))
12853 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12856 #endif /* !USE_GTK && !HAVE_NS */
12858 #endif /* HAVE_WINDOW_SYSTEM */
12862 /************************************************************************
12863 Horizontal scrolling
12864 ************************************************************************/
12866 static int hscroll_window_tree (Lisp_Object
);
12867 static int hscroll_windows (Lisp_Object
);
12869 /* For all leaf windows in the window tree rooted at WINDOW, set their
12870 hscroll value so that PT is (i) visible in the window, and (ii) so
12871 that it is not within a certain margin at the window's left and
12872 right border. Value is non-zero if any window's hscroll has been
12876 hscroll_window_tree (Lisp_Object window
)
12878 int hscrolled_p
= 0;
12879 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12880 int hscroll_step_abs
= 0;
12881 double hscroll_step_rel
= 0;
12883 if (hscroll_relative_p
)
12885 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12886 if (hscroll_step_rel
< 0)
12888 hscroll_relative_p
= 0;
12889 hscroll_step_abs
= 0;
12892 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12894 hscroll_step_abs
= XINT (Vhscroll_step
);
12895 if (hscroll_step_abs
< 0)
12896 hscroll_step_abs
= 0;
12899 hscroll_step_abs
= 0;
12901 while (WINDOWP (window
))
12903 struct window
*w
= XWINDOW (window
);
12905 if (WINDOWP (w
->contents
))
12906 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12907 else if (w
->cursor
.vpos
>= 0)
12910 int text_area_width
;
12911 struct glyph_row
*cursor_row
;
12912 struct glyph_row
*bottom_row
;
12915 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12916 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12917 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12919 cursor_row
= bottom_row
- 1;
12921 if (!cursor_row
->enabled_p
)
12923 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12924 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12925 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12927 cursor_row
= bottom_row
- 1;
12929 row_r2l_p
= cursor_row
->reversed_p
;
12931 text_area_width
= window_box_width (w
, TEXT_AREA
);
12933 /* Scroll when cursor is inside this scroll margin. */
12934 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12936 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12937 /* In some pathological cases, like restoring a window
12938 configuration into a frame that is much smaller than
12939 the one from which the configuration was saved, we
12940 get glyph rows whose start and end have zero buffer
12941 positions, which we cannot handle below. Just skip
12943 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12944 /* For left-to-right rows, hscroll when cursor is either
12945 (i) inside the right hscroll margin, or (ii) if it is
12946 inside the left margin and the window is already
12950 && w
->cursor
.x
<= h_margin
)
12951 || (cursor_row
->enabled_p
12952 && cursor_row
->truncated_on_right_p
12953 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12954 /* For right-to-left rows, the logic is similar,
12955 except that rules for scrolling to left and right
12956 are reversed. E.g., if cursor.x <= h_margin, we
12957 need to hscroll "to the right" unconditionally,
12958 and that will scroll the screen to the left so as
12959 to reveal the next portion of the row. */
12961 && ((cursor_row
->enabled_p
12962 /* FIXME: It is confusing to set the
12963 truncated_on_right_p flag when R2L rows
12964 are actually truncated on the left. */
12965 && cursor_row
->truncated_on_right_p
12966 && w
->cursor
.x
<= h_margin
)
12968 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12972 struct buffer
*saved_current_buffer
;
12976 /* Find point in a display of infinite width. */
12977 saved_current_buffer
= current_buffer
;
12978 current_buffer
= XBUFFER (w
->contents
);
12980 if (w
== XWINDOW (selected_window
))
12983 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12985 /* Move iterator to pt starting at cursor_row->start in
12986 a line with infinite width. */
12987 init_to_row_start (&it
, w
, cursor_row
);
12988 it
.last_visible_x
= INFINITY
;
12989 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12990 current_buffer
= saved_current_buffer
;
12992 /* Position cursor in window. */
12993 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12994 hscroll
= max (0, (it
.current_x
12995 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12996 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12997 : (text_area_width
/ 2))))
12998 / FRAME_COLUMN_WIDTH (it
.f
);
12999 else if ((!row_r2l_p
13000 && w
->cursor
.x
>= text_area_width
- h_margin
)
13001 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
13003 if (hscroll_relative_p
)
13004 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
13007 wanted_x
= text_area_width
13008 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13011 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13015 if (hscroll_relative_p
)
13016 wanted_x
= text_area_width
* hscroll_step_rel
13019 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
13022 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
13024 hscroll
= max (hscroll
, w
->min_hscroll
);
13026 /* Don't prevent redisplay optimizations if hscroll
13027 hasn't changed, as it will unnecessarily slow down
13029 if (w
->hscroll
!= hscroll
)
13031 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13032 w
->hscroll
= hscroll
;
13041 /* Value is non-zero if hscroll of any leaf window has been changed. */
13042 return hscrolled_p
;
13046 /* Set hscroll so that cursor is visible and not inside horizontal
13047 scroll margins for all windows in the tree rooted at WINDOW. See
13048 also hscroll_window_tree above. Value is non-zero if any window's
13049 hscroll has been changed. If it has, desired matrices on the frame
13050 of WINDOW are cleared. */
13053 hscroll_windows (Lisp_Object window
)
13055 int hscrolled_p
= hscroll_window_tree (window
);
13057 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13058 return hscrolled_p
;
13063 /************************************************************************
13065 ************************************************************************/
13067 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13068 to a non-zero value. This is sometimes handy to have in a debugger
13073 /* First and last unchanged row for try_window_id. */
13075 static int debug_first_unchanged_at_end_vpos
;
13076 static int debug_last_unchanged_at_beg_vpos
;
13078 /* Delta vpos and y. */
13080 static int debug_dvpos
, debug_dy
;
13082 /* Delta in characters and bytes for try_window_id. */
13084 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13086 /* Values of window_end_pos and window_end_vpos at the end of
13089 static ptrdiff_t debug_end_vpos
;
13091 /* Append a string to W->desired_matrix->method. FMT is a printf
13092 format string. If trace_redisplay_p is true also printf the
13093 resulting string to stderr. */
13095 static void debug_method_add (struct window
*, char const *, ...)
13096 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13099 debug_method_add (struct window
*w
, char const *fmt
, ...)
13102 char *method
= w
->desired_matrix
->method
;
13103 int len
= strlen (method
);
13104 int size
= sizeof w
->desired_matrix
->method
;
13105 int remaining
= size
- len
- 1;
13108 if (len
&& remaining
)
13111 --remaining
, ++len
;
13114 va_start (ap
, fmt
);
13115 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13118 if (trace_redisplay_p
)
13119 fprintf (stderr
, "%p (%s): %s\n",
13121 ((BUFFERP (w
->contents
)
13122 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13123 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13128 #endif /* GLYPH_DEBUG */
13131 /* Value is non-zero if all changes in window W, which displays
13132 current_buffer, are in the text between START and END. START is a
13133 buffer position, END is given as a distance from Z. Used in
13134 redisplay_internal for display optimization. */
13137 text_outside_line_unchanged_p (struct window
*w
,
13138 ptrdiff_t start
, ptrdiff_t end
)
13140 int unchanged_p
= 1;
13142 /* If text or overlays have changed, see where. */
13143 if (window_outdated (w
))
13145 /* Gap in the line? */
13146 if (GPT
< start
|| Z
- GPT
< end
)
13149 /* Changes start in front of the line, or end after it? */
13151 && (BEG_UNCHANGED
< start
- 1
13152 || END_UNCHANGED
< end
))
13155 /* If selective display, can't optimize if changes start at the
13156 beginning of the line. */
13158 && INTEGERP (BVAR (current_buffer
, selective_display
))
13159 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13160 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13163 /* If there are overlays at the start or end of the line, these
13164 may have overlay strings with newlines in them. A change at
13165 START, for instance, may actually concern the display of such
13166 overlay strings as well, and they are displayed on different
13167 lines. So, quickly rule out this case. (For the future, it
13168 might be desirable to implement something more telling than
13169 just BEG/END_UNCHANGED.) */
13172 if (BEG
+ BEG_UNCHANGED
== start
13173 && overlay_touches_p (start
))
13175 if (END_UNCHANGED
== end
13176 && overlay_touches_p (Z
- end
))
13180 /* Under bidi reordering, adding or deleting a character in the
13181 beginning of a paragraph, before the first strong directional
13182 character, can change the base direction of the paragraph (unless
13183 the buffer specifies a fixed paragraph direction), which will
13184 require to redisplay the whole paragraph. It might be worthwhile
13185 to find the paragraph limits and widen the range of redisplayed
13186 lines to that, but for now just give up this optimization. */
13187 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13188 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13192 return unchanged_p
;
13196 /* Do a frame update, taking possible shortcuts into account. This is
13197 the main external entry point for redisplay.
13199 If the last redisplay displayed an echo area message and that message
13200 is no longer requested, we clear the echo area or bring back the
13201 mini-buffer if that is in use. */
13206 redisplay_internal ();
13211 overlay_arrow_string_or_property (Lisp_Object var
)
13215 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13218 return Voverlay_arrow_string
;
13221 /* Return 1 if there are any overlay-arrows in current_buffer. */
13223 overlay_arrow_in_current_buffer_p (void)
13227 for (vlist
= Voverlay_arrow_variable_list
;
13229 vlist
= XCDR (vlist
))
13231 Lisp_Object var
= XCAR (vlist
);
13234 if (!SYMBOLP (var
))
13236 val
= find_symbol_value (var
);
13238 && current_buffer
== XMARKER (val
)->buffer
)
13245 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13249 overlay_arrows_changed_p (void)
13253 for (vlist
= Voverlay_arrow_variable_list
;
13255 vlist
= XCDR (vlist
))
13257 Lisp_Object var
= XCAR (vlist
);
13258 Lisp_Object val
, pstr
;
13260 if (!SYMBOLP (var
))
13262 val
= find_symbol_value (var
);
13263 if (!MARKERP (val
))
13265 if (! EQ (COERCE_MARKER (val
),
13266 Fget (var
, Qlast_arrow_position
))
13267 || ! (pstr
= overlay_arrow_string_or_property (var
),
13268 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13274 /* Mark overlay arrows to be updated on next redisplay. */
13277 update_overlay_arrows (int up_to_date
)
13281 for (vlist
= Voverlay_arrow_variable_list
;
13283 vlist
= XCDR (vlist
))
13285 Lisp_Object var
= XCAR (vlist
);
13287 if (!SYMBOLP (var
))
13290 if (up_to_date
> 0)
13292 Lisp_Object val
= find_symbol_value (var
);
13293 Fput (var
, Qlast_arrow_position
,
13294 COERCE_MARKER (val
));
13295 Fput (var
, Qlast_arrow_string
,
13296 overlay_arrow_string_or_property (var
));
13298 else if (up_to_date
< 0
13299 || !NILP (Fget (var
, Qlast_arrow_position
)))
13301 Fput (var
, Qlast_arrow_position
, Qt
);
13302 Fput (var
, Qlast_arrow_string
, Qt
);
13308 /* Return overlay arrow string to display at row.
13309 Return integer (bitmap number) for arrow bitmap in left fringe.
13310 Return nil if no overlay arrow. */
13313 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13317 for (vlist
= Voverlay_arrow_variable_list
;
13319 vlist
= XCDR (vlist
))
13321 Lisp_Object var
= XCAR (vlist
);
13324 if (!SYMBOLP (var
))
13327 val
= find_symbol_value (var
);
13330 && current_buffer
== XMARKER (val
)->buffer
13331 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13333 if (FRAME_WINDOW_P (it
->f
)
13334 /* FIXME: if ROW->reversed_p is set, this should test
13335 the right fringe, not the left one. */
13336 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13338 #ifdef HAVE_WINDOW_SYSTEM
13339 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13342 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13343 return make_number (fringe_bitmap
);
13346 return make_number (-1); /* Use default arrow bitmap. */
13348 return overlay_arrow_string_or_property (var
);
13355 /* Return 1 if point moved out of or into a composition. Otherwise
13356 return 0. PREV_BUF and PREV_PT are the last point buffer and
13357 position. BUF and PT are the current point buffer and position. */
13360 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13361 struct buffer
*buf
, ptrdiff_t pt
)
13363 ptrdiff_t start
, end
;
13365 Lisp_Object buffer
;
13367 XSETBUFFER (buffer
, buf
);
13368 /* Check a composition at the last point if point moved within the
13370 if (prev_buf
== buf
)
13373 /* Point didn't move. */
13376 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13377 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13378 && composition_valid_p (start
, end
, prop
)
13379 && start
< prev_pt
&& end
> prev_pt
)
13380 /* The last point was within the composition. Return 1 iff
13381 point moved out of the composition. */
13382 return (pt
<= start
|| pt
>= end
);
13385 /* Check a composition at the current point. */
13386 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13387 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13388 && composition_valid_p (start
, end
, prop
)
13389 && start
< pt
&& end
> pt
);
13392 /* Reconsider the clip changes of buffer which is displayed in W. */
13395 reconsider_clip_changes (struct window
*w
)
13397 struct buffer
*b
= XBUFFER (w
->contents
);
13399 if (b
->clip_changed
13400 && w
->window_end_valid
13401 && w
->current_matrix
->buffer
== b
13402 && w
->current_matrix
->zv
== BUF_ZV (b
)
13403 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13404 b
->clip_changed
= 0;
13406 /* If display wasn't paused, and W is not a tool bar window, see if
13407 point has been moved into or out of a composition. In that case,
13408 we set b->clip_changed to 1 to force updating the screen. If
13409 b->clip_changed has already been set to 1, we can skip this
13411 if (!b
->clip_changed
&& w
->window_end_valid
)
13413 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13414 ? PT
: marker_position (w
->pointm
));
13416 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13417 && check_point_in_composition (w
->current_matrix
->buffer
,
13418 w
->last_point
, b
, pt
))
13419 b
->clip_changed
= 1;
13424 propagate_buffer_redisplay (void)
13425 { /* Resetting b->text->redisplay is problematic!
13426 We can't just reset it in the case that some window that displays
13427 it has not been redisplayed; and such a window can stay
13428 unredisplayed for a long time if it's currently invisible.
13429 But we do want to reset it at the end of redisplay otherwise
13430 its displayed windows will keep being redisplayed over and over
13432 So we copy all b->text->redisplay flags up to their windows here,
13433 such that mark_window_display_accurate can safely reset
13434 b->text->redisplay. */
13435 Lisp_Object ws
= window_list ();
13436 for (; CONSP (ws
); ws
= XCDR (ws
))
13438 struct window
*thisw
= XWINDOW (XCAR (ws
));
13439 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13440 if (thisb
->text
->redisplay
)
13441 thisw
->redisplay
= true;
13445 #define STOP_POLLING \
13446 do { if (! polling_stopped_here) stop_polling (); \
13447 polling_stopped_here = 1; } while (0)
13449 #define RESUME_POLLING \
13450 do { if (polling_stopped_here) start_polling (); \
13451 polling_stopped_here = 0; } while (0)
13454 /* Perhaps in the future avoid recentering windows if it
13455 is not necessary; currently that causes some problems. */
13458 redisplay_internal (void)
13460 struct window
*w
= XWINDOW (selected_window
);
13464 bool must_finish
= 0, match_p
;
13465 struct text_pos tlbufpos
, tlendpos
;
13466 int number_of_visible_frames
;
13469 int polling_stopped_here
= 0;
13470 Lisp_Object tail
, frame
;
13472 /* True means redisplay has to consider all windows on all
13473 frames. False, only selected_window is considered. */
13474 bool consider_all_windows_p
;
13476 /* True means redisplay has to redisplay the miniwindow. */
13477 bool update_miniwindow_p
= false;
13479 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13481 /* No redisplay if running in batch mode or frame is not yet fully
13482 initialized, or redisplay is explicitly turned off by setting
13483 Vinhibit_redisplay. */
13484 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13485 || !NILP (Vinhibit_redisplay
))
13488 /* Don't examine these until after testing Vinhibit_redisplay.
13489 When Emacs is shutting down, perhaps because its connection to
13490 X has dropped, we should not look at them at all. */
13491 fr
= XFRAME (w
->frame
);
13492 sf
= SELECTED_FRAME ();
13494 if (!fr
->glyphs_initialized_p
)
13497 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13498 if (popup_activated ())
13502 /* I don't think this happens but let's be paranoid. */
13503 if (redisplaying_p
)
13506 /* Record a function that clears redisplaying_p
13507 when we leave this function. */
13508 count
= SPECPDL_INDEX ();
13509 record_unwind_protect_void (unwind_redisplay
);
13510 redisplaying_p
= 1;
13511 specbind (Qinhibit_free_realized_faces
, Qnil
);
13513 /* Record this function, so it appears on the profiler's backtraces. */
13514 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13516 FOR_EACH_FRAME (tail
, frame
)
13517 XFRAME (frame
)->already_hscrolled_p
= 0;
13520 /* Remember the currently selected window. */
13524 last_escape_glyph_frame
= NULL
;
13525 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13526 last_glyphless_glyph_frame
= NULL
;
13527 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13529 /* If face_change_count is non-zero, init_iterator will free all
13530 realized faces, which includes the faces referenced from current
13531 matrices. So, we can't reuse current matrices in this case. */
13532 if (face_change_count
)
13533 windows_or_buffers_changed
= 47;
13535 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13536 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13538 /* Since frames on a single ASCII terminal share the same
13539 display area, displaying a different frame means redisplay
13540 the whole thing. */
13541 SET_FRAME_GARBAGED (sf
);
13543 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13545 FRAME_TTY (sf
)->previous_frame
= sf
;
13548 /* Set the visible flags for all frames. Do this before checking for
13549 resized or garbaged frames; they want to know if their frames are
13550 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13551 number_of_visible_frames
= 0;
13553 FOR_EACH_FRAME (tail
, frame
)
13555 struct frame
*f
= XFRAME (frame
);
13557 if (FRAME_VISIBLE_P (f
))
13559 ++number_of_visible_frames
;
13560 /* Adjust matrices for visible frames only. */
13561 if (f
->fonts_changed
)
13563 adjust_frame_glyphs (f
);
13564 f
->fonts_changed
= 0;
13566 /* If cursor type has been changed on the frame
13567 other than selected, consider all frames. */
13568 if (f
!= sf
&& f
->cursor_type_changed
)
13569 update_mode_lines
= 31;
13571 clear_desired_matrices (f
);
13574 /* Notice any pending interrupt request to change frame size. */
13575 do_pending_window_change (1);
13577 /* do_pending_window_change could change the selected_window due to
13578 frame resizing which makes the selected window too small. */
13579 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13582 /* Clear frames marked as garbaged. */
13583 clear_garbaged_frames ();
13585 /* Build menubar and tool-bar items. */
13586 if (NILP (Vmemory_full
))
13587 prepare_menu_bars ();
13589 reconsider_clip_changes (w
);
13591 /* In most cases selected window displays current buffer. */
13592 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13595 /* Detect case that we need to write or remove a star in the mode line. */
13596 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13597 w
->update_mode_line
= 1;
13599 if (mode_line_update_needed (w
))
13600 w
->update_mode_line
= 1;
13602 /* If reconsider_clip_changes above decided that the narrowing
13603 in the current buffer changed, make sure all other windows
13604 showing that buffer will be redisplayed. */
13605 if (current_buffer
->clip_changed
)
13606 bset_update_mode_line (current_buffer
);
13609 /* Normally the message* functions will have already displayed and
13610 updated the echo area, but the frame may have been trashed, or
13611 the update may have been preempted, so display the echo area
13612 again here. Checking message_cleared_p captures the case that
13613 the echo area should be cleared. */
13614 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13615 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13616 || (message_cleared_p
13617 && minibuf_level
== 0
13618 /* If the mini-window is currently selected, this means the
13619 echo-area doesn't show through. */
13620 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13622 int window_height_changed_p
= echo_area_display (0);
13624 if (message_cleared_p
)
13625 update_miniwindow_p
= true;
13629 /* If we don't display the current message, don't clear the
13630 message_cleared_p flag, because, if we did, we wouldn't clear
13631 the echo area in the next redisplay which doesn't preserve
13633 if (!display_last_displayed_message_p
)
13634 message_cleared_p
= 0;
13636 if (window_height_changed_p
)
13638 windows_or_buffers_changed
= 50;
13640 /* If window configuration was changed, frames may have been
13641 marked garbaged. Clear them or we will experience
13642 surprises wrt scrolling. */
13643 clear_garbaged_frames ();
13646 else if (EQ (selected_window
, minibuf_window
)
13647 && (current_buffer
->clip_changed
|| window_outdated (w
))
13648 && resize_mini_window (w
, 0))
13650 /* Resized active mini-window to fit the size of what it is
13651 showing if its contents might have changed. */
13654 /* If window configuration was changed, frames may have been
13655 marked garbaged. Clear them or we will experience
13656 surprises wrt scrolling. */
13657 clear_garbaged_frames ();
13660 if (windows_or_buffers_changed
&& !update_mode_lines
)
13661 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13662 only the windows's contents needs to be refreshed, or whether the
13663 mode-lines also need a refresh. */
13664 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13665 ? REDISPLAY_SOME
: 32);
13667 /* If specs for an arrow have changed, do thorough redisplay
13668 to ensure we remove any arrow that should no longer exist. */
13669 if (overlay_arrows_changed_p ())
13670 /* Apparently, this is the only case where we update other windows,
13671 without updating other mode-lines. */
13672 windows_or_buffers_changed
= 49;
13674 consider_all_windows_p
= (update_mode_lines
13675 || windows_or_buffers_changed
);
13677 #define AINC(a,i) \
13678 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13679 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13681 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13682 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13684 /* Optimize the case that only the line containing the cursor in the
13685 selected window has changed. Variables starting with this_ are
13686 set in display_line and record information about the line
13687 containing the cursor. */
13688 tlbufpos
= this_line_start_pos
;
13689 tlendpos
= this_line_end_pos
;
13690 if (!consider_all_windows_p
13691 && CHARPOS (tlbufpos
) > 0
13692 && !w
->update_mode_line
13693 && !current_buffer
->clip_changed
13694 && !current_buffer
->prevent_redisplay_optimizations_p
13695 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13696 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13697 && !XFRAME (w
->frame
)->cursor_type_changed
13698 /* Make sure recorded data applies to current buffer, etc. */
13699 && this_line_buffer
== current_buffer
13702 && !w
->optional_new_start
13703 /* Point must be on the line that we have info recorded about. */
13704 && PT
>= CHARPOS (tlbufpos
)
13705 && PT
<= Z
- CHARPOS (tlendpos
)
13706 /* All text outside that line, including its final newline,
13707 must be unchanged. */
13708 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13709 CHARPOS (tlendpos
)))
13711 if (CHARPOS (tlbufpos
) > BEGV
13712 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13713 && (CHARPOS (tlbufpos
) == ZV
13714 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13715 /* Former continuation line has disappeared by becoming empty. */
13717 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13719 /* We have to handle the case of continuation around a
13720 wide-column character (see the comment in indent.c around
13723 For instance, in the following case:
13725 -------- Insert --------
13726 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13727 J_I_ ==> J_I_ `^^' are cursors.
13731 As we have to redraw the line above, we cannot use this
13735 int line_height_before
= this_line_pixel_height
;
13737 /* Note that start_display will handle the case that the
13738 line starting at tlbufpos is a continuation line. */
13739 start_display (&it
, w
, tlbufpos
);
13741 /* Implementation note: It this still necessary? */
13742 if (it
.current_x
!= this_line_start_x
)
13745 TRACE ((stderr
, "trying display optimization 1\n"));
13746 w
->cursor
.vpos
= -1;
13747 overlay_arrow_seen
= 0;
13748 it
.vpos
= this_line_vpos
;
13749 it
.current_y
= this_line_y
;
13750 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13751 display_line (&it
);
13753 /* If line contains point, is not continued,
13754 and ends at same distance from eob as before, we win. */
13755 if (w
->cursor
.vpos
>= 0
13756 /* Line is not continued, otherwise this_line_start_pos
13757 would have been set to 0 in display_line. */
13758 && CHARPOS (this_line_start_pos
)
13759 /* Line ends as before. */
13760 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13761 /* Line has same height as before. Otherwise other lines
13762 would have to be shifted up or down. */
13763 && this_line_pixel_height
== line_height_before
)
13765 /* If this is not the window's last line, we must adjust
13766 the charstarts of the lines below. */
13767 if (it
.current_y
< it
.last_visible_y
)
13769 struct glyph_row
*row
13770 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13771 ptrdiff_t delta
, delta_bytes
;
13773 /* We used to distinguish between two cases here,
13774 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13775 when the line ends in a newline or the end of the
13776 buffer's accessible portion. But both cases did
13777 the same, so they were collapsed. */
13779 - CHARPOS (tlendpos
)
13780 - MATRIX_ROW_START_CHARPOS (row
));
13781 delta_bytes
= (Z_BYTE
13782 - BYTEPOS (tlendpos
)
13783 - MATRIX_ROW_START_BYTEPOS (row
));
13785 increment_matrix_positions (w
->current_matrix
,
13786 this_line_vpos
+ 1,
13787 w
->current_matrix
->nrows
,
13788 delta
, delta_bytes
);
13791 /* If this row displays text now but previously didn't,
13792 or vice versa, w->window_end_vpos may have to be
13794 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13796 if (w
->window_end_vpos
< this_line_vpos
)
13797 w
->window_end_vpos
= this_line_vpos
;
13799 else if (w
->window_end_vpos
== this_line_vpos
13800 && this_line_vpos
> 0)
13801 w
->window_end_vpos
= this_line_vpos
- 1;
13802 w
->window_end_valid
= 0;
13804 /* Update hint: No need to try to scroll in update_window. */
13805 w
->desired_matrix
->no_scrolling_p
= 1;
13808 *w
->desired_matrix
->method
= 0;
13809 debug_method_add (w
, "optimization 1");
13811 #ifdef HAVE_WINDOW_SYSTEM
13812 update_window_fringes (w
, 0);
13819 else if (/* Cursor position hasn't changed. */
13820 PT
== w
->last_point
13821 /* Make sure the cursor was last displayed
13822 in this window. Otherwise we have to reposition it. */
13824 /* PXW: Must be converted to pixels, probably. */
13825 && 0 <= w
->cursor
.vpos
13826 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13830 do_pending_window_change (1);
13831 /* If selected_window changed, redisplay again. */
13832 if (WINDOWP (selected_window
)
13833 && (w
= XWINDOW (selected_window
)) != sw
)
13836 /* We used to always goto end_of_redisplay here, but this
13837 isn't enough if we have a blinking cursor. */
13838 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13839 goto end_of_redisplay
;
13843 /* If highlighting the region, or if the cursor is in the echo area,
13844 then we can't just move the cursor. */
13845 else if (NILP (Vshow_trailing_whitespace
)
13846 && !cursor_in_echo_area
)
13849 struct glyph_row
*row
;
13851 /* Skip from tlbufpos to PT and see where it is. Note that
13852 PT may be in invisible text. If so, we will end at the
13853 next visible position. */
13854 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13855 NULL
, DEFAULT_FACE_ID
);
13856 it
.current_x
= this_line_start_x
;
13857 it
.current_y
= this_line_y
;
13858 it
.vpos
= this_line_vpos
;
13860 /* The call to move_it_to stops in front of PT, but
13861 moves over before-strings. */
13862 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13864 if (it
.vpos
== this_line_vpos
13865 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13868 eassert (this_line_vpos
== it
.vpos
);
13869 eassert (this_line_y
== it
.current_y
);
13870 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13872 *w
->desired_matrix
->method
= 0;
13873 debug_method_add (w
, "optimization 3");
13882 /* Text changed drastically or point moved off of line. */
13883 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13886 CHARPOS (this_line_start_pos
) = 0;
13887 ++clear_face_cache_count
;
13888 #ifdef HAVE_WINDOW_SYSTEM
13889 ++clear_image_cache_count
;
13892 /* Build desired matrices, and update the display. If
13893 consider_all_windows_p is non-zero, do it for all windows on all
13894 frames. Otherwise do it for selected_window, only. */
13896 if (consider_all_windows_p
)
13898 FOR_EACH_FRAME (tail
, frame
)
13899 XFRAME (frame
)->updated_p
= 0;
13901 propagate_buffer_redisplay ();
13903 FOR_EACH_FRAME (tail
, frame
)
13905 struct frame
*f
= XFRAME (frame
);
13907 /* We don't have to do anything for unselected terminal
13909 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13910 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13915 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13918 /* Only GC scrollbars when we redisplay the whole frame. */
13919 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13920 /* Mark all the scroll bars to be removed; we'll redeem
13921 the ones we want when we redisplay their windows. */
13922 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13923 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13925 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13926 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13927 /* Remember that the invisible frames need to be redisplayed next
13928 time they're visible. */
13929 else if (!REDISPLAY_SOME_P ())
13930 f
->redisplay
= true;
13932 /* The X error handler may have deleted that frame. */
13933 if (!FRAME_LIVE_P (f
))
13936 /* Any scroll bars which redisplay_windows should have
13937 nuked should now go away. */
13938 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13939 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13941 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13943 /* If fonts changed on visible frame, display again. */
13944 if (f
->fonts_changed
)
13946 adjust_frame_glyphs (f
);
13947 f
->fonts_changed
= 0;
13951 /* See if we have to hscroll. */
13952 if (!f
->already_hscrolled_p
)
13954 f
->already_hscrolled_p
= 1;
13955 if (hscroll_windows (f
->root_window
))
13959 /* Prevent various kinds of signals during display
13960 update. stdio is not robust about handling
13961 signals, which can cause an apparent I/O error. */
13962 if (interrupt_input
)
13963 unrequest_sigio ();
13966 pending
|= update_frame (f
, 0, 0);
13967 f
->cursor_type_changed
= 0;
13973 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13977 /* Do the mark_window_display_accurate after all windows have
13978 been redisplayed because this call resets flags in buffers
13979 which are needed for proper redisplay. */
13980 FOR_EACH_FRAME (tail
, frame
)
13982 struct frame
*f
= XFRAME (frame
);
13985 f
->redisplay
= false;
13986 mark_window_display_accurate (f
->root_window
, 1);
13987 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13988 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13993 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13995 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13996 struct frame
*mini_frame
;
13998 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13999 /* Use list_of_error, not Qerror, so that
14000 we catch only errors and don't run the debugger. */
14001 internal_condition_case_1 (redisplay_window_1
, selected_window
,
14003 redisplay_window_error
);
14004 if (update_miniwindow_p
)
14005 internal_condition_case_1 (redisplay_window_1
, mini_window
,
14007 redisplay_window_error
);
14009 /* Compare desired and current matrices, perform output. */
14012 /* If fonts changed, display again. */
14013 if (sf
->fonts_changed
)
14016 /* Prevent various kinds of signals during display update.
14017 stdio is not robust about handling signals,
14018 which can cause an apparent I/O error. */
14019 if (interrupt_input
)
14020 unrequest_sigio ();
14023 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14025 if (hscroll_windows (selected_window
))
14028 XWINDOW (selected_window
)->must_be_updated_p
= true;
14029 pending
= update_frame (sf
, 0, 0);
14030 sf
->cursor_type_changed
= 0;
14033 /* We may have called echo_area_display at the top of this
14034 function. If the echo area is on another frame, that may
14035 have put text on a frame other than the selected one, so the
14036 above call to update_frame would not have caught it. Catch
14038 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14039 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14041 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14043 XWINDOW (mini_window
)->must_be_updated_p
= true;
14044 pending
|= update_frame (mini_frame
, 0, 0);
14045 mini_frame
->cursor_type_changed
= 0;
14046 if (!pending
&& hscroll_windows (mini_window
))
14051 /* If display was paused because of pending input, make sure we do a
14052 thorough update the next time. */
14055 /* Prevent the optimization at the beginning of
14056 redisplay_internal that tries a single-line update of the
14057 line containing the cursor in the selected window. */
14058 CHARPOS (this_line_start_pos
) = 0;
14060 /* Let the overlay arrow be updated the next time. */
14061 update_overlay_arrows (0);
14063 /* If we pause after scrolling, some rows in the current
14064 matrices of some windows are not valid. */
14065 if (!WINDOW_FULL_WIDTH_P (w
)
14066 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14067 update_mode_lines
= 36;
14071 if (!consider_all_windows_p
)
14073 /* This has already been done above if
14074 consider_all_windows_p is set. */
14075 if (XBUFFER (w
->contents
)->text
->redisplay
14076 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14077 /* This can happen if b->text->redisplay was set during
14079 propagate_buffer_redisplay ();
14080 mark_window_display_accurate_1 (w
, 1);
14082 /* Say overlay arrows are up to date. */
14083 update_overlay_arrows (1);
14085 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14086 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14089 update_mode_lines
= 0;
14090 windows_or_buffers_changed
= 0;
14093 /* Start SIGIO interrupts coming again. Having them off during the
14094 code above makes it less likely one will discard output, but not
14095 impossible, since there might be stuff in the system buffer here.
14096 But it is much hairier to try to do anything about that. */
14097 if (interrupt_input
)
14101 /* If a frame has become visible which was not before, redisplay
14102 again, so that we display it. Expose events for such a frame
14103 (which it gets when becoming visible) don't call the parts of
14104 redisplay constructing glyphs, so simply exposing a frame won't
14105 display anything in this case. So, we have to display these
14106 frames here explicitly. */
14111 FOR_EACH_FRAME (tail
, frame
)
14113 if (XFRAME (frame
)->visible
)
14117 if (new_count
!= number_of_visible_frames
)
14118 windows_or_buffers_changed
= 52;
14121 /* Change frame size now if a change is pending. */
14122 do_pending_window_change (1);
14124 /* If we just did a pending size change, or have additional
14125 visible frames, or selected_window changed, redisplay again. */
14126 if ((windows_or_buffers_changed
&& !pending
)
14127 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14130 /* Clear the face and image caches.
14132 We used to do this only if consider_all_windows_p. But the cache
14133 needs to be cleared if a timer creates images in the current
14134 buffer (e.g. the test case in Bug#6230). */
14136 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14138 clear_face_cache (0);
14139 clear_face_cache_count
= 0;
14142 #ifdef HAVE_WINDOW_SYSTEM
14143 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14145 clear_image_caches (Qnil
);
14146 clear_image_cache_count
= 0;
14148 #endif /* HAVE_WINDOW_SYSTEM */
14151 if (interrupt_input
&& interrupts_deferred
)
14154 unbind_to (count
, Qnil
);
14159 /* Redisplay, but leave alone any recent echo area message unless
14160 another message has been requested in its place.
14162 This is useful in situations where you need to redisplay but no
14163 user action has occurred, making it inappropriate for the message
14164 area to be cleared. See tracking_off and
14165 wait_reading_process_output for examples of these situations.
14167 FROM_WHERE is an integer saying from where this function was
14168 called. This is useful for debugging. */
14171 redisplay_preserve_echo_area (int from_where
)
14173 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14175 if (!NILP (echo_area_buffer
[1]))
14177 /* We have a previously displayed message, but no current
14178 message. Redisplay the previous message. */
14179 display_last_displayed_message_p
= 1;
14180 redisplay_internal ();
14181 display_last_displayed_message_p
= 0;
14184 redisplay_internal ();
14186 flush_frame (SELECTED_FRAME ());
14190 /* Function registered with record_unwind_protect in redisplay_internal. */
14193 unwind_redisplay (void)
14195 redisplaying_p
= 0;
14199 /* Mark the display of leaf window W as accurate or inaccurate.
14200 If ACCURATE_P is non-zero mark display of W as accurate. If
14201 ACCURATE_P is zero, arrange for W to be redisplayed the next
14202 time redisplay_internal is called. */
14205 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14207 struct buffer
*b
= XBUFFER (w
->contents
);
14209 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14210 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14211 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14215 b
->clip_changed
= false;
14216 b
->prevent_redisplay_optimizations_p
= false;
14217 eassert (buffer_window_count (b
) > 0);
14218 /* Resetting b->text->redisplay is problematic!
14219 In order to make it safer to do it here, redisplay_internal must
14220 have copied all b->text->redisplay to their respective windows. */
14221 b
->text
->redisplay
= false;
14223 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14224 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14225 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14226 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14228 w
->current_matrix
->buffer
= b
;
14229 w
->current_matrix
->begv
= BUF_BEGV (b
);
14230 w
->current_matrix
->zv
= BUF_ZV (b
);
14232 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14233 w
->last_cursor_off_p
= w
->cursor_off_p
;
14235 if (w
== XWINDOW (selected_window
))
14236 w
->last_point
= BUF_PT (b
);
14238 w
->last_point
= marker_position (w
->pointm
);
14240 w
->window_end_valid
= true;
14241 w
->update_mode_line
= false;
14244 w
->redisplay
= !accurate_p
;
14248 /* Mark the display of windows in the window tree rooted at WINDOW as
14249 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14250 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14251 be redisplayed the next time redisplay_internal is called. */
14254 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14258 for (; !NILP (window
); window
= w
->next
)
14260 w
= XWINDOW (window
);
14261 if (WINDOWP (w
->contents
))
14262 mark_window_display_accurate (w
->contents
, accurate_p
);
14264 mark_window_display_accurate_1 (w
, accurate_p
);
14268 update_overlay_arrows (1);
14270 /* Force a thorough redisplay the next time by setting
14271 last_arrow_position and last_arrow_string to t, which is
14272 unequal to any useful value of Voverlay_arrow_... */
14273 update_overlay_arrows (-1);
14277 /* Return value in display table DP (Lisp_Char_Table *) for character
14278 C. Since a display table doesn't have any parent, we don't have to
14279 follow parent. Do not call this function directly but use the
14280 macro DISP_CHAR_VECTOR. */
14283 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14287 if (ASCII_CHAR_P (c
))
14290 if (SUB_CHAR_TABLE_P (val
))
14291 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14297 XSETCHAR_TABLE (table
, dp
);
14298 val
= char_table_ref (table
, c
);
14307 /***********************************************************************
14309 ***********************************************************************/
14311 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14314 redisplay_windows (Lisp_Object window
)
14316 while (!NILP (window
))
14318 struct window
*w
= XWINDOW (window
);
14320 if (WINDOWP (w
->contents
))
14321 redisplay_windows (w
->contents
);
14322 else if (BUFFERP (w
->contents
))
14324 displayed_buffer
= XBUFFER (w
->contents
);
14325 /* Use list_of_error, not Qerror, so that
14326 we catch only errors and don't run the debugger. */
14327 internal_condition_case_1 (redisplay_window_0
, window
,
14329 redisplay_window_error
);
14337 redisplay_window_error (Lisp_Object ignore
)
14339 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14344 redisplay_window_0 (Lisp_Object window
)
14346 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14347 redisplay_window (window
, false);
14352 redisplay_window_1 (Lisp_Object window
)
14354 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14355 redisplay_window (window
, true);
14360 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14361 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14362 which positions recorded in ROW differ from current buffer
14365 Return 0 if cursor is not on this row, 1 otherwise. */
14368 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14369 struct glyph_matrix
*matrix
,
14370 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14373 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14374 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14375 struct glyph
*cursor
= NULL
;
14376 /* The last known character position in row. */
14377 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14379 ptrdiff_t pt_old
= PT
- delta
;
14380 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14381 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14382 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14383 /* A glyph beyond the edge of TEXT_AREA which we should never
14385 struct glyph
*glyphs_end
= end
;
14386 /* Non-zero means we've found a match for cursor position, but that
14387 glyph has the avoid_cursor_p flag set. */
14388 int match_with_avoid_cursor
= 0;
14389 /* Non-zero means we've seen at least one glyph that came from a
14391 int string_seen
= 0;
14392 /* Largest and smallest buffer positions seen so far during scan of
14394 ptrdiff_t bpos_max
= pos_before
;
14395 ptrdiff_t bpos_min
= pos_after
;
14396 /* Last buffer position covered by an overlay string with an integer
14397 `cursor' property. */
14398 ptrdiff_t bpos_covered
= 0;
14399 /* Non-zero means the display string on which to display the cursor
14400 comes from a text property, not from an overlay. */
14401 int string_from_text_prop
= 0;
14403 /* Don't even try doing anything if called for a mode-line or
14404 header-line row, since the rest of the code isn't prepared to
14405 deal with such calamities. */
14406 eassert (!row
->mode_line_p
);
14407 if (row
->mode_line_p
)
14410 /* Skip over glyphs not having an object at the start and the end of
14411 the row. These are special glyphs like truncation marks on
14412 terminal frames. */
14413 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14415 if (!row
->reversed_p
)
14418 && INTEGERP (glyph
->object
)
14419 && glyph
->charpos
< 0)
14421 x
+= glyph
->pixel_width
;
14425 && INTEGERP ((end
- 1)->object
)
14426 /* CHARPOS is zero for blanks and stretch glyphs
14427 inserted by extend_face_to_end_of_line. */
14428 && (end
- 1)->charpos
<= 0)
14430 glyph_before
= glyph
- 1;
14437 /* If the glyph row is reversed, we need to process it from back
14438 to front, so swap the edge pointers. */
14439 glyphs_end
= end
= glyph
- 1;
14440 glyph
+= row
->used
[TEXT_AREA
] - 1;
14442 while (glyph
> end
+ 1
14443 && INTEGERP (glyph
->object
)
14444 && glyph
->charpos
< 0)
14447 x
-= glyph
->pixel_width
;
14449 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14451 /* By default, in reversed rows we put the cursor on the
14452 rightmost (first in the reading order) glyph. */
14453 for (g
= end
+ 1; g
< glyph
; g
++)
14454 x
+= g
->pixel_width
;
14456 && INTEGERP ((end
+ 1)->object
)
14457 && (end
+ 1)->charpos
<= 0)
14459 glyph_before
= glyph
+ 1;
14463 else if (row
->reversed_p
)
14465 /* In R2L rows that don't display text, put the cursor on the
14466 rightmost glyph. Case in point: an empty last line that is
14467 part of an R2L paragraph. */
14469 /* Avoid placing the cursor on the last glyph of the row, where
14470 on terminal frames we hold the vertical border between
14471 adjacent windows. */
14472 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14473 && !WINDOW_RIGHTMOST_P (w
)
14474 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14476 x
= -1; /* will be computed below, at label compute_x */
14479 /* Step 1: Try to find the glyph whose character position
14480 corresponds to point. If that's not possible, find 2 glyphs
14481 whose character positions are the closest to point, one before
14482 point, the other after it. */
14483 if (!row
->reversed_p
)
14484 while (/* not marched to end of glyph row */
14486 /* glyph was not inserted by redisplay for internal purposes */
14487 && !INTEGERP (glyph
->object
))
14489 if (BUFFERP (glyph
->object
))
14491 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14493 if (glyph
->charpos
> bpos_max
)
14494 bpos_max
= glyph
->charpos
;
14495 if (glyph
->charpos
< bpos_min
)
14496 bpos_min
= glyph
->charpos
;
14497 if (!glyph
->avoid_cursor_p
)
14499 /* If we hit point, we've found the glyph on which to
14500 display the cursor. */
14503 match_with_avoid_cursor
= 0;
14506 /* See if we've found a better approximation to
14507 POS_BEFORE or to POS_AFTER. */
14508 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14510 pos_before
= glyph
->charpos
;
14511 glyph_before
= glyph
;
14513 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14515 pos_after
= glyph
->charpos
;
14516 glyph_after
= glyph
;
14519 else if (dpos
== 0)
14520 match_with_avoid_cursor
= 1;
14522 else if (STRINGP (glyph
->object
))
14524 Lisp_Object chprop
;
14525 ptrdiff_t glyph_pos
= glyph
->charpos
;
14527 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14529 if (!NILP (chprop
))
14531 /* If the string came from a `display' text property,
14532 look up the buffer position of that property and
14533 use that position to update bpos_max, as if we
14534 actually saw such a position in one of the row's
14535 glyphs. This helps with supporting integer values
14536 of `cursor' property on the display string in
14537 situations where most or all of the row's buffer
14538 text is completely covered by display properties,
14539 so that no glyph with valid buffer positions is
14540 ever seen in the row. */
14541 ptrdiff_t prop_pos
=
14542 string_buffer_position_lim (glyph
->object
, pos_before
,
14545 if (prop_pos
>= pos_before
)
14546 bpos_max
= prop_pos
;
14548 if (INTEGERP (chprop
))
14550 bpos_covered
= bpos_max
+ XINT (chprop
);
14551 /* If the `cursor' property covers buffer positions up
14552 to and including point, we should display cursor on
14553 this glyph. Note that, if a `cursor' property on one
14554 of the string's characters has an integer value, we
14555 will break out of the loop below _before_ we get to
14556 the position match above. IOW, integer values of
14557 the `cursor' property override the "exact match for
14558 point" strategy of positioning the cursor. */
14559 /* Implementation note: bpos_max == pt_old when, e.g.,
14560 we are in an empty line, where bpos_max is set to
14561 MATRIX_ROW_START_CHARPOS, see above. */
14562 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14571 x
+= glyph
->pixel_width
;
14574 else if (glyph
> end
) /* row is reversed */
14575 while (!INTEGERP (glyph
->object
))
14577 if (BUFFERP (glyph
->object
))
14579 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14581 if (glyph
->charpos
> bpos_max
)
14582 bpos_max
= glyph
->charpos
;
14583 if (glyph
->charpos
< bpos_min
)
14584 bpos_min
= glyph
->charpos
;
14585 if (!glyph
->avoid_cursor_p
)
14589 match_with_avoid_cursor
= 0;
14592 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14594 pos_before
= glyph
->charpos
;
14595 glyph_before
= glyph
;
14597 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14599 pos_after
= glyph
->charpos
;
14600 glyph_after
= glyph
;
14603 else if (dpos
== 0)
14604 match_with_avoid_cursor
= 1;
14606 else if (STRINGP (glyph
->object
))
14608 Lisp_Object chprop
;
14609 ptrdiff_t glyph_pos
= glyph
->charpos
;
14611 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14613 if (!NILP (chprop
))
14615 ptrdiff_t prop_pos
=
14616 string_buffer_position_lim (glyph
->object
, pos_before
,
14619 if (prop_pos
>= pos_before
)
14620 bpos_max
= prop_pos
;
14622 if (INTEGERP (chprop
))
14624 bpos_covered
= bpos_max
+ XINT (chprop
);
14625 /* If the `cursor' property covers buffer positions up
14626 to and including point, we should display cursor on
14628 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14637 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14639 x
--; /* can't use any pixel_width */
14642 x
-= glyph
->pixel_width
;
14645 /* Step 2: If we didn't find an exact match for point, we need to
14646 look for a proper place to put the cursor among glyphs between
14647 GLYPH_BEFORE and GLYPH_AFTER. */
14648 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14649 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14650 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14652 /* An empty line has a single glyph whose OBJECT is zero and
14653 whose CHARPOS is the position of a newline on that line.
14654 Note that on a TTY, there are more glyphs after that, which
14655 were produced by extend_face_to_end_of_line, but their
14656 CHARPOS is zero or negative. */
14658 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14659 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14660 /* On a TTY, continued and truncated rows also have a glyph at
14661 their end whose OBJECT is zero and whose CHARPOS is
14662 positive (the continuation and truncation glyphs), but such
14663 rows are obviously not "empty". */
14664 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14666 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14668 ptrdiff_t ellipsis_pos
;
14670 /* Scan back over the ellipsis glyphs. */
14671 if (!row
->reversed_p
)
14673 ellipsis_pos
= (glyph
- 1)->charpos
;
14674 while (glyph
> row
->glyphs
[TEXT_AREA
]
14675 && (glyph
- 1)->charpos
== ellipsis_pos
)
14676 glyph
--, x
-= glyph
->pixel_width
;
14677 /* That loop always goes one position too far, including
14678 the glyph before the ellipsis. So scan forward over
14680 x
+= glyph
->pixel_width
;
14683 else /* row is reversed */
14685 ellipsis_pos
= (glyph
+ 1)->charpos
;
14686 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14687 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14688 glyph
++, x
+= glyph
->pixel_width
;
14689 x
-= glyph
->pixel_width
;
14693 else if (match_with_avoid_cursor
)
14695 cursor
= glyph_after
;
14698 else if (string_seen
)
14700 int incr
= row
->reversed_p
? -1 : +1;
14702 /* Need to find the glyph that came out of a string which is
14703 present at point. That glyph is somewhere between
14704 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14705 positioned between POS_BEFORE and POS_AFTER in the
14707 struct glyph
*start
, *stop
;
14708 ptrdiff_t pos
= pos_before
;
14712 /* If the row ends in a newline from a display string,
14713 reordering could have moved the glyphs belonging to the
14714 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14715 in this case we extend the search to the last glyph in
14716 the row that was not inserted by redisplay. */
14717 if (row
->ends_in_newline_from_string_p
)
14720 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14723 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14724 correspond to POS_BEFORE and POS_AFTER, respectively. We
14725 need START and STOP in the order that corresponds to the
14726 row's direction as given by its reversed_p flag. If the
14727 directionality of characters between POS_BEFORE and
14728 POS_AFTER is the opposite of the row's base direction,
14729 these characters will have been reordered for display,
14730 and we need to reverse START and STOP. */
14731 if (!row
->reversed_p
)
14733 start
= min (glyph_before
, glyph_after
);
14734 stop
= max (glyph_before
, glyph_after
);
14738 start
= max (glyph_before
, glyph_after
);
14739 stop
= min (glyph_before
, glyph_after
);
14741 for (glyph
= start
+ incr
;
14742 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14745 /* Any glyphs that come from the buffer are here because
14746 of bidi reordering. Skip them, and only pay
14747 attention to glyphs that came from some string. */
14748 if (STRINGP (glyph
->object
))
14752 /* If the display property covers the newline, we
14753 need to search for it one position farther. */
14754 ptrdiff_t lim
= pos_after
14755 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14757 string_from_text_prop
= 0;
14758 str
= glyph
->object
;
14759 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14760 if (tem
== 0 /* from overlay */
14763 /* If the string from which this glyph came is
14764 found in the buffer at point, or at position
14765 that is closer to point than pos_after, then
14766 we've found the glyph we've been looking for.
14767 If it comes from an overlay (tem == 0), and
14768 it has the `cursor' property on one of its
14769 glyphs, record that glyph as a candidate for
14770 displaying the cursor. (As in the
14771 unidirectional version, we will display the
14772 cursor on the last candidate we find.) */
14775 || (tem
- pt_old
> 0 && tem
< pos_after
))
14777 /* The glyphs from this string could have
14778 been reordered. Find the one with the
14779 smallest string position. Or there could
14780 be a character in the string with the
14781 `cursor' property, which means display
14782 cursor on that character's glyph. */
14783 ptrdiff_t strpos
= glyph
->charpos
;
14788 string_from_text_prop
= 1;
14791 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14792 && EQ (glyph
->object
, str
);
14796 ptrdiff_t gpos
= glyph
->charpos
;
14798 cprop
= Fget_char_property (make_number (gpos
),
14806 if (tem
&& glyph
->charpos
< strpos
)
14808 strpos
= glyph
->charpos
;
14814 || (tem
- pt_old
> 0 && tem
< pos_after
))
14818 pos
= tem
+ 1; /* don't find previous instances */
14820 /* This string is not what we want; skip all of the
14821 glyphs that came from it. */
14822 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14823 && EQ (glyph
->object
, str
))
14830 /* If we reached the end of the line, and END was from a string,
14831 the cursor is not on this line. */
14833 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14834 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14835 && STRINGP (end
->object
)
14836 && row
->continued_p
)
14839 /* A truncated row may not include PT among its character positions.
14840 Setting the cursor inside the scroll margin will trigger
14841 recalculation of hscroll in hscroll_window_tree. But if a
14842 display string covers point, defer to the string-handling
14843 code below to figure this out. */
14844 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14846 cursor
= glyph_before
;
14849 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14850 /* Zero-width characters produce no glyphs. */
14852 && (row
->reversed_p
14853 ? glyph_after
> glyphs_end
14854 : glyph_after
< glyphs_end
)))
14856 cursor
= glyph_after
;
14862 if (cursor
!= NULL
)
14864 else if (glyph
== glyphs_end
14865 && pos_before
== pos_after
14866 && STRINGP ((row
->reversed_p
14867 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14868 : row
->glyphs
[TEXT_AREA
])->object
))
14870 /* If all the glyphs of this row came from strings, put the
14871 cursor on the first glyph of the row. This avoids having the
14872 cursor outside of the text area in this very rare and hard
14876 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14877 : row
->glyphs
[TEXT_AREA
];
14883 /* Need to compute x that corresponds to GLYPH. */
14884 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14886 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14888 x
+= g
->pixel_width
;
14892 /* ROW could be part of a continued line, which, under bidi
14893 reordering, might have other rows whose start and end charpos
14894 occlude point. Only set w->cursor if we found a better
14895 approximation to the cursor position than we have from previously
14896 examined candidate rows belonging to the same continued line. */
14897 if (/* We already have a candidate row. */
14898 w
->cursor
.vpos
>= 0
14899 /* That candidate is not the row we are processing. */
14900 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14901 /* Make sure cursor.vpos specifies a row whose start and end
14902 charpos occlude point, and it is valid candidate for being a
14903 cursor-row. This is because some callers of this function
14904 leave cursor.vpos at the row where the cursor was displayed
14905 during the last redisplay cycle. */
14906 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14907 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14908 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14911 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14913 /* Don't consider glyphs that are outside TEXT_AREA. */
14914 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14916 /* Keep the candidate whose buffer position is the closest to
14917 point or has the `cursor' property. */
14918 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14919 w
->cursor
.hpos
>= 0
14920 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14921 && ((BUFFERP (g1
->object
)
14922 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14923 || (BUFFERP (glyph
->object
)
14924 && eabs (g1
->charpos
- pt_old
)
14925 < eabs (glyph
->charpos
- pt_old
))))
14926 /* Previous candidate is a glyph from a string that has
14927 a non-nil `cursor' property. */
14928 || (STRINGP (g1
->object
)
14929 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14930 Qcursor
, g1
->object
))
14931 /* Previous candidate is from the same display
14932 string as this one, and the display string
14933 came from a text property. */
14934 || (EQ (g1
->object
, glyph
->object
)
14935 && string_from_text_prop
)
14936 /* this candidate is from newline and its
14937 position is not an exact match */
14938 || (INTEGERP (glyph
->object
)
14939 && glyph
->charpos
!= pt_old
)))))
14941 /* If this candidate gives an exact match, use that. */
14942 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14943 /* If this candidate is a glyph created for the
14944 terminating newline of a line, and point is on that
14945 newline, it wins because it's an exact match. */
14946 || (!row
->continued_p
14947 && INTEGERP (glyph
->object
)
14948 && glyph
->charpos
== 0
14949 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14950 /* Otherwise, keep the candidate that comes from a row
14951 spanning less buffer positions. This may win when one or
14952 both candidate positions are on glyphs that came from
14953 display strings, for which we cannot compare buffer
14955 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14956 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14957 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14960 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14962 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14963 w
->cursor
.y
= row
->y
+ dy
;
14965 if (w
== XWINDOW (selected_window
))
14967 if (!row
->continued_p
14968 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14971 this_line_buffer
= XBUFFER (w
->contents
);
14973 CHARPOS (this_line_start_pos
)
14974 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14975 BYTEPOS (this_line_start_pos
)
14976 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14978 CHARPOS (this_line_end_pos
)
14979 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14980 BYTEPOS (this_line_end_pos
)
14981 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14983 this_line_y
= w
->cursor
.y
;
14984 this_line_pixel_height
= row
->height
;
14985 this_line_vpos
= w
->cursor
.vpos
;
14986 this_line_start_x
= row
->x
;
14989 CHARPOS (this_line_start_pos
) = 0;
14996 /* Run window scroll functions, if any, for WINDOW with new window
14997 start STARTP. Sets the window start of WINDOW to that position.
14999 We assume that the window's buffer is really current. */
15001 static struct text_pos
15002 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
15004 struct window
*w
= XWINDOW (window
);
15005 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
15007 eassert (current_buffer
== XBUFFER (w
->contents
));
15009 if (!NILP (Vwindow_scroll_functions
))
15011 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
15012 make_number (CHARPOS (startp
)));
15013 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15014 /* In case the hook functions switch buffers. */
15015 set_buffer_internal (XBUFFER (w
->contents
));
15022 /* Make sure the line containing the cursor is fully visible.
15023 A value of 1 means there is nothing to be done.
15024 (Either the line is fully visible, or it cannot be made so,
15025 or we cannot tell.)
15027 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15028 is higher than window.
15030 If CURRENT_MATRIX_P is non-zero, use the information from the
15031 window's current glyph matrix; otherwise uze the desired glyph
15034 A value of 0 means the caller should do scrolling
15035 as if point had gone off the screen. */
15038 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15040 struct glyph_matrix
*matrix
;
15041 struct glyph_row
*row
;
15044 if (!make_cursor_line_fully_visible_p
)
15047 /* It's not always possible to find the cursor, e.g, when a window
15048 is full of overlay strings. Don't do anything in that case. */
15049 if (w
->cursor
.vpos
< 0)
15052 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15053 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15055 /* If the cursor row is not partially visible, there's nothing to do. */
15056 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15059 /* If the row the cursor is in is taller than the window's height,
15060 it's not clear what to do, so do nothing. */
15061 window_height
= window_box_height (w
);
15062 if (row
->height
>= window_height
)
15064 if (!force_p
|| MINI_WINDOW_P (w
)
15065 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15072 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15073 non-zero means only WINDOW is redisplayed in redisplay_internal.
15074 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15075 in redisplay_window to bring a partially visible line into view in
15076 the case that only the cursor has moved.
15078 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15079 last screen line's vertical height extends past the end of the screen.
15083 1 if scrolling succeeded
15085 0 if scrolling didn't find point.
15087 -1 if new fonts have been loaded so that we must interrupt
15088 redisplay, adjust glyph matrices, and try again. */
15094 SCROLLING_NEED_LARGER_MATRICES
15097 /* If scroll-conservatively is more than this, never recenter.
15099 If you change this, don't forget to update the doc string of
15100 `scroll-conservatively' and the Emacs manual. */
15101 #define SCROLL_LIMIT 100
15104 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15105 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15106 int temp_scroll_step
, int last_line_misfit
)
15108 struct window
*w
= XWINDOW (window
);
15109 struct frame
*f
= XFRAME (w
->frame
);
15110 struct text_pos pos
, startp
;
15112 int this_scroll_margin
, scroll_max
, rc
, height
;
15113 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15114 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15115 Lisp_Object aggressive
;
15116 /* We will never try scrolling more than this number of lines. */
15117 int scroll_limit
= SCROLL_LIMIT
;
15118 int frame_line_height
= default_line_pixel_height (w
);
15119 int window_total_lines
15120 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15123 debug_method_add (w
, "try_scrolling");
15126 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15128 /* Compute scroll margin height in pixels. We scroll when point is
15129 within this distance from the top or bottom of the window. */
15130 if (scroll_margin
> 0)
15131 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15132 * frame_line_height
;
15134 this_scroll_margin
= 0;
15136 /* Force arg_scroll_conservatively to have a reasonable value, to
15137 avoid scrolling too far away with slow move_it_* functions. Note
15138 that the user can supply scroll-conservatively equal to
15139 `most-positive-fixnum', which can be larger than INT_MAX. */
15140 if (arg_scroll_conservatively
> scroll_limit
)
15142 arg_scroll_conservatively
= scroll_limit
+ 1;
15143 scroll_max
= scroll_limit
* frame_line_height
;
15145 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15146 /* Compute how much we should try to scroll maximally to bring
15147 point into view. */
15148 scroll_max
= (max (scroll_step
,
15149 max (arg_scroll_conservatively
, temp_scroll_step
))
15150 * frame_line_height
);
15151 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15152 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15153 /* We're trying to scroll because of aggressive scrolling but no
15154 scroll_step is set. Choose an arbitrary one. */
15155 scroll_max
= 10 * frame_line_height
;
15161 /* Decide whether to scroll down. */
15162 if (PT
> CHARPOS (startp
))
15164 int scroll_margin_y
;
15166 /* Compute the pixel ypos of the scroll margin, then move IT to
15167 either that ypos or PT, whichever comes first. */
15168 start_display (&it
, w
, startp
);
15169 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15170 - frame_line_height
* extra_scroll_margin_lines
;
15171 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15172 (MOVE_TO_POS
| MOVE_TO_Y
));
15174 if (PT
> CHARPOS (it
.current
.pos
))
15176 int y0
= line_bottom_y (&it
);
15177 /* Compute how many pixels below window bottom to stop searching
15178 for PT. This avoids costly search for PT that is far away if
15179 the user limited scrolling by a small number of lines, but
15180 always finds PT if scroll_conservatively is set to a large
15181 number, such as most-positive-fixnum. */
15182 int slack
= max (scroll_max
, 10 * frame_line_height
);
15183 int y_to_move
= it
.last_visible_y
+ slack
;
15185 /* Compute the distance from the scroll margin to PT or to
15186 the scroll limit, whichever comes first. This should
15187 include the height of the cursor line, to make that line
15189 move_it_to (&it
, PT
, -1, y_to_move
,
15190 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15191 dy
= line_bottom_y (&it
) - y0
;
15193 if (dy
> scroll_max
)
15194 return SCROLLING_FAILED
;
15203 /* Point is in or below the bottom scroll margin, so move the
15204 window start down. If scrolling conservatively, move it just
15205 enough down to make point visible. If scroll_step is set,
15206 move it down by scroll_step. */
15207 if (arg_scroll_conservatively
)
15209 = min (max (dy
, frame_line_height
),
15210 frame_line_height
* arg_scroll_conservatively
);
15211 else if (scroll_step
|| temp_scroll_step
)
15212 amount_to_scroll
= scroll_max
;
15215 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15216 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15217 if (NUMBERP (aggressive
))
15219 double float_amount
= XFLOATINT (aggressive
) * height
;
15220 int aggressive_scroll
= float_amount
;
15221 if (aggressive_scroll
== 0 && float_amount
> 0)
15222 aggressive_scroll
= 1;
15223 /* Don't let point enter the scroll margin near top of
15224 the window. This could happen if the value of
15225 scroll_up_aggressively is too large and there are
15226 non-zero margins, because scroll_up_aggressively
15227 means put point that fraction of window height
15228 _from_the_bottom_margin_. */
15229 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15230 aggressive_scroll
= height
- 2*this_scroll_margin
;
15231 amount_to_scroll
= dy
+ aggressive_scroll
;
15235 if (amount_to_scroll
<= 0)
15236 return SCROLLING_FAILED
;
15238 start_display (&it
, w
, startp
);
15239 if (arg_scroll_conservatively
<= scroll_limit
)
15240 move_it_vertically (&it
, amount_to_scroll
);
15243 /* Extra precision for users who set scroll-conservatively
15244 to a large number: make sure the amount we scroll
15245 the window start is never less than amount_to_scroll,
15246 which was computed as distance from window bottom to
15247 point. This matters when lines at window top and lines
15248 below window bottom have different height. */
15250 void *it1data
= NULL
;
15251 /* We use a temporary it1 because line_bottom_y can modify
15252 its argument, if it moves one line down; see there. */
15255 SAVE_IT (it1
, it
, it1data
);
15256 start_y
= line_bottom_y (&it1
);
15258 RESTORE_IT (&it
, &it
, it1data
);
15259 move_it_by_lines (&it
, 1);
15260 SAVE_IT (it1
, it
, it1data
);
15261 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15264 /* If STARTP is unchanged, move it down another screen line. */
15265 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15266 move_it_by_lines (&it
, 1);
15267 startp
= it
.current
.pos
;
15271 struct text_pos scroll_margin_pos
= startp
;
15274 /* See if point is inside the scroll margin at the top of the
15276 if (this_scroll_margin
)
15280 start_display (&it
, w
, startp
);
15281 y_start
= it
.current_y
;
15282 move_it_vertically (&it
, this_scroll_margin
);
15283 scroll_margin_pos
= it
.current
.pos
;
15284 /* If we didn't move enough before hitting ZV, request
15285 additional amount of scroll, to move point out of the
15287 if (IT_CHARPOS (it
) == ZV
15288 && it
.current_y
- y_start
< this_scroll_margin
)
15289 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15292 if (PT
< CHARPOS (scroll_margin_pos
))
15294 /* Point is in the scroll margin at the top of the window or
15295 above what is displayed in the window. */
15298 /* Compute the vertical distance from PT to the scroll
15299 margin position. Move as far as scroll_max allows, or
15300 one screenful, or 10 screen lines, whichever is largest.
15301 Give up if distance is greater than scroll_max or if we
15302 didn't reach the scroll margin position. */
15303 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15304 start_display (&it
, w
, pos
);
15306 y_to_move
= max (it
.last_visible_y
,
15307 max (scroll_max
, 10 * frame_line_height
));
15308 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15310 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15311 dy
= it
.current_y
- y0
;
15312 if (dy
> scroll_max
15313 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15314 return SCROLLING_FAILED
;
15316 /* Additional scroll for when ZV was too close to point. */
15319 /* Compute new window start. */
15320 start_display (&it
, w
, startp
);
15322 if (arg_scroll_conservatively
)
15323 amount_to_scroll
= max (dy
, frame_line_height
*
15324 max (scroll_step
, temp_scroll_step
));
15325 else if (scroll_step
|| temp_scroll_step
)
15326 amount_to_scroll
= scroll_max
;
15329 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15330 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15331 if (NUMBERP (aggressive
))
15333 double float_amount
= XFLOATINT (aggressive
) * height
;
15334 int aggressive_scroll
= float_amount
;
15335 if (aggressive_scroll
== 0 && float_amount
> 0)
15336 aggressive_scroll
= 1;
15337 /* Don't let point enter the scroll margin near
15338 bottom of the window, if the value of
15339 scroll_down_aggressively happens to be too
15341 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15342 aggressive_scroll
= height
- 2*this_scroll_margin
;
15343 amount_to_scroll
= dy
+ aggressive_scroll
;
15347 if (amount_to_scroll
<= 0)
15348 return SCROLLING_FAILED
;
15350 move_it_vertically_backward (&it
, amount_to_scroll
);
15351 startp
= it
.current
.pos
;
15355 /* Run window scroll functions. */
15356 startp
= run_window_scroll_functions (window
, startp
);
15358 /* Display the window. Give up if new fonts are loaded, or if point
15360 if (!try_window (window
, startp
, 0))
15361 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15362 else if (w
->cursor
.vpos
< 0)
15364 clear_glyph_matrix (w
->desired_matrix
);
15365 rc
= SCROLLING_FAILED
;
15369 /* Maybe forget recorded base line for line number display. */
15370 if (!just_this_one_p
15371 || current_buffer
->clip_changed
15372 || BEG_UNCHANGED
< CHARPOS (startp
))
15373 w
->base_line_number
= 0;
15375 /* If cursor ends up on a partially visible line,
15376 treat that as being off the bottom of the screen. */
15377 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15378 /* It's possible that the cursor is on the first line of the
15379 buffer, which is partially obscured due to a vscroll
15380 (Bug#7537). In that case, avoid looping forever. */
15381 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15383 clear_glyph_matrix (w
->desired_matrix
);
15384 ++extra_scroll_margin_lines
;
15387 rc
= SCROLLING_SUCCESS
;
15394 /* Compute a suitable window start for window W if display of W starts
15395 on a continuation line. Value is non-zero if a new window start
15398 The new window start will be computed, based on W's width, starting
15399 from the start of the continued line. It is the start of the
15400 screen line with the minimum distance from the old start W->start. */
15403 compute_window_start_on_continuation_line (struct window
*w
)
15405 struct text_pos pos
, start_pos
;
15406 int window_start_changed_p
= 0;
15408 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15410 /* If window start is on a continuation line... Window start may be
15411 < BEGV in case there's invisible text at the start of the
15412 buffer (M-x rmail, for example). */
15413 if (CHARPOS (start_pos
) > BEGV
15414 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15417 struct glyph_row
*row
;
15419 /* Handle the case that the window start is out of range. */
15420 if (CHARPOS (start_pos
) < BEGV
)
15421 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15422 else if (CHARPOS (start_pos
) > ZV
)
15423 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15425 /* Find the start of the continued line. This should be fast
15426 because find_newline is fast (newline cache). */
15427 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15428 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15429 row
, DEFAULT_FACE_ID
);
15430 reseat_at_previous_visible_line_start (&it
);
15432 /* If the line start is "too far" away from the window start,
15433 say it takes too much time to compute a new window start. */
15434 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15435 /* PXW: Do we need upper bounds here? */
15436 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15438 int min_distance
, distance
;
15440 /* Move forward by display lines to find the new window
15441 start. If window width was enlarged, the new start can
15442 be expected to be > the old start. If window width was
15443 decreased, the new window start will be < the old start.
15444 So, we're looking for the display line start with the
15445 minimum distance from the old window start. */
15446 pos
= it
.current
.pos
;
15447 min_distance
= INFINITY
;
15448 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15449 distance
< min_distance
)
15451 min_distance
= distance
;
15452 pos
= it
.current
.pos
;
15453 if (it
.line_wrap
== WORD_WRAP
)
15455 /* Under WORD_WRAP, move_it_by_lines is likely to
15456 overshoot and stop not at the first, but the
15457 second character from the left margin. So in
15458 that case, we need a more tight control on the X
15459 coordinate of the iterator than move_it_by_lines
15460 promises in its contract. The method is to first
15461 go to the last (rightmost) visible character of a
15462 line, then move to the leftmost character on the
15463 next line in a separate call. */
15464 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15465 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15466 move_it_to (&it
, ZV
, 0,
15467 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15468 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15471 move_it_by_lines (&it
, 1);
15474 /* Set the window start there. */
15475 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15476 window_start_changed_p
= 1;
15480 return window_start_changed_p
;
15484 /* Try cursor movement in case text has not changed in window WINDOW,
15485 with window start STARTP. Value is
15487 CURSOR_MOVEMENT_SUCCESS if successful
15489 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15491 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15492 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15493 we want to scroll as if scroll-step were set to 1. See the code.
15495 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15496 which case we have to abort this redisplay, and adjust matrices
15501 CURSOR_MOVEMENT_SUCCESS
,
15502 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15503 CURSOR_MOVEMENT_MUST_SCROLL
,
15504 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15508 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15510 struct window
*w
= XWINDOW (window
);
15511 struct frame
*f
= XFRAME (w
->frame
);
15512 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15515 if (inhibit_try_cursor_movement
)
15519 /* Previously, there was a check for Lisp integer in the
15520 if-statement below. Now, this field is converted to
15521 ptrdiff_t, thus zero means invalid position in a buffer. */
15522 eassert (w
->last_point
> 0);
15523 /* Likewise there was a check whether window_end_vpos is nil or larger
15524 than the window. Now window_end_vpos is int and so never nil, but
15525 let's leave eassert to check whether it fits in the window. */
15526 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15528 /* Handle case where text has not changed, only point, and it has
15529 not moved off the frame. */
15530 if (/* Point may be in this window. */
15531 PT
>= CHARPOS (startp
)
15532 /* Selective display hasn't changed. */
15533 && !current_buffer
->clip_changed
15534 /* Function force-mode-line-update is used to force a thorough
15535 redisplay. It sets either windows_or_buffers_changed or
15536 update_mode_lines. So don't take a shortcut here for these
15538 && !update_mode_lines
15539 && !windows_or_buffers_changed
15540 && !f
->cursor_type_changed
15541 && NILP (Vshow_trailing_whitespace
)
15542 /* This code is not used for mini-buffer for the sake of the case
15543 of redisplaying to replace an echo area message; since in
15544 that case the mini-buffer contents per se are usually
15545 unchanged. This code is of no real use in the mini-buffer
15546 since the handling of this_line_start_pos, etc., in redisplay
15547 handles the same cases. */
15548 && !EQ (window
, minibuf_window
)
15549 && (FRAME_WINDOW_P (f
)
15550 || !overlay_arrow_in_current_buffer_p ()))
15552 int this_scroll_margin
, top_scroll_margin
;
15553 struct glyph_row
*row
= NULL
;
15554 int frame_line_height
= default_line_pixel_height (w
);
15555 int window_total_lines
15556 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15559 debug_method_add (w
, "cursor movement");
15562 /* Scroll if point within this distance from the top or bottom
15563 of the window. This is a pixel value. */
15564 if (scroll_margin
> 0)
15566 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15567 this_scroll_margin
*= frame_line_height
;
15570 this_scroll_margin
= 0;
15572 top_scroll_margin
= this_scroll_margin
;
15573 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15574 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15576 /* Start with the row the cursor was displayed during the last
15577 not paused redisplay. Give up if that row is not valid. */
15578 if (w
->last_cursor_vpos
< 0
15579 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15580 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15583 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15584 if (row
->mode_line_p
)
15586 if (!row
->enabled_p
)
15587 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15590 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15592 int scroll_p
= 0, must_scroll
= 0;
15593 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15595 if (PT
> w
->last_point
)
15597 /* Point has moved forward. */
15598 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15599 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15601 eassert (row
->enabled_p
);
15605 /* If the end position of a row equals the start
15606 position of the next row, and PT is at that position,
15607 we would rather display cursor in the next line. */
15608 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15609 && MATRIX_ROW_END_CHARPOS (row
) == PT
15610 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15611 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15612 && !cursor_row_p (row
))
15615 /* If within the scroll margin, scroll. Note that
15616 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15617 the next line would be drawn, and that
15618 this_scroll_margin can be zero. */
15619 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15620 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15621 /* Line is completely visible last line in window
15622 and PT is to be set in the next line. */
15623 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15624 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15625 && !row
->ends_at_zv_p
15626 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15629 else if (PT
< w
->last_point
)
15631 /* Cursor has to be moved backward. Note that PT >=
15632 CHARPOS (startp) because of the outer if-statement. */
15633 while (!row
->mode_line_p
15634 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15635 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15636 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15637 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15638 row
> w
->current_matrix
->rows
15639 && (row
-1)->ends_in_newline_from_string_p
))))
15640 && (row
->y
> top_scroll_margin
15641 || CHARPOS (startp
) == BEGV
))
15643 eassert (row
->enabled_p
);
15647 /* Consider the following case: Window starts at BEGV,
15648 there is invisible, intangible text at BEGV, so that
15649 display starts at some point START > BEGV. It can
15650 happen that we are called with PT somewhere between
15651 BEGV and START. Try to handle that case. */
15652 if (row
< w
->current_matrix
->rows
15653 || row
->mode_line_p
)
15655 row
= w
->current_matrix
->rows
;
15656 if (row
->mode_line_p
)
15660 /* Due to newlines in overlay strings, we may have to
15661 skip forward over overlay strings. */
15662 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15663 && MATRIX_ROW_END_CHARPOS (row
) == PT
15664 && !cursor_row_p (row
))
15667 /* If within the scroll margin, scroll. */
15668 if (row
->y
< top_scroll_margin
15669 && CHARPOS (startp
) != BEGV
)
15674 /* Cursor did not move. So don't scroll even if cursor line
15675 is partially visible, as it was so before. */
15676 rc
= CURSOR_MOVEMENT_SUCCESS
;
15679 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15680 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15682 /* if PT is not in the glyph row, give up. */
15683 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15686 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15687 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15689 struct glyph_row
*row1
;
15691 /* If rows are bidi-reordered and point moved, back up
15692 until we find a row that does not belong to a
15693 continuation line. This is because we must consider
15694 all rows of a continued line as candidates for the
15695 new cursor positioning, since row start and end
15696 positions change non-linearly with vertical position
15698 /* FIXME: Revisit this when glyph ``spilling'' in
15699 continuation lines' rows is implemented for
15700 bidi-reordered rows. */
15701 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15702 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15705 /* If we hit the beginning of the displayed portion
15706 without finding the first row of a continued
15710 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15713 eassert (row
->enabled_p
);
15718 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15719 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15720 /* Make sure this isn't a header line by any chance, since
15721 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15722 && !row
->mode_line_p
15723 && make_cursor_line_fully_visible_p
)
15725 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15726 && !row
->ends_at_zv_p
15727 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15728 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15729 else if (row
->height
> window_box_height (w
))
15731 /* If we end up in a partially visible line, let's
15732 make it fully visible, except when it's taller
15733 than the window, in which case we can't do much
15736 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15740 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15741 if (!cursor_row_fully_visible_p (w
, 0, 1))
15742 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15744 rc
= CURSOR_MOVEMENT_SUCCESS
;
15748 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15749 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15750 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15752 /* With bidi-reordered rows, there could be more than
15753 one candidate row whose start and end positions
15754 occlude point. We need to let set_cursor_from_row
15755 find the best candidate. */
15756 /* FIXME: Revisit this when glyph ``spilling'' in
15757 continuation lines' rows is implemented for
15758 bidi-reordered rows. */
15763 int at_zv_p
= 0, exact_match_p
= 0;
15765 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15766 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15767 && cursor_row_p (row
))
15768 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15770 /* As soon as we've found the exact match for point,
15771 or the first suitable row whose ends_at_zv_p flag
15772 is set, we are done. */
15775 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15776 w
->cursor
.vpos
)->ends_at_zv_p
;
15778 && w
->cursor
.hpos
>= 0
15779 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15782 struct glyph_row
*candidate
=
15783 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15785 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15786 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15789 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15790 || (INTEGERP (g
->object
)
15791 && (g
->charpos
== PT
15792 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15794 if (at_zv_p
|| exact_match_p
)
15796 rc
= CURSOR_MOVEMENT_SUCCESS
;
15800 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15804 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15805 || row
->continued_p
)
15806 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15807 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15808 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15809 /* If we didn't find any candidate rows, or exited the
15810 loop before all the candidates were examined, signal
15811 to the caller that this method failed. */
15812 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15814 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15815 && !row
->continued_p
))
15816 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15818 rc
= CURSOR_MOVEMENT_SUCCESS
;
15824 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15826 rc
= CURSOR_MOVEMENT_SUCCESS
;
15831 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15832 && MATRIX_ROW_START_CHARPOS (row
) == PT
15833 && cursor_row_p (row
));
15841 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15845 set_vertical_scroll_bar (struct window
*w
)
15847 ptrdiff_t start
, end
, whole
;
15849 /* Calculate the start and end positions for the current window.
15850 At some point, it would be nice to choose between scrollbars
15851 which reflect the whole buffer size, with special markers
15852 indicating narrowing, and scrollbars which reflect only the
15855 Note that mini-buffers sometimes aren't displaying any text. */
15856 if (!MINI_WINDOW_P (w
)
15857 || (w
== XWINDOW (minibuf_window
)
15858 && NILP (echo_area_buffer
[0])))
15860 struct buffer
*buf
= XBUFFER (w
->contents
);
15861 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15862 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15863 /* I don't think this is guaranteed to be right. For the
15864 moment, we'll pretend it is. */
15865 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15869 if (whole
< (end
- start
))
15870 whole
= end
- start
;
15873 start
= end
= whole
= 0;
15875 /* Indicate what this scroll bar ought to be displaying now. */
15876 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15877 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15878 (w
, end
- start
, whole
, start
);
15882 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15883 selected_window is redisplayed.
15885 We can return without actually redisplaying the window if fonts has been
15886 changed on window's frame. In that case, redisplay_internal will retry.
15888 As one of the important parts of redisplaying a window, we need to
15889 decide whether the previous window-start position (stored in the
15890 window's w->start marker position) is still valid, and if it isn't,
15891 recompute it. Some details about that:
15893 . The previous window-start could be in a continuation line, in
15894 which case we need to recompute it when the window width
15895 changes. See compute_window_start_on_continuation_line and its
15898 . The text that changed since last redisplay could include the
15899 previous window-start position. In that case, we try to salvage
15900 what we can from the current glyph matrix by calling
15901 try_scrolling, which see.
15903 . Some Emacs command could force us to use a specific window-start
15904 position by setting the window's force_start flag, or gently
15905 propose doing that by setting the window's optional_new_start
15906 flag. In these cases, we try using the specified start point if
15907 that succeeds (i.e. the window desired matrix is successfully
15908 recomputed, and point location is within the window). In case
15909 of optional_new_start, we first check if the specified start
15910 position is feasible, i.e. if it will allow point to be
15911 displayed in the window. If using the specified start point
15912 fails, e.g., if new fonts are needed to be loaded, we abort the
15913 redisplay cycle and leave it up to the next cycle to figure out
15916 . Note that the window's force_start flag is sometimes set by
15917 redisplay itself, when it decides that the previous window start
15918 point is fine and should be kept. Search for "goto force_start"
15919 below to see the details. Like the values of window-start
15920 specified outside of redisplay, these internally-deduced values
15921 are tested for feasibility, and ignored if found to be
15924 . Note that the function try_window, used to completely redisplay
15925 a window, accepts the window's start point as its argument.
15926 This is used several times in the redisplay code to control
15927 where the window start will be, according to user options such
15928 as scroll-conservatively, and also to ensure the screen line
15929 showing point will be fully (as opposed to partially) visible on
15933 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15935 struct window
*w
= XWINDOW (window
);
15936 struct frame
*f
= XFRAME (w
->frame
);
15937 struct buffer
*buffer
= XBUFFER (w
->contents
);
15938 struct buffer
*old
= current_buffer
;
15939 struct text_pos lpoint
, opoint
, startp
;
15940 int update_mode_line
;
15943 /* Record it now because it's overwritten. */
15944 bool current_matrix_up_to_date_p
= false;
15945 bool used_current_matrix_p
= false;
15946 /* This is less strict than current_matrix_up_to_date_p.
15947 It indicates that the buffer contents and narrowing are unchanged. */
15948 bool buffer_unchanged_p
= false;
15949 int temp_scroll_step
= 0;
15950 ptrdiff_t count
= SPECPDL_INDEX ();
15952 int centering_position
= -1;
15953 int last_line_misfit
= 0;
15954 ptrdiff_t beg_unchanged
, end_unchanged
;
15955 int frame_line_height
;
15957 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15961 *w
->desired_matrix
->method
= 0;
15964 if (!just_this_one_p
15965 && REDISPLAY_SOME_P ()
15968 && !buffer
->text
->redisplay
15969 && BUF_PT (buffer
) == w
->last_point
)
15972 /* Make sure that both W's markers are valid. */
15973 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15974 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15976 /* We come here again if we need to run window-text-change-functions
15979 reconsider_clip_changes (w
);
15980 frame_line_height
= default_line_pixel_height (w
);
15982 /* Has the mode line to be updated? */
15983 update_mode_line
= (w
->update_mode_line
15984 || update_mode_lines
15985 || buffer
->clip_changed
15986 || buffer
->prevent_redisplay_optimizations_p
);
15988 if (!just_this_one_p
)
15989 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15990 cleverly elsewhere. */
15991 w
->must_be_updated_p
= true;
15993 if (MINI_WINDOW_P (w
))
15995 if (w
== XWINDOW (echo_area_window
)
15996 && !NILP (echo_area_buffer
[0]))
15998 if (update_mode_line
)
15999 /* We may have to update a tty frame's menu bar or a
16000 tool-bar. Example `M-x C-h C-h C-g'. */
16001 goto finish_menu_bars
;
16003 /* We've already displayed the echo area glyphs in this window. */
16004 goto finish_scroll_bars
;
16006 else if ((w
!= XWINDOW (minibuf_window
)
16007 || minibuf_level
== 0)
16008 /* When buffer is nonempty, redisplay window normally. */
16009 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16010 /* Quail displays non-mini buffers in minibuffer window.
16011 In that case, redisplay the window normally. */
16012 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16014 /* W is a mini-buffer window, but it's not active, so clear
16016 int yb
= window_text_bottom_y (w
);
16017 struct glyph_row
*row
;
16020 for (y
= 0, row
= w
->desired_matrix
->rows
;
16022 y
+= row
->height
, ++row
)
16023 blank_row (w
, row
, y
);
16024 goto finish_scroll_bars
;
16027 clear_glyph_matrix (w
->desired_matrix
);
16030 /* Otherwise set up data on this window; select its buffer and point
16032 /* Really select the buffer, for the sake of buffer-local
16034 set_buffer_internal_1 (XBUFFER (w
->contents
));
16036 current_matrix_up_to_date_p
16037 = (w
->window_end_valid
16038 && !current_buffer
->clip_changed
16039 && !current_buffer
->prevent_redisplay_optimizations_p
16040 && !window_outdated (w
));
16042 /* Run the window-text-change-functions
16043 if it is possible that the text on the screen has changed
16044 (either due to modification of the text, or any other reason). */
16045 if (!current_matrix_up_to_date_p
16046 && !NILP (Vwindow_text_change_functions
))
16048 safe_run_hooks (Qwindow_text_change_functions
);
16052 beg_unchanged
= BEG_UNCHANGED
;
16053 end_unchanged
= END_UNCHANGED
;
16055 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16057 specbind (Qinhibit_point_motion_hooks
, Qt
);
16060 = (w
->window_end_valid
16061 && !current_buffer
->clip_changed
16062 && !window_outdated (w
));
16064 /* When windows_or_buffers_changed is non-zero, we can't rely
16065 on the window end being valid, so set it to zero there. */
16066 if (windows_or_buffers_changed
)
16068 /* If window starts on a continuation line, maybe adjust the
16069 window start in case the window's width changed. */
16070 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16071 compute_window_start_on_continuation_line (w
);
16073 w
->window_end_valid
= false;
16074 /* If so, we also can't rely on current matrix
16075 and should not fool try_cursor_movement below. */
16076 current_matrix_up_to_date_p
= false;
16079 /* Some sanity checks. */
16080 CHECK_WINDOW_END (w
);
16081 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16083 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16086 if (mode_line_update_needed (w
))
16087 update_mode_line
= 1;
16089 /* Point refers normally to the selected window. For any other
16090 window, set up appropriate value. */
16091 if (!EQ (window
, selected_window
))
16093 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16094 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16098 new_pt_byte
= BEGV_BYTE
;
16099 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16101 else if (new_pt
> (ZV
- 1))
16104 new_pt_byte
= ZV_BYTE
;
16105 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16108 /* We don't use SET_PT so that the point-motion hooks don't run. */
16109 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16112 /* If any of the character widths specified in the display table
16113 have changed, invalidate the width run cache. It's true that
16114 this may be a bit late to catch such changes, but the rest of
16115 redisplay goes (non-fatally) haywire when the display table is
16116 changed, so why should we worry about doing any better? */
16117 if (current_buffer
->width_run_cache
16118 || (current_buffer
->base_buffer
16119 && current_buffer
->base_buffer
->width_run_cache
))
16121 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16123 if (! disptab_matches_widthtab
16124 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16126 struct buffer
*buf
= current_buffer
;
16128 if (buf
->base_buffer
)
16129 buf
= buf
->base_buffer
;
16130 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16131 recompute_width_table (current_buffer
, disptab
);
16135 /* If window-start is screwed up, choose a new one. */
16136 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16139 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16141 /* If someone specified a new starting point but did not insist,
16142 check whether it can be used. */
16143 if ((w
->optional_new_start
|| window_frozen_p (w
))
16144 && CHARPOS (startp
) >= BEGV
16145 && CHARPOS (startp
) <= ZV
)
16147 ptrdiff_t it_charpos
;
16149 w
->optional_new_start
= 0;
16150 start_display (&it
, w
, startp
);
16151 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16152 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16153 /* Record IT's position now, since line_bottom_y might change
16155 it_charpos
= IT_CHARPOS (it
);
16156 /* Make sure we set the force_start flag only if the cursor row
16157 will be fully visible. Otherwise, the code under force_start
16158 label below will try to move point back into view, which is
16159 not what the code which sets optional_new_start wants. */
16160 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16161 && !w
->force_start
)
16163 if (it_charpos
== PT
)
16164 w
->force_start
= 1;
16165 /* IT may overshoot PT if text at PT is invisible. */
16166 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16167 w
->force_start
= 1;
16169 if (w
->force_start
)
16171 if (window_frozen_p (w
))
16172 debug_method_add (w
, "set force_start from frozen window start");
16174 debug_method_add (w
, "set force_start from optional_new_start");
16182 /* Handle case where place to start displaying has been specified,
16183 unless the specified location is outside the accessible range. */
16184 if (w
->force_start
)
16186 /* We set this later on if we have to adjust point. */
16189 w
->force_start
= 0;
16191 w
->window_end_valid
= 0;
16193 /* Forget any recorded base line for line number display. */
16194 if (!buffer_unchanged_p
)
16195 w
->base_line_number
= 0;
16197 /* Redisplay the mode line. Select the buffer properly for that.
16198 Also, run the hook window-scroll-functions
16199 because we have scrolled. */
16200 /* Note, we do this after clearing force_start because
16201 if there's an error, it is better to forget about force_start
16202 than to get into an infinite loop calling the hook functions
16203 and having them get more errors. */
16204 if (!update_mode_line
16205 || ! NILP (Vwindow_scroll_functions
))
16207 update_mode_line
= 1;
16208 w
->update_mode_line
= 1;
16209 startp
= run_window_scroll_functions (window
, startp
);
16212 if (CHARPOS (startp
) < BEGV
)
16213 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16214 else if (CHARPOS (startp
) > ZV
)
16215 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16217 /* Redisplay, then check if cursor has been set during the
16218 redisplay. Give up if new fonts were loaded. */
16219 /* We used to issue a CHECK_MARGINS argument to try_window here,
16220 but this causes scrolling to fail when point begins inside
16221 the scroll margin (bug#148) -- cyd */
16222 if (!try_window (window
, startp
, 0))
16224 w
->force_start
= 1;
16225 clear_glyph_matrix (w
->desired_matrix
);
16226 goto need_larger_matrices
;
16229 if (w
->cursor
.vpos
< 0)
16231 /* If point does not appear, try to move point so it does
16232 appear. The desired matrix has been built above, so we
16233 can use it here. */
16234 new_vpos
= window_box_height (w
) / 2;
16237 if (!cursor_row_fully_visible_p (w
, 0, 0))
16239 /* Point does appear, but on a line partly visible at end of window.
16240 Move it back to a fully-visible line. */
16241 new_vpos
= window_box_height (w
);
16242 /* But if window_box_height suggests a Y coordinate that is
16243 not less than we already have, that line will clearly not
16244 be fully visible, so give up and scroll the display.
16245 This can happen when the default face uses a font whose
16246 dimensions are different from the frame's default
16248 if (new_vpos
>= w
->cursor
.y
)
16250 w
->cursor
.vpos
= -1;
16251 clear_glyph_matrix (w
->desired_matrix
);
16252 goto try_to_scroll
;
16255 else if (w
->cursor
.vpos
>= 0)
16257 /* Some people insist on not letting point enter the scroll
16258 margin, even though this part handles windows that didn't
16260 int window_total_lines
16261 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16262 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16263 int pixel_margin
= margin
* frame_line_height
;
16264 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16266 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16267 below, which finds the row to move point to, advances by
16268 the Y coordinate of the _next_ row, see the definition of
16269 MATRIX_ROW_BOTTOM_Y. */
16270 if (w
->cursor
.vpos
< margin
+ header_line
)
16272 w
->cursor
.vpos
= -1;
16273 clear_glyph_matrix (w
->desired_matrix
);
16274 goto try_to_scroll
;
16278 int window_height
= window_box_height (w
);
16281 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16282 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16284 w
->cursor
.vpos
= -1;
16285 clear_glyph_matrix (w
->desired_matrix
);
16286 goto try_to_scroll
;
16291 /* If we need to move point for either of the above reasons,
16292 now actually do it. */
16295 struct glyph_row
*row
;
16297 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16298 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16301 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16302 MATRIX_ROW_START_BYTEPOS (row
));
16304 if (w
!= XWINDOW (selected_window
))
16305 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16306 else if (current_buffer
== old
)
16307 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16309 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16311 /* If we are highlighting the region, then we just changed
16312 the region, so redisplay to show it. */
16313 /* FIXME: We need to (re)run pre-redisplay-function! */
16314 /* if (markpos_of_region () >= 0)
16316 clear_glyph_matrix (w->desired_matrix);
16317 if (!try_window (window, startp, 0))
16318 goto need_larger_matrices;
16322 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16324 clear_glyph_matrix (w
->desired_matrix
);
16325 goto try_to_scroll
;
16329 debug_method_add (w
, "forced window start");
16334 /* Handle case where text has not changed, only point, and it has
16335 not moved off the frame, and we are not retrying after hscroll.
16336 (current_matrix_up_to_date_p is nonzero when retrying.) */
16337 if (current_matrix_up_to_date_p
16338 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16339 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16343 case CURSOR_MOVEMENT_SUCCESS
:
16344 used_current_matrix_p
= 1;
16347 case CURSOR_MOVEMENT_MUST_SCROLL
:
16348 goto try_to_scroll
;
16354 /* If current starting point was originally the beginning of a line
16355 but no longer is, find a new starting point. */
16356 else if (w
->start_at_line_beg
16357 && !(CHARPOS (startp
) <= BEGV
16358 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16361 debug_method_add (w
, "recenter 1");
16366 /* Try scrolling with try_window_id. Value is > 0 if update has
16367 been done, it is -1 if we know that the same window start will
16368 not work. It is 0 if unsuccessful for some other reason. */
16369 else if ((tem
= try_window_id (w
)) != 0)
16372 debug_method_add (w
, "try_window_id %d", tem
);
16375 if (f
->fonts_changed
)
16376 goto need_larger_matrices
;
16380 /* Otherwise try_window_id has returned -1 which means that we
16381 don't want the alternative below this comment to execute. */
16383 else if (CHARPOS (startp
) >= BEGV
16384 && CHARPOS (startp
) <= ZV
16385 && PT
>= CHARPOS (startp
)
16386 && (CHARPOS (startp
) < ZV
16387 /* Avoid starting at end of buffer. */
16388 || CHARPOS (startp
) == BEGV
16389 || !window_outdated (w
)))
16391 int d1
, d2
, d5
, d6
;
16394 /* If first window line is a continuation line, and window start
16395 is inside the modified region, but the first change is before
16396 current window start, we must select a new window start.
16398 However, if this is the result of a down-mouse event (e.g. by
16399 extending the mouse-drag-overlay), we don't want to select a
16400 new window start, since that would change the position under
16401 the mouse, resulting in an unwanted mouse-movement rather
16402 than a simple mouse-click. */
16403 if (!w
->start_at_line_beg
16404 && NILP (do_mouse_tracking
)
16405 && CHARPOS (startp
) > BEGV
16406 && CHARPOS (startp
) > BEG
+ beg_unchanged
16407 && CHARPOS (startp
) <= Z
- end_unchanged
16408 /* Even if w->start_at_line_beg is nil, a new window may
16409 start at a line_beg, since that's how set_buffer_window
16410 sets it. So, we need to check the return value of
16411 compute_window_start_on_continuation_line. (See also
16413 && XMARKER (w
->start
)->buffer
== current_buffer
16414 && compute_window_start_on_continuation_line (w
)
16415 /* It doesn't make sense to force the window start like we
16416 do at label force_start if it is already known that point
16417 will not be fully visible in the resulting window, because
16418 doing so will move point from its correct position
16419 instead of scrolling the window to bring point into view.
16421 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16422 /* A very tall row could need more than the window height,
16423 in which case we accept that it is partially visible. */
16424 && (rtop
!= 0) == (rbot
!= 0))
16426 w
->force_start
= 1;
16427 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16429 debug_method_add (w
, "recomputed window start in continuation line");
16435 debug_method_add (w
, "same window start");
16438 /* Try to redisplay starting at same place as before.
16439 If point has not moved off frame, accept the results. */
16440 if (!current_matrix_up_to_date_p
16441 /* Don't use try_window_reusing_current_matrix in this case
16442 because a window scroll function can have changed the
16444 || !NILP (Vwindow_scroll_functions
)
16445 || MINI_WINDOW_P (w
)
16446 || !(used_current_matrix_p
16447 = try_window_reusing_current_matrix (w
)))
16449 IF_DEBUG (debug_method_add (w
, "1"));
16450 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16451 /* -1 means we need to scroll.
16452 0 means we need new matrices, but fonts_changed
16453 is set in that case, so we will detect it below. */
16454 goto try_to_scroll
;
16457 if (f
->fonts_changed
)
16458 goto need_larger_matrices
;
16460 if (w
->cursor
.vpos
>= 0)
16462 if (!just_this_one_p
16463 || current_buffer
->clip_changed
16464 || BEG_UNCHANGED
< CHARPOS (startp
))
16465 /* Forget any recorded base line for line number display. */
16466 w
->base_line_number
= 0;
16468 if (!cursor_row_fully_visible_p (w
, 1, 0))
16470 clear_glyph_matrix (w
->desired_matrix
);
16471 last_line_misfit
= 1;
16473 /* Drop through and scroll. */
16478 clear_glyph_matrix (w
->desired_matrix
);
16483 /* Redisplay the mode line. Select the buffer properly for that. */
16484 if (!update_mode_line
)
16486 update_mode_line
= 1;
16487 w
->update_mode_line
= 1;
16490 /* Try to scroll by specified few lines. */
16491 if ((scroll_conservatively
16492 || emacs_scroll_step
16493 || temp_scroll_step
16494 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16495 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16496 && CHARPOS (startp
) >= BEGV
16497 && CHARPOS (startp
) <= ZV
)
16499 /* The function returns -1 if new fonts were loaded, 1 if
16500 successful, 0 if not successful. */
16501 int ss
= try_scrolling (window
, just_this_one_p
,
16502 scroll_conservatively
,
16504 temp_scroll_step
, last_line_misfit
);
16507 case SCROLLING_SUCCESS
:
16510 case SCROLLING_NEED_LARGER_MATRICES
:
16511 goto need_larger_matrices
;
16513 case SCROLLING_FAILED
:
16521 /* Finally, just choose a place to start which positions point
16522 according to user preferences. */
16527 debug_method_add (w
, "recenter");
16530 /* Forget any previously recorded base line for line number display. */
16531 if (!buffer_unchanged_p
)
16532 w
->base_line_number
= 0;
16534 /* Determine the window start relative to point. */
16535 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16536 it
.current_y
= it
.last_visible_y
;
16537 if (centering_position
< 0)
16539 int window_total_lines
16540 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16543 ? min (scroll_margin
, window_total_lines
/ 4)
16545 ptrdiff_t margin_pos
= CHARPOS (startp
);
16546 Lisp_Object aggressive
;
16549 /* If there is a scroll margin at the top of the window, find
16550 its character position. */
16552 /* Cannot call start_display if startp is not in the
16553 accessible region of the buffer. This can happen when we
16554 have just switched to a different buffer and/or changed
16555 its restriction. In that case, startp is initialized to
16556 the character position 1 (BEGV) because we did not yet
16557 have chance to display the buffer even once. */
16558 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16561 void *it1data
= NULL
;
16563 SAVE_IT (it1
, it
, it1data
);
16564 start_display (&it1
, w
, startp
);
16565 move_it_vertically (&it1
, margin
* frame_line_height
);
16566 margin_pos
= IT_CHARPOS (it1
);
16567 RESTORE_IT (&it
, &it
, it1data
);
16569 scrolling_up
= PT
> margin_pos
;
16572 ? BVAR (current_buffer
, scroll_up_aggressively
)
16573 : BVAR (current_buffer
, scroll_down_aggressively
);
16575 if (!MINI_WINDOW_P (w
)
16576 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16580 /* Setting scroll-conservatively overrides
16581 scroll-*-aggressively. */
16582 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16584 double float_amount
= XFLOATINT (aggressive
);
16586 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16587 if (pt_offset
== 0 && float_amount
> 0)
16589 if (pt_offset
&& margin
> 0)
16592 /* Compute how much to move the window start backward from
16593 point so that point will be displayed where the user
16597 centering_position
= it
.last_visible_y
;
16599 centering_position
-= pt_offset
;
16600 centering_position
-=
16601 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16602 + WINDOW_HEADER_LINE_HEIGHT (w
);
16603 /* Don't let point enter the scroll margin near top of
16605 if (centering_position
< margin
* frame_line_height
)
16606 centering_position
= margin
* frame_line_height
;
16609 centering_position
= margin
* frame_line_height
+ pt_offset
;
16612 /* Set the window start half the height of the window backward
16614 centering_position
= window_box_height (w
) / 2;
16616 move_it_vertically_backward (&it
, centering_position
);
16618 eassert (IT_CHARPOS (it
) >= BEGV
);
16620 /* The function move_it_vertically_backward may move over more
16621 than the specified y-distance. If it->w is small, e.g. a
16622 mini-buffer window, we may end up in front of the window's
16623 display area. Start displaying at the start of the line
16624 containing PT in this case. */
16625 if (it
.current_y
<= 0)
16627 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16628 move_it_vertically_backward (&it
, 0);
16632 it
.current_x
= it
.hpos
= 0;
16634 /* Set the window start position here explicitly, to avoid an
16635 infinite loop in case the functions in window-scroll-functions
16637 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16639 /* Run scroll hooks. */
16640 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16642 /* Redisplay the window. */
16643 if (!current_matrix_up_to_date_p
16644 || windows_or_buffers_changed
16645 || f
->cursor_type_changed
16646 /* Don't use try_window_reusing_current_matrix in this case
16647 because it can have changed the buffer. */
16648 || !NILP (Vwindow_scroll_functions
)
16649 || !just_this_one_p
16650 || MINI_WINDOW_P (w
)
16651 || !(used_current_matrix_p
16652 = try_window_reusing_current_matrix (w
)))
16653 try_window (window
, startp
, 0);
16655 /* If new fonts have been loaded (due to fontsets), give up. We
16656 have to start a new redisplay since we need to re-adjust glyph
16658 if (f
->fonts_changed
)
16659 goto need_larger_matrices
;
16661 /* If cursor did not appear assume that the middle of the window is
16662 in the first line of the window. Do it again with the next line.
16663 (Imagine a window of height 100, displaying two lines of height
16664 60. Moving back 50 from it->last_visible_y will end in the first
16666 if (w
->cursor
.vpos
< 0)
16668 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16670 clear_glyph_matrix (w
->desired_matrix
);
16671 move_it_by_lines (&it
, 1);
16672 try_window (window
, it
.current
.pos
, 0);
16674 else if (PT
< IT_CHARPOS (it
))
16676 clear_glyph_matrix (w
->desired_matrix
);
16677 move_it_by_lines (&it
, -1);
16678 try_window (window
, it
.current
.pos
, 0);
16682 /* Not much we can do about it. */
16686 /* Consider the following case: Window starts at BEGV, there is
16687 invisible, intangible text at BEGV, so that display starts at
16688 some point START > BEGV. It can happen that we are called with
16689 PT somewhere between BEGV and START. Try to handle that case,
16690 and similar ones. */
16691 if (w
->cursor
.vpos
< 0)
16693 /* First, try locating the proper glyph row for PT. */
16694 struct glyph_row
*row
=
16695 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16697 /* Sometimes point is at the beginning of invisible text that is
16698 before the 1st character displayed in the row. In that case,
16699 row_containing_pos fails to find the row, because no glyphs
16700 with appropriate buffer positions are present in the row.
16701 Therefore, we next try to find the row which shows the 1st
16702 position after the invisible text. */
16706 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16709 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16712 Lisp_Object invis_end
=
16713 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16716 if (NATNUMP (invis_end
))
16717 alt_pos
= XFASTINT (invis_end
);
16720 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16724 /* Finally, fall back on the first row of the window after the
16725 header line (if any). This is slightly better than not
16726 displaying the cursor at all. */
16729 row
= w
->current_matrix
->rows
;
16730 if (row
->mode_line_p
)
16733 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16736 if (!cursor_row_fully_visible_p (w
, 0, 0))
16738 /* If vscroll is enabled, disable it and try again. */
16742 clear_glyph_matrix (w
->desired_matrix
);
16746 /* Users who set scroll-conservatively to a large number want
16747 point just above/below the scroll margin. If we ended up
16748 with point's row partially visible, move the window start to
16749 make that row fully visible and out of the margin. */
16750 if (scroll_conservatively
> SCROLL_LIMIT
)
16752 int window_total_lines
16753 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16756 ? min (scroll_margin
, window_total_lines
/ 4)
16758 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16760 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16761 clear_glyph_matrix (w
->desired_matrix
);
16762 if (1 == try_window (window
, it
.current
.pos
,
16763 TRY_WINDOW_CHECK_MARGINS
))
16767 /* If centering point failed to make the whole line visible,
16768 put point at the top instead. That has to make the whole line
16769 visible, if it can be done. */
16770 if (centering_position
== 0)
16773 clear_glyph_matrix (w
->desired_matrix
);
16774 centering_position
= 0;
16780 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16781 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16782 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16784 /* Display the mode line, if we must. */
16785 if ((update_mode_line
16786 /* If window not full width, must redo its mode line
16787 if (a) the window to its side is being redone and
16788 (b) we do a frame-based redisplay. This is a consequence
16789 of how inverted lines are drawn in frame-based redisplay. */
16790 || (!just_this_one_p
16791 && !FRAME_WINDOW_P (f
)
16792 && !WINDOW_FULL_WIDTH_P (w
))
16793 /* Line number to display. */
16794 || w
->base_line_pos
> 0
16795 /* Column number is displayed and different from the one displayed. */
16796 || (w
->column_number_displayed
!= -1
16797 && (w
->column_number_displayed
!= current_column ())))
16798 /* This means that the window has a mode line. */
16799 && (WINDOW_WANTS_MODELINE_P (w
)
16800 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16803 display_mode_lines (w
);
16805 /* If mode line height has changed, arrange for a thorough
16806 immediate redisplay using the correct mode line height. */
16807 if (WINDOW_WANTS_MODELINE_P (w
)
16808 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16810 f
->fonts_changed
= 1;
16811 w
->mode_line_height
= -1;
16812 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16813 = DESIRED_MODE_LINE_HEIGHT (w
);
16816 /* If header line height has changed, arrange for a thorough
16817 immediate redisplay using the correct header line height. */
16818 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16819 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16821 f
->fonts_changed
= 1;
16822 w
->header_line_height
= -1;
16823 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16824 = DESIRED_HEADER_LINE_HEIGHT (w
);
16827 if (f
->fonts_changed
)
16828 goto need_larger_matrices
;
16831 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16833 w
->base_line_pos
= 0;
16834 w
->base_line_number
= 0;
16839 /* When we reach a frame's selected window, redo the frame's menu bar. */
16840 if (update_mode_line
16841 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16843 int redisplay_menu_p
= 0;
16845 if (FRAME_WINDOW_P (f
))
16847 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16848 || defined (HAVE_NS) || defined (USE_GTK)
16849 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16851 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16855 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16857 if (redisplay_menu_p
)
16858 display_menu_bar (w
);
16860 #ifdef HAVE_WINDOW_SYSTEM
16861 if (FRAME_WINDOW_P (f
))
16863 #if defined (USE_GTK) || defined (HAVE_NS)
16864 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16865 redisplay_tool_bar (f
);
16867 if (WINDOWP (f
->tool_bar_window
)
16868 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16869 || !NILP (Vauto_resize_tool_bars
))
16870 && redisplay_tool_bar (f
))
16871 ignore_mouse_drag_p
= 1;
16877 #ifdef HAVE_WINDOW_SYSTEM
16878 if (FRAME_WINDOW_P (f
)
16879 && update_window_fringes (w
, (just_this_one_p
16880 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16881 || w
->pseudo_window_p
)))
16885 if (draw_window_fringes (w
, 1))
16887 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16888 x_draw_right_divider (w
);
16890 x_draw_vertical_border (w
);
16896 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16897 x_draw_bottom_divider (w
);
16898 #endif /* HAVE_WINDOW_SYSTEM */
16900 /* We go to this label, with fonts_changed set, if it is
16901 necessary to try again using larger glyph matrices.
16902 We have to redeem the scroll bar even in this case,
16903 because the loop in redisplay_internal expects that. */
16904 need_larger_matrices
:
16906 finish_scroll_bars
:
16908 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16910 /* Set the thumb's position and size. */
16911 set_vertical_scroll_bar (w
);
16913 /* Note that we actually used the scroll bar attached to this
16914 window, so it shouldn't be deleted at the end of redisplay. */
16915 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16916 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16919 /* Restore current_buffer and value of point in it. The window
16920 update may have changed the buffer, so first make sure `opoint'
16921 is still valid (Bug#6177). */
16922 if (CHARPOS (opoint
) < BEGV
)
16923 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16924 else if (CHARPOS (opoint
) > ZV
)
16925 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16927 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16929 set_buffer_internal_1 (old
);
16930 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16931 shorter. This can be caused by log truncation in *Messages*. */
16932 if (CHARPOS (lpoint
) <= ZV
)
16933 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16935 unbind_to (count
, Qnil
);
16939 /* Build the complete desired matrix of WINDOW with a window start
16940 buffer position POS.
16942 Value is 1 if successful. It is zero if fonts were loaded during
16943 redisplay which makes re-adjusting glyph matrices necessary, and -1
16944 if point would appear in the scroll margins.
16945 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16946 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16950 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16952 struct window
*w
= XWINDOW (window
);
16954 struct glyph_row
*last_text_row
= NULL
;
16955 struct frame
*f
= XFRAME (w
->frame
);
16956 int frame_line_height
= default_line_pixel_height (w
);
16958 /* Make POS the new window start. */
16959 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16961 /* Mark cursor position as unknown. No overlay arrow seen. */
16962 w
->cursor
.vpos
= -1;
16963 overlay_arrow_seen
= 0;
16965 /* Initialize iterator and info to start at POS. */
16966 start_display (&it
, w
, pos
);
16968 /* Display all lines of W. */
16969 while (it
.current_y
< it
.last_visible_y
)
16971 if (display_line (&it
))
16972 last_text_row
= it
.glyph_row
- 1;
16973 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16977 /* Don't let the cursor end in the scroll margins. */
16978 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16979 && !MINI_WINDOW_P (w
))
16981 int this_scroll_margin
;
16982 int window_total_lines
16983 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16985 if (scroll_margin
> 0)
16987 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16988 this_scroll_margin
*= frame_line_height
;
16991 this_scroll_margin
= 0;
16993 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16994 && w
->cursor
.y
< this_scroll_margin
16995 && CHARPOS (pos
) > BEGV
16996 && IT_CHARPOS (it
) < ZV
)
16997 /* rms: considering make_cursor_line_fully_visible_p here
16998 seems to give wrong results. We don't want to recenter
16999 when the last line is partly visible, we want to allow
17000 that case to be handled in the usual way. */
17001 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17003 w
->cursor
.vpos
= -1;
17004 clear_glyph_matrix (w
->desired_matrix
);
17009 /* If bottom moved off end of frame, change mode line percentage. */
17010 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17011 w
->update_mode_line
= 1;
17013 /* Set window_end_pos to the offset of the last character displayed
17014 on the window from the end of current_buffer. Set
17015 window_end_vpos to its row number. */
17018 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17019 adjust_window_ends (w
, last_text_row
, 0);
17021 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17022 w
->window_end_vpos
)));
17026 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17027 w
->window_end_pos
= Z
- ZV
;
17028 w
->window_end_vpos
= 0;
17031 /* But that is not valid info until redisplay finishes. */
17032 w
->window_end_valid
= 0;
17038 /************************************************************************
17039 Window redisplay reusing current matrix when buffer has not changed
17040 ************************************************************************/
17042 /* Try redisplay of window W showing an unchanged buffer with a
17043 different window start than the last time it was displayed by
17044 reusing its current matrix. Value is non-zero if successful.
17045 W->start is the new window start. */
17048 try_window_reusing_current_matrix (struct window
*w
)
17050 struct frame
*f
= XFRAME (w
->frame
);
17051 struct glyph_row
*bottom_row
;
17054 struct text_pos start
, new_start
;
17055 int nrows_scrolled
, i
;
17056 struct glyph_row
*last_text_row
;
17057 struct glyph_row
*last_reused_text_row
;
17058 struct glyph_row
*start_row
;
17059 int start_vpos
, min_y
, max_y
;
17062 if (inhibit_try_window_reusing
)
17066 if (/* This function doesn't handle terminal frames. */
17067 !FRAME_WINDOW_P (f
)
17068 /* Don't try to reuse the display if windows have been split
17070 || windows_or_buffers_changed
17071 || f
->cursor_type_changed
)
17074 /* Can't do this if showing trailing whitespace. */
17075 if (!NILP (Vshow_trailing_whitespace
))
17078 /* If top-line visibility has changed, give up. */
17079 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17080 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17083 /* Give up if old or new display is scrolled vertically. We could
17084 make this function handle this, but right now it doesn't. */
17085 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17086 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17089 /* The variable new_start now holds the new window start. The old
17090 start `start' can be determined from the current matrix. */
17091 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17092 start
= start_row
->minpos
;
17093 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17095 /* Clear the desired matrix for the display below. */
17096 clear_glyph_matrix (w
->desired_matrix
);
17098 if (CHARPOS (new_start
) <= CHARPOS (start
))
17100 /* Don't use this method if the display starts with an ellipsis
17101 displayed for invisible text. It's not easy to handle that case
17102 below, and it's certainly not worth the effort since this is
17103 not a frequent case. */
17104 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17107 IF_DEBUG (debug_method_add (w
, "twu1"));
17109 /* Display up to a row that can be reused. The variable
17110 last_text_row is set to the last row displayed that displays
17111 text. Note that it.vpos == 0 if or if not there is a
17112 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17113 start_display (&it
, w
, new_start
);
17114 w
->cursor
.vpos
= -1;
17115 last_text_row
= last_reused_text_row
= NULL
;
17117 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17119 /* If we have reached into the characters in the START row,
17120 that means the line boundaries have changed. So we
17121 can't start copying with the row START. Maybe it will
17122 work to start copying with the following row. */
17123 while (IT_CHARPOS (it
) > CHARPOS (start
))
17125 /* Advance to the next row as the "start". */
17127 start
= start_row
->minpos
;
17128 /* If there are no more rows to try, or just one, give up. */
17129 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17130 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17131 || CHARPOS (start
) == ZV
)
17133 clear_glyph_matrix (w
->desired_matrix
);
17137 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17139 /* If we have reached alignment, we can copy the rest of the
17141 if (IT_CHARPOS (it
) == CHARPOS (start
)
17142 /* Don't accept "alignment" inside a display vector,
17143 since start_row could have started in the middle of
17144 that same display vector (thus their character
17145 positions match), and we have no way of telling if
17146 that is the case. */
17147 && it
.current
.dpvec_index
< 0)
17150 if (display_line (&it
))
17151 last_text_row
= it
.glyph_row
- 1;
17155 /* A value of current_y < last_visible_y means that we stopped
17156 at the previous window start, which in turn means that we
17157 have at least one reusable row. */
17158 if (it
.current_y
< it
.last_visible_y
)
17160 struct glyph_row
*row
;
17162 /* IT.vpos always starts from 0; it counts text lines. */
17163 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17165 /* Find PT if not already found in the lines displayed. */
17166 if (w
->cursor
.vpos
< 0)
17168 int dy
= it
.current_y
- start_row
->y
;
17170 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17171 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17173 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17174 dy
, nrows_scrolled
);
17177 clear_glyph_matrix (w
->desired_matrix
);
17182 /* Scroll the display. Do it before the current matrix is
17183 changed. The problem here is that update has not yet
17184 run, i.e. part of the current matrix is not up to date.
17185 scroll_run_hook will clear the cursor, and use the
17186 current matrix to get the height of the row the cursor is
17188 run
.current_y
= start_row
->y
;
17189 run
.desired_y
= it
.current_y
;
17190 run
.height
= it
.last_visible_y
- it
.current_y
;
17192 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17195 FRAME_RIF (f
)->update_window_begin_hook (w
);
17196 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17197 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17198 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17202 /* Shift current matrix down by nrows_scrolled lines. */
17203 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17204 rotate_matrix (w
->current_matrix
,
17206 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17209 /* Disable lines that must be updated. */
17210 for (i
= 0; i
< nrows_scrolled
; ++i
)
17211 (start_row
+ i
)->enabled_p
= false;
17213 /* Re-compute Y positions. */
17214 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17215 max_y
= it
.last_visible_y
;
17216 for (row
= start_row
+ nrows_scrolled
;
17220 row
->y
= it
.current_y
;
17221 row
->visible_height
= row
->height
;
17223 if (row
->y
< min_y
)
17224 row
->visible_height
-= min_y
- row
->y
;
17225 if (row
->y
+ row
->height
> max_y
)
17226 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17227 if (row
->fringe_bitmap_periodic_p
)
17228 row
->redraw_fringe_bitmaps_p
= 1;
17230 it
.current_y
+= row
->height
;
17232 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17233 last_reused_text_row
= row
;
17234 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17238 /* Disable lines in the current matrix which are now
17239 below the window. */
17240 for (++row
; row
< bottom_row
; ++row
)
17241 row
->enabled_p
= row
->mode_line_p
= 0;
17244 /* Update window_end_pos etc.; last_reused_text_row is the last
17245 reused row from the current matrix containing text, if any.
17246 The value of last_text_row is the last displayed line
17247 containing text. */
17248 if (last_reused_text_row
)
17249 adjust_window_ends (w
, last_reused_text_row
, 1);
17250 else if (last_text_row
)
17251 adjust_window_ends (w
, last_text_row
, 0);
17254 /* This window must be completely empty. */
17255 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17256 w
->window_end_pos
= Z
- ZV
;
17257 w
->window_end_vpos
= 0;
17259 w
->window_end_valid
= 0;
17261 /* Update hint: don't try scrolling again in update_window. */
17262 w
->desired_matrix
->no_scrolling_p
= 1;
17265 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17269 else if (CHARPOS (new_start
) > CHARPOS (start
))
17271 struct glyph_row
*pt_row
, *row
;
17272 struct glyph_row
*first_reusable_row
;
17273 struct glyph_row
*first_row_to_display
;
17275 int yb
= window_text_bottom_y (w
);
17277 /* Find the row starting at new_start, if there is one. Don't
17278 reuse a partially visible line at the end. */
17279 first_reusable_row
= start_row
;
17280 while (first_reusable_row
->enabled_p
17281 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17282 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17283 < CHARPOS (new_start
)))
17284 ++first_reusable_row
;
17286 /* Give up if there is no row to reuse. */
17287 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17288 || !first_reusable_row
->enabled_p
17289 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17290 != CHARPOS (new_start
)))
17293 /* We can reuse fully visible rows beginning with
17294 first_reusable_row to the end of the window. Set
17295 first_row_to_display to the first row that cannot be reused.
17296 Set pt_row to the row containing point, if there is any. */
17298 for (first_row_to_display
= first_reusable_row
;
17299 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17300 ++first_row_to_display
)
17302 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17303 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17304 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17305 && first_row_to_display
->ends_at_zv_p
17306 && pt_row
== NULL
)))
17307 pt_row
= first_row_to_display
;
17310 /* Start displaying at the start of first_row_to_display. */
17311 eassert (first_row_to_display
->y
< yb
);
17312 init_to_row_start (&it
, w
, first_row_to_display
);
17314 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17316 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17318 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17319 + WINDOW_HEADER_LINE_HEIGHT (w
));
17321 /* Display lines beginning with first_row_to_display in the
17322 desired matrix. Set last_text_row to the last row displayed
17323 that displays text. */
17324 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17325 if (pt_row
== NULL
)
17326 w
->cursor
.vpos
= -1;
17327 last_text_row
= NULL
;
17328 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17329 if (display_line (&it
))
17330 last_text_row
= it
.glyph_row
- 1;
17332 /* If point is in a reused row, adjust y and vpos of the cursor
17336 w
->cursor
.vpos
-= nrows_scrolled
;
17337 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17340 /* Give up if point isn't in a row displayed or reused. (This
17341 also handles the case where w->cursor.vpos < nrows_scrolled
17342 after the calls to display_line, which can happen with scroll
17343 margins. See bug#1295.) */
17344 if (w
->cursor
.vpos
< 0)
17346 clear_glyph_matrix (w
->desired_matrix
);
17350 /* Scroll the display. */
17351 run
.current_y
= first_reusable_row
->y
;
17352 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17353 run
.height
= it
.last_visible_y
- run
.current_y
;
17354 dy
= run
.current_y
- run
.desired_y
;
17359 FRAME_RIF (f
)->update_window_begin_hook (w
);
17360 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17361 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17362 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17366 /* Adjust Y positions of reused rows. */
17367 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17368 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17369 max_y
= it
.last_visible_y
;
17370 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17373 row
->visible_height
= row
->height
;
17374 if (row
->y
< min_y
)
17375 row
->visible_height
-= min_y
- row
->y
;
17376 if (row
->y
+ row
->height
> max_y
)
17377 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17378 if (row
->fringe_bitmap_periodic_p
)
17379 row
->redraw_fringe_bitmaps_p
= 1;
17382 /* Scroll the current matrix. */
17383 eassert (nrows_scrolled
> 0);
17384 rotate_matrix (w
->current_matrix
,
17386 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17389 /* Disable rows not reused. */
17390 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17391 row
->enabled_p
= false;
17393 /* Point may have moved to a different line, so we cannot assume that
17394 the previous cursor position is valid; locate the correct row. */
17397 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17399 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17400 && !row
->ends_at_zv_p
;
17404 w
->cursor
.y
= row
->y
;
17406 if (row
< bottom_row
)
17408 /* Can't simply scan the row for point with
17409 bidi-reordered glyph rows. Let set_cursor_from_row
17410 figure out where to put the cursor, and if it fails,
17412 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17414 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17417 clear_glyph_matrix (w
->desired_matrix
);
17423 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17424 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17427 && (!BUFFERP (glyph
->object
)
17428 || glyph
->charpos
< PT
);
17432 w
->cursor
.x
+= glyph
->pixel_width
;
17438 /* Adjust window end. A null value of last_text_row means that
17439 the window end is in reused rows which in turn means that
17440 only its vpos can have changed. */
17442 adjust_window_ends (w
, last_text_row
, 0);
17444 w
->window_end_vpos
-= nrows_scrolled
;
17446 w
->window_end_valid
= 0;
17447 w
->desired_matrix
->no_scrolling_p
= 1;
17450 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17460 /************************************************************************
17461 Window redisplay reusing current matrix when buffer has changed
17462 ************************************************************************/
17464 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17465 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17466 ptrdiff_t *, ptrdiff_t *);
17467 static struct glyph_row
*
17468 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17469 struct glyph_row
*);
17472 /* Return the last row in MATRIX displaying text. If row START is
17473 non-null, start searching with that row. IT gives the dimensions
17474 of the display. Value is null if matrix is empty; otherwise it is
17475 a pointer to the row found. */
17477 static struct glyph_row
*
17478 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17479 struct glyph_row
*start
)
17481 struct glyph_row
*row
, *row_found
;
17483 /* Set row_found to the last row in IT->w's current matrix
17484 displaying text. The loop looks funny but think of partially
17487 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17488 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17490 eassert (row
->enabled_p
);
17492 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17501 /* Return the last row in the current matrix of W that is not affected
17502 by changes at the start of current_buffer that occurred since W's
17503 current matrix was built. Value is null if no such row exists.
17505 BEG_UNCHANGED us the number of characters unchanged at the start of
17506 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17507 first changed character in current_buffer. Characters at positions <
17508 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17509 when the current matrix was built. */
17511 static struct glyph_row
*
17512 find_last_unchanged_at_beg_row (struct window
*w
)
17514 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17515 struct glyph_row
*row
;
17516 struct glyph_row
*row_found
= NULL
;
17517 int yb
= window_text_bottom_y (w
);
17519 /* Find the last row displaying unchanged text. */
17520 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17521 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17522 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17525 if (/* If row ends before first_changed_pos, it is unchanged,
17526 except in some case. */
17527 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17528 /* When row ends in ZV and we write at ZV it is not
17530 && !row
->ends_at_zv_p
17531 /* When first_changed_pos is the end of a continued line,
17532 row is not unchanged because it may be no longer
17534 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17535 && (row
->continued_p
17536 || row
->exact_window_width_line_p
))
17537 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17538 needs to be recomputed, so don't consider this row as
17539 unchanged. This happens when the last line was
17540 bidi-reordered and was killed immediately before this
17541 redisplay cycle. In that case, ROW->end stores the
17542 buffer position of the first visual-order character of
17543 the killed text, which is now beyond ZV. */
17544 && CHARPOS (row
->end
.pos
) <= ZV
)
17547 /* Stop if last visible row. */
17548 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17556 /* Find the first glyph row in the current matrix of W that is not
17557 affected by changes at the end of current_buffer since the
17558 time W's current matrix was built.
17560 Return in *DELTA the number of chars by which buffer positions in
17561 unchanged text at the end of current_buffer must be adjusted.
17563 Return in *DELTA_BYTES the corresponding number of bytes.
17565 Value is null if no such row exists, i.e. all rows are affected by
17568 static struct glyph_row
*
17569 find_first_unchanged_at_end_row (struct window
*w
,
17570 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17572 struct glyph_row
*row
;
17573 struct glyph_row
*row_found
= NULL
;
17575 *delta
= *delta_bytes
= 0;
17577 /* Display must not have been paused, otherwise the current matrix
17578 is not up to date. */
17579 eassert (w
->window_end_valid
);
17581 /* A value of window_end_pos >= END_UNCHANGED means that the window
17582 end is in the range of changed text. If so, there is no
17583 unchanged row at the end of W's current matrix. */
17584 if (w
->window_end_pos
>= END_UNCHANGED
)
17587 /* Set row to the last row in W's current matrix displaying text. */
17588 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17590 /* If matrix is entirely empty, no unchanged row exists. */
17591 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17593 /* The value of row is the last glyph row in the matrix having a
17594 meaningful buffer position in it. The end position of row
17595 corresponds to window_end_pos. This allows us to translate
17596 buffer positions in the current matrix to current buffer
17597 positions for characters not in changed text. */
17599 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17600 ptrdiff_t Z_BYTE_old
=
17601 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17602 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17603 struct glyph_row
*first_text_row
17604 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17606 *delta
= Z
- Z_old
;
17607 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17609 /* Set last_unchanged_pos to the buffer position of the last
17610 character in the buffer that has not been changed. Z is the
17611 index + 1 of the last character in current_buffer, i.e. by
17612 subtracting END_UNCHANGED we get the index of the last
17613 unchanged character, and we have to add BEG to get its buffer
17615 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17616 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17618 /* Search backward from ROW for a row displaying a line that
17619 starts at a minimum position >= last_unchanged_pos_old. */
17620 for (; row
> first_text_row
; --row
)
17622 /* This used to abort, but it can happen.
17623 It is ok to just stop the search instead here. KFS. */
17624 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17627 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17632 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17638 /* Make sure that glyph rows in the current matrix of window W
17639 reference the same glyph memory as corresponding rows in the
17640 frame's frame matrix. This function is called after scrolling W's
17641 current matrix on a terminal frame in try_window_id and
17642 try_window_reusing_current_matrix. */
17645 sync_frame_with_window_matrix_rows (struct window
*w
)
17647 struct frame
*f
= XFRAME (w
->frame
);
17648 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17650 /* Preconditions: W must be a leaf window and full-width. Its frame
17651 must have a frame matrix. */
17652 eassert (BUFFERP (w
->contents
));
17653 eassert (WINDOW_FULL_WIDTH_P (w
));
17654 eassert (!FRAME_WINDOW_P (f
));
17656 /* If W is a full-width window, glyph pointers in W's current matrix
17657 have, by definition, to be the same as glyph pointers in the
17658 corresponding frame matrix. Note that frame matrices have no
17659 marginal areas (see build_frame_matrix). */
17660 window_row
= w
->current_matrix
->rows
;
17661 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17662 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17663 while (window_row
< window_row_end
)
17665 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17666 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17668 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17669 frame_row
->glyphs
[TEXT_AREA
] = start
;
17670 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17671 frame_row
->glyphs
[LAST_AREA
] = end
;
17673 /* Disable frame rows whose corresponding window rows have
17674 been disabled in try_window_id. */
17675 if (!window_row
->enabled_p
)
17676 frame_row
->enabled_p
= false;
17678 ++window_row
, ++frame_row
;
17683 /* Find the glyph row in window W containing CHARPOS. Consider all
17684 rows between START and END (not inclusive). END null means search
17685 all rows to the end of the display area of W. Value is the row
17686 containing CHARPOS or null. */
17689 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17690 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17692 struct glyph_row
*row
= start
;
17693 struct glyph_row
*best_row
= NULL
;
17694 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17697 /* If we happen to start on a header-line, skip that. */
17698 if (row
->mode_line_p
)
17701 if ((end
&& row
>= end
) || !row
->enabled_p
)
17704 last_y
= window_text_bottom_y (w
) - dy
;
17708 /* Give up if we have gone too far. */
17709 if (end
&& row
>= end
)
17711 /* This formerly returned if they were equal.
17712 I think that both quantities are of a "last plus one" type;
17713 if so, when they are equal, the row is within the screen. -- rms. */
17714 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17717 /* If it is in this row, return this row. */
17718 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17719 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17720 /* The end position of a row equals the start
17721 position of the next row. If CHARPOS is there, we
17722 would rather consider it displayed in the next
17723 line, except when this line ends in ZV. */
17724 && !row_for_charpos_p (row
, charpos
)))
17725 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17729 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17730 || (!best_row
&& !row
->continued_p
))
17732 /* In bidi-reordered rows, there could be several rows whose
17733 edges surround CHARPOS, all of these rows belonging to
17734 the same continued line. We need to find the row which
17735 fits CHARPOS the best. */
17736 for (g
= row
->glyphs
[TEXT_AREA
];
17737 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17740 if (!STRINGP (g
->object
))
17742 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17744 mindif
= eabs (g
->charpos
- charpos
);
17746 /* Exact match always wins. */
17753 else if (best_row
&& !row
->continued_p
)
17760 /* Try to redisplay window W by reusing its existing display. W's
17761 current matrix must be up to date when this function is called,
17762 i.e. window_end_valid must be nonzero.
17766 >= 1 if successful, i.e. display has been updated
17768 1 means the changes were in front of a newline that precedes
17769 the window start, and the whole current matrix was reused
17770 2 means the changes were after the last position displayed
17771 in the window, and the whole current matrix was reused
17772 3 means portions of the current matrix were reused, while
17773 some of the screen lines were redrawn
17774 -1 if redisplay with same window start is known not to succeed
17775 0 if otherwise unsuccessful
17777 The following steps are performed:
17779 1. Find the last row in the current matrix of W that is not
17780 affected by changes at the start of current_buffer. If no such row
17783 2. Find the first row in W's current matrix that is not affected by
17784 changes at the end of current_buffer. Maybe there is no such row.
17786 3. Display lines beginning with the row + 1 found in step 1 to the
17787 row found in step 2 or, if step 2 didn't find a row, to the end of
17790 4. If cursor is not known to appear on the window, give up.
17792 5. If display stopped at the row found in step 2, scroll the
17793 display and current matrix as needed.
17795 6. Maybe display some lines at the end of W, if we must. This can
17796 happen under various circumstances, like a partially visible line
17797 becoming fully visible, or because newly displayed lines are displayed
17798 in smaller font sizes.
17800 7. Update W's window end information. */
17803 try_window_id (struct window
*w
)
17805 struct frame
*f
= XFRAME (w
->frame
);
17806 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17807 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17808 struct glyph_row
*last_unchanged_at_beg_row
;
17809 struct glyph_row
*first_unchanged_at_end_row
;
17810 struct glyph_row
*row
;
17811 struct glyph_row
*bottom_row
;
17814 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17816 struct text_pos start_pos
;
17818 int first_unchanged_at_end_vpos
= 0;
17819 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17820 struct text_pos start
;
17821 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17824 if (inhibit_try_window_id
)
17828 /* This is handy for debugging. */
17830 #define GIVE_UP(X) \
17832 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17836 #define GIVE_UP(X) return 0
17839 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17841 /* Don't use this for mini-windows because these can show
17842 messages and mini-buffers, and we don't handle that here. */
17843 if (MINI_WINDOW_P (w
))
17846 /* This flag is used to prevent redisplay optimizations. */
17847 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17850 /* This function's optimizations cannot be used if overlays have
17851 changed in the buffer displayed by the window, so give up if they
17853 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17856 /* Verify that narrowing has not changed.
17857 Also verify that we were not told to prevent redisplay optimizations.
17858 It would be nice to further
17859 reduce the number of cases where this prevents try_window_id. */
17860 if (current_buffer
->clip_changed
17861 || current_buffer
->prevent_redisplay_optimizations_p
)
17864 /* Window must either use window-based redisplay or be full width. */
17865 if (!FRAME_WINDOW_P (f
)
17866 && (!FRAME_LINE_INS_DEL_OK (f
)
17867 || !WINDOW_FULL_WIDTH_P (w
)))
17870 /* Give up if point is known NOT to appear in W. */
17871 if (PT
< CHARPOS (start
))
17874 /* Another way to prevent redisplay optimizations. */
17875 if (w
->last_modified
== 0)
17878 /* Verify that window is not hscrolled. */
17879 if (w
->hscroll
!= 0)
17882 /* Verify that display wasn't paused. */
17883 if (!w
->window_end_valid
)
17886 /* Likewise if highlighting trailing whitespace. */
17887 if (!NILP (Vshow_trailing_whitespace
))
17890 /* Can't use this if overlay arrow position and/or string have
17892 if (overlay_arrows_changed_p ())
17895 /* When word-wrap is on, adding a space to the first word of a
17896 wrapped line can change the wrap position, altering the line
17897 above it. It might be worthwhile to handle this more
17898 intelligently, but for now just redisplay from scratch. */
17899 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17902 /* Under bidi reordering, adding or deleting a character in the
17903 beginning of a paragraph, before the first strong directional
17904 character, can change the base direction of the paragraph (unless
17905 the buffer specifies a fixed paragraph direction), which will
17906 require to redisplay the whole paragraph. It might be worthwhile
17907 to find the paragraph limits and widen the range of redisplayed
17908 lines to that, but for now just give up this optimization and
17909 redisplay from scratch. */
17910 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17911 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17914 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17915 only if buffer has really changed. The reason is that the gap is
17916 initially at Z for freshly visited files. The code below would
17917 set end_unchanged to 0 in that case. */
17918 if (MODIFF
> SAVE_MODIFF
17919 /* This seems to happen sometimes after saving a buffer. */
17920 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17922 if (GPT
- BEG
< BEG_UNCHANGED
)
17923 BEG_UNCHANGED
= GPT
- BEG
;
17924 if (Z
- GPT
< END_UNCHANGED
)
17925 END_UNCHANGED
= Z
- GPT
;
17928 /* The position of the first and last character that has been changed. */
17929 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17930 last_changed_charpos
= Z
- END_UNCHANGED
;
17932 /* If window starts after a line end, and the last change is in
17933 front of that newline, then changes don't affect the display.
17934 This case happens with stealth-fontification. Note that although
17935 the display is unchanged, glyph positions in the matrix have to
17936 be adjusted, of course. */
17937 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17938 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17939 && ((last_changed_charpos
< CHARPOS (start
)
17940 && CHARPOS (start
) == BEGV
)
17941 || (last_changed_charpos
< CHARPOS (start
) - 1
17942 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17944 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17945 struct glyph_row
*r0
;
17947 /* Compute how many chars/bytes have been added to or removed
17948 from the buffer. */
17949 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17950 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17951 Z_delta
= Z
- Z_old
;
17952 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17954 /* Give up if PT is not in the window. Note that it already has
17955 been checked at the start of try_window_id that PT is not in
17956 front of the window start. */
17957 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17960 /* If window start is unchanged, we can reuse the whole matrix
17961 as is, after adjusting glyph positions. No need to compute
17962 the window end again, since its offset from Z hasn't changed. */
17963 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17964 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17965 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17966 /* PT must not be in a partially visible line. */
17967 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17968 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17970 /* Adjust positions in the glyph matrix. */
17971 if (Z_delta
|| Z_delta_bytes
)
17973 struct glyph_row
*r1
17974 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17975 increment_matrix_positions (w
->current_matrix
,
17976 MATRIX_ROW_VPOS (r0
, current_matrix
),
17977 MATRIX_ROW_VPOS (r1
, current_matrix
),
17978 Z_delta
, Z_delta_bytes
);
17981 /* Set the cursor. */
17982 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17984 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17989 /* Handle the case that changes are all below what is displayed in
17990 the window, and that PT is in the window. This shortcut cannot
17991 be taken if ZV is visible in the window, and text has been added
17992 there that is visible in the window. */
17993 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17994 /* ZV is not visible in the window, or there are no
17995 changes at ZV, actually. */
17996 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17997 || first_changed_charpos
== last_changed_charpos
))
17999 struct glyph_row
*r0
;
18001 /* Give up if PT is not in the window. Note that it already has
18002 been checked at the start of try_window_id that PT is not in
18003 front of the window start. */
18004 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18007 /* If window start is unchanged, we can reuse the whole matrix
18008 as is, without changing glyph positions since no text has
18009 been added/removed in front of the window end. */
18010 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18011 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18012 /* PT must not be in a partially visible line. */
18013 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18014 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18016 /* We have to compute the window end anew since text
18017 could have been added/removed after it. */
18018 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18019 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18021 /* Set the cursor. */
18022 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18024 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18029 /* Give up if window start is in the changed area.
18031 The condition used to read
18033 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18035 but why that was tested escapes me at the moment. */
18036 if (CHARPOS (start
) >= first_changed_charpos
18037 && CHARPOS (start
) <= last_changed_charpos
)
18040 /* Check that window start agrees with the start of the first glyph
18041 row in its current matrix. Check this after we know the window
18042 start is not in changed text, otherwise positions would not be
18044 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18045 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18048 /* Give up if the window ends in strings. Overlay strings
18049 at the end are difficult to handle, so don't try. */
18050 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18051 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18054 /* Compute the position at which we have to start displaying new
18055 lines. Some of the lines at the top of the window might be
18056 reusable because they are not displaying changed text. Find the
18057 last row in W's current matrix not affected by changes at the
18058 start of current_buffer. Value is null if changes start in the
18059 first line of window. */
18060 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18061 if (last_unchanged_at_beg_row
)
18063 /* Avoid starting to display in the middle of a character, a TAB
18064 for instance. This is easier than to set up the iterator
18065 exactly, and it's not a frequent case, so the additional
18066 effort wouldn't really pay off. */
18067 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18068 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18069 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18070 --last_unchanged_at_beg_row
;
18072 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18075 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18077 start_pos
= it
.current
.pos
;
18079 /* Start displaying new lines in the desired matrix at the same
18080 vpos we would use in the current matrix, i.e. below
18081 last_unchanged_at_beg_row. */
18082 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18084 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18085 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18087 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18091 /* There are no reusable lines at the start of the window.
18092 Start displaying in the first text line. */
18093 start_display (&it
, w
, start
);
18094 it
.vpos
= it
.first_vpos
;
18095 start_pos
= it
.current
.pos
;
18098 /* Find the first row that is not affected by changes at the end of
18099 the buffer. Value will be null if there is no unchanged row, in
18100 which case we must redisplay to the end of the window. delta
18101 will be set to the value by which buffer positions beginning with
18102 first_unchanged_at_end_row have to be adjusted due to text
18104 first_unchanged_at_end_row
18105 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18106 IF_DEBUG (debug_delta
= delta
);
18107 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18109 /* Set stop_pos to the buffer position up to which we will have to
18110 display new lines. If first_unchanged_at_end_row != NULL, this
18111 is the buffer position of the start of the line displayed in that
18112 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18113 that we don't stop at a buffer position. */
18115 if (first_unchanged_at_end_row
)
18117 eassert (last_unchanged_at_beg_row
== NULL
18118 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18120 /* If this is a continuation line, move forward to the next one
18121 that isn't. Changes in lines above affect this line.
18122 Caution: this may move first_unchanged_at_end_row to a row
18123 not displaying text. */
18124 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18125 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18126 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18127 < it
.last_visible_y
))
18128 ++first_unchanged_at_end_row
;
18130 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18131 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18132 >= it
.last_visible_y
))
18133 first_unchanged_at_end_row
= NULL
;
18136 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18138 first_unchanged_at_end_vpos
18139 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18140 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18143 else if (last_unchanged_at_beg_row
== NULL
)
18149 /* Either there is no unchanged row at the end, or the one we have
18150 now displays text. This is a necessary condition for the window
18151 end pos calculation at the end of this function. */
18152 eassert (first_unchanged_at_end_row
== NULL
18153 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18155 debug_last_unchanged_at_beg_vpos
18156 = (last_unchanged_at_beg_row
18157 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18159 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18161 #endif /* GLYPH_DEBUG */
18164 /* Display new lines. Set last_text_row to the last new line
18165 displayed which has text on it, i.e. might end up as being the
18166 line where the window_end_vpos is. */
18167 w
->cursor
.vpos
= -1;
18168 last_text_row
= NULL
;
18169 overlay_arrow_seen
= 0;
18170 while (it
.current_y
< it
.last_visible_y
18171 && !f
->fonts_changed
18172 && (first_unchanged_at_end_row
== NULL
18173 || IT_CHARPOS (it
) < stop_pos
))
18175 if (display_line (&it
))
18176 last_text_row
= it
.glyph_row
- 1;
18179 if (f
->fonts_changed
)
18183 /* Compute differences in buffer positions, y-positions etc. for
18184 lines reused at the bottom of the window. Compute what we can
18186 if (first_unchanged_at_end_row
18187 /* No lines reused because we displayed everything up to the
18188 bottom of the window. */
18189 && it
.current_y
< it
.last_visible_y
)
18192 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18194 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18195 run
.current_y
= first_unchanged_at_end_row
->y
;
18196 run
.desired_y
= run
.current_y
+ dy
;
18197 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18201 delta
= delta_bytes
= dvpos
= dy
18202 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18203 first_unchanged_at_end_row
= NULL
;
18205 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18208 /* Find the cursor if not already found. We have to decide whether
18209 PT will appear on this window (it sometimes doesn't, but this is
18210 not a very frequent case.) This decision has to be made before
18211 the current matrix is altered. A value of cursor.vpos < 0 means
18212 that PT is either in one of the lines beginning at
18213 first_unchanged_at_end_row or below the window. Don't care for
18214 lines that might be displayed later at the window end; as
18215 mentioned, this is not a frequent case. */
18216 if (w
->cursor
.vpos
< 0)
18218 /* Cursor in unchanged rows at the top? */
18219 if (PT
< CHARPOS (start_pos
)
18220 && last_unchanged_at_beg_row
)
18222 row
= row_containing_pos (w
, PT
,
18223 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18224 last_unchanged_at_beg_row
+ 1, 0);
18226 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18229 /* Start from first_unchanged_at_end_row looking for PT. */
18230 else if (first_unchanged_at_end_row
)
18232 row
= row_containing_pos (w
, PT
- delta
,
18233 first_unchanged_at_end_row
, NULL
, 0);
18235 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18236 delta_bytes
, dy
, dvpos
);
18239 /* Give up if cursor was not found. */
18240 if (w
->cursor
.vpos
< 0)
18242 clear_glyph_matrix (w
->desired_matrix
);
18247 /* Don't let the cursor end in the scroll margins. */
18249 int this_scroll_margin
, cursor_height
;
18250 int frame_line_height
= default_line_pixel_height (w
);
18251 int window_total_lines
18252 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18254 this_scroll_margin
=
18255 max (0, min (scroll_margin
, window_total_lines
/ 4));
18256 this_scroll_margin
*= frame_line_height
;
18257 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18259 if ((w
->cursor
.y
< this_scroll_margin
18260 && CHARPOS (start
) > BEGV
)
18261 /* Old redisplay didn't take scroll margin into account at the bottom,
18262 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18263 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18264 ? cursor_height
+ this_scroll_margin
18265 : 1)) > it
.last_visible_y
)
18267 w
->cursor
.vpos
= -1;
18268 clear_glyph_matrix (w
->desired_matrix
);
18273 /* Scroll the display. Do it before changing the current matrix so
18274 that xterm.c doesn't get confused about where the cursor glyph is
18276 if (dy
&& run
.height
)
18280 if (FRAME_WINDOW_P (f
))
18282 FRAME_RIF (f
)->update_window_begin_hook (w
);
18283 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18284 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18285 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18289 /* Terminal frame. In this case, dvpos gives the number of
18290 lines to scroll by; dvpos < 0 means scroll up. */
18292 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18293 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18294 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18295 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18296 + window_internal_height (w
));
18298 #if defined (HAVE_GPM) || defined (MSDOS)
18299 x_clear_window_mouse_face (w
);
18301 /* Perform the operation on the screen. */
18304 /* Scroll last_unchanged_at_beg_row to the end of the
18305 window down dvpos lines. */
18306 set_terminal_window (f
, end
);
18308 /* On dumb terminals delete dvpos lines at the end
18309 before inserting dvpos empty lines. */
18310 if (!FRAME_SCROLL_REGION_OK (f
))
18311 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18313 /* Insert dvpos empty lines in front of
18314 last_unchanged_at_beg_row. */
18315 ins_del_lines (f
, from
, dvpos
);
18317 else if (dvpos
< 0)
18319 /* Scroll up last_unchanged_at_beg_vpos to the end of
18320 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18321 set_terminal_window (f
, end
);
18323 /* Delete dvpos lines in front of
18324 last_unchanged_at_beg_vpos. ins_del_lines will set
18325 the cursor to the given vpos and emit |dvpos| delete
18327 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18329 /* On a dumb terminal insert dvpos empty lines at the
18331 if (!FRAME_SCROLL_REGION_OK (f
))
18332 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18335 set_terminal_window (f
, 0);
18341 /* Shift reused rows of the current matrix to the right position.
18342 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18344 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18345 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18348 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18349 bottom_vpos
, dvpos
);
18350 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18353 else if (dvpos
> 0)
18355 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18356 bottom_vpos
, dvpos
);
18357 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18358 first_unchanged_at_end_vpos
+ dvpos
);
18361 /* For frame-based redisplay, make sure that current frame and window
18362 matrix are in sync with respect to glyph memory. */
18363 if (!FRAME_WINDOW_P (f
))
18364 sync_frame_with_window_matrix_rows (w
);
18366 /* Adjust buffer positions in reused rows. */
18367 if (delta
|| delta_bytes
)
18368 increment_matrix_positions (current_matrix
,
18369 first_unchanged_at_end_vpos
+ dvpos
,
18370 bottom_vpos
, delta
, delta_bytes
);
18372 /* Adjust Y positions. */
18374 shift_glyph_matrix (w
, current_matrix
,
18375 first_unchanged_at_end_vpos
+ dvpos
,
18378 if (first_unchanged_at_end_row
)
18380 first_unchanged_at_end_row
+= dvpos
;
18381 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18382 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18383 first_unchanged_at_end_row
= NULL
;
18386 /* If scrolling up, there may be some lines to display at the end of
18388 last_text_row_at_end
= NULL
;
18391 /* Scrolling up can leave for example a partially visible line
18392 at the end of the window to be redisplayed. */
18393 /* Set last_row to the glyph row in the current matrix where the
18394 window end line is found. It has been moved up or down in
18395 the matrix by dvpos. */
18396 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18397 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18399 /* If last_row is the window end line, it should display text. */
18400 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18402 /* If window end line was partially visible before, begin
18403 displaying at that line. Otherwise begin displaying with the
18404 line following it. */
18405 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18407 init_to_row_start (&it
, w
, last_row
);
18408 it
.vpos
= last_vpos
;
18409 it
.current_y
= last_row
->y
;
18413 init_to_row_end (&it
, w
, last_row
);
18414 it
.vpos
= 1 + last_vpos
;
18415 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18419 /* We may start in a continuation line. If so, we have to
18420 get the right continuation_lines_width and current_x. */
18421 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18422 it
.hpos
= it
.current_x
= 0;
18424 /* Display the rest of the lines at the window end. */
18425 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18426 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18428 /* Is it always sure that the display agrees with lines in
18429 the current matrix? I don't think so, so we mark rows
18430 displayed invalid in the current matrix by setting their
18431 enabled_p flag to zero. */
18432 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18433 if (display_line (&it
))
18434 last_text_row_at_end
= it
.glyph_row
- 1;
18438 /* Update window_end_pos and window_end_vpos. */
18439 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18441 /* Window end line if one of the preserved rows from the current
18442 matrix. Set row to the last row displaying text in current
18443 matrix starting at first_unchanged_at_end_row, after
18445 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18446 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18447 first_unchanged_at_end_row
);
18448 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18449 adjust_window_ends (w
, row
, 1);
18450 eassert (w
->window_end_bytepos
>= 0);
18451 IF_DEBUG (debug_method_add (w
, "A"));
18453 else if (last_text_row_at_end
)
18455 adjust_window_ends (w
, last_text_row_at_end
, 0);
18456 eassert (w
->window_end_bytepos
>= 0);
18457 IF_DEBUG (debug_method_add (w
, "B"));
18459 else if (last_text_row
)
18461 /* We have displayed either to the end of the window or at the
18462 end of the window, i.e. the last row with text is to be found
18463 in the desired matrix. */
18464 adjust_window_ends (w
, last_text_row
, 0);
18465 eassert (w
->window_end_bytepos
>= 0);
18467 else if (first_unchanged_at_end_row
== NULL
18468 && last_text_row
== NULL
18469 && last_text_row_at_end
== NULL
)
18471 /* Displayed to end of window, but no line containing text was
18472 displayed. Lines were deleted at the end of the window. */
18473 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18474 int vpos
= w
->window_end_vpos
;
18475 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18476 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18479 row
== NULL
&& vpos
>= first_vpos
;
18480 --vpos
, --current_row
, --desired_row
)
18482 if (desired_row
->enabled_p
)
18484 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18487 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18491 eassert (row
!= NULL
);
18492 w
->window_end_vpos
= vpos
+ 1;
18493 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18494 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18495 eassert (w
->window_end_bytepos
>= 0);
18496 IF_DEBUG (debug_method_add (w
, "C"));
18501 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18502 debug_end_vpos
= w
->window_end_vpos
));
18504 /* Record that display has not been completed. */
18505 w
->window_end_valid
= 0;
18506 w
->desired_matrix
->no_scrolling_p
= 1;
18514 /***********************************************************************
18515 More debugging support
18516 ***********************************************************************/
18520 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18521 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18522 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18525 /* Dump the contents of glyph matrix MATRIX on stderr.
18527 GLYPHS 0 means don't show glyph contents.
18528 GLYPHS 1 means show glyphs in short form
18529 GLYPHS > 1 means show glyphs in long form. */
18532 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18535 for (i
= 0; i
< matrix
->nrows
; ++i
)
18536 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18540 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18541 the glyph row and area where the glyph comes from. */
18544 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18546 if (glyph
->type
== CHAR_GLYPH
18547 || glyph
->type
== GLYPHLESS_GLYPH
)
18550 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18551 glyph
- row
->glyphs
[TEXT_AREA
],
18552 (glyph
->type
== CHAR_GLYPH
18556 (BUFFERP (glyph
->object
)
18558 : (STRINGP (glyph
->object
)
18560 : (INTEGERP (glyph
->object
)
18563 glyph
->pixel_width
,
18565 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18569 glyph
->left_box_line_p
,
18570 glyph
->right_box_line_p
);
18572 else if (glyph
->type
== STRETCH_GLYPH
)
18575 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18576 glyph
- row
->glyphs
[TEXT_AREA
],
18579 (BUFFERP (glyph
->object
)
18581 : (STRINGP (glyph
->object
)
18583 : (INTEGERP (glyph
->object
)
18586 glyph
->pixel_width
,
18590 glyph
->left_box_line_p
,
18591 glyph
->right_box_line_p
);
18593 else if (glyph
->type
== IMAGE_GLYPH
)
18596 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18597 glyph
- row
->glyphs
[TEXT_AREA
],
18600 (BUFFERP (glyph
->object
)
18602 : (STRINGP (glyph
->object
)
18604 : (INTEGERP (glyph
->object
)
18607 glyph
->pixel_width
,
18611 glyph
->left_box_line_p
,
18612 glyph
->right_box_line_p
);
18614 else if (glyph
->type
== COMPOSITE_GLYPH
)
18617 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18618 glyph
- row
->glyphs
[TEXT_AREA
],
18621 (BUFFERP (glyph
->object
)
18623 : (STRINGP (glyph
->object
)
18625 : (INTEGERP (glyph
->object
)
18628 glyph
->pixel_width
,
18630 if (glyph
->u
.cmp
.automatic
)
18633 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18634 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18636 glyph
->left_box_line_p
,
18637 glyph
->right_box_line_p
);
18642 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18643 GLYPHS 0 means don't show glyph contents.
18644 GLYPHS 1 means show glyphs in short form
18645 GLYPHS > 1 means show glyphs in long form. */
18648 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18652 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18653 fprintf (stderr
, "==============================================================================\n");
18655 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18656 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18658 MATRIX_ROW_START_CHARPOS (row
),
18659 MATRIX_ROW_END_CHARPOS (row
),
18660 row
->used
[TEXT_AREA
],
18661 row
->contains_overlapping_glyphs_p
,
18663 row
->truncated_on_left_p
,
18664 row
->truncated_on_right_p
,
18666 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18667 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18670 row
->ends_in_middle_of_char_p
,
18671 row
->starts_in_middle_of_char_p
,
18677 row
->visible_height
,
18680 /* The next 3 lines should align to "Start" in the header. */
18681 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18682 row
->end
.overlay_string_index
,
18683 row
->continuation_lines_width
);
18684 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18685 CHARPOS (row
->start
.string_pos
),
18686 CHARPOS (row
->end
.string_pos
));
18687 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18688 row
->end
.dpvec_index
);
18695 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18697 struct glyph
*glyph
= row
->glyphs
[area
];
18698 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18700 /* Glyph for a line end in text. */
18701 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18704 if (glyph
< glyph_end
)
18705 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18707 for (; glyph
< glyph_end
; ++glyph
)
18708 dump_glyph (row
, glyph
, area
);
18711 else if (glyphs
== 1)
18715 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18717 char *s
= alloca (row
->used
[area
] + 4);
18720 for (i
= 0; i
< row
->used
[area
]; ++i
)
18722 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18723 if (i
== row
->used
[area
] - 1
18724 && area
== TEXT_AREA
18725 && INTEGERP (glyph
->object
)
18726 && glyph
->type
== CHAR_GLYPH
18727 && glyph
->u
.ch
== ' ')
18729 strcpy (&s
[i
], "[\\n]");
18732 else if (glyph
->type
== CHAR_GLYPH
18733 && glyph
->u
.ch
< 0x80
18734 && glyph
->u
.ch
>= ' ')
18735 s
[i
] = glyph
->u
.ch
;
18741 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18747 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18748 Sdump_glyph_matrix
, 0, 1, "p",
18749 doc
: /* Dump the current matrix of the selected window to stderr.
18750 Shows contents of glyph row structures. With non-nil
18751 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18752 glyphs in short form, otherwise show glyphs in long form. */)
18753 (Lisp_Object glyphs
)
18755 struct window
*w
= XWINDOW (selected_window
);
18756 struct buffer
*buffer
= XBUFFER (w
->contents
);
18758 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18759 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18760 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18761 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18762 fprintf (stderr
, "=============================================\n");
18763 dump_glyph_matrix (w
->current_matrix
,
18764 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18769 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18770 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18773 struct frame
*f
= XFRAME (selected_frame
);
18774 dump_glyph_matrix (f
->current_matrix
, 1);
18779 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18780 doc
: /* Dump glyph row ROW to stderr.
18781 GLYPH 0 means don't dump glyphs.
18782 GLYPH 1 means dump glyphs in short form.
18783 GLYPH > 1 or omitted means dump glyphs in long form. */)
18784 (Lisp_Object row
, Lisp_Object glyphs
)
18786 struct glyph_matrix
*matrix
;
18789 CHECK_NUMBER (row
);
18790 matrix
= XWINDOW (selected_window
)->current_matrix
;
18792 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18793 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18795 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18800 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18801 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18802 GLYPH 0 means don't dump glyphs.
18803 GLYPH 1 means dump glyphs in short form.
18804 GLYPH > 1 or omitted means dump glyphs in long form.
18806 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18808 (Lisp_Object row
, Lisp_Object glyphs
)
18810 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18811 struct frame
*sf
= SELECTED_FRAME ();
18812 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18815 CHECK_NUMBER (row
);
18817 if (vpos
>= 0 && vpos
< m
->nrows
)
18818 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18819 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18825 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18826 doc
: /* Toggle tracing of redisplay.
18827 With ARG, turn tracing on if and only if ARG is positive. */)
18831 trace_redisplay_p
= !trace_redisplay_p
;
18834 arg
= Fprefix_numeric_value (arg
);
18835 trace_redisplay_p
= XINT (arg
) > 0;
18842 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18843 doc
: /* Like `format', but print result to stderr.
18844 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18845 (ptrdiff_t nargs
, Lisp_Object
*args
)
18847 Lisp_Object s
= Fformat (nargs
, args
);
18848 fprintf (stderr
, "%s", SDATA (s
));
18852 #endif /* GLYPH_DEBUG */
18856 /***********************************************************************
18857 Building Desired Matrix Rows
18858 ***********************************************************************/
18860 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18861 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18863 static struct glyph_row
*
18864 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18866 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18867 struct buffer
*buffer
= XBUFFER (w
->contents
);
18868 struct buffer
*old
= current_buffer
;
18869 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18870 int arrow_len
= SCHARS (overlay_arrow_string
);
18871 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18872 const unsigned char *p
;
18875 int n_glyphs_before
;
18877 set_buffer_temp (buffer
);
18878 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18879 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18880 SET_TEXT_POS (it
.position
, 0, 0);
18882 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18884 while (p
< arrow_end
)
18886 Lisp_Object face
, ilisp
;
18888 /* Get the next character. */
18890 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18893 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18894 if (! ASCII_CHAR_P (it
.c
))
18895 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18899 /* Get its face. */
18900 ilisp
= make_number (p
- arrow_string
);
18901 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18902 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18904 /* Compute its width, get its glyphs. */
18905 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18906 SET_TEXT_POS (it
.position
, -1, -1);
18907 PRODUCE_GLYPHS (&it
);
18909 /* If this character doesn't fit any more in the line, we have
18910 to remove some glyphs. */
18911 if (it
.current_x
> it
.last_visible_x
)
18913 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18918 set_buffer_temp (old
);
18919 return it
.glyph_row
;
18923 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18924 glyphs to insert is determined by produce_special_glyphs. */
18927 insert_left_trunc_glyphs (struct it
*it
)
18929 struct it truncate_it
;
18930 struct glyph
*from
, *end
, *to
, *toend
;
18932 eassert (!FRAME_WINDOW_P (it
->f
)
18933 || (!it
->glyph_row
->reversed_p
18934 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18935 || (it
->glyph_row
->reversed_p
18936 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18938 /* Get the truncation glyphs. */
18940 truncate_it
.current_x
= 0;
18941 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18942 truncate_it
.glyph_row
= &scratch_glyph_row
;
18943 truncate_it
.area
= TEXT_AREA
;
18944 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18945 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18946 truncate_it
.object
= make_number (0);
18947 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18949 /* Overwrite glyphs from IT with truncation glyphs. */
18950 if (!it
->glyph_row
->reversed_p
)
18952 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18954 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18955 end
= from
+ tused
;
18956 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18957 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18958 if (FRAME_WINDOW_P (it
->f
))
18960 /* On GUI frames, when variable-size fonts are displayed,
18961 the truncation glyphs may need more pixels than the row's
18962 glyphs they overwrite. We overwrite more glyphs to free
18963 enough screen real estate, and enlarge the stretch glyph
18964 on the right (see display_line), if there is one, to
18965 preserve the screen position of the truncation glyphs on
18968 struct glyph
*g
= to
;
18971 /* The first glyph could be partially visible, in which case
18972 it->glyph_row->x will be negative. But we want the left
18973 truncation glyphs to be aligned at the left margin of the
18974 window, so we override the x coordinate at which the row
18976 it
->glyph_row
->x
= 0;
18977 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18979 w
+= g
->pixel_width
;
18982 if (g
- to
- tused
> 0)
18984 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18985 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18987 used
= it
->glyph_row
->used
[TEXT_AREA
];
18988 if (it
->glyph_row
->truncated_on_right_p
18989 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18990 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18993 int extra
= w
- it
->truncation_pixel_width
;
18995 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19002 /* There may be padding glyphs left over. Overwrite them too. */
19003 if (!FRAME_WINDOW_P (it
->f
))
19005 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19007 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19014 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19018 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19020 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19021 that back to front. */
19022 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19023 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19024 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19025 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19026 if (FRAME_WINDOW_P (it
->f
))
19029 struct glyph
*g
= to
;
19031 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19033 w
+= g
->pixel_width
;
19036 if (to
- g
- tused
> 0)
19038 if (it
->glyph_row
->truncated_on_right_p
19039 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19040 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19042 int extra
= w
- it
->truncation_pixel_width
;
19044 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19048 while (from
>= end
&& to
>= toend
)
19050 if (!FRAME_WINDOW_P (it
->f
))
19052 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19055 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19056 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19057 while (from
>= end
&& to
>= toend
)
19063 /* Need to free some room before prepending additional
19065 int move_by
= from
- end
+ 1;
19066 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19067 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19069 for ( ; g
>= g0
; g
--)
19071 while (from
>= end
)
19073 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19078 /* Compute the hash code for ROW. */
19080 row_hash (struct glyph_row
*row
)
19083 unsigned hashval
= 0;
19085 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19086 for (k
= 0; k
< row
->used
[area
]; ++k
)
19087 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19088 + row
->glyphs
[area
][k
].u
.val
19089 + row
->glyphs
[area
][k
].face_id
19090 + row
->glyphs
[area
][k
].padding_p
19091 + (row
->glyphs
[area
][k
].type
<< 2));
19096 /* Compute the pixel height and width of IT->glyph_row.
19098 Most of the time, ascent and height of a display line will be equal
19099 to the max_ascent and max_height values of the display iterator
19100 structure. This is not the case if
19102 1. We hit ZV without displaying anything. In this case, max_ascent
19103 and max_height will be zero.
19105 2. We have some glyphs that don't contribute to the line height.
19106 (The glyph row flag contributes_to_line_height_p is for future
19107 pixmap extensions).
19109 The first case is easily covered by using default values because in
19110 these cases, the line height does not really matter, except that it
19111 must not be zero. */
19114 compute_line_metrics (struct it
*it
)
19116 struct glyph_row
*row
= it
->glyph_row
;
19118 if (FRAME_WINDOW_P (it
->f
))
19120 int i
, min_y
, max_y
;
19122 /* The line may consist of one space only, that was added to
19123 place the cursor on it. If so, the row's height hasn't been
19125 if (row
->height
== 0)
19127 if (it
->max_ascent
+ it
->max_descent
== 0)
19128 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19129 row
->ascent
= it
->max_ascent
;
19130 row
->height
= it
->max_ascent
+ it
->max_descent
;
19131 row
->phys_ascent
= it
->max_phys_ascent
;
19132 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19133 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19136 /* Compute the width of this line. */
19137 row
->pixel_width
= row
->x
;
19138 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19139 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19141 eassert (row
->pixel_width
>= 0);
19142 eassert (row
->ascent
>= 0 && row
->height
> 0);
19144 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19145 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19147 /* If first line's physical ascent is larger than its logical
19148 ascent, use the physical ascent, and make the row taller.
19149 This makes accented characters fully visible. */
19150 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19151 && row
->phys_ascent
> row
->ascent
)
19153 row
->height
+= row
->phys_ascent
- row
->ascent
;
19154 row
->ascent
= row
->phys_ascent
;
19157 /* Compute how much of the line is visible. */
19158 row
->visible_height
= row
->height
;
19160 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19161 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19163 if (row
->y
< min_y
)
19164 row
->visible_height
-= min_y
- row
->y
;
19165 if (row
->y
+ row
->height
> max_y
)
19166 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19170 row
->pixel_width
= row
->used
[TEXT_AREA
];
19171 if (row
->continued_p
)
19172 row
->pixel_width
-= it
->continuation_pixel_width
;
19173 else if (row
->truncated_on_right_p
)
19174 row
->pixel_width
-= it
->truncation_pixel_width
;
19175 row
->ascent
= row
->phys_ascent
= 0;
19176 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19177 row
->extra_line_spacing
= 0;
19180 /* Compute a hash code for this row. */
19181 row
->hash
= row_hash (row
);
19183 it
->max_ascent
= it
->max_descent
= 0;
19184 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19188 /* Append one space to the glyph row of iterator IT if doing a
19189 window-based redisplay. The space has the same face as
19190 IT->face_id. Value is non-zero if a space was added.
19192 This function is called to make sure that there is always one glyph
19193 at the end of a glyph row that the cursor can be set on under
19194 window-systems. (If there weren't such a glyph we would not know
19195 how wide and tall a box cursor should be displayed).
19197 At the same time this space let's a nicely handle clearing to the
19198 end of the line if the row ends in italic text. */
19201 append_space_for_newline (struct it
*it
, int default_face_p
)
19203 if (FRAME_WINDOW_P (it
->f
))
19205 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19207 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19208 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19210 /* Save some values that must not be changed.
19211 Must save IT->c and IT->len because otherwise
19212 ITERATOR_AT_END_P wouldn't work anymore after
19213 append_space_for_newline has been called. */
19214 enum display_element_type saved_what
= it
->what
;
19215 int saved_c
= it
->c
, saved_len
= it
->len
;
19216 int saved_char_to_display
= it
->char_to_display
;
19217 int saved_x
= it
->current_x
;
19218 int saved_face_id
= it
->face_id
;
19219 int saved_box_end
= it
->end_of_box_run_p
;
19220 struct text_pos saved_pos
;
19221 Lisp_Object saved_object
;
19224 saved_object
= it
->object
;
19225 saved_pos
= it
->position
;
19227 it
->what
= IT_CHARACTER
;
19228 memset (&it
->position
, 0, sizeof it
->position
);
19229 it
->object
= make_number (0);
19230 it
->c
= it
->char_to_display
= ' ';
19233 /* If the default face was remapped, be sure to use the
19234 remapped face for the appended newline. */
19235 if (default_face_p
)
19236 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19237 else if (it
->face_before_selective_p
)
19238 it
->face_id
= it
->saved_face_id
;
19239 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19240 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19241 /* In R2L rows, we will prepend a stretch glyph that will
19242 have the end_of_box_run_p flag set for it, so there's no
19243 need for the appended newline glyph to have that flag
19245 if (it
->glyph_row
->reversed_p
19246 /* But if the appended newline glyph goes all the way to
19247 the end of the row, there will be no stretch glyph,
19248 so leave the box flag set. */
19249 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19250 it
->end_of_box_run_p
= 0;
19252 PRODUCE_GLYPHS (it
);
19254 it
->override_ascent
= -1;
19255 it
->constrain_row_ascent_descent_p
= 0;
19256 it
->current_x
= saved_x
;
19257 it
->object
= saved_object
;
19258 it
->position
= saved_pos
;
19259 it
->what
= saved_what
;
19260 it
->face_id
= saved_face_id
;
19261 it
->len
= saved_len
;
19263 it
->char_to_display
= saved_char_to_display
;
19264 it
->end_of_box_run_p
= saved_box_end
;
19273 /* Extend the face of the last glyph in the text area of IT->glyph_row
19274 to the end of the display line. Called from display_line. If the
19275 glyph row is empty, add a space glyph to it so that we know the
19276 face to draw. Set the glyph row flag fill_line_p. If the glyph
19277 row is R2L, prepend a stretch glyph to cover the empty space to the
19278 left of the leftmost glyph. */
19281 extend_face_to_end_of_line (struct it
*it
)
19283 struct face
*face
, *default_face
;
19284 struct frame
*f
= it
->f
;
19286 /* If line is already filled, do nothing. Non window-system frames
19287 get a grace of one more ``pixel'' because their characters are
19288 1-``pixel'' wide, so they hit the equality too early. This grace
19289 is needed only for R2L rows that are not continued, to produce
19290 one extra blank where we could display the cursor. */
19291 if ((it
->current_x
>= it
->last_visible_x
19292 + (!FRAME_WINDOW_P (f
)
19293 && it
->glyph_row
->reversed_p
19294 && !it
->glyph_row
->continued_p
))
19295 /* If the window has display margins, we will need to extend
19296 their face even if the text area is filled. */
19297 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19298 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19301 /* The default face, possibly remapped. */
19302 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19304 /* Face extension extends the background and box of IT->face_id
19305 to the end of the line. If the background equals the background
19306 of the frame, we don't have to do anything. */
19307 if (it
->face_before_selective_p
)
19308 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19310 face
= FACE_FROM_ID (f
, it
->face_id
);
19312 if (FRAME_WINDOW_P (f
)
19313 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19314 && face
->box
== FACE_NO_BOX
19315 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19316 #ifdef HAVE_WINDOW_SYSTEM
19319 && !it
->glyph_row
->reversed_p
)
19322 /* Set the glyph row flag indicating that the face of the last glyph
19323 in the text area has to be drawn to the end of the text area. */
19324 it
->glyph_row
->fill_line_p
= 1;
19326 /* If current character of IT is not ASCII, make sure we have the
19327 ASCII face. This will be automatically undone the next time
19328 get_next_display_element returns a multibyte character. Note
19329 that the character will always be single byte in unibyte
19331 if (!ASCII_CHAR_P (it
->c
))
19333 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19336 if (FRAME_WINDOW_P (f
))
19338 /* If the row is empty, add a space with the current face of IT,
19339 so that we know which face to draw. */
19340 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19342 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19343 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19344 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19346 /* Mode line and the header line don't have margins, and
19347 likewise the frame's tool-bar window, if there is any. */
19348 if (!(it
->glyph_row
->mode_line_p
19349 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19350 || (WINDOWP (f
->tool_bar_window
)
19351 && it
->w
== XWINDOW (f
->tool_bar_window
))
19355 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19356 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19358 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19359 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19361 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19363 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19364 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19366 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19367 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19369 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19372 #ifdef HAVE_WINDOW_SYSTEM
19373 if (it
->glyph_row
->reversed_p
)
19375 /* Prepend a stretch glyph to the row, such that the
19376 rightmost glyph will be drawn flushed all the way to the
19377 right margin of the window. The stretch glyph that will
19378 occupy the empty space, if any, to the left of the
19380 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19381 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19382 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19384 int row_width
, stretch_ascent
, stretch_width
;
19385 struct text_pos saved_pos
;
19386 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19388 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19389 row_width
+= g
->pixel_width
;
19391 /* FIXME: There are various minor display glitches in R2L
19392 rows when only one of the fringes is missing. The
19393 strange condition below produces the least bad effect. */
19394 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19395 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19396 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19397 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19399 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19400 stretch_width
-= row_width
;
19402 if (stretch_width
> 0)
19405 (((it
->ascent
+ it
->descent
)
19406 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19407 saved_pos
= it
->position
;
19408 memset (&it
->position
, 0, sizeof it
->position
);
19409 saved_avoid_cursor
= it
->avoid_cursor_p
;
19410 it
->avoid_cursor_p
= 1;
19411 saved_face_id
= it
->face_id
;
19412 saved_box_start
= it
->start_of_box_run_p
;
19413 /* The last row's stretch glyph should get the default
19414 face, to avoid painting the rest of the window with
19415 the region face, if the region ends at ZV. */
19416 if (it
->glyph_row
->ends_at_zv_p
)
19417 it
->face_id
= default_face
->id
;
19419 it
->face_id
= face
->id
;
19420 it
->start_of_box_run_p
= 0;
19421 append_stretch_glyph (it
, make_number (0), stretch_width
,
19422 it
->ascent
+ it
->descent
, stretch_ascent
);
19423 it
->position
= saved_pos
;
19424 it
->avoid_cursor_p
= saved_avoid_cursor
;
19425 it
->face_id
= saved_face_id
;
19426 it
->start_of_box_run_p
= saved_box_start
;
19428 /* If stretch_width comes out negative, it means that the
19429 last glyph is only partially visible. In R2L rows, we
19430 want the leftmost glyph to be partially visible, so we
19431 need to give the row the corresponding left offset. */
19432 if (stretch_width
< 0)
19433 it
->glyph_row
->x
= stretch_width
;
19435 #endif /* HAVE_WINDOW_SYSTEM */
19439 /* Save some values that must not be changed. */
19440 int saved_x
= it
->current_x
;
19441 struct text_pos saved_pos
;
19442 Lisp_Object saved_object
;
19443 enum display_element_type saved_what
= it
->what
;
19444 int saved_face_id
= it
->face_id
;
19446 saved_object
= it
->object
;
19447 saved_pos
= it
->position
;
19449 it
->what
= IT_CHARACTER
;
19450 memset (&it
->position
, 0, sizeof it
->position
);
19451 it
->object
= make_number (0);
19452 it
->c
= it
->char_to_display
= ' ';
19455 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19456 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19457 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19458 && !it
->glyph_row
->mode_line_p
19459 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19461 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19462 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19464 for (it
->current_x
= 0; g
< e
; g
++)
19465 it
->current_x
+= g
->pixel_width
;
19467 it
->area
= LEFT_MARGIN_AREA
;
19468 it
->face_id
= default_face
->id
;
19469 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19470 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19472 PRODUCE_GLYPHS (it
);
19473 /* term.c:produce_glyphs advances it->current_x only for
19475 it
->current_x
+= it
->pixel_width
;
19478 it
->current_x
= saved_x
;
19479 it
->area
= TEXT_AREA
;
19482 /* The last row's blank glyphs should get the default face, to
19483 avoid painting the rest of the window with the region face,
19484 if the region ends at ZV. */
19485 if (it
->glyph_row
->ends_at_zv_p
)
19486 it
->face_id
= default_face
->id
;
19488 it
->face_id
= face
->id
;
19489 PRODUCE_GLYPHS (it
);
19491 while (it
->current_x
<= it
->last_visible_x
)
19492 PRODUCE_GLYPHS (it
);
19494 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19495 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19496 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19497 && !it
->glyph_row
->mode_line_p
19498 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19500 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19501 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19503 for ( ; g
< e
; g
++)
19504 it
->current_x
+= g
->pixel_width
;
19506 it
->area
= RIGHT_MARGIN_AREA
;
19507 it
->face_id
= default_face
->id
;
19508 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19509 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19511 PRODUCE_GLYPHS (it
);
19512 it
->current_x
+= it
->pixel_width
;
19515 it
->area
= TEXT_AREA
;
19518 /* Don't count these blanks really. It would let us insert a left
19519 truncation glyph below and make us set the cursor on them, maybe. */
19520 it
->current_x
= saved_x
;
19521 it
->object
= saved_object
;
19522 it
->position
= saved_pos
;
19523 it
->what
= saved_what
;
19524 it
->face_id
= saved_face_id
;
19529 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19530 trailing whitespace. */
19533 trailing_whitespace_p (ptrdiff_t charpos
)
19535 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19538 while (bytepos
< ZV_BYTE
19539 && (c
= FETCH_CHAR (bytepos
),
19540 c
== ' ' || c
== '\t'))
19543 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19545 if (bytepos
!= PT_BYTE
)
19552 /* Highlight trailing whitespace, if any, in ROW. */
19555 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19557 int used
= row
->used
[TEXT_AREA
];
19561 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19562 struct glyph
*glyph
= start
+ used
- 1;
19564 if (row
->reversed_p
)
19566 /* Right-to-left rows need to be processed in the opposite
19567 direction, so swap the edge pointers. */
19569 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19572 /* Skip over glyphs inserted to display the cursor at the
19573 end of a line, for extending the face of the last glyph
19574 to the end of the line on terminals, and for truncation
19575 and continuation glyphs. */
19576 if (!row
->reversed_p
)
19578 while (glyph
>= start
19579 && glyph
->type
== CHAR_GLYPH
19580 && INTEGERP (glyph
->object
))
19585 while (glyph
<= start
19586 && glyph
->type
== CHAR_GLYPH
19587 && INTEGERP (glyph
->object
))
19591 /* If last glyph is a space or stretch, and it's trailing
19592 whitespace, set the face of all trailing whitespace glyphs in
19593 IT->glyph_row to `trailing-whitespace'. */
19594 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19595 && BUFFERP (glyph
->object
)
19596 && (glyph
->type
== STRETCH_GLYPH
19597 || (glyph
->type
== CHAR_GLYPH
19598 && glyph
->u
.ch
== ' '))
19599 && trailing_whitespace_p (glyph
->charpos
))
19601 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19605 if (!row
->reversed_p
)
19607 while (glyph
>= start
19608 && BUFFERP (glyph
->object
)
19609 && (glyph
->type
== STRETCH_GLYPH
19610 || (glyph
->type
== CHAR_GLYPH
19611 && glyph
->u
.ch
== ' ')))
19612 (glyph
--)->face_id
= face_id
;
19616 while (glyph
<= start
19617 && BUFFERP (glyph
->object
)
19618 && (glyph
->type
== STRETCH_GLYPH
19619 || (glyph
->type
== CHAR_GLYPH
19620 && glyph
->u
.ch
== ' ')))
19621 (glyph
++)->face_id
= face_id
;
19628 /* Value is non-zero if glyph row ROW should be
19629 considered to hold the buffer position CHARPOS. */
19632 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19636 if (charpos
== CHARPOS (row
->end
.pos
)
19637 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19639 /* Suppose the row ends on a string.
19640 Unless the row is continued, that means it ends on a newline
19641 in the string. If it's anything other than a display string
19642 (e.g., a before-string from an overlay), we don't want the
19643 cursor there. (This heuristic seems to give the optimal
19644 behavior for the various types of multi-line strings.)
19645 One exception: if the string has `cursor' property on one of
19646 its characters, we _do_ want the cursor there. */
19647 if (CHARPOS (row
->end
.string_pos
) >= 0)
19649 if (row
->continued_p
)
19653 /* Check for `display' property. */
19654 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19655 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19656 struct glyph
*glyph
;
19659 for (glyph
= end
; glyph
>= beg
; --glyph
)
19660 if (STRINGP (glyph
->object
))
19663 = Fget_char_property (make_number (charpos
),
19667 && display_prop_string_p (prop
, glyph
->object
));
19668 /* If there's a `cursor' property on one of the
19669 string's characters, this row is a cursor row,
19670 even though this is not a display string. */
19673 Lisp_Object s
= glyph
->object
;
19675 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19677 ptrdiff_t gpos
= glyph
->charpos
;
19679 if (!NILP (Fget_char_property (make_number (gpos
),
19691 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19693 /* If the row ends in middle of a real character,
19694 and the line is continued, we want the cursor here.
19695 That's because CHARPOS (ROW->end.pos) would equal
19696 PT if PT is before the character. */
19697 if (!row
->ends_in_ellipsis_p
)
19698 result
= row
->continued_p
;
19700 /* If the row ends in an ellipsis, then
19701 CHARPOS (ROW->end.pos) will equal point after the
19702 invisible text. We want that position to be displayed
19703 after the ellipsis. */
19706 /* If the row ends at ZV, display the cursor at the end of that
19707 row instead of at the start of the row below. */
19708 else if (row
->ends_at_zv_p
)
19717 /* Value is non-zero if glyph row ROW should be
19718 used to hold the cursor. */
19721 cursor_row_p (struct glyph_row
*row
)
19723 return row_for_charpos_p (row
, PT
);
19728 /* Push the property PROP so that it will be rendered at the current
19729 position in IT. Return 1 if PROP was successfully pushed, 0
19730 otherwise. Called from handle_line_prefix to handle the
19731 `line-prefix' and `wrap-prefix' properties. */
19734 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19736 struct text_pos pos
=
19737 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19739 eassert (it
->method
== GET_FROM_BUFFER
19740 || it
->method
== GET_FROM_DISPLAY_VECTOR
19741 || it
->method
== GET_FROM_STRING
);
19743 /* We need to save the current buffer/string position, so it will be
19744 restored by pop_it, because iterate_out_of_display_property
19745 depends on that being set correctly, but some situations leave
19746 it->position not yet set when this function is called. */
19747 push_it (it
, &pos
);
19749 if (STRINGP (prop
))
19751 if (SCHARS (prop
) == 0)
19758 it
->string_from_prefix_prop_p
= 1;
19759 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19760 it
->current
.overlay_string_index
= -1;
19761 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19762 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19763 it
->method
= GET_FROM_STRING
;
19764 it
->stop_charpos
= 0;
19766 it
->base_level_stop
= 0;
19768 /* Force paragraph direction to be that of the parent
19770 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19771 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19773 it
->paragraph_embedding
= L2R
;
19775 /* Set up the bidi iterator for this display string. */
19778 it
->bidi_it
.string
.lstring
= it
->string
;
19779 it
->bidi_it
.string
.s
= NULL
;
19780 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19781 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19782 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19783 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19784 it
->bidi_it
.w
= it
->w
;
19785 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19788 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19790 it
->method
= GET_FROM_STRETCH
;
19793 #ifdef HAVE_WINDOW_SYSTEM
19794 else if (IMAGEP (prop
))
19796 it
->what
= IT_IMAGE
;
19797 it
->image_id
= lookup_image (it
->f
, prop
);
19798 it
->method
= GET_FROM_IMAGE
;
19800 #endif /* HAVE_WINDOW_SYSTEM */
19803 pop_it (it
); /* bogus display property, give up */
19810 /* Return the character-property PROP at the current position in IT. */
19813 get_it_property (struct it
*it
, Lisp_Object prop
)
19815 Lisp_Object position
, object
= it
->object
;
19817 if (STRINGP (object
))
19818 position
= make_number (IT_STRING_CHARPOS (*it
));
19819 else if (BUFFERP (object
))
19821 position
= make_number (IT_CHARPOS (*it
));
19822 object
= it
->window
;
19827 return Fget_char_property (position
, prop
, object
);
19830 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19833 handle_line_prefix (struct it
*it
)
19835 Lisp_Object prefix
;
19837 if (it
->continuation_lines_width
> 0)
19839 prefix
= get_it_property (it
, Qwrap_prefix
);
19841 prefix
= Vwrap_prefix
;
19845 prefix
= get_it_property (it
, Qline_prefix
);
19847 prefix
= Vline_prefix
;
19849 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19851 /* If the prefix is wider than the window, and we try to wrap
19852 it, it would acquire its own wrap prefix, and so on till the
19853 iterator stack overflows. So, don't wrap the prefix. */
19854 it
->line_wrap
= TRUNCATE
;
19855 it
->avoid_cursor_p
= 1;
19861 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19862 only for R2L lines from display_line and display_string, when they
19863 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19864 the line/string needs to be continued on the next glyph row. */
19866 unproduce_glyphs (struct it
*it
, int n
)
19868 struct glyph
*glyph
, *end
;
19870 eassert (it
->glyph_row
);
19871 eassert (it
->glyph_row
->reversed_p
);
19872 eassert (it
->area
== TEXT_AREA
);
19873 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19875 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19876 n
= it
->glyph_row
->used
[TEXT_AREA
];
19877 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19878 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19879 for ( ; glyph
< end
; glyph
++)
19880 glyph
[-n
] = *glyph
;
19883 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19884 and ROW->maxpos. */
19886 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19887 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19888 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19890 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19891 lines' rows is implemented for bidi-reordered rows. */
19893 /* ROW->minpos is the value of min_pos, the minimal buffer position
19894 we have in ROW, or ROW->start.pos if that is smaller. */
19895 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19896 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19898 /* We didn't find buffer positions smaller than ROW->start, or
19899 didn't find _any_ valid buffer positions in any of the glyphs,
19900 so we must trust the iterator's computed positions. */
19901 row
->minpos
= row
->start
.pos
;
19904 max_pos
= CHARPOS (it
->current
.pos
);
19905 max_bpos
= BYTEPOS (it
->current
.pos
);
19908 /* Here are the various use-cases for ending the row, and the
19909 corresponding values for ROW->maxpos:
19911 Line ends in a newline from buffer eol_pos + 1
19912 Line is continued from buffer max_pos + 1
19913 Line is truncated on right it->current.pos
19914 Line ends in a newline from string max_pos + 1(*)
19915 (*) + 1 only when line ends in a forward scan
19916 Line is continued from string max_pos
19917 Line is continued from display vector max_pos
19918 Line is entirely from a string min_pos == max_pos
19919 Line is entirely from a display vector min_pos == max_pos
19920 Line that ends at ZV ZV
19922 If you discover other use-cases, please add them here as
19924 if (row
->ends_at_zv_p
)
19925 row
->maxpos
= it
->current
.pos
;
19926 else if (row
->used
[TEXT_AREA
])
19928 int seen_this_string
= 0;
19929 struct glyph_row
*r1
= row
- 1;
19931 /* Did we see the same display string on the previous row? */
19932 if (STRINGP (it
->object
)
19933 /* this is not the first row */
19934 && row
> it
->w
->desired_matrix
->rows
19935 /* previous row is not the header line */
19936 && !r1
->mode_line_p
19937 /* previous row also ends in a newline from a string */
19938 && r1
->ends_in_newline_from_string_p
)
19940 struct glyph
*start
, *end
;
19942 /* Search for the last glyph of the previous row that came
19943 from buffer or string. Depending on whether the row is
19944 L2R or R2L, we need to process it front to back or the
19945 other way round. */
19946 if (!r1
->reversed_p
)
19948 start
= r1
->glyphs
[TEXT_AREA
];
19949 end
= start
+ r1
->used
[TEXT_AREA
];
19950 /* Glyphs inserted by redisplay have an integer (zero)
19951 as their object. */
19953 && INTEGERP ((end
- 1)->object
)
19954 && (end
- 1)->charpos
<= 0)
19958 if (EQ ((end
- 1)->object
, it
->object
))
19959 seen_this_string
= 1;
19962 /* If all the glyphs of the previous row were inserted
19963 by redisplay, it means the previous row was
19964 produced from a single newline, which is only
19965 possible if that newline came from the same string
19966 as the one which produced this ROW. */
19967 seen_this_string
= 1;
19971 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19972 start
= end
+ r1
->used
[TEXT_AREA
];
19974 && INTEGERP ((end
+ 1)->object
)
19975 && (end
+ 1)->charpos
<= 0)
19979 if (EQ ((end
+ 1)->object
, it
->object
))
19980 seen_this_string
= 1;
19983 seen_this_string
= 1;
19986 /* Take note of each display string that covers a newline only
19987 once, the first time we see it. This is for when a display
19988 string includes more than one newline in it. */
19989 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19991 /* If we were scanning the buffer forward when we displayed
19992 the string, we want to account for at least one buffer
19993 position that belongs to this row (position covered by
19994 the display string), so that cursor positioning will
19995 consider this row as a candidate when point is at the end
19996 of the visual line represented by this row. This is not
19997 required when scanning back, because max_pos will already
19998 have a much larger value. */
19999 if (CHARPOS (row
->end
.pos
) > max_pos
)
20000 INC_BOTH (max_pos
, max_bpos
);
20001 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20003 else if (CHARPOS (it
->eol_pos
) > 0)
20004 SET_TEXT_POS (row
->maxpos
,
20005 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20006 else if (row
->continued_p
)
20008 /* If max_pos is different from IT's current position, it
20009 means IT->method does not belong to the display element
20010 at max_pos. However, it also means that the display
20011 element at max_pos was displayed in its entirety on this
20012 line, which is equivalent to saying that the next line
20013 starts at the next buffer position. */
20014 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20015 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20018 INC_BOTH (max_pos
, max_bpos
);
20019 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20022 else if (row
->truncated_on_right_p
)
20023 /* display_line already called reseat_at_next_visible_line_start,
20024 which puts the iterator at the beginning of the next line, in
20025 the logical order. */
20026 row
->maxpos
= it
->current
.pos
;
20027 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20028 /* A line that is entirely from a string/image/stretch... */
20029 row
->maxpos
= row
->minpos
;
20034 row
->maxpos
= it
->current
.pos
;
20037 /* Construct the glyph row IT->glyph_row in the desired matrix of
20038 IT->w from text at the current position of IT. See dispextern.h
20039 for an overview of struct it. Value is non-zero if
20040 IT->glyph_row displays text, as opposed to a line displaying ZV
20044 display_line (struct it
*it
)
20046 struct glyph_row
*row
= it
->glyph_row
;
20047 Lisp_Object overlay_arrow_string
;
20049 void *wrap_data
= NULL
;
20050 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20051 int wrap_row_used
= -1;
20052 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20053 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20054 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20055 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20056 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20058 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20059 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20060 bool pending_handle_line_prefix
= false;
20062 /* We always start displaying at hpos zero even if hscrolled. */
20063 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20065 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20066 >= it
->w
->desired_matrix
->nrows
)
20068 it
->w
->nrows_scale_factor
++;
20069 it
->f
->fonts_changed
= 1;
20073 /* Clear the result glyph row and enable it. */
20074 prepare_desired_row (it
->w
, row
, false);
20076 row
->y
= it
->current_y
;
20077 row
->start
= it
->start
;
20078 row
->continuation_lines_width
= it
->continuation_lines_width
;
20079 row
->displays_text_p
= 1;
20080 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20081 it
->starts_in_middle_of_char_p
= 0;
20083 /* Arrange the overlays nicely for our purposes. Usually, we call
20084 display_line on only one line at a time, in which case this
20085 can't really hurt too much, or we call it on lines which appear
20086 one after another in the buffer, in which case all calls to
20087 recenter_overlay_lists but the first will be pretty cheap. */
20088 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20090 /* Move over display elements that are not visible because we are
20091 hscrolled. This may stop at an x-position < IT->first_visible_x
20092 if the first glyph is partially visible or if we hit a line end. */
20093 if (it
->current_x
< it
->first_visible_x
)
20095 enum move_it_result move_result
;
20097 this_line_min_pos
= row
->start
.pos
;
20098 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20099 MOVE_TO_POS
| MOVE_TO_X
);
20100 /* If we are under a large hscroll, move_it_in_display_line_to
20101 could hit the end of the line without reaching
20102 it->first_visible_x. Pretend that we did reach it. This is
20103 especially important on a TTY, where we will call
20104 extend_face_to_end_of_line, which needs to know how many
20105 blank glyphs to produce. */
20106 if (it
->current_x
< it
->first_visible_x
20107 && (move_result
== MOVE_NEWLINE_OR_CR
20108 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20109 it
->current_x
= it
->first_visible_x
;
20111 /* Record the smallest positions seen while we moved over
20112 display elements that are not visible. This is needed by
20113 redisplay_internal for optimizing the case where the cursor
20114 stays inside the same line. The rest of this function only
20115 considers positions that are actually displayed, so
20116 RECORD_MAX_MIN_POS will not otherwise record positions that
20117 are hscrolled to the left of the left edge of the window. */
20118 min_pos
= CHARPOS (this_line_min_pos
);
20119 min_bpos
= BYTEPOS (this_line_min_pos
);
20121 else if (it
->area
== TEXT_AREA
)
20123 /* We only do this when not calling move_it_in_display_line_to
20124 above, because that function calls itself handle_line_prefix. */
20125 handle_line_prefix (it
);
20129 /* Line-prefix and wrap-prefix are always displayed in the text
20130 area. But if this is the first call to display_line after
20131 init_iterator, the iterator might have been set up to write
20132 into a marginal area, e.g. if the line begins with some
20133 display property that writes to the margins. So we need to
20134 wait with the call to handle_line_prefix until whatever
20135 writes to the margin has done its job. */
20136 pending_handle_line_prefix
= true;
20139 /* Get the initial row height. This is either the height of the
20140 text hscrolled, if there is any, or zero. */
20141 row
->ascent
= it
->max_ascent
;
20142 row
->height
= it
->max_ascent
+ it
->max_descent
;
20143 row
->phys_ascent
= it
->max_phys_ascent
;
20144 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20145 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20147 /* Utility macro to record max and min buffer positions seen until now. */
20148 #define RECORD_MAX_MIN_POS(IT) \
20151 int composition_p = !STRINGP ((IT)->string) \
20152 && ((IT)->what == IT_COMPOSITION); \
20153 ptrdiff_t current_pos = \
20154 composition_p ? (IT)->cmp_it.charpos \
20155 : IT_CHARPOS (*(IT)); \
20156 ptrdiff_t current_bpos = \
20157 composition_p ? CHAR_TO_BYTE (current_pos) \
20158 : IT_BYTEPOS (*(IT)); \
20159 if (current_pos < min_pos) \
20161 min_pos = current_pos; \
20162 min_bpos = current_bpos; \
20164 if (IT_CHARPOS (*it) > max_pos) \
20166 max_pos = IT_CHARPOS (*it); \
20167 max_bpos = IT_BYTEPOS (*it); \
20172 /* Loop generating characters. The loop is left with IT on the next
20173 character to display. */
20176 int n_glyphs_before
, hpos_before
, x_before
;
20178 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20180 /* Retrieve the next thing to display. Value is zero if end of
20182 if (!get_next_display_element (it
))
20184 /* Maybe add a space at the end of this line that is used to
20185 display the cursor there under X. Set the charpos of the
20186 first glyph of blank lines not corresponding to any text
20188 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20189 row
->exact_window_width_line_p
= 1;
20190 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20191 || row
->used
[TEXT_AREA
] == 0)
20193 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20194 row
->displays_text_p
= 0;
20196 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20197 && (!MINI_WINDOW_P (it
->w
)
20198 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20199 row
->indicate_empty_line_p
= 1;
20202 it
->continuation_lines_width
= 0;
20203 row
->ends_at_zv_p
= 1;
20204 /* A row that displays right-to-left text must always have
20205 its last face extended all the way to the end of line,
20206 even if this row ends in ZV, because we still write to
20207 the screen left to right. We also need to extend the
20208 last face if the default face is remapped to some
20209 different face, otherwise the functions that clear
20210 portions of the screen will clear with the default face's
20211 background color. */
20212 if (row
->reversed_p
20213 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20214 extend_face_to_end_of_line (it
);
20218 /* Now, get the metrics of what we want to display. This also
20219 generates glyphs in `row' (which is IT->glyph_row). */
20220 n_glyphs_before
= row
->used
[TEXT_AREA
];
20223 /* Remember the line height so far in case the next element doesn't
20224 fit on the line. */
20225 if (it
->line_wrap
!= TRUNCATE
)
20227 ascent
= it
->max_ascent
;
20228 descent
= it
->max_descent
;
20229 phys_ascent
= it
->max_phys_ascent
;
20230 phys_descent
= it
->max_phys_descent
;
20232 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20234 if (IT_DISPLAYING_WHITESPACE (it
))
20238 SAVE_IT (wrap_it
, *it
, wrap_data
);
20240 wrap_row_used
= row
->used
[TEXT_AREA
];
20241 wrap_row_ascent
= row
->ascent
;
20242 wrap_row_height
= row
->height
;
20243 wrap_row_phys_ascent
= row
->phys_ascent
;
20244 wrap_row_phys_height
= row
->phys_height
;
20245 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20246 wrap_row_min_pos
= min_pos
;
20247 wrap_row_min_bpos
= min_bpos
;
20248 wrap_row_max_pos
= max_pos
;
20249 wrap_row_max_bpos
= max_bpos
;
20255 PRODUCE_GLYPHS (it
);
20257 /* If this display element was in marginal areas, continue with
20259 if (it
->area
!= TEXT_AREA
)
20261 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20262 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20263 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20264 row
->phys_height
= max (row
->phys_height
,
20265 it
->max_phys_ascent
+ it
->max_phys_descent
);
20266 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20267 it
->max_extra_line_spacing
);
20268 set_iterator_to_next (it
, 1);
20269 /* If we didn't handle the line/wrap prefix above, and the
20270 call to set_iterator_to_next just switched to TEXT_AREA,
20271 process the prefix now. */
20272 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20274 pending_handle_line_prefix
= false;
20275 handle_line_prefix (it
);
20280 /* Does the display element fit on the line? If we truncate
20281 lines, we should draw past the right edge of the window. If
20282 we don't truncate, we want to stop so that we can display the
20283 continuation glyph before the right margin. If lines are
20284 continued, there are two possible strategies for characters
20285 resulting in more than 1 glyph (e.g. tabs): Display as many
20286 glyphs as possible in this line and leave the rest for the
20287 continuation line, or display the whole element in the next
20288 line. Original redisplay did the former, so we do it also. */
20289 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20290 hpos_before
= it
->hpos
;
20293 if (/* Not a newline. */
20295 /* Glyphs produced fit entirely in the line. */
20296 && it
->current_x
< it
->last_visible_x
)
20298 it
->hpos
+= nglyphs
;
20299 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20300 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20301 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20302 row
->phys_height
= max (row
->phys_height
,
20303 it
->max_phys_ascent
+ it
->max_phys_descent
);
20304 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20305 it
->max_extra_line_spacing
);
20306 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20307 /* In R2L rows, we arrange in extend_face_to_end_of_line
20308 to add a right offset to the line, by a suitable
20309 change to the stretch glyph that is the leftmost
20310 glyph of the line. */
20311 && !row
->reversed_p
)
20312 row
->x
= x
- it
->first_visible_x
;
20313 /* Record the maximum and minimum buffer positions seen so
20314 far in glyphs that will be displayed by this row. */
20316 RECORD_MAX_MIN_POS (it
);
20321 struct glyph
*glyph
;
20323 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20325 /* Identify the glyphs added by the last call to
20326 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20327 the previous glyphs. */
20328 if (!row
->reversed_p
)
20329 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20331 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20332 new_x
= x
+ glyph
->pixel_width
;
20334 if (/* Lines are continued. */
20335 it
->line_wrap
!= TRUNCATE
20336 && (/* Glyph doesn't fit on the line. */
20337 new_x
> it
->last_visible_x
20338 /* Or it fits exactly on a window system frame. */
20339 || (new_x
== it
->last_visible_x
20340 && FRAME_WINDOW_P (it
->f
)
20341 && (row
->reversed_p
20342 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20343 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20345 /* End of a continued line. */
20348 || (new_x
== it
->last_visible_x
20349 && FRAME_WINDOW_P (it
->f
)
20350 && (row
->reversed_p
20351 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20352 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20354 /* Current glyph is the only one on the line or
20355 fits exactly on the line. We must continue
20356 the line because we can't draw the cursor
20357 after the glyph. */
20358 row
->continued_p
= 1;
20359 it
->current_x
= new_x
;
20360 it
->continuation_lines_width
+= new_x
;
20362 if (i
== nglyphs
- 1)
20364 /* If line-wrap is on, check if a previous
20365 wrap point was found. */
20366 if (wrap_row_used
> 0
20367 /* Even if there is a previous wrap
20368 point, continue the line here as
20369 usual, if (i) the previous character
20370 was a space or tab AND (ii) the
20371 current character is not. */
20373 || IT_DISPLAYING_WHITESPACE (it
)))
20376 /* Record the maximum and minimum buffer
20377 positions seen so far in glyphs that will be
20378 displayed by this row. */
20380 RECORD_MAX_MIN_POS (it
);
20381 set_iterator_to_next (it
, 1);
20382 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20384 if (!get_next_display_element (it
))
20386 row
->exact_window_width_line_p
= 1;
20387 it
->continuation_lines_width
= 0;
20388 row
->continued_p
= 0;
20389 row
->ends_at_zv_p
= 1;
20391 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20393 row
->continued_p
= 0;
20394 row
->exact_window_width_line_p
= 1;
20398 else if (it
->bidi_p
)
20399 RECORD_MAX_MIN_POS (it
);
20400 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20401 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20402 extend_face_to_end_of_line (it
);
20404 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20405 && !FRAME_WINDOW_P (it
->f
))
20407 /* A padding glyph that doesn't fit on this line.
20408 This means the whole character doesn't fit
20410 if (row
->reversed_p
)
20411 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20412 - n_glyphs_before
);
20413 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20415 /* Fill the rest of the row with continuation
20416 glyphs like in 20.x. */
20417 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20418 < row
->glyphs
[1 + TEXT_AREA
])
20419 produce_special_glyphs (it
, IT_CONTINUATION
);
20421 row
->continued_p
= 1;
20422 it
->current_x
= x_before
;
20423 it
->continuation_lines_width
+= x_before
;
20425 /* Restore the height to what it was before the
20426 element not fitting on the line. */
20427 it
->max_ascent
= ascent
;
20428 it
->max_descent
= descent
;
20429 it
->max_phys_ascent
= phys_ascent
;
20430 it
->max_phys_descent
= phys_descent
;
20431 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20432 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20433 extend_face_to_end_of_line (it
);
20435 else if (wrap_row_used
> 0)
20438 if (row
->reversed_p
)
20439 unproduce_glyphs (it
,
20440 row
->used
[TEXT_AREA
] - wrap_row_used
);
20441 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20442 it
->continuation_lines_width
+= wrap_x
;
20443 row
->used
[TEXT_AREA
] = wrap_row_used
;
20444 row
->ascent
= wrap_row_ascent
;
20445 row
->height
= wrap_row_height
;
20446 row
->phys_ascent
= wrap_row_phys_ascent
;
20447 row
->phys_height
= wrap_row_phys_height
;
20448 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20449 min_pos
= wrap_row_min_pos
;
20450 min_bpos
= wrap_row_min_bpos
;
20451 max_pos
= wrap_row_max_pos
;
20452 max_bpos
= wrap_row_max_bpos
;
20453 row
->continued_p
= 1;
20454 row
->ends_at_zv_p
= 0;
20455 row
->exact_window_width_line_p
= 0;
20456 it
->continuation_lines_width
+= x
;
20458 /* Make sure that a non-default face is extended
20459 up to the right margin of the window. */
20460 extend_face_to_end_of_line (it
);
20462 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20464 /* A TAB that extends past the right edge of the
20465 window. This produces a single glyph on
20466 window system frames. We leave the glyph in
20467 this row and let it fill the row, but don't
20468 consume the TAB. */
20469 if ((row
->reversed_p
20470 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20471 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20472 produce_special_glyphs (it
, IT_CONTINUATION
);
20473 it
->continuation_lines_width
+= it
->last_visible_x
;
20474 row
->ends_in_middle_of_char_p
= 1;
20475 row
->continued_p
= 1;
20476 glyph
->pixel_width
= it
->last_visible_x
- x
;
20477 it
->starts_in_middle_of_char_p
= 1;
20478 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20479 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20480 extend_face_to_end_of_line (it
);
20484 /* Something other than a TAB that draws past
20485 the right edge of the window. Restore
20486 positions to values before the element. */
20487 if (row
->reversed_p
)
20488 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20489 - (n_glyphs_before
+ i
));
20490 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20492 /* Display continuation glyphs. */
20493 it
->current_x
= x_before
;
20494 it
->continuation_lines_width
+= x
;
20495 if (!FRAME_WINDOW_P (it
->f
)
20496 || (row
->reversed_p
20497 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20498 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20499 produce_special_glyphs (it
, IT_CONTINUATION
);
20500 row
->continued_p
= 1;
20502 extend_face_to_end_of_line (it
);
20504 if (nglyphs
> 1 && i
> 0)
20506 row
->ends_in_middle_of_char_p
= 1;
20507 it
->starts_in_middle_of_char_p
= 1;
20510 /* Restore the height to what it was before the
20511 element not fitting on the line. */
20512 it
->max_ascent
= ascent
;
20513 it
->max_descent
= descent
;
20514 it
->max_phys_ascent
= phys_ascent
;
20515 it
->max_phys_descent
= phys_descent
;
20520 else if (new_x
> it
->first_visible_x
)
20522 /* Increment number of glyphs actually displayed. */
20525 /* Record the maximum and minimum buffer positions
20526 seen so far in glyphs that will be displayed by
20529 RECORD_MAX_MIN_POS (it
);
20531 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20532 /* Glyph is partially visible, i.e. row starts at
20533 negative X position. Don't do that in R2L
20534 rows, where we arrange to add a right offset to
20535 the line in extend_face_to_end_of_line, by a
20536 suitable change to the stretch glyph that is
20537 the leftmost glyph of the line. */
20538 row
->x
= x
- it
->first_visible_x
;
20539 /* When the last glyph of an R2L row only fits
20540 partially on the line, we need to set row->x to a
20541 negative offset, so that the leftmost glyph is
20542 the one that is partially visible. But if we are
20543 going to produce the truncation glyph, this will
20544 be taken care of in produce_special_glyphs. */
20545 if (row
->reversed_p
20546 && new_x
> it
->last_visible_x
20547 && !(it
->line_wrap
== TRUNCATE
20548 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20550 eassert (FRAME_WINDOW_P (it
->f
));
20551 row
->x
= it
->last_visible_x
- new_x
;
20556 /* Glyph is completely off the left margin of the
20557 window. This should not happen because of the
20558 move_it_in_display_line at the start of this
20559 function, unless the text display area of the
20560 window is empty. */
20561 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20564 /* Even if this display element produced no glyphs at all,
20565 we want to record its position. */
20566 if (it
->bidi_p
&& nglyphs
== 0)
20567 RECORD_MAX_MIN_POS (it
);
20569 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20570 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20571 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20572 row
->phys_height
= max (row
->phys_height
,
20573 it
->max_phys_ascent
+ it
->max_phys_descent
);
20574 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20575 it
->max_extra_line_spacing
);
20577 /* End of this display line if row is continued. */
20578 if (row
->continued_p
|| row
->ends_at_zv_p
)
20583 /* Is this a line end? If yes, we're also done, after making
20584 sure that a non-default face is extended up to the right
20585 margin of the window. */
20586 if (ITERATOR_AT_END_OF_LINE_P (it
))
20588 int used_before
= row
->used
[TEXT_AREA
];
20590 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20592 /* Add a space at the end of the line that is used to
20593 display the cursor there. */
20594 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20595 append_space_for_newline (it
, 0);
20597 /* Extend the face to the end of the line. */
20598 extend_face_to_end_of_line (it
);
20600 /* Make sure we have the position. */
20601 if (used_before
== 0)
20602 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20604 /* Record the position of the newline, for use in
20606 it
->eol_pos
= it
->current
.pos
;
20608 /* Consume the line end. This skips over invisible lines. */
20609 set_iterator_to_next (it
, 1);
20610 it
->continuation_lines_width
= 0;
20614 /* Proceed with next display element. Note that this skips
20615 over lines invisible because of selective display. */
20616 set_iterator_to_next (it
, 1);
20618 /* If we truncate lines, we are done when the last displayed
20619 glyphs reach past the right margin of the window. */
20620 if (it
->line_wrap
== TRUNCATE
20621 && ((FRAME_WINDOW_P (it
->f
)
20622 /* Images are preprocessed in produce_image_glyph such
20623 that they are cropped at the right edge of the
20624 window, so an image glyph will always end exactly at
20625 last_visible_x, even if there's no right fringe. */
20626 && ((row
->reversed_p
20627 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20628 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20629 || it
->what
== IT_IMAGE
))
20630 ? (it
->current_x
>= it
->last_visible_x
)
20631 : (it
->current_x
> it
->last_visible_x
)))
20633 /* Maybe add truncation glyphs. */
20634 if (!FRAME_WINDOW_P (it
->f
)
20635 || (row
->reversed_p
20636 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20637 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20641 if (!row
->reversed_p
)
20643 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20644 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20649 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20650 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20652 /* Remove any padding glyphs at the front of ROW, to
20653 make room for the truncation glyphs we will be
20654 adding below. The loop below always inserts at
20655 least one truncation glyph, so also remove the
20656 last glyph added to ROW. */
20657 unproduce_glyphs (it
, i
+ 1);
20658 /* Adjust i for the loop below. */
20659 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20662 /* produce_special_glyphs overwrites the last glyph, so
20663 we don't want that if we want to keep that last
20664 glyph, which means it's an image. */
20665 if (it
->current_x
> it
->last_visible_x
)
20667 it
->current_x
= x_before
;
20668 if (!FRAME_WINDOW_P (it
->f
))
20670 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20672 row
->used
[TEXT_AREA
] = i
;
20673 produce_special_glyphs (it
, IT_TRUNCATION
);
20678 row
->used
[TEXT_AREA
] = i
;
20679 produce_special_glyphs (it
, IT_TRUNCATION
);
20681 it
->hpos
= hpos_before
;
20684 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20686 /* Don't truncate if we can overflow newline into fringe. */
20687 if (!get_next_display_element (it
))
20689 it
->continuation_lines_width
= 0;
20690 row
->ends_at_zv_p
= 1;
20691 row
->exact_window_width_line_p
= 1;
20694 if (ITERATOR_AT_END_OF_LINE_P (it
))
20696 row
->exact_window_width_line_p
= 1;
20697 goto at_end_of_line
;
20699 it
->current_x
= x_before
;
20700 it
->hpos
= hpos_before
;
20703 row
->truncated_on_right_p
= 1;
20704 it
->continuation_lines_width
= 0;
20705 reseat_at_next_visible_line_start (it
, 0);
20706 /* We insist below that IT's position be at ZV because in
20707 bidi-reordered lines the character at visible line start
20708 might not be the character that follows the newline in
20709 the logical order. */
20710 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20711 row
->ends_at_zv_p
=
20712 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20714 row
->ends_at_zv_p
= false;
20720 bidi_unshelve_cache (wrap_data
, 1);
20722 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20723 at the left window margin. */
20724 if (it
->first_visible_x
20725 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20727 if (!FRAME_WINDOW_P (it
->f
)
20728 || (((row
->reversed_p
20729 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20730 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20731 /* Don't let insert_left_trunc_glyphs overwrite the
20732 first glyph of the row if it is an image. */
20733 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20734 insert_left_trunc_glyphs (it
);
20735 row
->truncated_on_left_p
= 1;
20738 /* Remember the position at which this line ends.
20740 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20741 cannot be before the call to find_row_edges below, since that is
20742 where these positions are determined. */
20743 row
->end
= it
->current
;
20746 row
->minpos
= row
->start
.pos
;
20747 row
->maxpos
= row
->end
.pos
;
20751 /* ROW->minpos and ROW->maxpos must be the smallest and
20752 `1 + the largest' buffer positions in ROW. But if ROW was
20753 bidi-reordered, these two positions can be anywhere in the
20754 row, so we must determine them now. */
20755 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20758 /* If the start of this line is the overlay arrow-position, then
20759 mark this glyph row as the one containing the overlay arrow.
20760 This is clearly a mess with variable size fonts. It would be
20761 better to let it be displayed like cursors under X. */
20762 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20763 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20764 !NILP (overlay_arrow_string
)))
20766 /* Overlay arrow in window redisplay is a fringe bitmap. */
20767 if (STRINGP (overlay_arrow_string
))
20769 struct glyph_row
*arrow_row
20770 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20771 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20772 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20773 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20774 struct glyph
*p2
, *end
;
20776 /* Copy the arrow glyphs. */
20777 while (glyph
< arrow_end
)
20780 /* Throw away padding glyphs. */
20782 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20783 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20789 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20794 eassert (INTEGERP (overlay_arrow_string
));
20795 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20797 overlay_arrow_seen
= 1;
20800 /* Highlight trailing whitespace. */
20801 if (!NILP (Vshow_trailing_whitespace
))
20802 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20804 /* Compute pixel dimensions of this line. */
20805 compute_line_metrics (it
);
20807 /* Implementation note: No changes in the glyphs of ROW or in their
20808 faces can be done past this point, because compute_line_metrics
20809 computes ROW's hash value and stores it within the glyph_row
20812 /* Record whether this row ends inside an ellipsis. */
20813 row
->ends_in_ellipsis_p
20814 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20815 && it
->ellipsis_p
);
20817 /* Save fringe bitmaps in this row. */
20818 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20819 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20820 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20821 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20823 it
->left_user_fringe_bitmap
= 0;
20824 it
->left_user_fringe_face_id
= 0;
20825 it
->right_user_fringe_bitmap
= 0;
20826 it
->right_user_fringe_face_id
= 0;
20828 /* Maybe set the cursor. */
20829 cvpos
= it
->w
->cursor
.vpos
;
20831 /* In bidi-reordered rows, keep checking for proper cursor
20832 position even if one has been found already, because buffer
20833 positions in such rows change non-linearly with ROW->VPOS,
20834 when a line is continued. One exception: when we are at ZV,
20835 display cursor on the first suitable glyph row, since all
20836 the empty rows after that also have their position set to ZV. */
20837 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20838 lines' rows is implemented for bidi-reordered rows. */
20840 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20841 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20842 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20843 && cursor_row_p (row
))
20844 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20846 /* Prepare for the next line. This line starts horizontally at (X
20847 HPOS) = (0 0). Vertical positions are incremented. As a
20848 convenience for the caller, IT->glyph_row is set to the next
20850 it
->current_x
= it
->hpos
= 0;
20851 it
->current_y
+= row
->height
;
20852 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20855 /* The next row should by default use the same value of the
20856 reversed_p flag as this one. set_iterator_to_next decides when
20857 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20858 the flag accordingly. */
20859 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20860 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20861 it
->start
= row
->end
;
20862 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20864 #undef RECORD_MAX_MIN_POS
20867 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20868 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20869 doc
: /* Return paragraph direction at point in BUFFER.
20870 Value is either `left-to-right' or `right-to-left'.
20871 If BUFFER is omitted or nil, it defaults to the current buffer.
20873 Paragraph direction determines how the text in the paragraph is displayed.
20874 In left-to-right paragraphs, text begins at the left margin of the window
20875 and the reading direction is generally left to right. In right-to-left
20876 paragraphs, text begins at the right margin and is read from right to left.
20878 See also `bidi-paragraph-direction'. */)
20879 (Lisp_Object buffer
)
20881 struct buffer
*buf
= current_buffer
;
20882 struct buffer
*old
= buf
;
20884 if (! NILP (buffer
))
20886 CHECK_BUFFER (buffer
);
20887 buf
= XBUFFER (buffer
);
20890 if (NILP (BVAR (buf
, bidi_display_reordering
))
20891 || NILP (BVAR (buf
, enable_multibyte_characters
))
20892 /* When we are loading loadup.el, the character property tables
20893 needed for bidi iteration are not yet available. */
20894 || !NILP (Vpurify_flag
))
20895 return Qleft_to_right
;
20896 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20897 return BVAR (buf
, bidi_paragraph_direction
);
20900 /* Determine the direction from buffer text. We could try to
20901 use current_matrix if it is up to date, but this seems fast
20902 enough as it is. */
20903 struct bidi_it itb
;
20904 ptrdiff_t pos
= BUF_PT (buf
);
20905 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20907 void *itb_data
= bidi_shelve_cache ();
20909 set_buffer_temp (buf
);
20910 /* bidi_paragraph_init finds the base direction of the paragraph
20911 by searching forward from paragraph start. We need the base
20912 direction of the current or _previous_ paragraph, so we need
20913 to make sure we are within that paragraph. To that end, find
20914 the previous non-empty line. */
20915 if (pos
>= ZV
&& pos
> BEGV
)
20916 DEC_BOTH (pos
, bytepos
);
20917 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20918 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20920 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20921 || c
== ' ' || c
== '\t' || c
== '\f')
20923 if (bytepos
<= BEGV_BYTE
)
20928 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20931 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20932 itb
.paragraph_dir
= NEUTRAL_DIR
;
20933 itb
.string
.s
= NULL
;
20934 itb
.string
.lstring
= Qnil
;
20935 itb
.string
.bufpos
= 0;
20936 itb
.string
.from_disp_str
= 0;
20937 itb
.string
.unibyte
= 0;
20938 /* We have no window to use here for ignoring window-specific
20939 overlays. Using NULL for window pointer will cause
20940 compute_display_string_pos to use the current buffer. */
20942 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20943 bidi_unshelve_cache (itb_data
, 0);
20944 set_buffer_temp (old
);
20945 switch (itb
.paragraph_dir
)
20948 return Qleft_to_right
;
20951 return Qright_to_left
;
20959 DEFUN ("move-point-visually", Fmove_point_visually
,
20960 Smove_point_visually
, 1, 1, 0,
20961 doc
: /* Move point in the visual order in the specified DIRECTION.
20962 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20965 Value is the new character position of point. */)
20966 (Lisp_Object direction
)
20968 struct window
*w
= XWINDOW (selected_window
);
20969 struct buffer
*b
= XBUFFER (w
->contents
);
20970 struct glyph_row
*row
;
20972 Lisp_Object paragraph_dir
;
20974 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20975 (!(ROW)->continued_p \
20976 && INTEGERP ((GLYPH)->object) \
20977 && (GLYPH)->type == CHAR_GLYPH \
20978 && (GLYPH)->u.ch == ' ' \
20979 && (GLYPH)->charpos >= 0 \
20980 && !(GLYPH)->avoid_cursor_p)
20982 CHECK_NUMBER (direction
);
20983 dir
= XINT (direction
);
20989 /* If current matrix is up-to-date, we can use the information
20990 recorded in the glyphs, at least as long as the goal is on the
20992 if (w
->window_end_valid
20993 && !windows_or_buffers_changed
20995 && !b
->clip_changed
20996 && !b
->prevent_redisplay_optimizations_p
20997 && !window_outdated (w
)
20998 /* We rely below on the cursor coordinates to be up to date, but
20999 we cannot trust them if some command moved point since the
21000 last complete redisplay. */
21001 && w
->last_point
== BUF_PT (b
)
21002 && w
->cursor
.vpos
>= 0
21003 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21004 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21006 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21007 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21008 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21010 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21012 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21014 SET_PT (g
->charpos
);
21015 w
->cursor
.vpos
= -1;
21016 return make_number (PT
);
21018 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21022 if (BUFFERP (gpt
->object
))
21025 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21026 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21028 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
21030 else if (BUFFERP (g
->object
))
21031 new_pos
= g
->charpos
;
21035 w
->cursor
.vpos
= -1;
21036 return make_number (PT
);
21038 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21040 /* Glyphs inserted at the end of a non-empty line for
21041 positioning the cursor have zero charpos, so we must
21042 deduce the value of point by other means. */
21043 if (g
->charpos
> 0)
21044 SET_PT (g
->charpos
);
21045 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21047 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21048 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21051 w
->cursor
.vpos
= -1;
21052 return make_number (PT
);
21055 if (g
== e
|| INTEGERP (g
->object
))
21057 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21058 goto simulate_display
;
21059 if (!row
->reversed_p
)
21063 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21064 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21065 goto simulate_display
;
21069 if (row
->reversed_p
&& !row
->continued_p
)
21071 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21072 w
->cursor
.vpos
= -1;
21073 return make_number (PT
);
21075 g
= row
->glyphs
[TEXT_AREA
];
21076 e
= g
+ row
->used
[TEXT_AREA
];
21077 for ( ; g
< e
; g
++)
21079 if (BUFFERP (g
->object
)
21080 /* Empty lines have only one glyph, which stands
21081 for the newline, and whose charpos is the
21082 buffer position of the newline. */
21083 || ROW_GLYPH_NEWLINE_P (row
, g
)
21084 /* When the buffer ends in a newline, the line at
21085 EOB also has one glyph, but its charpos is -1. */
21086 || (row
->ends_at_zv_p
21087 && !row
->reversed_p
21088 && INTEGERP (g
->object
)
21089 && g
->type
== CHAR_GLYPH
21090 && g
->u
.ch
== ' '))
21092 if (g
->charpos
> 0)
21093 SET_PT (g
->charpos
);
21094 else if (!row
->reversed_p
21095 && row
->ends_at_zv_p
21100 w
->cursor
.vpos
= -1;
21101 return make_number (PT
);
21107 if (!row
->reversed_p
&& !row
->continued_p
)
21109 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21110 w
->cursor
.vpos
= -1;
21111 return make_number (PT
);
21113 e
= row
->glyphs
[TEXT_AREA
];
21114 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21115 for ( ; g
>= e
; g
--)
21117 if (BUFFERP (g
->object
)
21118 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21120 /* Empty R2L lines on GUI frames have the buffer
21121 position of the newline stored in the stretch
21123 || g
->type
== STRETCH_GLYPH
21124 || (row
->ends_at_zv_p
21126 && INTEGERP (g
->object
)
21127 && g
->type
== CHAR_GLYPH
21128 && g
->u
.ch
== ' '))
21130 if (g
->charpos
> 0)
21131 SET_PT (g
->charpos
);
21132 else if (row
->reversed_p
21133 && row
->ends_at_zv_p
21138 w
->cursor
.vpos
= -1;
21139 return make_number (PT
);
21148 /* If we wind up here, we failed to move by using the glyphs, so we
21149 need to simulate display instead. */
21152 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21154 paragraph_dir
= Qleft_to_right
;
21155 if (EQ (paragraph_dir
, Qright_to_left
))
21157 if (PT
<= BEGV
&& dir
< 0)
21158 xsignal0 (Qbeginning_of_buffer
);
21159 else if (PT
>= ZV
&& dir
> 0)
21160 xsignal0 (Qend_of_buffer
);
21163 struct text_pos pt
;
21165 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21167 bool overshoot_expected
= false;
21168 bool target_is_eol_p
= false;
21170 /* Setup the arena. */
21171 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21172 start_display (&it
, w
, pt
);
21174 if (it
.cmp_it
.id
< 0
21175 && it
.method
== GET_FROM_STRING
21176 && it
.area
== TEXT_AREA
21177 && it
.string_from_display_prop_p
21178 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21179 overshoot_expected
= true;
21181 /* Find the X coordinate of point. We start from the beginning
21182 of this or previous line to make sure we are before point in
21183 the logical order (since the move_it_* functions can only
21186 reseat_at_previous_visible_line_start (&it
);
21187 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21188 if (IT_CHARPOS (it
) != PT
)
21190 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21191 -1, -1, -1, MOVE_TO_POS
);
21192 /* If we missed point because the character there is
21193 displayed out of a display vector that has more than one
21194 glyph, retry expecting overshoot. */
21195 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21196 && it
.current
.dpvec_index
> 0
21197 && !overshoot_expected
)
21199 overshoot_expected
= true;
21202 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21203 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21205 pt_x
= it
.current_x
;
21207 if (dir
> 0 || overshoot_expected
)
21209 struct glyph_row
*row
= it
.glyph_row
;
21211 /* When point is at beginning of line, we don't have
21212 information about the glyph there loaded into struct
21213 it. Calling get_next_display_element fixes that. */
21215 get_next_display_element (&it
);
21216 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21217 it
.glyph_row
= NULL
;
21218 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21219 it
.glyph_row
= row
;
21220 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21221 it, lest it will become out of sync with it's buffer
21223 it
.current_x
= pt_x
;
21226 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21227 pixel_width
= it
.pixel_width
;
21228 if (overshoot_expected
&& at_eol_p
)
21230 else if (pixel_width
<= 0)
21233 /* If there's a display string (or something similar) at point,
21234 we are actually at the glyph to the left of point, so we need
21235 to correct the X coordinate. */
21236 if (overshoot_expected
)
21239 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21241 pt_x
+= pixel_width
;
21244 /* Compute target X coordinate, either to the left or to the
21245 right of point. On TTY frames, all characters have the same
21246 pixel width of 1, so we can use that. On GUI frames we don't
21247 have an easy way of getting at the pixel width of the
21248 character to the left of point, so we use a different method
21249 of getting to that place. */
21251 target_x
= pt_x
+ pixel_width
;
21253 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21255 /* Target X coordinate could be one line above or below the line
21256 of point, in which case we need to adjust the target X
21257 coordinate. Also, if moving to the left, we need to begin at
21258 the left edge of the point's screen line. */
21263 start_display (&it
, w
, pt
);
21264 reseat_at_previous_visible_line_start (&it
);
21265 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21267 move_it_by_lines (&it
, pt_vpos
);
21271 move_it_by_lines (&it
, -1);
21272 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21273 target_is_eol_p
= true;
21274 /* Under word-wrap, we don't know the x coordinate of
21275 the last character displayed on the previous line,
21276 which immediately precedes the wrap point. To find
21277 out its x coordinate, we try moving to the right
21278 margin of the window, which will stop at the wrap
21279 point, and then reset target_x to point at the
21280 character that precedes the wrap point. This is not
21281 needed on GUI frames, because (see below) there we
21282 move from the left margin one grapheme cluster at a
21283 time, and stop when we hit the wrap point. */
21284 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21286 void *it_data
= NULL
;
21289 SAVE_IT (it2
, it
, it_data
);
21290 move_it_in_display_line_to (&it
, ZV
, target_x
,
21291 MOVE_TO_POS
| MOVE_TO_X
);
21292 /* If we arrived at target_x, that _is_ the last
21293 character on the previous line. */
21294 if (it
.current_x
!= target_x
)
21295 target_x
= it
.current_x
- 1;
21296 RESTORE_IT (&it
, &it2
, it_data
);
21303 || (target_x
>= it
.last_visible_x
21304 && it
.line_wrap
!= TRUNCATE
))
21307 move_it_by_lines (&it
, 0);
21308 move_it_by_lines (&it
, 1);
21313 /* Move to the target X coordinate. */
21314 #ifdef HAVE_WINDOW_SYSTEM
21315 /* On GUI frames, as we don't know the X coordinate of the
21316 character to the left of point, moving point to the left
21317 requires walking, one grapheme cluster at a time, until we
21318 find ourself at a place immediately to the left of the
21319 character at point. */
21320 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21322 struct text_pos new_pos
;
21323 enum move_it_result rc
= MOVE_X_REACHED
;
21325 if (it
.current_x
== 0)
21326 get_next_display_element (&it
);
21327 if (it
.what
== IT_COMPOSITION
)
21329 new_pos
.charpos
= it
.cmp_it
.charpos
;
21330 new_pos
.bytepos
= -1;
21333 new_pos
= it
.current
.pos
;
21335 while (it
.current_x
+ it
.pixel_width
<= target_x
21336 && (rc
== MOVE_X_REACHED
21337 /* Under word-wrap, move_it_in_display_line_to
21338 stops at correct coordinates, but sometimes
21339 returns MOVE_POS_MATCH_OR_ZV. */
21340 || (it
.line_wrap
== WORD_WRAP
21341 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21343 int new_x
= it
.current_x
+ it
.pixel_width
;
21345 /* For composed characters, we want the position of the
21346 first character in the grapheme cluster (usually, the
21347 composition's base character), whereas it.current
21348 might give us the position of the _last_ one, e.g. if
21349 the composition is rendered in reverse due to bidi
21351 if (it
.what
== IT_COMPOSITION
)
21353 new_pos
.charpos
= it
.cmp_it
.charpos
;
21354 new_pos
.bytepos
= -1;
21357 new_pos
= it
.current
.pos
;
21358 if (new_x
== it
.current_x
)
21360 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21361 MOVE_TO_POS
| MOVE_TO_X
);
21362 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21365 /* The previous position we saw in the loop is the one we
21367 if (new_pos
.bytepos
== -1)
21368 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21369 it
.current
.pos
= new_pos
;
21373 if (it
.current_x
!= target_x
)
21374 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21376 /* When lines are truncated, the above loop will stop at the
21377 window edge. But we want to get to the end of line, even if
21378 it is beyond the window edge; automatic hscroll will then
21379 scroll the window to show point as appropriate. */
21380 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21381 && get_next_display_element (&it
))
21383 struct text_pos new_pos
= it
.current
.pos
;
21385 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21387 set_iterator_to_next (&it
, 0);
21388 if (it
.method
== GET_FROM_BUFFER
)
21389 new_pos
= it
.current
.pos
;
21390 if (!get_next_display_element (&it
))
21394 it
.current
.pos
= new_pos
;
21397 /* If we ended up in a display string that covers point, move to
21398 buffer position to the right in the visual order. */
21401 while (IT_CHARPOS (it
) == PT
)
21403 set_iterator_to_next (&it
, 0);
21404 if (!get_next_display_element (&it
))
21409 /* Move point to that position. */
21410 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21413 return make_number (PT
);
21415 #undef ROW_GLYPH_NEWLINE_P
21419 /***********************************************************************
21421 ***********************************************************************/
21423 /* Redisplay the menu bar in the frame for window W.
21425 The menu bar of X frames that don't have X toolkit support is
21426 displayed in a special window W->frame->menu_bar_window.
21428 The menu bar of terminal frames is treated specially as far as
21429 glyph matrices are concerned. Menu bar lines are not part of
21430 windows, so the update is done directly on the frame matrix rows
21431 for the menu bar. */
21434 display_menu_bar (struct window
*w
)
21436 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21441 /* Don't do all this for graphical frames. */
21443 if (FRAME_W32_P (f
))
21446 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21452 if (FRAME_NS_P (f
))
21454 #endif /* HAVE_NS */
21456 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21457 eassert (!FRAME_WINDOW_P (f
));
21458 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21459 it
.first_visible_x
= 0;
21460 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21461 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21462 if (FRAME_WINDOW_P (f
))
21464 /* Menu bar lines are displayed in the desired matrix of the
21465 dummy window menu_bar_window. */
21466 struct window
*menu_w
;
21467 menu_w
= XWINDOW (f
->menu_bar_window
);
21468 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21470 it
.first_visible_x
= 0;
21471 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21474 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21476 /* This is a TTY frame, i.e. character hpos/vpos are used as
21478 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21480 it
.first_visible_x
= 0;
21481 it
.last_visible_x
= FRAME_COLS (f
);
21484 /* FIXME: This should be controlled by a user option. See the
21485 comments in redisplay_tool_bar and display_mode_line about
21487 it
.paragraph_embedding
= L2R
;
21489 /* Clear all rows of the menu bar. */
21490 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21492 struct glyph_row
*row
= it
.glyph_row
+ i
;
21493 clear_glyph_row (row
);
21494 row
->enabled_p
= true;
21495 row
->full_width_p
= 1;
21498 /* Display all items of the menu bar. */
21499 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21500 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21502 Lisp_Object string
;
21504 /* Stop at nil string. */
21505 string
= AREF (items
, i
+ 1);
21509 /* Remember where item was displayed. */
21510 ASET (items
, i
+ 3, make_number (it
.hpos
));
21512 /* Display the item, pad with one space. */
21513 if (it
.current_x
< it
.last_visible_x
)
21514 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21515 SCHARS (string
) + 1, 0, 0, -1);
21518 /* Fill out the line with spaces. */
21519 if (it
.current_x
< it
.last_visible_x
)
21520 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21522 /* Compute the total height of the lines. */
21523 compute_line_metrics (&it
);
21526 /* Deep copy of a glyph row, including the glyphs. */
21528 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21530 struct glyph
*pointers
[1 + LAST_AREA
];
21531 int to_used
= to
->used
[TEXT_AREA
];
21533 /* Save glyph pointers of TO. */
21534 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21536 /* Do a structure assignment. */
21539 /* Restore original glyph pointers of TO. */
21540 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21542 /* Copy the glyphs. */
21543 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21544 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21546 /* If we filled only part of the TO row, fill the rest with
21547 space_glyph (which will display as empty space). */
21548 if (to_used
> from
->used
[TEXT_AREA
])
21549 fill_up_frame_row_with_spaces (to
, to_used
);
21552 /* Display one menu item on a TTY, by overwriting the glyphs in the
21553 frame F's desired glyph matrix with glyphs produced from the menu
21554 item text. Called from term.c to display TTY drop-down menus one
21557 ITEM_TEXT is the menu item text as a C string.
21559 FACE_ID is the face ID to be used for this menu item. FACE_ID
21560 could specify one of 3 faces: a face for an enabled item, a face
21561 for a disabled item, or a face for a selected item.
21563 X and Y are coordinates of the first glyph in the frame's desired
21564 matrix to be overwritten by the menu item. Since this is a TTY, Y
21565 is the zero-based number of the glyph row and X is the zero-based
21566 glyph number in the row, starting from left, where to start
21567 displaying the item.
21569 SUBMENU non-zero means this menu item drops down a submenu, which
21570 should be indicated by displaying a proper visual cue after the
21574 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21575 int x
, int y
, int submenu
)
21578 struct frame
*f
= SELECTED_FRAME ();
21579 struct window
*w
= XWINDOW (f
->selected_window
);
21580 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21581 struct glyph_row
*row
;
21582 size_t item_len
= strlen (item_text
);
21584 eassert (FRAME_TERMCAP_P (f
));
21586 /* Don't write beyond the matrix's last row. This can happen for
21587 TTY screens that are not high enough to show the entire menu.
21588 (This is actually a bit of defensive programming, as
21589 tty_menu_display already limits the number of menu items to one
21590 less than the number of screen lines.) */
21591 if (y
>= f
->desired_matrix
->nrows
)
21594 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21595 it
.first_visible_x
= 0;
21596 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21597 row
= it
.glyph_row
;
21598 /* Start with the row contents from the current matrix. */
21599 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21600 saved_width
= row
->full_width_p
;
21601 row
->full_width_p
= 1;
21602 saved_reversed
= row
->reversed_p
;
21603 row
->reversed_p
= 0;
21604 row
->enabled_p
= true;
21606 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21608 eassert (x
< f
->desired_matrix
->matrix_w
);
21609 it
.current_x
= it
.hpos
= x
;
21610 it
.current_y
= it
.vpos
= y
;
21611 saved_used
= row
->used
[TEXT_AREA
];
21612 saved_truncated
= row
->truncated_on_right_p
;
21613 row
->used
[TEXT_AREA
] = x
;
21614 it
.face_id
= face_id
;
21615 it
.line_wrap
= TRUNCATE
;
21617 /* FIXME: This should be controlled by a user option. See the
21618 comments in redisplay_tool_bar and display_mode_line about this.
21619 Also, if paragraph_embedding could ever be R2L, changes will be
21620 needed to avoid shifting to the right the row characters in
21621 term.c:append_glyph. */
21622 it
.paragraph_embedding
= L2R
;
21624 /* Pad with a space on the left. */
21625 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21627 /* Display the menu item, pad with spaces to WIDTH. */
21630 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21631 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21633 /* Indicate with " >" that there's a submenu. */
21634 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21635 FRAME_COLS (f
) - 1, -1);
21638 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21639 width
, 0, FRAME_COLS (f
) - 1, -1);
21641 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21642 row
->truncated_on_right_p
= saved_truncated
;
21643 row
->hash
= row_hash (row
);
21644 row
->full_width_p
= saved_width
;
21645 row
->reversed_p
= saved_reversed
;
21648 /***********************************************************************
21650 ***********************************************************************/
21652 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21653 FORCE is non-zero, redisplay mode lines unconditionally.
21654 Otherwise, redisplay only mode lines that are garbaged. Value is
21655 the number of windows whose mode lines were redisplayed. */
21658 redisplay_mode_lines (Lisp_Object window
, bool force
)
21662 while (!NILP (window
))
21664 struct window
*w
= XWINDOW (window
);
21666 if (WINDOWP (w
->contents
))
21667 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21669 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21670 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21672 struct text_pos lpoint
;
21673 struct buffer
*old
= current_buffer
;
21675 /* Set the window's buffer for the mode line display. */
21676 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21677 set_buffer_internal_1 (XBUFFER (w
->contents
));
21679 /* Point refers normally to the selected window. For any
21680 other window, set up appropriate value. */
21681 if (!EQ (window
, selected_window
))
21683 struct text_pos pt
;
21685 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21686 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21689 /* Display mode lines. */
21690 clear_glyph_matrix (w
->desired_matrix
);
21691 if (display_mode_lines (w
))
21694 /* Restore old settings. */
21695 set_buffer_internal_1 (old
);
21696 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21706 /* Display the mode and/or header line of window W. Value is the
21707 sum number of mode lines and header lines displayed. */
21710 display_mode_lines (struct window
*w
)
21712 Lisp_Object old_selected_window
= selected_window
;
21713 Lisp_Object old_selected_frame
= selected_frame
;
21714 Lisp_Object new_frame
= w
->frame
;
21715 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21718 selected_frame
= new_frame
;
21719 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21720 or window's point, then we'd need select_window_1 here as well. */
21721 XSETWINDOW (selected_window
, w
);
21722 XFRAME (new_frame
)->selected_window
= selected_window
;
21724 /* These will be set while the mode line specs are processed. */
21725 line_number_displayed
= 0;
21726 w
->column_number_displayed
= -1;
21728 if (WINDOW_WANTS_MODELINE_P (w
))
21730 struct window
*sel_w
= XWINDOW (old_selected_window
);
21732 /* Select mode line face based on the real selected window. */
21733 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21734 BVAR (current_buffer
, mode_line_format
));
21738 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21740 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21741 BVAR (current_buffer
, header_line_format
));
21745 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21746 selected_frame
= old_selected_frame
;
21747 selected_window
= old_selected_window
;
21749 w
->must_be_updated_p
= true;
21754 /* Display mode or header line of window W. FACE_ID specifies which
21755 line to display; it is either MODE_LINE_FACE_ID or
21756 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21757 display. Value is the pixel height of the mode/header line
21761 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21765 ptrdiff_t count
= SPECPDL_INDEX ();
21767 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21768 /* Don't extend on a previously drawn mode-line.
21769 This may happen if called from pos_visible_p. */
21770 it
.glyph_row
->enabled_p
= false;
21771 prepare_desired_row (w
, it
.glyph_row
, true);
21773 it
.glyph_row
->mode_line_p
= 1;
21775 /* FIXME: This should be controlled by a user option. But
21776 supporting such an option is not trivial, since the mode line is
21777 made up of many separate strings. */
21778 it
.paragraph_embedding
= L2R
;
21780 record_unwind_protect (unwind_format_mode_line
,
21781 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21783 mode_line_target
= MODE_LINE_DISPLAY
;
21785 /* Temporarily make frame's keyboard the current kboard so that
21786 kboard-local variables in the mode_line_format will get the right
21788 push_kboard (FRAME_KBOARD (it
.f
));
21789 record_unwind_save_match_data ();
21790 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21793 unbind_to (count
, Qnil
);
21795 /* Fill up with spaces. */
21796 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21798 compute_line_metrics (&it
);
21799 it
.glyph_row
->full_width_p
= 1;
21800 it
.glyph_row
->continued_p
= 0;
21801 it
.glyph_row
->truncated_on_left_p
= 0;
21802 it
.glyph_row
->truncated_on_right_p
= 0;
21804 /* Make a 3D mode-line have a shadow at its right end. */
21805 face
= FACE_FROM_ID (it
.f
, face_id
);
21806 extend_face_to_end_of_line (&it
);
21807 if (face
->box
!= FACE_NO_BOX
)
21809 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21810 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21811 last
->right_box_line_p
= 1;
21814 return it
.glyph_row
->height
;
21817 /* Move element ELT in LIST to the front of LIST.
21818 Return the updated list. */
21821 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21823 register Lisp_Object tail
, prev
;
21824 register Lisp_Object tem
;
21828 while (CONSP (tail
))
21834 /* Splice out the link TAIL. */
21836 list
= XCDR (tail
);
21838 Fsetcdr (prev
, XCDR (tail
));
21840 /* Now make it the first. */
21841 Fsetcdr (tail
, list
);
21846 tail
= XCDR (tail
);
21850 /* Not found--return unchanged LIST. */
21854 /* Contribute ELT to the mode line for window IT->w. How it
21855 translates into text depends on its data type.
21857 IT describes the display environment in which we display, as usual.
21859 DEPTH is the depth in recursion. It is used to prevent
21860 infinite recursion here.
21862 FIELD_WIDTH is the number of characters the display of ELT should
21863 occupy in the mode line, and PRECISION is the maximum number of
21864 characters to display from ELT's representation. See
21865 display_string for details.
21867 Returns the hpos of the end of the text generated by ELT.
21869 PROPS is a property list to add to any string we encounter.
21871 If RISKY is nonzero, remove (disregard) any properties in any string
21872 we encounter, and ignore :eval and :propertize.
21874 The global variable `mode_line_target' determines whether the
21875 output is passed to `store_mode_line_noprop',
21876 `store_mode_line_string', or `display_string'. */
21879 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21880 Lisp_Object elt
, Lisp_Object props
, int risky
)
21882 int n
= 0, field
, prec
;
21887 elt
= build_string ("*too-deep*");
21891 switch (XTYPE (elt
))
21895 /* A string: output it and check for %-constructs within it. */
21897 ptrdiff_t offset
= 0;
21899 if (SCHARS (elt
) > 0
21900 && (!NILP (props
) || risky
))
21902 Lisp_Object oprops
, aelt
;
21903 oprops
= Ftext_properties_at (make_number (0), elt
);
21905 /* If the starting string's properties are not what
21906 we want, translate the string. Also, if the string
21907 is risky, do that anyway. */
21909 if (NILP (Fequal (props
, oprops
)) || risky
)
21911 /* If the starting string has properties,
21912 merge the specified ones onto the existing ones. */
21913 if (! NILP (oprops
) && !risky
)
21917 oprops
= Fcopy_sequence (oprops
);
21919 while (CONSP (tem
))
21921 oprops
= Fplist_put (oprops
, XCAR (tem
),
21922 XCAR (XCDR (tem
)));
21923 tem
= XCDR (XCDR (tem
));
21928 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21929 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21931 /* AELT is what we want. Move it to the front
21932 without consing. */
21934 mode_line_proptrans_alist
21935 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21941 /* If AELT has the wrong props, it is useless.
21942 so get rid of it. */
21944 mode_line_proptrans_alist
21945 = Fdelq (aelt
, mode_line_proptrans_alist
);
21947 elt
= Fcopy_sequence (elt
);
21948 Fset_text_properties (make_number (0), Flength (elt
),
21950 /* Add this item to mode_line_proptrans_alist. */
21951 mode_line_proptrans_alist
21952 = Fcons (Fcons (elt
, props
),
21953 mode_line_proptrans_alist
);
21954 /* Truncate mode_line_proptrans_alist
21955 to at most 50 elements. */
21956 tem
= Fnthcdr (make_number (50),
21957 mode_line_proptrans_alist
);
21959 XSETCDR (tem
, Qnil
);
21968 prec
= precision
- n
;
21969 switch (mode_line_target
)
21971 case MODE_LINE_NOPROP
:
21972 case MODE_LINE_TITLE
:
21973 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21975 case MODE_LINE_STRING
:
21976 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21978 case MODE_LINE_DISPLAY
:
21979 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21980 0, prec
, 0, STRING_MULTIBYTE (elt
));
21987 /* Handle the non-literal case. */
21989 while ((precision
<= 0 || n
< precision
)
21990 && SREF (elt
, offset
) != 0
21991 && (mode_line_target
!= MODE_LINE_DISPLAY
21992 || it
->current_x
< it
->last_visible_x
))
21994 ptrdiff_t last_offset
= offset
;
21996 /* Advance to end of string or next format specifier. */
21997 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22000 if (offset
- 1 != last_offset
)
22002 ptrdiff_t nchars
, nbytes
;
22004 /* Output to end of string or up to '%'. Field width
22005 is length of string. Don't output more than
22006 PRECISION allows us. */
22009 prec
= c_string_width (SDATA (elt
) + last_offset
,
22010 offset
- last_offset
, precision
- n
,
22013 switch (mode_line_target
)
22015 case MODE_LINE_NOPROP
:
22016 case MODE_LINE_TITLE
:
22017 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22019 case MODE_LINE_STRING
:
22021 ptrdiff_t bytepos
= last_offset
;
22022 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22023 ptrdiff_t endpos
= (precision
<= 0
22024 ? string_byte_to_char (elt
, offset
)
22025 : charpos
+ nchars
);
22027 n
+= store_mode_line_string (NULL
,
22028 Fsubstring (elt
, make_number (charpos
),
22029 make_number (endpos
)),
22033 case MODE_LINE_DISPLAY
:
22035 ptrdiff_t bytepos
= last_offset
;
22036 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22038 if (precision
<= 0)
22039 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22040 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22042 STRING_MULTIBYTE (elt
));
22047 else /* c == '%' */
22049 ptrdiff_t percent_position
= offset
;
22051 /* Get the specified minimum width. Zero means
22054 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22055 field
= field
* 10 + c
- '0';
22057 /* Don't pad beyond the total padding allowed. */
22058 if (field_width
- n
> 0 && field
> field_width
- n
)
22059 field
= field_width
- n
;
22061 /* Note that either PRECISION <= 0 or N < PRECISION. */
22062 prec
= precision
- n
;
22065 n
+= display_mode_element (it
, depth
, field
, prec
,
22066 Vglobal_mode_string
, props
,
22071 ptrdiff_t bytepos
, charpos
;
22073 Lisp_Object string
;
22075 bytepos
= percent_position
;
22076 charpos
= (STRING_MULTIBYTE (elt
)
22077 ? string_byte_to_char (elt
, bytepos
)
22079 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22080 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22082 switch (mode_line_target
)
22084 case MODE_LINE_NOPROP
:
22085 case MODE_LINE_TITLE
:
22086 n
+= store_mode_line_noprop (spec
, field
, prec
);
22088 case MODE_LINE_STRING
:
22090 Lisp_Object tem
= build_string (spec
);
22091 props
= Ftext_properties_at (make_number (charpos
), elt
);
22092 /* Should only keep face property in props */
22093 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22096 case MODE_LINE_DISPLAY
:
22098 int nglyphs_before
, nwritten
;
22100 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22101 nwritten
= display_string (spec
, string
, elt
,
22106 /* Assign to the glyphs written above the
22107 string where the `%x' came from, position
22111 struct glyph
*glyph
22112 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22116 for (i
= 0; i
< nwritten
; ++i
)
22118 glyph
[i
].object
= elt
;
22119 glyph
[i
].charpos
= charpos
;
22136 /* A symbol: process the value of the symbol recursively
22137 as if it appeared here directly. Avoid error if symbol void.
22138 Special case: if value of symbol is a string, output the string
22141 register Lisp_Object tem
;
22143 /* If the variable is not marked as risky to set
22144 then its contents are risky to use. */
22145 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22148 tem
= Fboundp (elt
);
22151 tem
= Fsymbol_value (elt
);
22152 /* If value is a string, output that string literally:
22153 don't check for % within it. */
22157 if (!EQ (tem
, elt
))
22159 /* Give up right away for nil or t. */
22169 register Lisp_Object car
, tem
;
22171 /* A cons cell: five distinct cases.
22172 If first element is :eval or :propertize, do something special.
22173 If first element is a string or a cons, process all the elements
22174 and effectively concatenate them.
22175 If first element is a negative number, truncate displaying cdr to
22176 at most that many characters. If positive, pad (with spaces)
22177 to at least that many characters.
22178 If first element is a symbol, process the cadr or caddr recursively
22179 according to whether the symbol's value is non-nil or nil. */
22181 if (EQ (car
, QCeval
))
22183 /* An element of the form (:eval FORM) means evaluate FORM
22184 and use the result as mode line elements. */
22189 if (CONSP (XCDR (elt
)))
22192 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22193 n
+= display_mode_element (it
, depth
, field_width
- n
,
22194 precision
- n
, spec
, props
,
22198 else if (EQ (car
, QCpropertize
))
22200 /* An element of the form (:propertize ELT PROPS...)
22201 means display ELT but applying properties PROPS. */
22206 if (CONSP (XCDR (elt
)))
22207 n
+= display_mode_element (it
, depth
, field_width
- n
,
22208 precision
- n
, XCAR (XCDR (elt
)),
22209 XCDR (XCDR (elt
)), risky
);
22211 else if (SYMBOLP (car
))
22213 tem
= Fboundp (car
);
22217 /* elt is now the cdr, and we know it is a cons cell.
22218 Use its car if CAR has a non-nil value. */
22221 tem
= Fsymbol_value (car
);
22228 /* Symbol's value is nil (or symbol is unbound)
22229 Get the cddr of the original list
22230 and if possible find the caddr and use that. */
22234 else if (!CONSP (elt
))
22239 else if (INTEGERP (car
))
22241 register int lim
= XINT (car
);
22245 /* Negative int means reduce maximum width. */
22246 if (precision
<= 0)
22249 precision
= min (precision
, -lim
);
22253 /* Padding specified. Don't let it be more than
22254 current maximum. */
22256 lim
= min (precision
, lim
);
22258 /* If that's more padding than already wanted, queue it.
22259 But don't reduce padding already specified even if
22260 that is beyond the current truncation point. */
22261 field_width
= max (lim
, field_width
);
22265 else if (STRINGP (car
) || CONSP (car
))
22267 Lisp_Object halftail
= elt
;
22271 && (precision
<= 0 || n
< precision
))
22273 n
+= display_mode_element (it
, depth
,
22274 /* Do padding only after the last
22275 element in the list. */
22276 (! CONSP (XCDR (elt
))
22279 precision
- n
, XCAR (elt
),
22283 if ((len
& 1) == 0)
22284 halftail
= XCDR (halftail
);
22285 /* Check for cycle. */
22286 if (EQ (halftail
, elt
))
22295 elt
= build_string ("*invalid*");
22299 /* Pad to FIELD_WIDTH. */
22300 if (field_width
> 0 && n
< field_width
)
22302 switch (mode_line_target
)
22304 case MODE_LINE_NOPROP
:
22305 case MODE_LINE_TITLE
:
22306 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22308 case MODE_LINE_STRING
:
22309 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22311 case MODE_LINE_DISPLAY
:
22312 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22321 /* Store a mode-line string element in mode_line_string_list.
22323 If STRING is non-null, display that C string. Otherwise, the Lisp
22324 string LISP_STRING is displayed.
22326 FIELD_WIDTH is the minimum number of output glyphs to produce.
22327 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22328 with spaces. FIELD_WIDTH <= 0 means don't pad.
22330 PRECISION is the maximum number of characters to output from
22331 STRING. PRECISION <= 0 means don't truncate the string.
22333 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22334 properties to the string.
22336 PROPS are the properties to add to the string.
22337 The mode_line_string_face face property is always added to the string.
22341 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22342 int field_width
, int precision
, Lisp_Object props
)
22347 if (string
!= NULL
)
22349 len
= strlen (string
);
22350 if (precision
> 0 && len
> precision
)
22352 lisp_string
= make_string (string
, len
);
22354 props
= mode_line_string_face_prop
;
22355 else if (!NILP (mode_line_string_face
))
22357 Lisp_Object face
= Fplist_get (props
, Qface
);
22358 props
= Fcopy_sequence (props
);
22360 face
= mode_line_string_face
;
22362 face
= list2 (face
, mode_line_string_face
);
22363 props
= Fplist_put (props
, Qface
, face
);
22365 Fadd_text_properties (make_number (0), make_number (len
),
22366 props
, lisp_string
);
22370 len
= XFASTINT (Flength (lisp_string
));
22371 if (precision
> 0 && len
> precision
)
22374 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22377 if (!NILP (mode_line_string_face
))
22381 props
= Ftext_properties_at (make_number (0), lisp_string
);
22382 face
= Fplist_get (props
, Qface
);
22384 face
= mode_line_string_face
;
22386 face
= list2 (face
, mode_line_string_face
);
22387 props
= list2 (Qface
, face
);
22389 lisp_string
= Fcopy_sequence (lisp_string
);
22392 Fadd_text_properties (make_number (0), make_number (len
),
22393 props
, lisp_string
);
22398 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22402 if (field_width
> len
)
22404 field_width
-= len
;
22405 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22407 Fadd_text_properties (make_number (0), make_number (field_width
),
22408 props
, lisp_string
);
22409 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22417 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22419 doc
: /* Format a string out of a mode line format specification.
22420 First arg FORMAT specifies the mode line format (see `mode-line-format'
22421 for details) to use.
22423 By default, the format is evaluated for the currently selected window.
22425 Optional second arg FACE specifies the face property to put on all
22426 characters for which no face is specified. The value nil means the
22427 default face. The value t means whatever face the window's mode line
22428 currently uses (either `mode-line' or `mode-line-inactive',
22429 depending on whether the window is the selected window or not).
22430 An integer value means the value string has no text
22433 Optional third and fourth args WINDOW and BUFFER specify the window
22434 and buffer to use as the context for the formatting (defaults
22435 are the selected window and the WINDOW's buffer). */)
22436 (Lisp_Object format
, Lisp_Object face
,
22437 Lisp_Object window
, Lisp_Object buffer
)
22442 struct buffer
*old_buffer
= NULL
;
22444 int no_props
= INTEGERP (face
);
22445 ptrdiff_t count
= SPECPDL_INDEX ();
22447 int string_start
= 0;
22449 w
= decode_any_window (window
);
22450 XSETWINDOW (window
, w
);
22453 buffer
= w
->contents
;
22454 CHECK_BUFFER (buffer
);
22456 /* Make formatting the modeline a non-op when noninteractive, otherwise
22457 there will be problems later caused by a partially initialized frame. */
22458 if (NILP (format
) || noninteractive
)
22459 return empty_unibyte_string
;
22464 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22465 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22466 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22467 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22468 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22469 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22470 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22473 old_buffer
= current_buffer
;
22475 /* Save things including mode_line_proptrans_alist,
22476 and set that to nil so that we don't alter the outer value. */
22477 record_unwind_protect (unwind_format_mode_line
,
22478 format_mode_line_unwind_data
22479 (XFRAME (WINDOW_FRAME (w
)),
22480 old_buffer
, selected_window
, 1));
22481 mode_line_proptrans_alist
= Qnil
;
22483 Fselect_window (window
, Qt
);
22484 set_buffer_internal_1 (XBUFFER (buffer
));
22486 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22490 mode_line_target
= MODE_LINE_NOPROP
;
22491 mode_line_string_face_prop
= Qnil
;
22492 mode_line_string_list
= Qnil
;
22493 string_start
= MODE_LINE_NOPROP_LEN (0);
22497 mode_line_target
= MODE_LINE_STRING
;
22498 mode_line_string_list
= Qnil
;
22499 mode_line_string_face
= face
;
22500 mode_line_string_face_prop
22501 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22504 push_kboard (FRAME_KBOARD (it
.f
));
22505 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22510 len
= MODE_LINE_NOPROP_LEN (string_start
);
22511 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22515 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22516 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22517 empty_unibyte_string
);
22520 unbind_to (count
, Qnil
);
22524 /* Write a null-terminated, right justified decimal representation of
22525 the positive integer D to BUF using a minimal field width WIDTH. */
22528 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22530 register char *p
= buf
;
22538 *p
++ = d
% 10 + '0';
22543 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22554 /* Write a null-terminated, right justified decimal and "human
22555 readable" representation of the nonnegative integer D to BUF using
22556 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22558 static const char power_letter
[] =
22572 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22574 /* We aim to represent the nonnegative integer D as
22575 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22576 ptrdiff_t quotient
= d
;
22578 /* -1 means: do not use TENTHS. */
22582 /* Length of QUOTIENT.TENTHS as a string. */
22588 if (quotient
>= 1000)
22590 /* Scale to the appropriate EXPONENT. */
22593 remainder
= quotient
% 1000;
22597 while (quotient
>= 1000);
22599 /* Round to nearest and decide whether to use TENTHS or not. */
22602 tenths
= remainder
/ 100;
22603 if (remainder
% 100 >= 50)
22610 if (quotient
== 10)
22618 if (remainder
>= 500)
22620 if (quotient
< 999)
22631 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22632 if (tenths
== -1 && quotient
<= 99)
22639 p
= psuffix
= buf
+ max (width
, length
);
22641 /* Print EXPONENT. */
22642 *psuffix
++ = power_letter
[exponent
];
22645 /* Print TENTHS. */
22648 *--p
= '0' + tenths
;
22652 /* Print QUOTIENT. */
22655 int digit
= quotient
% 10;
22656 *--p
= '0' + digit
;
22658 while ((quotient
/= 10) != 0);
22660 /* Print leading spaces. */
22665 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22666 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22667 type of CODING_SYSTEM. Return updated pointer into BUF. */
22669 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22672 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22675 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22676 const unsigned char *eol_str
;
22678 /* The EOL conversion we are using. */
22679 Lisp_Object eoltype
;
22681 val
= CODING_SYSTEM_SPEC (coding_system
);
22684 if (!VECTORP (val
)) /* Not yet decided. */
22686 *buf
++ = multibyte
? '-' : ' ';
22688 eoltype
= eol_mnemonic_undecided
;
22689 /* Don't mention EOL conversion if it isn't decided. */
22694 Lisp_Object eolvalue
;
22696 attrs
= AREF (val
, 0);
22697 eolvalue
= AREF (val
, 2);
22700 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22705 /* The EOL conversion that is normal on this system. */
22707 if (NILP (eolvalue
)) /* Not yet decided. */
22708 eoltype
= eol_mnemonic_undecided
;
22709 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22710 eoltype
= eol_mnemonic_undecided
;
22711 else /* eolvalue is Qunix, Qdos, or Qmac. */
22712 eoltype
= (EQ (eolvalue
, Qunix
)
22713 ? eol_mnemonic_unix
22714 : (EQ (eolvalue
, Qdos
) == 1
22715 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22721 /* Mention the EOL conversion if it is not the usual one. */
22722 if (STRINGP (eoltype
))
22724 eol_str
= SDATA (eoltype
);
22725 eol_str_len
= SBYTES (eoltype
);
22727 else if (CHARACTERP (eoltype
))
22729 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22730 int c
= XFASTINT (eoltype
);
22731 eol_str_len
= CHAR_STRING (c
, tmp
);
22736 eol_str
= invalid_eol_type
;
22737 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22739 memcpy (buf
, eol_str
, eol_str_len
);
22740 buf
+= eol_str_len
;
22746 /* Return a string for the output of a mode line %-spec for window W,
22747 generated by character C. FIELD_WIDTH > 0 means pad the string
22748 returned with spaces to that value. Return a Lisp string in
22749 *STRING if the resulting string is taken from that Lisp string.
22751 Note we operate on the current buffer for most purposes. */
22753 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22755 static const char *
22756 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22757 Lisp_Object
*string
)
22760 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22761 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22762 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22763 produce strings from numerical values, so limit preposterously
22764 large values of FIELD_WIDTH to avoid overrunning the buffer's
22765 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22766 bytes plus the terminating null. */
22767 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22768 struct buffer
*b
= current_buffer
;
22776 if (!NILP (BVAR (b
, read_only
)))
22778 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22783 /* This differs from %* only for a modified read-only buffer. */
22784 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22786 if (!NILP (BVAR (b
, read_only
)))
22791 /* This differs from %* in ignoring read-only-ness. */
22792 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22804 if (command_loop_level
> 5)
22806 p
= decode_mode_spec_buf
;
22807 for (i
= 0; i
< command_loop_level
; i
++)
22810 return decode_mode_spec_buf
;
22818 if (command_loop_level
> 5)
22820 p
= decode_mode_spec_buf
;
22821 for (i
= 0; i
< command_loop_level
; i
++)
22824 return decode_mode_spec_buf
;
22831 /* Let lots_of_dashes be a string of infinite length. */
22832 if (mode_line_target
== MODE_LINE_NOPROP
22833 || mode_line_target
== MODE_LINE_STRING
)
22835 if (field_width
<= 0
22836 || field_width
> sizeof (lots_of_dashes
))
22838 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22839 decode_mode_spec_buf
[i
] = '-';
22840 decode_mode_spec_buf
[i
] = '\0';
22841 return decode_mode_spec_buf
;
22844 return lots_of_dashes
;
22848 obj
= BVAR (b
, name
);
22852 /* %c and %l are ignored in `frame-title-format'.
22853 (In redisplay_internal, the frame title is drawn _before_ the
22854 windows are updated, so the stuff which depends on actual
22855 window contents (such as %l) may fail to render properly, or
22856 even crash emacs.) */
22857 if (mode_line_target
== MODE_LINE_TITLE
)
22861 ptrdiff_t col
= current_column ();
22862 w
->column_number_displayed
= col
;
22863 pint2str (decode_mode_spec_buf
, width
, col
);
22864 return decode_mode_spec_buf
;
22868 #ifndef SYSTEM_MALLOC
22870 if (NILP (Vmemory_full
))
22873 return "!MEM FULL! ";
22880 /* %F displays the frame name. */
22881 if (!NILP (f
->title
))
22882 return SSDATA (f
->title
);
22883 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22884 return SSDATA (f
->name
);
22888 obj
= BVAR (b
, filename
);
22893 ptrdiff_t size
= ZV
- BEGV
;
22894 pint2str (decode_mode_spec_buf
, width
, size
);
22895 return decode_mode_spec_buf
;
22900 ptrdiff_t size
= ZV
- BEGV
;
22901 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22902 return decode_mode_spec_buf
;
22907 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22908 ptrdiff_t topline
, nlines
, height
;
22911 /* %c and %l are ignored in `frame-title-format'. */
22912 if (mode_line_target
== MODE_LINE_TITLE
)
22915 startpos
= marker_position (w
->start
);
22916 startpos_byte
= marker_byte_position (w
->start
);
22917 height
= WINDOW_TOTAL_LINES (w
);
22919 /* If we decided that this buffer isn't suitable for line numbers,
22920 don't forget that too fast. */
22921 if (w
->base_line_pos
== -1)
22924 /* If the buffer is very big, don't waste time. */
22925 if (INTEGERP (Vline_number_display_limit
)
22926 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22928 w
->base_line_pos
= 0;
22929 w
->base_line_number
= 0;
22933 if (w
->base_line_number
> 0
22934 && w
->base_line_pos
> 0
22935 && w
->base_line_pos
<= startpos
)
22937 line
= w
->base_line_number
;
22938 linepos
= w
->base_line_pos
;
22939 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22944 linepos
= BUF_BEGV (b
);
22945 linepos_byte
= BUF_BEGV_BYTE (b
);
22948 /* Count lines from base line to window start position. */
22949 nlines
= display_count_lines (linepos_byte
,
22953 topline
= nlines
+ line
;
22955 /* Determine a new base line, if the old one is too close
22956 or too far away, or if we did not have one.
22957 "Too close" means it's plausible a scroll-down would
22958 go back past it. */
22959 if (startpos
== BUF_BEGV (b
))
22961 w
->base_line_number
= topline
;
22962 w
->base_line_pos
= BUF_BEGV (b
);
22964 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22965 || linepos
== BUF_BEGV (b
))
22967 ptrdiff_t limit
= BUF_BEGV (b
);
22968 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22969 ptrdiff_t position
;
22970 ptrdiff_t distance
=
22971 (height
* 2 + 30) * line_number_display_limit_width
;
22973 if (startpos
- distance
> limit
)
22975 limit
= startpos
- distance
;
22976 limit_byte
= CHAR_TO_BYTE (limit
);
22979 nlines
= display_count_lines (startpos_byte
,
22981 - (height
* 2 + 30),
22983 /* If we couldn't find the lines we wanted within
22984 line_number_display_limit_width chars per line,
22985 give up on line numbers for this window. */
22986 if (position
== limit_byte
&& limit
== startpos
- distance
)
22988 w
->base_line_pos
= -1;
22989 w
->base_line_number
= 0;
22993 w
->base_line_number
= topline
- nlines
;
22994 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22997 /* Now count lines from the start pos to point. */
22998 nlines
= display_count_lines (startpos_byte
,
22999 PT_BYTE
, PT
, &junk
);
23001 /* Record that we did display the line number. */
23002 line_number_displayed
= 1;
23004 /* Make the string to show. */
23005 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23006 return decode_mode_spec_buf
;
23009 char* p
= decode_mode_spec_buf
;
23010 int pad
= width
- 2;
23016 return decode_mode_spec_buf
;
23022 obj
= BVAR (b
, mode_name
);
23026 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23032 ptrdiff_t pos
= marker_position (w
->start
);
23033 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23035 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23037 if (pos
<= BUF_BEGV (b
))
23042 else if (pos
<= BUF_BEGV (b
))
23046 if (total
> 1000000)
23047 /* Do it differently for a large value, to avoid overflow. */
23048 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23050 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23051 /* We can't normally display a 3-digit number,
23052 so get us a 2-digit number that is close. */
23055 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23056 return decode_mode_spec_buf
;
23060 /* Display percentage of size above the bottom of the screen. */
23063 ptrdiff_t toppos
= marker_position (w
->start
);
23064 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23065 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23067 if (botpos
>= BUF_ZV (b
))
23069 if (toppos
<= BUF_BEGV (b
))
23076 if (total
> 1000000)
23077 /* Do it differently for a large value, to avoid overflow. */
23078 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23080 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23081 /* We can't normally display a 3-digit number,
23082 so get us a 2-digit number that is close. */
23085 if (toppos
<= BUF_BEGV (b
))
23086 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23088 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23089 return decode_mode_spec_buf
;
23094 /* status of process */
23095 obj
= Fget_buffer_process (Fcurrent_buffer ());
23097 return "no process";
23099 obj
= Fsymbol_name (Fprocess_status (obj
));
23105 ptrdiff_t count
= inhibit_garbage_collection ();
23106 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23107 Lisp_Object val
= Qnil
;
23109 if (STRINGP (curdir
))
23110 val
= call1 (intern ("file-remote-p"), curdir
);
23112 unbind_to (count
, Qnil
);
23121 /* coding-system (not including end-of-line format) */
23123 /* coding-system (including end-of-line type) */
23125 int eol_flag
= (c
== 'Z');
23126 char *p
= decode_mode_spec_buf
;
23128 if (! FRAME_WINDOW_P (f
))
23130 /* No need to mention EOL here--the terminal never needs
23131 to do EOL conversion. */
23132 p
= decode_mode_spec_coding (CODING_ID_NAME
23133 (FRAME_KEYBOARD_CODING (f
)->id
),
23135 p
= decode_mode_spec_coding (CODING_ID_NAME
23136 (FRAME_TERMINAL_CODING (f
)->id
),
23139 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23142 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23143 #ifdef subprocesses
23144 obj
= Fget_buffer_process (Fcurrent_buffer ());
23145 if (PROCESSP (obj
))
23147 p
= decode_mode_spec_coding
23148 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23149 p
= decode_mode_spec_coding
23150 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23152 #endif /* subprocesses */
23155 return decode_mode_spec_buf
;
23162 return SSDATA (obj
);
23169 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23170 means count lines back from START_BYTE. But don't go beyond
23171 LIMIT_BYTE. Return the number of lines thus found (always
23174 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23175 either the position COUNT lines after/before START_BYTE, if we
23176 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23180 display_count_lines (ptrdiff_t start_byte
,
23181 ptrdiff_t limit_byte
, ptrdiff_t count
,
23182 ptrdiff_t *byte_pos_ptr
)
23184 register unsigned char *cursor
;
23185 unsigned char *base
;
23187 register ptrdiff_t ceiling
;
23188 register unsigned char *ceiling_addr
;
23189 ptrdiff_t orig_count
= count
;
23191 /* If we are not in selective display mode,
23192 check only for newlines. */
23193 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23194 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23198 while (start_byte
< limit_byte
)
23200 ceiling
= BUFFER_CEILING_OF (start_byte
);
23201 ceiling
= min (limit_byte
- 1, ceiling
);
23202 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23203 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23207 if (selective_display
)
23209 while (*cursor
!= '\n' && *cursor
!= 015
23210 && ++cursor
!= ceiling_addr
)
23212 if (cursor
== ceiling_addr
)
23217 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23226 start_byte
+= cursor
- base
;
23227 *byte_pos_ptr
= start_byte
;
23231 while (cursor
< ceiling_addr
);
23233 start_byte
+= ceiling_addr
- base
;
23238 while (start_byte
> limit_byte
)
23240 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23241 ceiling
= max (limit_byte
, ceiling
);
23242 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23243 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23246 if (selective_display
)
23248 while (--cursor
>= ceiling_addr
23249 && *cursor
!= '\n' && *cursor
!= 015)
23251 if (cursor
< ceiling_addr
)
23256 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23263 start_byte
+= cursor
- base
+ 1;
23264 *byte_pos_ptr
= start_byte
;
23265 /* When scanning backwards, we should
23266 not count the newline posterior to which we stop. */
23267 return - orig_count
- 1;
23270 start_byte
+= ceiling_addr
- base
;
23274 *byte_pos_ptr
= limit_byte
;
23277 return - orig_count
+ count
;
23278 return orig_count
- count
;
23284 /***********************************************************************
23286 ***********************************************************************/
23288 /* Display a NUL-terminated string, starting with index START.
23290 If STRING is non-null, display that C string. Otherwise, the Lisp
23291 string LISP_STRING is displayed. There's a case that STRING is
23292 non-null and LISP_STRING is not nil. It means STRING is a string
23293 data of LISP_STRING. In that case, we display LISP_STRING while
23294 ignoring its text properties.
23296 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23297 FACE_STRING. Display STRING or LISP_STRING with the face at
23298 FACE_STRING_POS in FACE_STRING:
23300 Display the string in the environment given by IT, but use the
23301 standard display table, temporarily.
23303 FIELD_WIDTH is the minimum number of output glyphs to produce.
23304 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23305 with spaces. If STRING has more characters, more than FIELD_WIDTH
23306 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23308 PRECISION is the maximum number of characters to output from
23309 STRING. PRECISION < 0 means don't truncate the string.
23311 This is roughly equivalent to printf format specifiers:
23313 FIELD_WIDTH PRECISION PRINTF
23314 ----------------------------------------
23320 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23321 display them, and < 0 means obey the current buffer's value of
23322 enable_multibyte_characters.
23324 Value is the number of columns displayed. */
23327 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23328 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23329 int field_width
, int precision
, int max_x
, int multibyte
)
23331 int hpos_at_start
= it
->hpos
;
23332 int saved_face_id
= it
->face_id
;
23333 struct glyph_row
*row
= it
->glyph_row
;
23334 ptrdiff_t it_charpos
;
23336 /* Initialize the iterator IT for iteration over STRING beginning
23337 with index START. */
23338 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23339 precision
, field_width
, multibyte
);
23340 if (string
&& STRINGP (lisp_string
))
23341 /* LISP_STRING is the one returned by decode_mode_spec. We should
23342 ignore its text properties. */
23343 it
->stop_charpos
= it
->end_charpos
;
23345 /* If displaying STRING, set up the face of the iterator from
23346 FACE_STRING, if that's given. */
23347 if (STRINGP (face_string
))
23353 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23354 0, &endptr
, it
->base_face_id
, 0);
23355 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23356 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23359 /* Set max_x to the maximum allowed X position. Don't let it go
23360 beyond the right edge of the window. */
23362 max_x
= it
->last_visible_x
;
23364 max_x
= min (max_x
, it
->last_visible_x
);
23366 /* Skip over display elements that are not visible. because IT->w is
23368 if (it
->current_x
< it
->first_visible_x
)
23369 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23370 MOVE_TO_POS
| MOVE_TO_X
);
23372 row
->ascent
= it
->max_ascent
;
23373 row
->height
= it
->max_ascent
+ it
->max_descent
;
23374 row
->phys_ascent
= it
->max_phys_ascent
;
23375 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23376 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23378 if (STRINGP (it
->string
))
23379 it_charpos
= IT_STRING_CHARPOS (*it
);
23381 it_charpos
= IT_CHARPOS (*it
);
23383 /* This condition is for the case that we are called with current_x
23384 past last_visible_x. */
23385 while (it
->current_x
< max_x
)
23387 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23389 /* Get the next display element. */
23390 if (!get_next_display_element (it
))
23393 /* Produce glyphs. */
23394 x_before
= it
->current_x
;
23395 n_glyphs_before
= row
->used
[TEXT_AREA
];
23396 PRODUCE_GLYPHS (it
);
23398 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23401 while (i
< nglyphs
)
23403 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23405 if (it
->line_wrap
!= TRUNCATE
23406 && x
+ glyph
->pixel_width
> max_x
)
23408 /* End of continued line or max_x reached. */
23409 if (CHAR_GLYPH_PADDING_P (*glyph
))
23411 /* A wide character is unbreakable. */
23412 if (row
->reversed_p
)
23413 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23414 - n_glyphs_before
);
23415 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23416 it
->current_x
= x_before
;
23420 if (row
->reversed_p
)
23421 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23422 - (n_glyphs_before
+ i
));
23423 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23428 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23430 /* Glyph is at least partially visible. */
23432 if (x
< it
->first_visible_x
)
23433 row
->x
= x
- it
->first_visible_x
;
23437 /* Glyph is off the left margin of the display area.
23438 Should not happen. */
23442 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23443 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23444 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23445 row
->phys_height
= max (row
->phys_height
,
23446 it
->max_phys_ascent
+ it
->max_phys_descent
);
23447 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23448 it
->max_extra_line_spacing
);
23449 x
+= glyph
->pixel_width
;
23453 /* Stop if max_x reached. */
23457 /* Stop at line ends. */
23458 if (ITERATOR_AT_END_OF_LINE_P (it
))
23460 it
->continuation_lines_width
= 0;
23464 set_iterator_to_next (it
, 1);
23465 if (STRINGP (it
->string
))
23466 it_charpos
= IT_STRING_CHARPOS (*it
);
23468 it_charpos
= IT_CHARPOS (*it
);
23470 /* Stop if truncating at the right edge. */
23471 if (it
->line_wrap
== TRUNCATE
23472 && it
->current_x
>= it
->last_visible_x
)
23474 /* Add truncation mark, but don't do it if the line is
23475 truncated at a padding space. */
23476 if (it_charpos
< it
->string_nchars
)
23478 if (!FRAME_WINDOW_P (it
->f
))
23482 if (it
->current_x
> it
->last_visible_x
)
23484 if (!row
->reversed_p
)
23486 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23487 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23492 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23493 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23495 unproduce_glyphs (it
, ii
+ 1);
23496 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23498 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23500 row
->used
[TEXT_AREA
] = ii
;
23501 produce_special_glyphs (it
, IT_TRUNCATION
);
23504 produce_special_glyphs (it
, IT_TRUNCATION
);
23506 row
->truncated_on_right_p
= 1;
23512 /* Maybe insert a truncation at the left. */
23513 if (it
->first_visible_x
23516 if (!FRAME_WINDOW_P (it
->f
)
23517 || (row
->reversed_p
23518 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23519 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23520 insert_left_trunc_glyphs (it
);
23521 row
->truncated_on_left_p
= 1;
23524 it
->face_id
= saved_face_id
;
23526 /* Value is number of columns displayed. */
23527 return it
->hpos
- hpos_at_start
;
23532 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23533 appears as an element of LIST or as the car of an element of LIST.
23534 If PROPVAL is a list, compare each element against LIST in that
23535 way, and return 1/2 if any element of PROPVAL is found in LIST.
23536 Otherwise return 0. This function cannot quit.
23537 The return value is 2 if the text is invisible but with an ellipsis
23538 and 1 if it's invisible and without an ellipsis. */
23541 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23543 register Lisp_Object tail
, proptail
;
23545 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23547 register Lisp_Object tem
;
23549 if (EQ (propval
, tem
))
23551 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23552 return NILP (XCDR (tem
)) ? 1 : 2;
23555 if (CONSP (propval
))
23557 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23559 Lisp_Object propelt
;
23560 propelt
= XCAR (proptail
);
23561 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23563 register Lisp_Object tem
;
23565 if (EQ (propelt
, tem
))
23567 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23568 return NILP (XCDR (tem
)) ? 1 : 2;
23576 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23577 doc
: /* Non-nil if the property makes the text invisible.
23578 POS-OR-PROP can be a marker or number, in which case it is taken to be
23579 a position in the current buffer and the value of the `invisible' property
23580 is checked; or it can be some other value, which is then presumed to be the
23581 value of the `invisible' property of the text of interest.
23582 The non-nil value returned can be t for truly invisible text or something
23583 else if the text is replaced by an ellipsis. */)
23584 (Lisp_Object pos_or_prop
)
23587 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23588 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23590 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23591 return (invis
== 0 ? Qnil
23593 : make_number (invis
));
23596 /* Calculate a width or height in pixels from a specification using
23597 the following elements:
23600 NUM - a (fractional) multiple of the default font width/height
23601 (NUM) - specifies exactly NUM pixels
23602 UNIT - a fixed number of pixels, see below.
23603 ELEMENT - size of a display element in pixels, see below.
23604 (NUM . SPEC) - equals NUM * SPEC
23605 (+ SPEC SPEC ...) - add pixel values
23606 (- SPEC SPEC ...) - subtract pixel values
23607 (- SPEC) - negate pixel value
23610 INT or FLOAT - a number constant
23611 SYMBOL - use symbol's (buffer local) variable binding.
23614 in - pixels per inch *)
23615 mm - pixels per 1/1000 meter *)
23616 cm - pixels per 1/100 meter *)
23617 width - width of current font in pixels.
23618 height - height of current font in pixels.
23620 *) using the ratio(s) defined in display-pixels-per-inch.
23624 left-fringe - left fringe width in pixels
23625 right-fringe - right fringe width in pixels
23627 left-margin - left margin width in pixels
23628 right-margin - right margin width in pixels
23630 scroll-bar - scroll-bar area width in pixels
23634 Pixels corresponding to 5 inches:
23637 Total width of non-text areas on left side of window (if scroll-bar is on left):
23638 '(space :width (+ left-fringe left-margin scroll-bar))
23640 Align to first text column (in header line):
23641 '(space :align-to 0)
23643 Align to middle of text area minus half the width of variable `my-image'
23644 containing a loaded image:
23645 '(space :align-to (0.5 . (- text my-image)))
23647 Width of left margin minus width of 1 character in the default font:
23648 '(space :width (- left-margin 1))
23650 Width of left margin minus width of 2 characters in the current font:
23651 '(space :width (- left-margin (2 . width)))
23653 Center 1 character over left-margin (in header line):
23654 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23656 Different ways to express width of left fringe plus left margin minus one pixel:
23657 '(space :width (- (+ left-fringe left-margin) (1)))
23658 '(space :width (+ left-fringe left-margin (- (1))))
23659 '(space :width (+ left-fringe left-margin (-1)))
23664 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23665 struct font
*font
, int width_p
, int *align_to
)
23669 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23670 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23673 return OK_PIXELS (0);
23675 eassert (FRAME_LIVE_P (it
->f
));
23677 if (SYMBOLP (prop
))
23679 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23681 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23683 if (unit
[0] == 'i' && unit
[1] == 'n')
23685 else if (unit
[0] == 'm' && unit
[1] == 'm')
23687 else if (unit
[0] == 'c' && unit
[1] == 'm')
23693 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23694 : FRAME_RES_Y (it
->f
));
23697 return OK_PIXELS (ppi
/ pixels
);
23702 #ifdef HAVE_WINDOW_SYSTEM
23703 if (EQ (prop
, Qheight
))
23704 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23705 if (EQ (prop
, Qwidth
))
23706 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23708 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23709 return OK_PIXELS (1);
23712 if (EQ (prop
, Qtext
))
23713 return OK_PIXELS (width_p
23714 ? window_box_width (it
->w
, TEXT_AREA
)
23715 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23717 if (align_to
&& *align_to
< 0)
23720 if (EQ (prop
, Qleft
))
23721 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23722 if (EQ (prop
, Qright
))
23723 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23724 if (EQ (prop
, Qcenter
))
23725 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23726 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23727 if (EQ (prop
, Qleft_fringe
))
23728 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23729 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23730 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23731 if (EQ (prop
, Qright_fringe
))
23732 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23733 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23734 : window_box_right_offset (it
->w
, TEXT_AREA
));
23735 if (EQ (prop
, Qleft_margin
))
23736 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23737 if (EQ (prop
, Qright_margin
))
23738 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23739 if (EQ (prop
, Qscroll_bar
))
23740 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23742 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23743 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23744 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23749 if (EQ (prop
, Qleft_fringe
))
23750 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23751 if (EQ (prop
, Qright_fringe
))
23752 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23753 if (EQ (prop
, Qleft_margin
))
23754 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23755 if (EQ (prop
, Qright_margin
))
23756 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23757 if (EQ (prop
, Qscroll_bar
))
23758 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23761 prop
= buffer_local_value_1 (prop
, it
->w
->contents
);
23762 if (EQ (prop
, Qunbound
))
23766 if (INTEGERP (prop
) || FLOATP (prop
))
23768 int base_unit
= (width_p
23769 ? FRAME_COLUMN_WIDTH (it
->f
)
23770 : FRAME_LINE_HEIGHT (it
->f
));
23771 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23776 Lisp_Object car
= XCAR (prop
);
23777 Lisp_Object cdr
= XCDR (prop
);
23781 #ifdef HAVE_WINDOW_SYSTEM
23782 if (FRAME_WINDOW_P (it
->f
)
23783 && valid_image_p (prop
))
23785 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23786 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23788 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23791 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23797 while (CONSP (cdr
))
23799 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23800 font
, width_p
, align_to
))
23803 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23808 if (EQ (car
, Qminus
))
23810 return OK_PIXELS (pixels
);
23813 car
= buffer_local_value_1 (car
, it
->w
->contents
);
23814 if (EQ (car
, Qunbound
))
23818 if (INTEGERP (car
) || FLOATP (car
))
23821 pixels
= XFLOATINT (car
);
23823 return OK_PIXELS (pixels
);
23824 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23825 font
, width_p
, align_to
))
23826 return OK_PIXELS (pixels
* fact
);
23837 /***********************************************************************
23839 ***********************************************************************/
23841 #ifdef HAVE_WINDOW_SYSTEM
23846 dump_glyph_string (struct glyph_string
*s
)
23848 fprintf (stderr
, "glyph string\n");
23849 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23850 s
->x
, s
->y
, s
->width
, s
->height
);
23851 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23852 fprintf (stderr
, " hl = %d\n", s
->hl
);
23853 fprintf (stderr
, " left overhang = %d, right = %d\n",
23854 s
->left_overhang
, s
->right_overhang
);
23855 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23856 fprintf (stderr
, " extends to end of line = %d\n",
23857 s
->extends_to_end_of_line_p
);
23858 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23859 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23862 #endif /* GLYPH_DEBUG */
23864 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23865 of XChar2b structures for S; it can't be allocated in
23866 init_glyph_string because it must be allocated via `alloca'. W
23867 is the window on which S is drawn. ROW and AREA are the glyph row
23868 and area within the row from which S is constructed. START is the
23869 index of the first glyph structure covered by S. HL is a
23870 face-override for drawing S. */
23873 #define OPTIONAL_HDC(hdc) HDC hdc,
23874 #define DECLARE_HDC(hdc) HDC hdc;
23875 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23876 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23879 #ifndef OPTIONAL_HDC
23880 #define OPTIONAL_HDC(hdc)
23881 #define DECLARE_HDC(hdc)
23882 #define ALLOCATE_HDC(hdc, f)
23883 #define RELEASE_HDC(hdc, f)
23887 init_glyph_string (struct glyph_string
*s
,
23889 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23890 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23892 memset (s
, 0, sizeof *s
);
23894 s
->f
= XFRAME (w
->frame
);
23898 s
->display
= FRAME_X_DISPLAY (s
->f
);
23899 s
->window
= FRAME_X_WINDOW (s
->f
);
23900 s
->char2b
= char2b
;
23904 s
->first_glyph
= row
->glyphs
[area
] + start
;
23905 s
->height
= row
->height
;
23906 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23907 s
->ybase
= s
->y
+ row
->ascent
;
23911 /* Append the list of glyph strings with head H and tail T to the list
23912 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23915 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23916 struct glyph_string
*h
, struct glyph_string
*t
)
23930 /* Prepend the list of glyph strings with head H and tail T to the
23931 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23935 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23936 struct glyph_string
*h
, struct glyph_string
*t
)
23950 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23951 Set *HEAD and *TAIL to the resulting list. */
23954 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23955 struct glyph_string
*s
)
23957 s
->next
= s
->prev
= NULL
;
23958 append_glyph_string_lists (head
, tail
, s
, s
);
23962 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23963 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23964 make sure that X resources for the face returned are allocated.
23965 Value is a pointer to a realized face that is ready for display if
23966 DISPLAY_P is non-zero. */
23968 static struct face
*
23969 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23970 XChar2b
*char2b
, int display_p
)
23972 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23977 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23979 if (code
== FONT_INVALID_CODE
)
23982 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23984 /* Make sure X resources of the face are allocated. */
23985 #ifdef HAVE_X_WINDOWS
23989 eassert (face
!= NULL
);
23990 PREPARE_FACE_FOR_DISPLAY (f
, face
);
23997 /* Get face and two-byte form of character glyph GLYPH on frame F.
23998 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23999 a pointer to a realized face that is ready for display. */
24001 static struct face
*
24002 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24003 XChar2b
*char2b
, int *two_byte_p
)
24008 eassert (glyph
->type
== CHAR_GLYPH
);
24009 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24011 /* Make sure X resources of the face are allocated. */
24012 eassert (face
!= NULL
);
24013 PREPARE_FACE_FOR_DISPLAY (f
, face
);
24020 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24021 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24023 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24025 if (code
== FONT_INVALID_CODE
)
24029 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24034 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24035 Return 1 if FONT has a glyph for C, otherwise return 0. */
24038 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24042 if (CHAR_BYTE8_P (c
))
24043 code
= CHAR_TO_BYTE8 (c
);
24045 code
= font
->driver
->encode_char (font
, c
);
24047 if (code
== FONT_INVALID_CODE
)
24049 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24054 /* Fill glyph string S with composition components specified by S->cmp.
24056 BASE_FACE is the base face of the composition.
24057 S->cmp_from is the index of the first component for S.
24059 OVERLAPS non-zero means S should draw the foreground only, and use
24060 its physical height for clipping. See also draw_glyphs.
24062 Value is the index of a component not in S. */
24065 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24069 /* For all glyphs of this composition, starting at the offset
24070 S->cmp_from, until we reach the end of the definition or encounter a
24071 glyph that requires the different face, add it to S. */
24076 s
->for_overlaps
= overlaps
;
24079 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24081 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24083 /* TAB in a composition means display glyphs with padding space
24084 on the left or right. */
24087 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24090 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24097 s
->font
= s
->face
->font
;
24099 else if (s
->face
!= face
)
24107 if (s
->face
== NULL
)
24109 s
->face
= base_face
->ascii_face
;
24110 s
->font
= s
->face
->font
;
24113 /* All glyph strings for the same composition has the same width,
24114 i.e. the width set for the first component of the composition. */
24115 s
->width
= s
->first_glyph
->pixel_width
;
24117 /* If the specified font could not be loaded, use the frame's
24118 default font, but record the fact that we couldn't load it in
24119 the glyph string so that we can draw rectangles for the
24120 characters of the glyph string. */
24121 if (s
->font
== NULL
)
24123 s
->font_not_found_p
= 1;
24124 s
->font
= FRAME_FONT (s
->f
);
24127 /* Adjust base line for subscript/superscript text. */
24128 s
->ybase
+= s
->first_glyph
->voffset
;
24130 /* This glyph string must always be drawn with 16-bit functions. */
24137 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24138 int start
, int end
, int overlaps
)
24140 struct glyph
*glyph
, *last
;
24141 Lisp_Object lgstring
;
24144 s
->for_overlaps
= overlaps
;
24145 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24146 last
= s
->row
->glyphs
[s
->area
] + end
;
24147 s
->cmp_id
= glyph
->u
.cmp
.id
;
24148 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24149 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24150 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24151 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24152 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24154 while (glyph
< last
24155 && glyph
->u
.cmp
.automatic
24156 && glyph
->u
.cmp
.id
== s
->cmp_id
24157 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24158 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24160 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24162 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24163 unsigned code
= LGLYPH_CODE (lglyph
);
24165 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24167 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24168 return glyph
- s
->row
->glyphs
[s
->area
];
24172 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24173 See the comment of fill_glyph_string for arguments.
24174 Value is the index of the first glyph not in S. */
24178 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24179 int start
, int end
, int overlaps
)
24181 struct glyph
*glyph
, *last
;
24184 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24185 s
->for_overlaps
= overlaps
;
24186 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24187 last
= s
->row
->glyphs
[s
->area
] + end
;
24188 voffset
= glyph
->voffset
;
24189 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24190 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24192 s
->width
= glyph
->pixel_width
;
24194 while (glyph
< last
24195 && glyph
->type
== GLYPHLESS_GLYPH
24196 && glyph
->voffset
== voffset
24197 && glyph
->face_id
== face_id
)
24200 s
->width
+= glyph
->pixel_width
;
24203 s
->ybase
+= voffset
;
24204 return glyph
- s
->row
->glyphs
[s
->area
];
24208 /* Fill glyph string S from a sequence of character glyphs.
24210 FACE_ID is the face id of the string. START is the index of the
24211 first glyph to consider, END is the index of the last + 1.
24212 OVERLAPS non-zero means S should draw the foreground only, and use
24213 its physical height for clipping. See also draw_glyphs.
24215 Value is the index of the first glyph not in S. */
24218 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24219 int start
, int end
, int overlaps
)
24221 struct glyph
*glyph
, *last
;
24223 int glyph_not_available_p
;
24225 eassert (s
->f
== XFRAME (s
->w
->frame
));
24226 eassert (s
->nchars
== 0);
24227 eassert (start
>= 0 && end
> start
);
24229 s
->for_overlaps
= overlaps
;
24230 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24231 last
= s
->row
->glyphs
[s
->area
] + end
;
24232 voffset
= glyph
->voffset
;
24233 s
->padding_p
= glyph
->padding_p
;
24234 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24236 while (glyph
< last
24237 && glyph
->type
== CHAR_GLYPH
24238 && glyph
->voffset
== voffset
24239 /* Same face id implies same font, nowadays. */
24240 && glyph
->face_id
== face_id
24241 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24245 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24246 s
->char2b
+ s
->nchars
,
24248 s
->two_byte_p
= two_byte_p
;
24250 eassert (s
->nchars
<= end
- start
);
24251 s
->width
+= glyph
->pixel_width
;
24252 if (glyph
++->padding_p
!= s
->padding_p
)
24256 s
->font
= s
->face
->font
;
24258 /* If the specified font could not be loaded, use the frame's font,
24259 but record the fact that we couldn't load it in
24260 S->font_not_found_p so that we can draw rectangles for the
24261 characters of the glyph string. */
24262 if (s
->font
== NULL
|| glyph_not_available_p
)
24264 s
->font_not_found_p
= 1;
24265 s
->font
= FRAME_FONT (s
->f
);
24268 /* Adjust base line for subscript/superscript text. */
24269 s
->ybase
+= voffset
;
24271 eassert (s
->face
&& s
->face
->gc
);
24272 return glyph
- s
->row
->glyphs
[s
->area
];
24276 /* Fill glyph string S from image glyph S->first_glyph. */
24279 fill_image_glyph_string (struct glyph_string
*s
)
24281 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24282 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24284 s
->slice
= s
->first_glyph
->slice
.img
;
24285 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24286 s
->font
= s
->face
->font
;
24287 s
->width
= s
->first_glyph
->pixel_width
;
24289 /* Adjust base line for subscript/superscript text. */
24290 s
->ybase
+= s
->first_glyph
->voffset
;
24294 /* Fill glyph string S from a sequence of stretch glyphs.
24296 START is the index of the first glyph to consider,
24297 END is the index of the last + 1.
24299 Value is the index of the first glyph not in S. */
24302 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24304 struct glyph
*glyph
, *last
;
24305 int voffset
, face_id
;
24307 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24309 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24310 last
= s
->row
->glyphs
[s
->area
] + end
;
24311 face_id
= glyph
->face_id
;
24312 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24313 s
->font
= s
->face
->font
;
24314 s
->width
= glyph
->pixel_width
;
24316 voffset
= glyph
->voffset
;
24320 && glyph
->type
== STRETCH_GLYPH
24321 && glyph
->voffset
== voffset
24322 && glyph
->face_id
== face_id
);
24324 s
->width
+= glyph
->pixel_width
;
24326 /* Adjust base line for subscript/superscript text. */
24327 s
->ybase
+= voffset
;
24329 /* The case that face->gc == 0 is handled when drawing the glyph
24330 string by calling PREPARE_FACE_FOR_DISPLAY. */
24332 return glyph
- s
->row
->glyphs
[s
->area
];
24335 static struct font_metrics
*
24336 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24338 static struct font_metrics metrics
;
24343 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24344 if (code
== FONT_INVALID_CODE
)
24346 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24351 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24352 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24353 assumed to be zero. */
24356 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24358 *left
= *right
= 0;
24360 if (glyph
->type
== CHAR_GLYPH
)
24364 struct font_metrics
*pcm
;
24366 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24367 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24369 if (pcm
->rbearing
> pcm
->width
)
24370 *right
= pcm
->rbearing
- pcm
->width
;
24371 if (pcm
->lbearing
< 0)
24372 *left
= -pcm
->lbearing
;
24375 else if (glyph
->type
== COMPOSITE_GLYPH
)
24377 if (! glyph
->u
.cmp
.automatic
)
24379 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24381 if (cmp
->rbearing
> cmp
->pixel_width
)
24382 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24383 if (cmp
->lbearing
< 0)
24384 *left
= - cmp
->lbearing
;
24388 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24389 struct font_metrics metrics
;
24391 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24392 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24393 if (metrics
.rbearing
> metrics
.width
)
24394 *right
= metrics
.rbearing
- metrics
.width
;
24395 if (metrics
.lbearing
< 0)
24396 *left
= - metrics
.lbearing
;
24402 /* Return the index of the first glyph preceding glyph string S that
24403 is overwritten by S because of S's left overhang. Value is -1
24404 if no glyphs are overwritten. */
24407 left_overwritten (struct glyph_string
*s
)
24411 if (s
->left_overhang
)
24414 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24415 int first
= s
->first_glyph
- glyphs
;
24417 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24418 x
-= glyphs
[i
].pixel_width
;
24429 /* Return the index of the first glyph preceding glyph string S that
24430 is overwriting S because of its right overhang. Value is -1 if no
24431 glyph in front of S overwrites S. */
24434 left_overwriting (struct glyph_string
*s
)
24437 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24438 int first
= s
->first_glyph
- glyphs
;
24442 for (i
= first
- 1; i
>= 0; --i
)
24445 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24448 x
-= glyphs
[i
].pixel_width
;
24455 /* Return the index of the last glyph following glyph string S that is
24456 overwritten by S because of S's right overhang. Value is -1 if
24457 no such glyph is found. */
24460 right_overwritten (struct glyph_string
*s
)
24464 if (s
->right_overhang
)
24467 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24468 int first
= (s
->first_glyph
- glyphs
24469 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24470 int end
= s
->row
->used
[s
->area
];
24472 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24473 x
+= glyphs
[i
].pixel_width
;
24482 /* Return the index of the last glyph following glyph string S that
24483 overwrites S because of its left overhang. Value is negative
24484 if no such glyph is found. */
24487 right_overwriting (struct glyph_string
*s
)
24490 int end
= s
->row
->used
[s
->area
];
24491 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24492 int first
= (s
->first_glyph
- glyphs
24493 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24497 for (i
= first
; i
< end
; ++i
)
24500 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24503 x
+= glyphs
[i
].pixel_width
;
24510 /* Set background width of glyph string S. START is the index of the
24511 first glyph following S. LAST_X is the right-most x-position + 1
24512 in the drawing area. */
24515 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24517 /* If the face of this glyph string has to be drawn to the end of
24518 the drawing area, set S->extends_to_end_of_line_p. */
24520 if (start
== s
->row
->used
[s
->area
]
24521 && ((s
->row
->fill_line_p
24522 && (s
->hl
== DRAW_NORMAL_TEXT
24523 || s
->hl
== DRAW_IMAGE_RAISED
24524 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24525 || s
->hl
== DRAW_MOUSE_FACE
))
24526 s
->extends_to_end_of_line_p
= 1;
24528 /* If S extends its face to the end of the line, set its
24529 background_width to the distance to the right edge of the drawing
24531 if (s
->extends_to_end_of_line_p
)
24532 s
->background_width
= last_x
- s
->x
+ 1;
24534 s
->background_width
= s
->width
;
24538 /* Compute overhangs and x-positions for glyph string S and its
24539 predecessors, or successors. X is the starting x-position for S.
24540 BACKWARD_P non-zero means process predecessors. */
24543 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24549 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24550 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24560 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24561 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24571 /* The following macros are only called from draw_glyphs below.
24572 They reference the following parameters of that function directly:
24573 `w', `row', `area', and `overlap_p'
24574 as well as the following local variables:
24575 `s', `f', and `hdc' (in W32) */
24578 /* On W32, silently add local `hdc' variable to argument list of
24579 init_glyph_string. */
24580 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24581 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24583 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24584 init_glyph_string (s, char2b, w, row, area, start, hl)
24587 /* Add a glyph string for a stretch glyph to the list of strings
24588 between HEAD and TAIL. START is the index of the stretch glyph in
24589 row area AREA of glyph row ROW. END is the index of the last glyph
24590 in that glyph row area. X is the current output position assigned
24591 to the new glyph string constructed. HL overrides that face of the
24592 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24593 is the right-most x-position of the drawing area. */
24595 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24596 and below -- keep them on one line. */
24597 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24600 s = alloca (sizeof *s); \
24601 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24602 START = fill_stretch_glyph_string (s, START, END); \
24603 append_glyph_string (&HEAD, &TAIL, s); \
24609 /* Add a glyph string for an image glyph to the list of strings
24610 between HEAD and TAIL. START is the index of the image glyph in
24611 row area AREA of glyph row ROW. END is the index of the last glyph
24612 in that glyph row area. X is the current output position assigned
24613 to the new glyph string constructed. HL overrides that face of the
24614 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24615 is the right-most x-position of the drawing area. */
24617 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24620 s = alloca (sizeof *s); \
24621 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24622 fill_image_glyph_string (s); \
24623 append_glyph_string (&HEAD, &TAIL, s); \
24630 /* Add a glyph string for a sequence of character glyphs to the list
24631 of strings between HEAD and TAIL. START is the index of the first
24632 glyph in row area AREA of glyph row ROW that is part of the new
24633 glyph string. END is the index of the last glyph in that glyph row
24634 area. X is the current output position assigned to the new glyph
24635 string constructed. HL overrides that face of the glyph; e.g. it
24636 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24637 right-most x-position of the drawing area. */
24639 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24645 face_id = (row)->glyphs[area][START].face_id; \
24647 s = alloca (sizeof *s); \
24648 char2b = alloca ((END - START) * sizeof *char2b); \
24649 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24650 append_glyph_string (&HEAD, &TAIL, s); \
24652 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24657 /* Add a glyph string for a composite sequence to the list of strings
24658 between HEAD and TAIL. START is the index of the first glyph in
24659 row area AREA of glyph row ROW that is part of the new glyph
24660 string. END is the index of the last glyph in that glyph row area.
24661 X is the current output position assigned to the new glyph string
24662 constructed. HL overrides that face of the glyph; e.g. it is
24663 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24664 x-position of the drawing area. */
24666 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24668 int face_id = (row)->glyphs[area][START].face_id; \
24669 struct face *base_face = FACE_FROM_ID (f, face_id); \
24670 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24671 struct composition *cmp = composition_table[cmp_id]; \
24673 struct glyph_string *first_s = NULL; \
24676 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24678 /* Make glyph_strings for each glyph sequence that is drawable by \
24679 the same face, and append them to HEAD/TAIL. */ \
24680 for (n = 0; n < cmp->glyph_len;) \
24682 s = alloca (sizeof *s); \
24683 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24684 append_glyph_string (&(HEAD), &(TAIL), s); \
24690 n = fill_composite_glyph_string (s, base_face, overlaps); \
24698 /* Add a glyph string for a glyph-string sequence to the list of strings
24699 between HEAD and TAIL. */
24701 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24705 Lisp_Object gstring; \
24707 face_id = (row)->glyphs[area][START].face_id; \
24708 gstring = (composition_gstring_from_id \
24709 ((row)->glyphs[area][START].u.cmp.id)); \
24710 s = alloca (sizeof *s); \
24711 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24712 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24713 append_glyph_string (&(HEAD), &(TAIL), s); \
24715 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24719 /* Add a glyph string for a sequence of glyphless character's glyphs
24720 to the list of strings between HEAD and TAIL. The meanings of
24721 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24723 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24728 face_id = (row)->glyphs[area][START].face_id; \
24730 s = alloca (sizeof *s); \
24731 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24732 append_glyph_string (&HEAD, &TAIL, s); \
24734 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24740 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24741 of AREA of glyph row ROW on window W between indices START and END.
24742 HL overrides the face for drawing glyph strings, e.g. it is
24743 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24744 x-positions of the drawing area.
24746 This is an ugly monster macro construct because we must use alloca
24747 to allocate glyph strings (because draw_glyphs can be called
24748 asynchronously). */
24750 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24753 HEAD = TAIL = NULL; \
24754 while (START < END) \
24756 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24757 switch (first_glyph->type) \
24760 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24764 case COMPOSITE_GLYPH: \
24765 if (first_glyph->u.cmp.automatic) \
24766 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24769 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24773 case STRETCH_GLYPH: \
24774 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24778 case IMAGE_GLYPH: \
24779 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24783 case GLYPHLESS_GLYPH: \
24784 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24794 set_glyph_string_background_width (s, START, LAST_X); \
24801 /* Draw glyphs between START and END in AREA of ROW on window W,
24802 starting at x-position X. X is relative to AREA in W. HL is a
24803 face-override with the following meaning:
24805 DRAW_NORMAL_TEXT draw normally
24806 DRAW_CURSOR draw in cursor face
24807 DRAW_MOUSE_FACE draw in mouse face.
24808 DRAW_INVERSE_VIDEO draw in mode line face
24809 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24810 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24812 If OVERLAPS is non-zero, draw only the foreground of characters and
24813 clip to the physical height of ROW. Non-zero value also defines
24814 the overlapping part to be drawn:
24816 OVERLAPS_PRED overlap with preceding rows
24817 OVERLAPS_SUCC overlap with succeeding rows
24818 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24819 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24821 Value is the x-position reached, relative to AREA of W. */
24824 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24825 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24826 enum draw_glyphs_face hl
, int overlaps
)
24828 struct glyph_string
*head
, *tail
;
24829 struct glyph_string
*s
;
24830 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24831 int i
, j
, x_reached
, last_x
, area_left
= 0;
24832 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24835 ALLOCATE_HDC (hdc
, f
);
24837 /* Let's rather be paranoid than getting a SEGV. */
24838 end
= min (end
, row
->used
[area
]);
24839 start
= clip_to_bounds (0, start
, end
);
24841 /* Translate X to frame coordinates. Set last_x to the right
24842 end of the drawing area. */
24843 if (row
->full_width_p
)
24845 /* X is relative to the left edge of W, without scroll bars
24847 area_left
= WINDOW_LEFT_EDGE_X (w
);
24848 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24849 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24853 area_left
= window_box_left (w
, area
);
24854 last_x
= area_left
+ window_box_width (w
, area
);
24858 /* Build a doubly-linked list of glyph_string structures between
24859 head and tail from what we have to draw. Note that the macro
24860 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24861 the reason we use a separate variable `i'. */
24863 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24865 x_reached
= tail
->x
+ tail
->background_width
;
24869 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24870 the row, redraw some glyphs in front or following the glyph
24871 strings built above. */
24872 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24874 struct glyph_string
*h
, *t
;
24875 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24876 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24877 int check_mouse_face
= 0;
24880 /* If mouse highlighting is on, we may need to draw adjacent
24881 glyphs using mouse-face highlighting. */
24882 if (area
== TEXT_AREA
&& row
->mouse_face_p
24883 && hlinfo
->mouse_face_beg_row
>= 0
24884 && hlinfo
->mouse_face_end_row
>= 0)
24886 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24888 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24889 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24891 check_mouse_face
= 1;
24892 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24893 ? hlinfo
->mouse_face_beg_col
: 0;
24894 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24895 ? hlinfo
->mouse_face_end_col
24896 : row
->used
[TEXT_AREA
];
24900 /* Compute overhangs for all glyph strings. */
24901 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24902 for (s
= head
; s
; s
= s
->next
)
24903 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24905 /* Prepend glyph strings for glyphs in front of the first glyph
24906 string that are overwritten because of the first glyph
24907 string's left overhang. The background of all strings
24908 prepended must be drawn because the first glyph string
24910 i
= left_overwritten (head
);
24913 enum draw_glyphs_face overlap_hl
;
24915 /* If this row contains mouse highlighting, attempt to draw
24916 the overlapped glyphs with the correct highlight. This
24917 code fails if the overlap encompasses more than one glyph
24918 and mouse-highlight spans only some of these glyphs.
24919 However, making it work perfectly involves a lot more
24920 code, and I don't know if the pathological case occurs in
24921 practice, so we'll stick to this for now. --- cyd */
24922 if (check_mouse_face
24923 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24924 overlap_hl
= DRAW_MOUSE_FACE
;
24926 overlap_hl
= DRAW_NORMAL_TEXT
;
24929 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24930 overlap_hl
, dummy_x
, last_x
);
24932 compute_overhangs_and_x (t
, head
->x
, 1);
24933 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24937 /* Prepend glyph strings for glyphs in front of the first glyph
24938 string that overwrite that glyph string because of their
24939 right overhang. For these strings, only the foreground must
24940 be drawn, because it draws over the glyph string at `head'.
24941 The background must not be drawn because this would overwrite
24942 right overhangs of preceding glyphs for which no glyph
24944 i
= left_overwriting (head
);
24947 enum draw_glyphs_face overlap_hl
;
24949 if (check_mouse_face
24950 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24951 overlap_hl
= DRAW_MOUSE_FACE
;
24953 overlap_hl
= DRAW_NORMAL_TEXT
;
24956 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24957 overlap_hl
, dummy_x
, last_x
);
24958 for (s
= h
; s
; s
= s
->next
)
24959 s
->background_filled_p
= 1;
24960 compute_overhangs_and_x (t
, head
->x
, 1);
24961 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24964 /* Append glyphs strings for glyphs following the last glyph
24965 string tail that are overwritten by tail. The background of
24966 these strings has to be drawn because tail's foreground draws
24968 i
= right_overwritten (tail
);
24971 enum draw_glyphs_face overlap_hl
;
24973 if (check_mouse_face
24974 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24975 overlap_hl
= DRAW_MOUSE_FACE
;
24977 overlap_hl
= DRAW_NORMAL_TEXT
;
24979 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24980 overlap_hl
, x
, last_x
);
24981 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24982 we don't have `end = i;' here. */
24983 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24984 append_glyph_string_lists (&head
, &tail
, h
, t
);
24988 /* Append glyph strings for glyphs following the last glyph
24989 string tail that overwrite tail. The foreground of such
24990 glyphs has to be drawn because it writes into the background
24991 of tail. The background must not be drawn because it could
24992 paint over the foreground of following glyphs. */
24993 i
= right_overwriting (tail
);
24996 enum draw_glyphs_face overlap_hl
;
24997 if (check_mouse_face
24998 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24999 overlap_hl
= DRAW_MOUSE_FACE
;
25001 overlap_hl
= DRAW_NORMAL_TEXT
;
25004 i
++; /* We must include the Ith glyph. */
25005 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25006 overlap_hl
, x
, last_x
);
25007 for (s
= h
; s
; s
= s
->next
)
25008 s
->background_filled_p
= 1;
25009 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25010 append_glyph_string_lists (&head
, &tail
, h
, t
);
25012 if (clip_head
|| clip_tail
)
25013 for (s
= head
; s
; s
= s
->next
)
25015 s
->clip_head
= clip_head
;
25016 s
->clip_tail
= clip_tail
;
25020 /* Draw all strings. */
25021 for (s
= head
; s
; s
= s
->next
)
25022 FRAME_RIF (f
)->draw_glyph_string (s
);
25025 /* When focus a sole frame and move horizontally, this sets on_p to 0
25026 causing a failure to erase prev cursor position. */
25027 if (area
== TEXT_AREA
25028 && !row
->full_width_p
25029 /* When drawing overlapping rows, only the glyph strings'
25030 foreground is drawn, which doesn't erase a cursor
25034 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25035 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25036 : (tail
? tail
->x
+ tail
->background_width
: x
));
25040 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25041 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25045 /* Value is the x-position up to which drawn, relative to AREA of W.
25046 This doesn't include parts drawn because of overhangs. */
25047 if (row
->full_width_p
)
25048 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25050 x_reached
-= area_left
;
25052 RELEASE_HDC (hdc
, f
);
25057 /* Expand row matrix if too narrow. Don't expand if area
25060 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25062 if (!it->f->fonts_changed \
25063 && (it->glyph_row->glyphs[area] \
25064 < it->glyph_row->glyphs[area + 1])) \
25066 it->w->ncols_scale_factor++; \
25067 it->f->fonts_changed = 1; \
25071 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25072 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25075 append_glyph (struct it
*it
)
25077 struct glyph
*glyph
;
25078 enum glyph_row_area area
= it
->area
;
25080 eassert (it
->glyph_row
);
25081 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25083 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25084 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25086 /* If the glyph row is reversed, we need to prepend the glyph
25087 rather than append it. */
25088 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25092 /* Make room for the additional glyph. */
25093 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25095 glyph
= it
->glyph_row
->glyphs
[area
];
25097 glyph
->charpos
= CHARPOS (it
->position
);
25098 glyph
->object
= it
->object
;
25099 if (it
->pixel_width
> 0)
25101 glyph
->pixel_width
= it
->pixel_width
;
25102 glyph
->padding_p
= 0;
25106 /* Assure at least 1-pixel width. Otherwise, cursor can't
25107 be displayed correctly. */
25108 glyph
->pixel_width
= 1;
25109 glyph
->padding_p
= 1;
25111 glyph
->ascent
= it
->ascent
;
25112 glyph
->descent
= it
->descent
;
25113 glyph
->voffset
= it
->voffset
;
25114 glyph
->type
= CHAR_GLYPH
;
25115 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25116 glyph
->multibyte_p
= it
->multibyte_p
;
25117 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25119 /* In R2L rows, the left and the right box edges need to be
25120 drawn in reverse direction. */
25121 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25122 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25126 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25127 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25129 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25130 || it
->phys_descent
> it
->descent
);
25131 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25132 glyph
->face_id
= it
->face_id
;
25133 glyph
->u
.ch
= it
->char_to_display
;
25134 glyph
->slice
.img
= null_glyph_slice
;
25135 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25138 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25139 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25141 glyph
->bidi_type
= it
->bidi_it
.type
;
25145 glyph
->resolved_level
= 0;
25146 glyph
->bidi_type
= UNKNOWN_BT
;
25148 ++it
->glyph_row
->used
[area
];
25151 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25154 /* Store one glyph for the composition IT->cmp_it.id in
25155 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25159 append_composite_glyph (struct it
*it
)
25161 struct glyph
*glyph
;
25162 enum glyph_row_area area
= it
->area
;
25164 eassert (it
->glyph_row
);
25166 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25167 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25169 /* If the glyph row is reversed, we need to prepend the glyph
25170 rather than append it. */
25171 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25175 /* Make room for the new glyph. */
25176 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25178 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25180 glyph
->charpos
= it
->cmp_it
.charpos
;
25181 glyph
->object
= it
->object
;
25182 glyph
->pixel_width
= it
->pixel_width
;
25183 glyph
->ascent
= it
->ascent
;
25184 glyph
->descent
= it
->descent
;
25185 glyph
->voffset
= it
->voffset
;
25186 glyph
->type
= COMPOSITE_GLYPH
;
25187 if (it
->cmp_it
.ch
< 0)
25189 glyph
->u
.cmp
.automatic
= 0;
25190 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25191 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25195 glyph
->u
.cmp
.automatic
= 1;
25196 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25197 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25198 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25200 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25201 glyph
->multibyte_p
= it
->multibyte_p
;
25202 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25204 /* In R2L rows, the left and the right box edges need to be
25205 drawn in reverse direction. */
25206 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25207 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25211 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25212 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25214 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25215 || it
->phys_descent
> it
->descent
);
25216 glyph
->padding_p
= 0;
25217 glyph
->glyph_not_available_p
= 0;
25218 glyph
->face_id
= it
->face_id
;
25219 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25222 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25223 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25225 glyph
->bidi_type
= it
->bidi_it
.type
;
25227 ++it
->glyph_row
->used
[area
];
25230 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25234 /* Change IT->ascent and IT->height according to the setting of
25238 take_vertical_position_into_account (struct it
*it
)
25242 if (it
->voffset
< 0)
25243 /* Increase the ascent so that we can display the text higher
25245 it
->ascent
-= it
->voffset
;
25247 /* Increase the descent so that we can display the text lower
25249 it
->descent
+= it
->voffset
;
25254 /* Produce glyphs/get display metrics for the image IT is loaded with.
25255 See the description of struct display_iterator in dispextern.h for
25256 an overview of struct display_iterator. */
25259 produce_image_glyph (struct it
*it
)
25263 int glyph_ascent
, crop
;
25264 struct glyph_slice slice
;
25266 eassert (it
->what
== IT_IMAGE
);
25268 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25270 /* Make sure X resources of the face is loaded. */
25271 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25273 if (it
->image_id
< 0)
25275 /* Fringe bitmap. */
25276 it
->ascent
= it
->phys_ascent
= 0;
25277 it
->descent
= it
->phys_descent
= 0;
25278 it
->pixel_width
= 0;
25283 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25285 /* Make sure X resources of the image is loaded. */
25286 prepare_image_for_display (it
->f
, img
);
25288 slice
.x
= slice
.y
= 0;
25289 slice
.width
= img
->width
;
25290 slice
.height
= img
->height
;
25292 if (INTEGERP (it
->slice
.x
))
25293 slice
.x
= XINT (it
->slice
.x
);
25294 else if (FLOATP (it
->slice
.x
))
25295 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25297 if (INTEGERP (it
->slice
.y
))
25298 slice
.y
= XINT (it
->slice
.y
);
25299 else if (FLOATP (it
->slice
.y
))
25300 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25302 if (INTEGERP (it
->slice
.width
))
25303 slice
.width
= XINT (it
->slice
.width
);
25304 else if (FLOATP (it
->slice
.width
))
25305 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25307 if (INTEGERP (it
->slice
.height
))
25308 slice
.height
= XINT (it
->slice
.height
);
25309 else if (FLOATP (it
->slice
.height
))
25310 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25312 if (slice
.x
>= img
->width
)
25313 slice
.x
= img
->width
;
25314 if (slice
.y
>= img
->height
)
25315 slice
.y
= img
->height
;
25316 if (slice
.x
+ slice
.width
>= img
->width
)
25317 slice
.width
= img
->width
- slice
.x
;
25318 if (slice
.y
+ slice
.height
> img
->height
)
25319 slice
.height
= img
->height
- slice
.y
;
25321 if (slice
.width
== 0 || slice
.height
== 0)
25324 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25326 it
->descent
= slice
.height
- glyph_ascent
;
25328 it
->descent
+= img
->vmargin
;
25329 if (slice
.y
+ slice
.height
== img
->height
)
25330 it
->descent
+= img
->vmargin
;
25331 it
->phys_descent
= it
->descent
;
25333 it
->pixel_width
= slice
.width
;
25335 it
->pixel_width
+= img
->hmargin
;
25336 if (slice
.x
+ slice
.width
== img
->width
)
25337 it
->pixel_width
+= img
->hmargin
;
25339 /* It's quite possible for images to have an ascent greater than
25340 their height, so don't get confused in that case. */
25341 if (it
->descent
< 0)
25346 if (face
->box
!= FACE_NO_BOX
)
25348 if (face
->box_line_width
> 0)
25351 it
->ascent
+= face
->box_line_width
;
25352 if (slice
.y
+ slice
.height
== img
->height
)
25353 it
->descent
+= face
->box_line_width
;
25356 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25357 it
->pixel_width
+= eabs (face
->box_line_width
);
25358 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25359 it
->pixel_width
+= eabs (face
->box_line_width
);
25362 take_vertical_position_into_account (it
);
25364 /* Automatically crop wide image glyphs at right edge so we can
25365 draw the cursor on same display row. */
25366 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25367 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25369 it
->pixel_width
-= crop
;
25370 slice
.width
-= crop
;
25375 struct glyph
*glyph
;
25376 enum glyph_row_area area
= it
->area
;
25378 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25379 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25381 glyph
->charpos
= CHARPOS (it
->position
);
25382 glyph
->object
= it
->object
;
25383 glyph
->pixel_width
= it
->pixel_width
;
25384 glyph
->ascent
= glyph_ascent
;
25385 glyph
->descent
= it
->descent
;
25386 glyph
->voffset
= it
->voffset
;
25387 glyph
->type
= IMAGE_GLYPH
;
25388 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25389 glyph
->multibyte_p
= it
->multibyte_p
;
25390 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25392 /* In R2L rows, the left and the right box edges need to be
25393 drawn in reverse direction. */
25394 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25395 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25399 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25400 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25402 glyph
->overlaps_vertically_p
= 0;
25403 glyph
->padding_p
= 0;
25404 glyph
->glyph_not_available_p
= 0;
25405 glyph
->face_id
= it
->face_id
;
25406 glyph
->u
.img_id
= img
->id
;
25407 glyph
->slice
.img
= slice
;
25408 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25411 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25412 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25414 glyph
->bidi_type
= it
->bidi_it
.type
;
25416 ++it
->glyph_row
->used
[area
];
25419 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25424 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25425 of the glyph, WIDTH and HEIGHT are the width and height of the
25426 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25429 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25430 int width
, int height
, int ascent
)
25432 struct glyph
*glyph
;
25433 enum glyph_row_area area
= it
->area
;
25435 eassert (ascent
>= 0 && ascent
<= height
);
25437 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25438 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25440 /* If the glyph row is reversed, we need to prepend the glyph
25441 rather than append it. */
25442 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25446 /* Make room for the additional glyph. */
25447 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25449 glyph
= it
->glyph_row
->glyphs
[area
];
25451 /* Decrease the width of the first glyph of the row that
25452 begins before first_visible_x (e.g., due to hscroll).
25453 This is so the overall width of the row becomes smaller
25454 by the scroll amount, and the stretch glyph appended by
25455 extend_face_to_end_of_line will be wider, to shift the
25456 row glyphs to the right. (In L2R rows, the corresponding
25457 left-shift effect is accomplished by setting row->x to a
25458 negative value, which won't work with R2L rows.)
25460 This must leave us with a positive value of WIDTH, since
25461 otherwise the call to move_it_in_display_line_to at the
25462 beginning of display_line would have got past the entire
25463 first glyph, and then it->current_x would have been
25464 greater or equal to it->first_visible_x. */
25465 if (it
->current_x
< it
->first_visible_x
)
25466 width
-= it
->first_visible_x
- it
->current_x
;
25467 eassert (width
> 0);
25469 glyph
->charpos
= CHARPOS (it
->position
);
25470 glyph
->object
= object
;
25471 glyph
->pixel_width
= width
;
25472 glyph
->ascent
= ascent
;
25473 glyph
->descent
= height
- ascent
;
25474 glyph
->voffset
= it
->voffset
;
25475 glyph
->type
= STRETCH_GLYPH
;
25476 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25477 glyph
->multibyte_p
= it
->multibyte_p
;
25478 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25480 /* In R2L rows, the left and the right box edges need to be
25481 drawn in reverse direction. */
25482 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25483 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25487 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25488 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25490 glyph
->overlaps_vertically_p
= 0;
25491 glyph
->padding_p
= 0;
25492 glyph
->glyph_not_available_p
= 0;
25493 glyph
->face_id
= it
->face_id
;
25494 glyph
->u
.stretch
.ascent
= ascent
;
25495 glyph
->u
.stretch
.height
= height
;
25496 glyph
->slice
.img
= null_glyph_slice
;
25497 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25500 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25501 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25503 glyph
->bidi_type
= it
->bidi_it
.type
;
25507 glyph
->resolved_level
= 0;
25508 glyph
->bidi_type
= UNKNOWN_BT
;
25510 ++it
->glyph_row
->used
[area
];
25513 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25516 #endif /* HAVE_WINDOW_SYSTEM */
25518 /* Produce a stretch glyph for iterator IT. IT->object is the value
25519 of the glyph property displayed. The value must be a list
25520 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25523 1. `:width WIDTH' specifies that the space should be WIDTH *
25524 canonical char width wide. WIDTH may be an integer or floating
25527 2. `:relative-width FACTOR' specifies that the width of the stretch
25528 should be computed from the width of the first character having the
25529 `glyph' property, and should be FACTOR times that width.
25531 3. `:align-to HPOS' specifies that the space should be wide enough
25532 to reach HPOS, a value in canonical character units.
25534 Exactly one of the above pairs must be present.
25536 4. `:height HEIGHT' specifies that the height of the stretch produced
25537 should be HEIGHT, measured in canonical character units.
25539 5. `:relative-height FACTOR' specifies that the height of the
25540 stretch should be FACTOR times the height of the characters having
25541 the glyph property.
25543 Either none or exactly one of 4 or 5 must be present.
25545 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25546 of the stretch should be used for the ascent of the stretch.
25547 ASCENT must be in the range 0 <= ASCENT <= 100. */
25550 produce_stretch_glyph (struct it
*it
)
25552 /* (space :width WIDTH :height HEIGHT ...) */
25553 Lisp_Object prop
, plist
;
25554 int width
= 0, height
= 0, align_to
= -1;
25555 int zero_width_ok_p
= 0;
25557 struct font
*font
= NULL
;
25559 #ifdef HAVE_WINDOW_SYSTEM
25561 int zero_height_ok_p
= 0;
25563 if (FRAME_WINDOW_P (it
->f
))
25565 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25566 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25567 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
25571 /* List should start with `space'. */
25572 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25573 plist
= XCDR (it
->object
);
25575 /* Compute the width of the stretch. */
25576 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25577 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25579 /* Absolute width `:width WIDTH' specified and valid. */
25580 zero_width_ok_p
= 1;
25583 #ifdef HAVE_WINDOW_SYSTEM
25584 else if (FRAME_WINDOW_P (it
->f
)
25585 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25587 /* Relative width `:relative-width FACTOR' specified and valid.
25588 Compute the width of the characters having the `glyph'
25591 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25594 if (it
->multibyte_p
)
25595 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25598 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25599 if (! ASCII_CHAR_P (it2
.c
))
25600 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25603 it2
.glyph_row
= NULL
;
25604 it2
.what
= IT_CHARACTER
;
25605 x_produce_glyphs (&it2
);
25606 width
= NUMVAL (prop
) * it2
.pixel_width
;
25608 #endif /* HAVE_WINDOW_SYSTEM */
25609 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25610 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25612 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25613 align_to
= (align_to
< 0
25615 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25616 else if (align_to
< 0)
25617 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25618 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25619 zero_width_ok_p
= 1;
25622 /* Nothing specified -> width defaults to canonical char width. */
25623 width
= FRAME_COLUMN_WIDTH (it
->f
);
25625 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25628 #ifdef HAVE_WINDOW_SYSTEM
25629 /* Compute height. */
25630 if (FRAME_WINDOW_P (it
->f
))
25632 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25633 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25636 zero_height_ok_p
= 1;
25638 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25640 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25642 height
= FONT_HEIGHT (font
);
25644 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25647 /* Compute percentage of height used for ascent. If
25648 `:ascent ASCENT' is present and valid, use that. Otherwise,
25649 derive the ascent from the font in use. */
25650 if (prop
= Fplist_get (plist
, QCascent
),
25651 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25652 ascent
= height
* NUMVAL (prop
) / 100.0;
25653 else if (!NILP (prop
)
25654 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25655 ascent
= min (max (0, (int)tem
), height
);
25657 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25660 #endif /* HAVE_WINDOW_SYSTEM */
25663 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25664 && it
->current_x
+ width
> it
->last_visible_x
)
25666 width
= it
->last_visible_x
- it
->current_x
;
25667 #ifdef HAVE_WINDOW_SYSTEM
25668 /* Subtract one more pixel from the stretch width, but only on
25669 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25670 width
-= FRAME_WINDOW_P (it
->f
);
25674 if (width
> 0 && height
> 0 && it
->glyph_row
)
25676 Lisp_Object o_object
= it
->object
;
25677 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25680 if (!STRINGP (object
))
25681 object
= it
->w
->contents
;
25682 #ifdef HAVE_WINDOW_SYSTEM
25683 if (FRAME_WINDOW_P (it
->f
))
25684 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25688 it
->object
= object
;
25689 it
->char_to_display
= ' ';
25690 it
->pixel_width
= it
->len
= 1;
25692 tty_append_glyph (it
);
25693 it
->object
= o_object
;
25697 it
->pixel_width
= width
;
25698 #ifdef HAVE_WINDOW_SYSTEM
25699 if (FRAME_WINDOW_P (it
->f
))
25701 it
->ascent
= it
->phys_ascent
= ascent
;
25702 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25703 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25704 take_vertical_position_into_account (it
);
25708 it
->nglyphs
= width
;
25711 /* Get information about special display element WHAT in an
25712 environment described by IT. WHAT is one of IT_TRUNCATION or
25713 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25714 non-null glyph_row member. This function ensures that fields like
25715 face_id, c, len of IT are left untouched. */
25718 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25725 temp_it
.object
= make_number (0);
25726 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25728 if (what
== IT_CONTINUATION
)
25730 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25731 if (it
->bidi_it
.paragraph_dir
== R2L
)
25732 SET_GLYPH_FROM_CHAR (glyph
, '/');
25734 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25736 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25738 /* FIXME: Should we mirror GC for R2L lines? */
25739 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25740 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25743 else if (what
== IT_TRUNCATION
)
25745 /* Truncation glyph. */
25746 SET_GLYPH_FROM_CHAR (glyph
, '$');
25748 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25750 /* FIXME: Should we mirror GC for R2L lines? */
25751 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25752 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25758 #ifdef HAVE_WINDOW_SYSTEM
25759 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25760 is turned off, we precede the truncation/continuation glyphs by a
25761 stretch glyph whose width is computed such that these special
25762 glyphs are aligned at the window margin, even when very different
25763 fonts are used in different glyph rows. */
25764 if (FRAME_WINDOW_P (temp_it
.f
)
25765 /* init_iterator calls this with it->glyph_row == NULL, and it
25766 wants only the pixel width of the truncation/continuation
25768 && temp_it
.glyph_row
25769 /* insert_left_trunc_glyphs calls us at the beginning of the
25770 row, and it has its own calculation of the stretch glyph
25772 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25773 && (temp_it
.glyph_row
->reversed_p
25774 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25775 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25777 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25779 if (stretch_width
> 0)
25781 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25782 struct font
*font
=
25783 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25784 int stretch_ascent
=
25785 (((temp_it
.ascent
+ temp_it
.descent
)
25786 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25788 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25789 temp_it
.ascent
+ temp_it
.descent
,
25796 temp_it
.what
= IT_CHARACTER
;
25797 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25798 temp_it
.face_id
= GLYPH_FACE (glyph
);
25799 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25801 PRODUCE_GLYPHS (&temp_it
);
25802 it
->pixel_width
= temp_it
.pixel_width
;
25803 it
->nglyphs
= temp_it
.nglyphs
;
25806 #ifdef HAVE_WINDOW_SYSTEM
25808 /* Calculate line-height and line-spacing properties.
25809 An integer value specifies explicit pixel value.
25810 A float value specifies relative value to current face height.
25811 A cons (float . face-name) specifies relative value to
25812 height of specified face font.
25814 Returns height in pixels, or nil. */
25818 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25819 int boff
, int override
)
25821 Lisp_Object face_name
= Qnil
;
25822 int ascent
, descent
, height
;
25824 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25829 face_name
= XCAR (val
);
25831 if (!NUMBERP (val
))
25832 val
= make_number (1);
25833 if (NILP (face_name
))
25835 height
= it
->ascent
+ it
->descent
;
25840 if (NILP (face_name
))
25842 font
= FRAME_FONT (it
->f
);
25843 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25845 else if (EQ (face_name
, Qt
))
25854 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25856 return make_number (-1);
25858 face
= FACE_FROM_ID (it
->f
, face_id
);
25861 return make_number (-1);
25862 boff
= font
->baseline_offset
;
25863 if (font
->vertical_centering
)
25864 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25867 ascent
= FONT_BASE (font
) + boff
;
25868 descent
= FONT_DESCENT (font
) - boff
;
25872 it
->override_ascent
= ascent
;
25873 it
->override_descent
= descent
;
25874 it
->override_boff
= boff
;
25877 height
= ascent
+ descent
;
25881 height
= (int)(XFLOAT_DATA (val
) * height
);
25882 else if (INTEGERP (val
))
25883 height
*= XINT (val
);
25885 return make_number (height
);
25889 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25890 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25891 and only if this is for a character for which no font was found.
25893 If the display method (it->glyphless_method) is
25894 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25895 length of the acronym or the hexadecimal string, UPPER_XOFF and
25896 UPPER_YOFF are pixel offsets for the upper part of the string,
25897 LOWER_XOFF and LOWER_YOFF are for the lower part.
25899 For the other display methods, LEN through LOWER_YOFF are zero. */
25902 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25903 short upper_xoff
, short upper_yoff
,
25904 short lower_xoff
, short lower_yoff
)
25906 struct glyph
*glyph
;
25907 enum glyph_row_area area
= it
->area
;
25909 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25910 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25912 /* If the glyph row is reversed, we need to prepend the glyph
25913 rather than append it. */
25914 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25918 /* Make room for the additional glyph. */
25919 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25921 glyph
= it
->glyph_row
->glyphs
[area
];
25923 glyph
->charpos
= CHARPOS (it
->position
);
25924 glyph
->object
= it
->object
;
25925 glyph
->pixel_width
= it
->pixel_width
;
25926 glyph
->ascent
= it
->ascent
;
25927 glyph
->descent
= it
->descent
;
25928 glyph
->voffset
= it
->voffset
;
25929 glyph
->type
= GLYPHLESS_GLYPH
;
25930 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25931 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25932 glyph
->u
.glyphless
.len
= len
;
25933 glyph
->u
.glyphless
.ch
= it
->c
;
25934 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25935 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25936 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25937 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25938 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25939 glyph
->multibyte_p
= it
->multibyte_p
;
25940 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25942 /* In R2L rows, the left and the right box edges need to be
25943 drawn in reverse direction. */
25944 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25945 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25949 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25950 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25952 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25953 || it
->phys_descent
> it
->descent
);
25954 glyph
->padding_p
= 0;
25955 glyph
->glyph_not_available_p
= 0;
25956 glyph
->face_id
= face_id
;
25957 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25960 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25961 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25963 glyph
->bidi_type
= it
->bidi_it
.type
;
25965 ++it
->glyph_row
->used
[area
];
25968 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25972 /* Produce a glyph for a glyphless character for iterator IT.
25973 IT->glyphless_method specifies which method to use for displaying
25974 the character. See the description of enum
25975 glyphless_display_method in dispextern.h for the detail.
25977 FOR_NO_FONT is nonzero if and only if this is for a character for
25978 which no font was found. ACRONYM, if non-nil, is an acronym string
25979 for the character. */
25982 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25987 int base_width
, base_height
, width
, height
;
25988 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25991 /* Get the metrics of the base font. We always refer to the current
25993 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25994 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25995 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25996 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25997 base_height
= it
->ascent
+ it
->descent
;
25998 base_width
= font
->average_width
;
26000 face_id
= merge_glyphless_glyph_face (it
);
26002 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26004 it
->pixel_width
= THIN_SPACE_WIDTH
;
26006 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26008 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26010 width
= CHAR_WIDTH (it
->c
);
26013 else if (width
> 4)
26015 it
->pixel_width
= base_width
* width
;
26017 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26023 unsigned int code
[6];
26025 int ascent
, descent
;
26026 struct font_metrics metrics_upper
, metrics_lower
;
26028 face
= FACE_FROM_ID (it
->f
, face_id
);
26029 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26030 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
26032 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26034 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26035 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26036 if (CONSP (acronym
))
26037 acronym
= XCAR (acronym
);
26038 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26042 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26043 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26046 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
26047 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26048 upper_len
= (len
+ 1) / 2;
26049 font
->driver
->text_extents (font
, code
, upper_len
,
26051 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26056 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26057 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26058 upper_xoff
= upper_yoff
= 2; /* the typical case */
26059 if (base_width
>= width
)
26061 /* Align the upper to the left, the lower to the right. */
26062 it
->pixel_width
= base_width
;
26063 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26067 /* Center the shorter one. */
26068 it
->pixel_width
= width
;
26069 if (metrics_upper
.width
>= metrics_lower
.width
)
26070 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26073 /* FIXME: This code doesn't look right. It formerly was
26074 missing the "lower_xoff = 0;", which couldn't have
26075 been right since it left lower_xoff uninitialized. */
26077 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26081 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26082 top, bottom, and between upper and lower strings. */
26083 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26084 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26085 /* Center vertically.
26086 H:base_height, D:base_descent
26087 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26089 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26090 descent = D - H/2 + h/2;
26091 lower_yoff = descent - 2 - ld;
26092 upper_yoff = lower_yoff - la - 1 - ud; */
26093 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26094 descent
= it
->descent
- (base_height
- height
) / 2;
26095 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26096 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26097 - metrics_upper
.descent
);
26098 /* Don't make the height shorter than the base height. */
26099 if (height
> base_height
)
26101 it
->ascent
= ascent
;
26102 it
->descent
= descent
;
26106 it
->phys_ascent
= it
->ascent
;
26107 it
->phys_descent
= it
->descent
;
26109 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26110 upper_xoff
, upper_yoff
,
26111 lower_xoff
, lower_yoff
);
26113 take_vertical_position_into_account (it
);
26118 Produce glyphs/get display metrics for the display element IT is
26119 loaded with. See the description of struct it in dispextern.h
26120 for an overview of struct it. */
26123 x_produce_glyphs (struct it
*it
)
26125 int extra_line_spacing
= it
->extra_line_spacing
;
26127 it
->glyph_not_available_p
= 0;
26129 if (it
->what
== IT_CHARACTER
)
26132 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26133 struct font
*font
= face
->font
;
26134 struct font_metrics
*pcm
= NULL
;
26135 int boff
; /* Baseline offset. */
26139 /* When no suitable font is found, display this character by
26140 the method specified in the first extra slot of
26141 Vglyphless_char_display. */
26142 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26144 eassert (it
->what
== IT_GLYPHLESS
);
26145 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26149 boff
= font
->baseline_offset
;
26150 if (font
->vertical_centering
)
26151 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26153 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26159 if (it
->override_ascent
>= 0)
26161 it
->ascent
= it
->override_ascent
;
26162 it
->descent
= it
->override_descent
;
26163 boff
= it
->override_boff
;
26167 it
->ascent
= FONT_BASE (font
) + boff
;
26168 it
->descent
= FONT_DESCENT (font
) - boff
;
26171 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26173 pcm
= get_per_char_metric (font
, &char2b
);
26174 if (pcm
->width
== 0
26175 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26181 it
->phys_ascent
= pcm
->ascent
+ boff
;
26182 it
->phys_descent
= pcm
->descent
- boff
;
26183 it
->pixel_width
= pcm
->width
;
26187 it
->glyph_not_available_p
= 1;
26188 it
->phys_ascent
= it
->ascent
;
26189 it
->phys_descent
= it
->descent
;
26190 it
->pixel_width
= font
->space_width
;
26193 if (it
->constrain_row_ascent_descent_p
)
26195 if (it
->descent
> it
->max_descent
)
26197 it
->ascent
+= it
->descent
- it
->max_descent
;
26198 it
->descent
= it
->max_descent
;
26200 if (it
->ascent
> it
->max_ascent
)
26202 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26203 it
->ascent
= it
->max_ascent
;
26205 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26206 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26207 extra_line_spacing
= 0;
26210 /* If this is a space inside a region of text with
26211 `space-width' property, change its width. */
26212 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26214 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26216 /* If face has a box, add the box thickness to the character
26217 height. If character has a box line to the left and/or
26218 right, add the box line width to the character's width. */
26219 if (face
->box
!= FACE_NO_BOX
)
26221 int thick
= face
->box_line_width
;
26225 it
->ascent
+= thick
;
26226 it
->descent
+= thick
;
26231 if (it
->start_of_box_run_p
)
26232 it
->pixel_width
+= thick
;
26233 if (it
->end_of_box_run_p
)
26234 it
->pixel_width
+= thick
;
26237 /* If face has an overline, add the height of the overline
26238 (1 pixel) and a 1 pixel margin to the character height. */
26239 if (face
->overline_p
)
26240 it
->ascent
+= overline_margin
;
26242 if (it
->constrain_row_ascent_descent_p
)
26244 if (it
->ascent
> it
->max_ascent
)
26245 it
->ascent
= it
->max_ascent
;
26246 if (it
->descent
> it
->max_descent
)
26247 it
->descent
= it
->max_descent
;
26250 take_vertical_position_into_account (it
);
26252 /* If we have to actually produce glyphs, do it. */
26257 /* Translate a space with a `space-width' property
26258 into a stretch glyph. */
26259 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26260 / FONT_HEIGHT (font
));
26261 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26262 it
->ascent
+ it
->descent
, ascent
);
26267 /* If characters with lbearing or rbearing are displayed
26268 in this line, record that fact in a flag of the
26269 glyph row. This is used to optimize X output code. */
26270 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26271 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26273 if (! stretched_p
&& it
->pixel_width
== 0)
26274 /* We assure that all visible glyphs have at least 1-pixel
26276 it
->pixel_width
= 1;
26278 else if (it
->char_to_display
== '\n')
26280 /* A newline has no width, but we need the height of the
26281 line. But if previous part of the line sets a height,
26282 don't increase that height. */
26284 Lisp_Object height
;
26285 Lisp_Object total_height
= Qnil
;
26287 it
->override_ascent
= -1;
26288 it
->pixel_width
= 0;
26291 height
= get_it_property (it
, Qline_height
);
26292 /* Split (line-height total-height) list. */
26294 && CONSP (XCDR (height
))
26295 && NILP (XCDR (XCDR (height
))))
26297 total_height
= XCAR (XCDR (height
));
26298 height
= XCAR (height
);
26300 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26302 if (it
->override_ascent
>= 0)
26304 it
->ascent
= it
->override_ascent
;
26305 it
->descent
= it
->override_descent
;
26306 boff
= it
->override_boff
;
26310 it
->ascent
= FONT_BASE (font
) + boff
;
26311 it
->descent
= FONT_DESCENT (font
) - boff
;
26314 if (EQ (height
, Qt
))
26316 if (it
->descent
> it
->max_descent
)
26318 it
->ascent
+= it
->descent
- it
->max_descent
;
26319 it
->descent
= it
->max_descent
;
26321 if (it
->ascent
> it
->max_ascent
)
26323 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26324 it
->ascent
= it
->max_ascent
;
26326 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26327 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26328 it
->constrain_row_ascent_descent_p
= 1;
26329 extra_line_spacing
= 0;
26333 Lisp_Object spacing
;
26335 it
->phys_ascent
= it
->ascent
;
26336 it
->phys_descent
= it
->descent
;
26338 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26339 && face
->box
!= FACE_NO_BOX
26340 && face
->box_line_width
> 0)
26342 it
->ascent
+= face
->box_line_width
;
26343 it
->descent
+= face
->box_line_width
;
26346 && XINT (height
) > it
->ascent
+ it
->descent
)
26347 it
->ascent
= XINT (height
) - it
->descent
;
26349 if (!NILP (total_height
))
26350 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26353 spacing
= get_it_property (it
, Qline_spacing
);
26354 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26356 if (INTEGERP (spacing
))
26358 extra_line_spacing
= XINT (spacing
);
26359 if (!NILP (total_height
))
26360 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26364 else /* i.e. (it->char_to_display == '\t') */
26366 if (font
->space_width
> 0)
26368 int tab_width
= it
->tab_width
* font
->space_width
;
26369 int x
= it
->current_x
+ it
->continuation_lines_width
;
26370 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26372 /* If the distance from the current position to the next tab
26373 stop is less than a space character width, use the
26374 tab stop after that. */
26375 if (next_tab_x
- x
< font
->space_width
)
26376 next_tab_x
+= tab_width
;
26378 it
->pixel_width
= next_tab_x
- x
;
26380 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26381 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26385 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26386 it
->ascent
+ it
->descent
, it
->ascent
);
26391 it
->pixel_width
= 0;
26396 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26398 /* A static composition.
26400 Note: A composition is represented as one glyph in the
26401 glyph matrix. There are no padding glyphs.
26403 Important note: pixel_width, ascent, and descent are the
26404 values of what is drawn by draw_glyphs (i.e. the values of
26405 the overall glyphs composed). */
26406 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26407 int boff
; /* baseline offset */
26408 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26409 int glyph_len
= cmp
->glyph_len
;
26410 struct font
*font
= face
->font
;
26414 /* If we have not yet calculated pixel size data of glyphs of
26415 the composition for the current face font, calculate them
26416 now. Theoretically, we have to check all fonts for the
26417 glyphs, but that requires much time and memory space. So,
26418 here we check only the font of the first glyph. This may
26419 lead to incorrect display, but it's very rare, and C-l
26420 (recenter-top-bottom) can correct the display anyway. */
26421 if (! cmp
->font
|| cmp
->font
!= font
)
26423 /* Ascent and descent of the font of the first character
26424 of this composition (adjusted by baseline offset).
26425 Ascent and descent of overall glyphs should not be less
26426 than these, respectively. */
26427 int font_ascent
, font_descent
, font_height
;
26428 /* Bounding box of the overall glyphs. */
26429 int leftmost
, rightmost
, lowest
, highest
;
26430 int lbearing
, rbearing
;
26431 int i
, width
, ascent
, descent
;
26432 int left_padded
= 0, right_padded
= 0;
26433 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26435 struct font_metrics
*pcm
;
26436 int font_not_found_p
;
26439 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26440 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26442 if (glyph_len
< cmp
->glyph_len
)
26444 for (i
= 0; i
< glyph_len
; i
++)
26446 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26448 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26453 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26454 : IT_CHARPOS (*it
));
26455 /* If no suitable font is found, use the default font. */
26456 font_not_found_p
= font
== NULL
;
26457 if (font_not_found_p
)
26459 face
= face
->ascii_face
;
26462 boff
= font
->baseline_offset
;
26463 if (font
->vertical_centering
)
26464 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26465 font_ascent
= FONT_BASE (font
) + boff
;
26466 font_descent
= FONT_DESCENT (font
) - boff
;
26467 font_height
= FONT_HEIGHT (font
);
26472 if (! font_not_found_p
)
26474 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26476 pcm
= get_per_char_metric (font
, &char2b
);
26479 /* Initialize the bounding box. */
26482 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26483 ascent
= pcm
->ascent
;
26484 descent
= pcm
->descent
;
26485 lbearing
= pcm
->lbearing
;
26486 rbearing
= pcm
->rbearing
;
26490 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26491 ascent
= FONT_BASE (font
);
26492 descent
= FONT_DESCENT (font
);
26499 lowest
= - descent
+ boff
;
26500 highest
= ascent
+ boff
;
26502 if (! font_not_found_p
26503 && font
->default_ascent
26504 && CHAR_TABLE_P (Vuse_default_ascent
)
26505 && !NILP (Faref (Vuse_default_ascent
,
26506 make_number (it
->char_to_display
))))
26507 highest
= font
->default_ascent
+ boff
;
26509 /* Draw the first glyph at the normal position. It may be
26510 shifted to right later if some other glyphs are drawn
26512 cmp
->offsets
[i
* 2] = 0;
26513 cmp
->offsets
[i
* 2 + 1] = boff
;
26514 cmp
->lbearing
= lbearing
;
26515 cmp
->rbearing
= rbearing
;
26517 /* Set cmp->offsets for the remaining glyphs. */
26518 for (i
++; i
< glyph_len
; i
++)
26520 int left
, right
, btm
, top
;
26521 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26523 struct face
*this_face
;
26527 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26528 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26529 font
= this_face
->font
;
26535 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26537 pcm
= get_per_char_metric (font
, &char2b
);
26540 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26543 width
= pcm
->width
;
26544 ascent
= pcm
->ascent
;
26545 descent
= pcm
->descent
;
26546 lbearing
= pcm
->lbearing
;
26547 rbearing
= pcm
->rbearing
;
26548 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26550 /* Relative composition with or without
26551 alternate chars. */
26552 left
= (leftmost
+ rightmost
- width
) / 2;
26553 btm
= - descent
+ boff
;
26554 if (font
->relative_compose
26555 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26556 || NILP (Faref (Vignore_relative_composition
,
26557 make_number (ch
)))))
26560 if (- descent
>= font
->relative_compose
)
26561 /* One extra pixel between two glyphs. */
26563 else if (ascent
<= 0)
26564 /* One extra pixel between two glyphs. */
26565 btm
= lowest
- 1 - ascent
- descent
;
26570 /* A composition rule is specified by an integer
26571 value that encodes global and new reference
26572 points (GREF and NREF). GREF and NREF are
26573 specified by numbers as below:
26575 0---1---2 -- ascent
26579 9--10--11 -- center
26581 ---3---4---5--- baseline
26583 6---7---8 -- descent
26585 int rule
= COMPOSITION_RULE (cmp
, i
);
26586 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26588 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26589 grefx
= gref
% 3, nrefx
= nref
% 3;
26590 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26592 xoff
= font_height
* (xoff
- 128) / 256;
26594 yoff
= font_height
* (yoff
- 128) / 256;
26597 + grefx
* (rightmost
- leftmost
) / 2
26598 - nrefx
* width
/ 2
26601 btm
= ((grefy
== 0 ? highest
26603 : grefy
== 2 ? lowest
26604 : (highest
+ lowest
) / 2)
26605 - (nrefy
== 0 ? ascent
+ descent
26606 : nrefy
== 1 ? descent
- boff
26608 : (ascent
+ descent
) / 2)
26612 cmp
->offsets
[i
* 2] = left
;
26613 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26615 /* Update the bounding box of the overall glyphs. */
26618 right
= left
+ width
;
26619 if (left
< leftmost
)
26621 if (right
> rightmost
)
26624 top
= btm
+ descent
+ ascent
;
26630 if (cmp
->lbearing
> left
+ lbearing
)
26631 cmp
->lbearing
= left
+ lbearing
;
26632 if (cmp
->rbearing
< left
+ rbearing
)
26633 cmp
->rbearing
= left
+ rbearing
;
26637 /* If there are glyphs whose x-offsets are negative,
26638 shift all glyphs to the right and make all x-offsets
26642 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26643 cmp
->offsets
[i
* 2] -= leftmost
;
26644 rightmost
-= leftmost
;
26645 cmp
->lbearing
-= leftmost
;
26646 cmp
->rbearing
-= leftmost
;
26649 if (left_padded
&& cmp
->lbearing
< 0)
26651 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26652 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26653 rightmost
-= cmp
->lbearing
;
26654 cmp
->rbearing
-= cmp
->lbearing
;
26657 if (right_padded
&& rightmost
< cmp
->rbearing
)
26659 rightmost
= cmp
->rbearing
;
26662 cmp
->pixel_width
= rightmost
;
26663 cmp
->ascent
= highest
;
26664 cmp
->descent
= - lowest
;
26665 if (cmp
->ascent
< font_ascent
)
26666 cmp
->ascent
= font_ascent
;
26667 if (cmp
->descent
< font_descent
)
26668 cmp
->descent
= font_descent
;
26672 && (cmp
->lbearing
< 0
26673 || cmp
->rbearing
> cmp
->pixel_width
))
26674 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26676 it
->pixel_width
= cmp
->pixel_width
;
26677 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26678 it
->descent
= it
->phys_descent
= cmp
->descent
;
26679 if (face
->box
!= FACE_NO_BOX
)
26681 int thick
= face
->box_line_width
;
26685 it
->ascent
+= thick
;
26686 it
->descent
+= thick
;
26691 if (it
->start_of_box_run_p
)
26692 it
->pixel_width
+= thick
;
26693 if (it
->end_of_box_run_p
)
26694 it
->pixel_width
+= thick
;
26697 /* If face has an overline, add the height of the overline
26698 (1 pixel) and a 1 pixel margin to the character height. */
26699 if (face
->overline_p
)
26700 it
->ascent
+= overline_margin
;
26702 take_vertical_position_into_account (it
);
26703 if (it
->ascent
< 0)
26705 if (it
->descent
< 0)
26708 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26709 append_composite_glyph (it
);
26711 else if (it
->what
== IT_COMPOSITION
)
26713 /* A dynamic (automatic) composition. */
26714 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26715 Lisp_Object gstring
;
26716 struct font_metrics metrics
;
26720 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26722 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26725 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26726 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26727 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26728 it
->descent
= it
->phys_descent
= metrics
.descent
;
26729 if (face
->box
!= FACE_NO_BOX
)
26731 int thick
= face
->box_line_width
;
26735 it
->ascent
+= thick
;
26736 it
->descent
+= thick
;
26741 if (it
->start_of_box_run_p
)
26742 it
->pixel_width
+= thick
;
26743 if (it
->end_of_box_run_p
)
26744 it
->pixel_width
+= thick
;
26746 /* If face has an overline, add the height of the overline
26747 (1 pixel) and a 1 pixel margin to the character height. */
26748 if (face
->overline_p
)
26749 it
->ascent
+= overline_margin
;
26750 take_vertical_position_into_account (it
);
26751 if (it
->ascent
< 0)
26753 if (it
->descent
< 0)
26757 append_composite_glyph (it
);
26759 else if (it
->what
== IT_GLYPHLESS
)
26760 produce_glyphless_glyph (it
, 0, Qnil
);
26761 else if (it
->what
== IT_IMAGE
)
26762 produce_image_glyph (it
);
26763 else if (it
->what
== IT_STRETCH
)
26764 produce_stretch_glyph (it
);
26767 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26768 because this isn't true for images with `:ascent 100'. */
26769 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26770 if (it
->area
== TEXT_AREA
)
26771 it
->current_x
+= it
->pixel_width
;
26773 if (extra_line_spacing
> 0)
26775 it
->descent
+= extra_line_spacing
;
26776 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26777 it
->max_extra_line_spacing
= extra_line_spacing
;
26780 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26781 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26782 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26783 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26787 Output LEN glyphs starting at START at the nominal cursor position.
26788 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26789 being updated, and UPDATED_AREA is the area of that row being updated. */
26792 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26793 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26795 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26797 eassert (updated_row
);
26798 /* When the window is hscrolled, cursor hpos can legitimately be out
26799 of bounds, but we draw the cursor at the corresponding window
26800 margin in that case. */
26801 if (!updated_row
->reversed_p
&& chpos
< 0)
26803 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26804 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26808 /* Write glyphs. */
26810 hpos
= start
- updated_row
->glyphs
[updated_area
];
26811 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26812 updated_row
, updated_area
,
26814 DRAW_NORMAL_TEXT
, 0);
26816 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26817 if (updated_area
== TEXT_AREA
26818 && w
->phys_cursor_on_p
26819 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26821 && chpos
< hpos
+ len
)
26822 w
->phys_cursor_on_p
= 0;
26826 /* Advance the output cursor. */
26827 w
->output_cursor
.hpos
+= len
;
26828 w
->output_cursor
.x
= x
;
26833 Insert LEN glyphs from START at the nominal cursor position. */
26836 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26837 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26840 int line_height
, shift_by_width
, shifted_region_width
;
26841 struct glyph_row
*row
;
26842 struct glyph
*glyph
;
26843 int frame_x
, frame_y
;
26846 eassert (updated_row
);
26848 f
= XFRAME (WINDOW_FRAME (w
));
26850 /* Get the height of the line we are in. */
26852 line_height
= row
->height
;
26854 /* Get the width of the glyphs to insert. */
26855 shift_by_width
= 0;
26856 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26857 shift_by_width
+= glyph
->pixel_width
;
26859 /* Get the width of the region to shift right. */
26860 shifted_region_width
= (window_box_width (w
, updated_area
)
26861 - w
->output_cursor
.x
26865 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26866 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26868 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26869 line_height
, shift_by_width
);
26871 /* Write the glyphs. */
26872 hpos
= start
- row
->glyphs
[updated_area
];
26873 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26875 DRAW_NORMAL_TEXT
, 0);
26877 /* Advance the output cursor. */
26878 w
->output_cursor
.hpos
+= len
;
26879 w
->output_cursor
.x
+= shift_by_width
;
26885 Erase the current text line from the nominal cursor position
26886 (inclusive) to pixel column TO_X (exclusive). The idea is that
26887 everything from TO_X onward is already erased.
26889 TO_X is a pixel position relative to UPDATED_AREA of currently
26890 updated window W. TO_X == -1 means clear to the end of this area. */
26893 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26894 enum glyph_row_area updated_area
, int to_x
)
26897 int max_x
, min_y
, max_y
;
26898 int from_x
, from_y
, to_y
;
26900 eassert (updated_row
);
26901 f
= XFRAME (w
->frame
);
26903 if (updated_row
->full_width_p
)
26904 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26905 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26907 max_x
= window_box_width (w
, updated_area
);
26908 max_y
= window_text_bottom_y (w
);
26910 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26911 of window. For TO_X > 0, truncate to end of drawing area. */
26917 to_x
= min (to_x
, max_x
);
26919 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26921 /* Notice if the cursor will be cleared by this operation. */
26922 if (!updated_row
->full_width_p
)
26923 notice_overwritten_cursor (w
, updated_area
,
26924 w
->output_cursor
.x
, -1,
26926 MATRIX_ROW_BOTTOM_Y (updated_row
));
26928 from_x
= w
->output_cursor
.x
;
26930 /* Translate to frame coordinates. */
26931 if (updated_row
->full_width_p
)
26933 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26934 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26938 int area_left
= window_box_left (w
, updated_area
);
26939 from_x
+= area_left
;
26943 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26944 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26945 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26947 /* Prevent inadvertently clearing to end of the X window. */
26948 if (to_x
> from_x
&& to_y
> from_y
)
26951 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26952 to_x
- from_x
, to_y
- from_y
);
26957 #endif /* HAVE_WINDOW_SYSTEM */
26961 /***********************************************************************
26963 ***********************************************************************/
26965 /* Value is the internal representation of the specified cursor type
26966 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26967 of the bar cursor. */
26969 static enum text_cursor_kinds
26970 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26972 enum text_cursor_kinds type
;
26977 if (EQ (arg
, Qbox
))
26978 return FILLED_BOX_CURSOR
;
26980 if (EQ (arg
, Qhollow
))
26981 return HOLLOW_BOX_CURSOR
;
26983 if (EQ (arg
, Qbar
))
26990 && EQ (XCAR (arg
), Qbar
)
26991 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26993 *width
= XINT (XCDR (arg
));
26997 if (EQ (arg
, Qhbar
))
27000 return HBAR_CURSOR
;
27004 && EQ (XCAR (arg
), Qhbar
)
27005 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27007 *width
= XINT (XCDR (arg
));
27008 return HBAR_CURSOR
;
27011 /* Treat anything unknown as "hollow box cursor".
27012 It was bad to signal an error; people have trouble fixing
27013 .Xdefaults with Emacs, when it has something bad in it. */
27014 type
= HOLLOW_BOX_CURSOR
;
27019 /* Set the default cursor types for specified frame. */
27021 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27026 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27027 FRAME_CURSOR_WIDTH (f
) = width
;
27029 /* By default, set up the blink-off state depending on the on-state. */
27031 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27034 FRAME_BLINK_OFF_CURSOR (f
)
27035 = get_specified_cursor_type (XCDR (tem
), &width
);
27036 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27039 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27041 /* Make sure the cursor gets redrawn. */
27042 f
->cursor_type_changed
= 1;
27046 #ifdef HAVE_WINDOW_SYSTEM
27048 /* Return the cursor we want to be displayed in window W. Return
27049 width of bar/hbar cursor through WIDTH arg. Return with
27050 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27051 (i.e. if the `system caret' should track this cursor).
27053 In a mini-buffer window, we want the cursor only to appear if we
27054 are reading input from this window. For the selected window, we
27055 want the cursor type given by the frame parameter or buffer local
27056 setting of cursor-type. If explicitly marked off, draw no cursor.
27057 In all other cases, we want a hollow box cursor. */
27059 static enum text_cursor_kinds
27060 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27061 int *active_cursor
)
27063 struct frame
*f
= XFRAME (w
->frame
);
27064 struct buffer
*b
= XBUFFER (w
->contents
);
27065 int cursor_type
= DEFAULT_CURSOR
;
27066 Lisp_Object alt_cursor
;
27067 int non_selected
= 0;
27069 *active_cursor
= 1;
27072 if (cursor_in_echo_area
27073 && FRAME_HAS_MINIBUF_P (f
)
27074 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27076 if (w
== XWINDOW (echo_area_window
))
27078 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27080 *width
= FRAME_CURSOR_WIDTH (f
);
27081 return FRAME_DESIRED_CURSOR (f
);
27084 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27087 *active_cursor
= 0;
27091 /* Detect a nonselected window or nonselected frame. */
27092 else if (w
!= XWINDOW (f
->selected_window
)
27093 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27095 *active_cursor
= 0;
27097 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27103 /* Never display a cursor in a window in which cursor-type is nil. */
27104 if (NILP (BVAR (b
, cursor_type
)))
27107 /* Get the normal cursor type for this window. */
27108 if (EQ (BVAR (b
, cursor_type
), Qt
))
27110 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27111 *width
= FRAME_CURSOR_WIDTH (f
);
27114 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27116 /* Use cursor-in-non-selected-windows instead
27117 for non-selected window or frame. */
27120 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27121 if (!EQ (Qt
, alt_cursor
))
27122 return get_specified_cursor_type (alt_cursor
, width
);
27123 /* t means modify the normal cursor type. */
27124 if (cursor_type
== FILLED_BOX_CURSOR
)
27125 cursor_type
= HOLLOW_BOX_CURSOR
;
27126 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27128 return cursor_type
;
27131 /* Use normal cursor if not blinked off. */
27132 if (!w
->cursor_off_p
)
27134 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27136 if (cursor_type
== FILLED_BOX_CURSOR
)
27138 /* Using a block cursor on large images can be very annoying.
27139 So use a hollow cursor for "large" images.
27140 If image is not transparent (no mask), also use hollow cursor. */
27141 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27142 if (img
!= NULL
&& IMAGEP (img
->spec
))
27144 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27145 where N = size of default frame font size.
27146 This should cover most of the "tiny" icons people may use. */
27148 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27149 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27150 cursor_type
= HOLLOW_BOX_CURSOR
;
27153 else if (cursor_type
!= NO_CURSOR
)
27155 /* Display current only supports BOX and HOLLOW cursors for images.
27156 So for now, unconditionally use a HOLLOW cursor when cursor is
27157 not a solid box cursor. */
27158 cursor_type
= HOLLOW_BOX_CURSOR
;
27161 return cursor_type
;
27164 /* Cursor is blinked off, so determine how to "toggle" it. */
27166 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27167 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27168 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27170 /* Then see if frame has specified a specific blink off cursor type. */
27171 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27173 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27174 return FRAME_BLINK_OFF_CURSOR (f
);
27178 /* Some people liked having a permanently visible blinking cursor,
27179 while others had very strong opinions against it. So it was
27180 decided to remove it. KFS 2003-09-03 */
27182 /* Finally perform built-in cursor blinking:
27183 filled box <-> hollow box
27184 wide [h]bar <-> narrow [h]bar
27185 narrow [h]bar <-> no cursor
27186 other type <-> no cursor */
27188 if (cursor_type
== FILLED_BOX_CURSOR
)
27189 return HOLLOW_BOX_CURSOR
;
27191 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27194 return cursor_type
;
27202 /* Notice when the text cursor of window W has been completely
27203 overwritten by a drawing operation that outputs glyphs in AREA
27204 starting at X0 and ending at X1 in the line starting at Y0 and
27205 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27206 the rest of the line after X0 has been written. Y coordinates
27207 are window-relative. */
27210 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27211 int x0
, int x1
, int y0
, int y1
)
27213 int cx0
, cx1
, cy0
, cy1
;
27214 struct glyph_row
*row
;
27216 if (!w
->phys_cursor_on_p
)
27218 if (area
!= TEXT_AREA
)
27221 if (w
->phys_cursor
.vpos
< 0
27222 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27223 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27224 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27227 if (row
->cursor_in_fringe_p
)
27229 row
->cursor_in_fringe_p
= 0;
27230 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27231 w
->phys_cursor_on_p
= 0;
27235 cx0
= w
->phys_cursor
.x
;
27236 cx1
= cx0
+ w
->phys_cursor_width
;
27237 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27240 /* The cursor image will be completely removed from the
27241 screen if the output area intersects the cursor area in
27242 y-direction. When we draw in [y0 y1[, and some part of
27243 the cursor is at y < y0, that part must have been drawn
27244 before. When scrolling, the cursor is erased before
27245 actually scrolling, so we don't come here. When not
27246 scrolling, the rows above the old cursor row must have
27247 changed, and in this case these rows must have written
27248 over the cursor image.
27250 Likewise if part of the cursor is below y1, with the
27251 exception of the cursor being in the first blank row at
27252 the buffer and window end because update_text_area
27253 doesn't draw that row. (Except when it does, but
27254 that's handled in update_text_area.) */
27256 cy0
= w
->phys_cursor
.y
;
27257 cy1
= cy0
+ w
->phys_cursor_height
;
27258 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27261 w
->phys_cursor_on_p
= 0;
27264 #endif /* HAVE_WINDOW_SYSTEM */
27267 /************************************************************************
27269 ************************************************************************/
27271 #ifdef HAVE_WINDOW_SYSTEM
27274 Fix the display of area AREA of overlapping row ROW in window W
27275 with respect to the overlapping part OVERLAPS. */
27278 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27279 enum glyph_row_area area
, int overlaps
)
27286 for (i
= 0; i
< row
->used
[area
];)
27288 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27290 int start
= i
, start_x
= x
;
27294 x
+= row
->glyphs
[area
][i
].pixel_width
;
27297 while (i
< row
->used
[area
]
27298 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27300 draw_glyphs (w
, start_x
, row
, area
,
27302 DRAW_NORMAL_TEXT
, overlaps
);
27306 x
+= row
->glyphs
[area
][i
].pixel_width
;
27316 Draw the cursor glyph of window W in glyph row ROW. See the
27317 comment of draw_glyphs for the meaning of HL. */
27320 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27321 enum draw_glyphs_face hl
)
27323 /* If cursor hpos is out of bounds, don't draw garbage. This can
27324 happen in mini-buffer windows when switching between echo area
27325 glyphs and mini-buffer. */
27326 if ((row
->reversed_p
27327 ? (w
->phys_cursor
.hpos
>= 0)
27328 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27330 int on_p
= w
->phys_cursor_on_p
;
27332 int hpos
= w
->phys_cursor
.hpos
;
27334 /* When the window is hscrolled, cursor hpos can legitimately be
27335 out of bounds, but we draw the cursor at the corresponding
27336 window margin in that case. */
27337 if (!row
->reversed_p
&& hpos
< 0)
27339 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27340 hpos
= row
->used
[TEXT_AREA
] - 1;
27342 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27344 w
->phys_cursor_on_p
= on_p
;
27346 if (hl
== DRAW_CURSOR
)
27347 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27348 /* When we erase the cursor, and ROW is overlapped by other
27349 rows, make sure that these overlapping parts of other rows
27351 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27353 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27355 if (row
> w
->current_matrix
->rows
27356 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27357 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27358 OVERLAPS_ERASED_CURSOR
);
27360 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27361 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27362 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27363 OVERLAPS_ERASED_CURSOR
);
27369 /* Erase the image of a cursor of window W from the screen. */
27375 erase_phys_cursor (struct window
*w
)
27377 struct frame
*f
= XFRAME (w
->frame
);
27378 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27379 int hpos
= w
->phys_cursor
.hpos
;
27380 int vpos
= w
->phys_cursor
.vpos
;
27381 int mouse_face_here_p
= 0;
27382 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27383 struct glyph_row
*cursor_row
;
27384 struct glyph
*cursor_glyph
;
27385 enum draw_glyphs_face hl
;
27387 /* No cursor displayed or row invalidated => nothing to do on the
27389 if (w
->phys_cursor_type
== NO_CURSOR
)
27390 goto mark_cursor_off
;
27392 /* VPOS >= active_glyphs->nrows means that window has been resized.
27393 Don't bother to erase the cursor. */
27394 if (vpos
>= active_glyphs
->nrows
)
27395 goto mark_cursor_off
;
27397 /* If row containing cursor is marked invalid, there is nothing we
27399 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27400 if (!cursor_row
->enabled_p
)
27401 goto mark_cursor_off
;
27403 /* If line spacing is > 0, old cursor may only be partially visible in
27404 window after split-window. So adjust visible height. */
27405 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27406 window_text_bottom_y (w
) - cursor_row
->y
);
27408 /* If row is completely invisible, don't attempt to delete a cursor which
27409 isn't there. This can happen if cursor is at top of a window, and
27410 we switch to a buffer with a header line in that window. */
27411 if (cursor_row
->visible_height
<= 0)
27412 goto mark_cursor_off
;
27414 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27415 if (cursor_row
->cursor_in_fringe_p
)
27417 cursor_row
->cursor_in_fringe_p
= 0;
27418 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27419 goto mark_cursor_off
;
27422 /* This can happen when the new row is shorter than the old one.
27423 In this case, either draw_glyphs or clear_end_of_line
27424 should have cleared the cursor. Note that we wouldn't be
27425 able to erase the cursor in this case because we don't have a
27426 cursor glyph at hand. */
27427 if ((cursor_row
->reversed_p
27428 ? (w
->phys_cursor
.hpos
< 0)
27429 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27430 goto mark_cursor_off
;
27432 /* When the window is hscrolled, cursor hpos can legitimately be out
27433 of bounds, but we draw the cursor at the corresponding window
27434 margin in that case. */
27435 if (!cursor_row
->reversed_p
&& hpos
< 0)
27437 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27438 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27440 /* If the cursor is in the mouse face area, redisplay that when
27441 we clear the cursor. */
27442 if (! NILP (hlinfo
->mouse_face_window
)
27443 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27444 /* Don't redraw the cursor's spot in mouse face if it is at the
27445 end of a line (on a newline). The cursor appears there, but
27446 mouse highlighting does not. */
27447 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27448 mouse_face_here_p
= 1;
27450 /* Maybe clear the display under the cursor. */
27451 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27454 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27457 cursor_glyph
= get_phys_cursor_glyph (w
);
27458 if (cursor_glyph
== NULL
)
27459 goto mark_cursor_off
;
27461 width
= cursor_glyph
->pixel_width
;
27462 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27463 x
= w
->phys_cursor
.x
;
27465 width
-= left_x
- x
;
27466 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27467 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27468 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27471 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27474 /* Erase the cursor by redrawing the character underneath it. */
27475 if (mouse_face_here_p
)
27476 hl
= DRAW_MOUSE_FACE
;
27478 hl
= DRAW_NORMAL_TEXT
;
27479 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27482 w
->phys_cursor_on_p
= 0;
27483 w
->phys_cursor_type
= NO_CURSOR
;
27488 Display or clear cursor of window W. If ON is zero, clear the
27489 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27490 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27493 display_and_set_cursor (struct window
*w
, bool on
,
27494 int hpos
, int vpos
, int x
, int y
)
27496 struct frame
*f
= XFRAME (w
->frame
);
27497 int new_cursor_type
;
27498 int new_cursor_width
;
27500 struct glyph_row
*glyph_row
;
27501 struct glyph
*glyph
;
27503 /* This is pointless on invisible frames, and dangerous on garbaged
27504 windows and frames; in the latter case, the frame or window may
27505 be in the midst of changing its size, and x and y may be off the
27507 if (! FRAME_VISIBLE_P (f
)
27508 || FRAME_GARBAGED_P (f
)
27509 || vpos
>= w
->current_matrix
->nrows
27510 || hpos
>= w
->current_matrix
->matrix_w
)
27513 /* If cursor is off and we want it off, return quickly. */
27514 if (!on
&& !w
->phys_cursor_on_p
)
27517 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27518 /* If cursor row is not enabled, we don't really know where to
27519 display the cursor. */
27520 if (!glyph_row
->enabled_p
)
27522 w
->phys_cursor_on_p
= 0;
27527 if (!glyph_row
->exact_window_width_line_p
27528 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27529 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27531 eassert (input_blocked_p ());
27533 /* Set new_cursor_type to the cursor we want to be displayed. */
27534 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27535 &new_cursor_width
, &active_cursor
);
27537 /* If cursor is currently being shown and we don't want it to be or
27538 it is in the wrong place, or the cursor type is not what we want,
27540 if (w
->phys_cursor_on_p
27542 || w
->phys_cursor
.x
!= x
27543 || w
->phys_cursor
.y
!= y
27544 /* HPOS can be negative in R2L rows whose
27545 exact_window_width_line_p flag is set (i.e. their newline
27546 would "overflow into the fringe"). */
27548 || new_cursor_type
!= w
->phys_cursor_type
27549 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27550 && new_cursor_width
!= w
->phys_cursor_width
)))
27551 erase_phys_cursor (w
);
27553 /* Don't check phys_cursor_on_p here because that flag is only set
27554 to zero in some cases where we know that the cursor has been
27555 completely erased, to avoid the extra work of erasing the cursor
27556 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27557 still not be visible, or it has only been partly erased. */
27560 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27561 w
->phys_cursor_height
= glyph_row
->height
;
27563 /* Set phys_cursor_.* before x_draw_.* is called because some
27564 of them may need the information. */
27565 w
->phys_cursor
.x
= x
;
27566 w
->phys_cursor
.y
= glyph_row
->y
;
27567 w
->phys_cursor
.hpos
= hpos
;
27568 w
->phys_cursor
.vpos
= vpos
;
27571 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27572 new_cursor_type
, new_cursor_width
,
27573 on
, active_cursor
);
27577 /* Switch the display of W's cursor on or off, according to the value
27581 update_window_cursor (struct window
*w
, bool on
)
27583 /* Don't update cursor in windows whose frame is in the process
27584 of being deleted. */
27585 if (w
->current_matrix
)
27587 int hpos
= w
->phys_cursor
.hpos
;
27588 int vpos
= w
->phys_cursor
.vpos
;
27589 struct glyph_row
*row
;
27591 if (vpos
>= w
->current_matrix
->nrows
27592 || hpos
>= w
->current_matrix
->matrix_w
)
27595 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27597 /* When the window is hscrolled, cursor hpos can legitimately be
27598 out of bounds, but we draw the cursor at the corresponding
27599 window margin in that case. */
27600 if (!row
->reversed_p
&& hpos
< 0)
27602 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27603 hpos
= row
->used
[TEXT_AREA
] - 1;
27606 display_and_set_cursor (w
, on
, hpos
, vpos
,
27607 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27613 /* Call update_window_cursor with parameter ON_P on all leaf windows
27614 in the window tree rooted at W. */
27617 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27621 if (WINDOWP (w
->contents
))
27622 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27624 update_window_cursor (w
, on_p
);
27626 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27632 Display the cursor on window W, or clear it, according to ON_P.
27633 Don't change the cursor's position. */
27636 x_update_cursor (struct frame
*f
, bool on_p
)
27638 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27643 Clear the cursor of window W to background color, and mark the
27644 cursor as not shown. This is used when the text where the cursor
27645 is about to be rewritten. */
27648 x_clear_cursor (struct window
*w
)
27650 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27651 update_window_cursor (w
, 0);
27654 #endif /* HAVE_WINDOW_SYSTEM */
27656 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27659 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27660 int start_hpos
, int end_hpos
,
27661 enum draw_glyphs_face draw
)
27663 #ifdef HAVE_WINDOW_SYSTEM
27664 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27666 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27670 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27671 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27675 /* Display the active region described by mouse_face_* according to DRAW. */
27678 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27680 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27681 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27683 if (/* If window is in the process of being destroyed, don't bother
27685 w
->current_matrix
!= NULL
27686 /* Don't update mouse highlight if hidden. */
27687 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27688 /* Recognize when we are called to operate on rows that don't exist
27689 anymore. This can happen when a window is split. */
27690 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27692 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27693 struct glyph_row
*row
, *first
, *last
;
27695 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27696 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27698 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27700 int start_hpos
, end_hpos
, start_x
;
27702 /* For all but the first row, the highlight starts at column 0. */
27705 /* R2L rows have BEG and END in reversed order, but the
27706 screen drawing geometry is always left to right. So
27707 we need to mirror the beginning and end of the
27708 highlighted area in R2L rows. */
27709 if (!row
->reversed_p
)
27711 start_hpos
= hlinfo
->mouse_face_beg_col
;
27712 start_x
= hlinfo
->mouse_face_beg_x
;
27714 else if (row
== last
)
27716 start_hpos
= hlinfo
->mouse_face_end_col
;
27717 start_x
= hlinfo
->mouse_face_end_x
;
27725 else if (row
->reversed_p
&& row
== last
)
27727 start_hpos
= hlinfo
->mouse_face_end_col
;
27728 start_x
= hlinfo
->mouse_face_end_x
;
27738 if (!row
->reversed_p
)
27739 end_hpos
= hlinfo
->mouse_face_end_col
;
27740 else if (row
== first
)
27741 end_hpos
= hlinfo
->mouse_face_beg_col
;
27744 end_hpos
= row
->used
[TEXT_AREA
];
27745 if (draw
== DRAW_NORMAL_TEXT
)
27746 row
->fill_line_p
= 1; /* Clear to end of line */
27749 else if (row
->reversed_p
&& row
== first
)
27750 end_hpos
= hlinfo
->mouse_face_beg_col
;
27753 end_hpos
= row
->used
[TEXT_AREA
];
27754 if (draw
== DRAW_NORMAL_TEXT
)
27755 row
->fill_line_p
= 1; /* Clear to end of line */
27758 if (end_hpos
> start_hpos
)
27760 draw_row_with_mouse_face (w
, start_x
, row
,
27761 start_hpos
, end_hpos
, draw
);
27764 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27768 #ifdef HAVE_WINDOW_SYSTEM
27769 /* When we've written over the cursor, arrange for it to
27770 be displayed again. */
27771 if (FRAME_WINDOW_P (f
)
27772 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27774 int hpos
= w
->phys_cursor
.hpos
;
27776 /* When the window is hscrolled, cursor hpos can legitimately be
27777 out of bounds, but we draw the cursor at the corresponding
27778 window margin in that case. */
27779 if (!row
->reversed_p
&& hpos
< 0)
27781 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27782 hpos
= row
->used
[TEXT_AREA
] - 1;
27785 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27786 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27789 #endif /* HAVE_WINDOW_SYSTEM */
27792 #ifdef HAVE_WINDOW_SYSTEM
27793 /* Change the mouse cursor. */
27794 if (FRAME_WINDOW_P (f
))
27796 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27797 if (draw
== DRAW_NORMAL_TEXT
27798 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27799 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27802 if (draw
== DRAW_MOUSE_FACE
)
27803 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27805 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27807 #endif /* HAVE_WINDOW_SYSTEM */
27811 Clear out the mouse-highlighted active region.
27812 Redraw it un-highlighted first. Value is non-zero if mouse
27813 face was actually drawn unhighlighted. */
27816 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27820 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27822 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27826 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27827 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27828 hlinfo
->mouse_face_window
= Qnil
;
27829 hlinfo
->mouse_face_overlay
= Qnil
;
27833 /* Return true if the coordinates HPOS and VPOS on windows W are
27834 within the mouse face on that window. */
27836 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27838 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27840 /* Quickly resolve the easy cases. */
27841 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27842 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27844 if (vpos
< hlinfo
->mouse_face_beg_row
27845 || vpos
> hlinfo
->mouse_face_end_row
)
27847 if (vpos
> hlinfo
->mouse_face_beg_row
27848 && vpos
< hlinfo
->mouse_face_end_row
)
27851 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27853 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27855 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27858 else if ((vpos
== hlinfo
->mouse_face_beg_row
27859 && hpos
>= hlinfo
->mouse_face_beg_col
)
27860 || (vpos
== hlinfo
->mouse_face_end_row
27861 && hpos
< hlinfo
->mouse_face_end_col
))
27866 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27868 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27871 else if ((vpos
== hlinfo
->mouse_face_beg_row
27872 && hpos
<= hlinfo
->mouse_face_beg_col
)
27873 || (vpos
== hlinfo
->mouse_face_end_row
27874 && hpos
> hlinfo
->mouse_face_end_col
))
27882 True if physical cursor of window W is within mouse face. */
27885 cursor_in_mouse_face_p (struct window
*w
)
27887 int hpos
= w
->phys_cursor
.hpos
;
27888 int vpos
= w
->phys_cursor
.vpos
;
27889 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27891 /* When the window is hscrolled, cursor hpos can legitimately be out
27892 of bounds, but we draw the cursor at the corresponding window
27893 margin in that case. */
27894 if (!row
->reversed_p
&& hpos
< 0)
27896 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27897 hpos
= row
->used
[TEXT_AREA
] - 1;
27899 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27904 /* Find the glyph rows START_ROW and END_ROW of window W that display
27905 characters between buffer positions START_CHARPOS and END_CHARPOS
27906 (excluding END_CHARPOS). DISP_STRING is a display string that
27907 covers these buffer positions. This is similar to
27908 row_containing_pos, but is more accurate when bidi reordering makes
27909 buffer positions change non-linearly with glyph rows. */
27911 rows_from_pos_range (struct window
*w
,
27912 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27913 Lisp_Object disp_string
,
27914 struct glyph_row
**start
, struct glyph_row
**end
)
27916 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27917 int last_y
= window_text_bottom_y (w
);
27918 struct glyph_row
*row
;
27923 while (!first
->enabled_p
27924 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27927 /* Find the START row. */
27929 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27932 /* A row can potentially be the START row if the range of the
27933 characters it displays intersects the range
27934 [START_CHARPOS..END_CHARPOS). */
27935 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27936 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27937 /* See the commentary in row_containing_pos, for the
27938 explanation of the complicated way to check whether
27939 some position is beyond the end of the characters
27940 displayed by a row. */
27941 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27942 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27943 && !row
->ends_at_zv_p
27944 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27945 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27946 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27947 && !row
->ends_at_zv_p
27948 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27950 /* Found a candidate row. Now make sure at least one of the
27951 glyphs it displays has a charpos from the range
27952 [START_CHARPOS..END_CHARPOS).
27954 This is not obvious because bidi reordering could make
27955 buffer positions of a row be 1,2,3,102,101,100, and if we
27956 want to highlight characters in [50..60), we don't want
27957 this row, even though [50..60) does intersect [1..103),
27958 the range of character positions given by the row's start
27959 and end positions. */
27960 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27961 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27965 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27966 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27967 /* A glyph that comes from DISP_STRING is by
27968 definition to be highlighted. */
27969 || EQ (g
->object
, disp_string
))
27978 /* Find the END row. */
27980 /* If the last row is partially visible, start looking for END
27981 from that row, instead of starting from FIRST. */
27982 && !(row
->enabled_p
27983 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27985 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27987 struct glyph_row
*next
= row
+ 1;
27988 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27990 if (!next
->enabled_p
27991 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27992 /* The first row >= START whose range of displayed characters
27993 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27994 is the row END + 1. */
27995 || (start_charpos
< next_start
27996 && end_charpos
< next_start
)
27997 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27998 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27999 && !next
->ends_at_zv_p
28000 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28001 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28002 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28003 && !next
->ends_at_zv_p
28004 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28011 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28012 but none of the characters it displays are in the range, it is
28014 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28015 struct glyph
*s
= g
;
28016 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28020 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28021 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28022 /* If the buffer position of the first glyph in
28023 the row is equal to END_CHARPOS, it means
28024 the last character to be highlighted is the
28025 newline of ROW, and we must consider NEXT as
28027 || (((!next
->reversed_p
&& g
== s
)
28028 || (next
->reversed_p
&& g
== e
- 1))
28029 && (g
->charpos
== end_charpos
28030 /* Special case for when NEXT is an
28031 empty line at ZV. */
28032 || (g
->charpos
== -1
28033 && !row
->ends_at_zv_p
28034 && next_start
== end_charpos
)))))
28035 /* A glyph that comes from DISP_STRING is by
28036 definition to be highlighted. */
28037 || EQ (g
->object
, disp_string
))
28046 /* The first row that ends at ZV must be the last to be
28048 else if (next
->ends_at_zv_p
)
28057 /* This function sets the mouse_face_* elements of HLINFO, assuming
28058 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28059 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28060 for the overlay or run of text properties specifying the mouse
28061 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28062 before-string and after-string that must also be highlighted.
28063 DISP_STRING, if non-nil, is a display string that may cover some
28064 or all of the highlighted text. */
28067 mouse_face_from_buffer_pos (Lisp_Object window
,
28068 Mouse_HLInfo
*hlinfo
,
28069 ptrdiff_t mouse_charpos
,
28070 ptrdiff_t start_charpos
,
28071 ptrdiff_t end_charpos
,
28072 Lisp_Object before_string
,
28073 Lisp_Object after_string
,
28074 Lisp_Object disp_string
)
28076 struct window
*w
= XWINDOW (window
);
28077 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28078 struct glyph_row
*r1
, *r2
;
28079 struct glyph
*glyph
, *end
;
28080 ptrdiff_t ignore
, pos
;
28083 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28084 eassert (NILP (before_string
) || STRINGP (before_string
));
28085 eassert (NILP (after_string
) || STRINGP (after_string
));
28087 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28088 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28090 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28091 /* If the before-string or display-string contains newlines,
28092 rows_from_pos_range skips to its last row. Move back. */
28093 if (!NILP (before_string
) || !NILP (disp_string
))
28095 struct glyph_row
*prev
;
28096 while ((prev
= r1
- 1, prev
>= first
)
28097 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28098 && prev
->used
[TEXT_AREA
] > 0)
28100 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28101 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28102 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28104 || !(EQ (glyph
->object
, before_string
)
28105 || EQ (glyph
->object
, disp_string
)))
28112 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28113 hlinfo
->mouse_face_past_end
= 1;
28115 else if (!NILP (after_string
))
28117 /* If the after-string has newlines, advance to its last row. */
28118 struct glyph_row
*next
;
28119 struct glyph_row
*last
28120 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28122 for (next
= r2
+ 1;
28124 && next
->used
[TEXT_AREA
] > 0
28125 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28129 /* The rest of the display engine assumes that mouse_face_beg_row is
28130 either above mouse_face_end_row or identical to it. But with
28131 bidi-reordered continued lines, the row for START_CHARPOS could
28132 be below the row for END_CHARPOS. If so, swap the rows and store
28133 them in correct order. */
28136 struct glyph_row
*tem
= r2
;
28142 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28143 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28145 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28146 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28147 could be anywhere in the row and in any order. The strategy
28148 below is to find the leftmost and the rightmost glyph that
28149 belongs to either of these 3 strings, or whose position is
28150 between START_CHARPOS and END_CHARPOS, and highlight all the
28151 glyphs between those two. This may cover more than just the text
28152 between START_CHARPOS and END_CHARPOS if the range of characters
28153 strides the bidi level boundary, e.g. if the beginning is in R2L
28154 text while the end is in L2R text or vice versa. */
28155 if (!r1
->reversed_p
)
28157 /* This row is in a left to right paragraph. Scan it left to
28159 glyph
= r1
->glyphs
[TEXT_AREA
];
28160 end
= glyph
+ r1
->used
[TEXT_AREA
];
28163 /* Skip truncation glyphs at the start of the glyph row. */
28164 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28166 && INTEGERP (glyph
->object
)
28167 && glyph
->charpos
< 0;
28169 x
+= glyph
->pixel_width
;
28171 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28172 or DISP_STRING, and the first glyph from buffer whose
28173 position is between START_CHARPOS and END_CHARPOS. */
28175 && !INTEGERP (glyph
->object
)
28176 && !EQ (glyph
->object
, disp_string
)
28177 && !(BUFFERP (glyph
->object
)
28178 && (glyph
->charpos
>= start_charpos
28179 && glyph
->charpos
< end_charpos
));
28182 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28183 are present at buffer positions between START_CHARPOS and
28184 END_CHARPOS, or if they come from an overlay. */
28185 if (EQ (glyph
->object
, before_string
))
28187 pos
= string_buffer_position (before_string
,
28189 /* If pos == 0, it means before_string came from an
28190 overlay, not from a buffer position. */
28191 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28194 else if (EQ (glyph
->object
, after_string
))
28196 pos
= string_buffer_position (after_string
, end_charpos
);
28197 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28200 x
+= glyph
->pixel_width
;
28202 hlinfo
->mouse_face_beg_x
= x
;
28203 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28207 /* This row is in a right to left paragraph. Scan it right to
28211 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28212 glyph
= end
+ r1
->used
[TEXT_AREA
];
28214 /* Skip truncation glyphs at the start of the glyph row. */
28215 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28217 && INTEGERP (glyph
->object
)
28218 && glyph
->charpos
< 0;
28222 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28223 or DISP_STRING, and the first glyph from buffer whose
28224 position is between START_CHARPOS and END_CHARPOS. */
28226 && !INTEGERP (glyph
->object
)
28227 && !EQ (glyph
->object
, disp_string
)
28228 && !(BUFFERP (glyph
->object
)
28229 && (glyph
->charpos
>= start_charpos
28230 && glyph
->charpos
< end_charpos
));
28233 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28234 are present at buffer positions between START_CHARPOS and
28235 END_CHARPOS, or if they come from an overlay. */
28236 if (EQ (glyph
->object
, before_string
))
28238 pos
= string_buffer_position (before_string
, start_charpos
);
28239 /* If pos == 0, it means before_string came from an
28240 overlay, not from a buffer position. */
28241 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28244 else if (EQ (glyph
->object
, after_string
))
28246 pos
= string_buffer_position (after_string
, end_charpos
);
28247 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28252 glyph
++; /* first glyph to the right of the highlighted area */
28253 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28254 x
+= g
->pixel_width
;
28255 hlinfo
->mouse_face_beg_x
= x
;
28256 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28259 /* If the highlight ends in a different row, compute GLYPH and END
28260 for the end row. Otherwise, reuse the values computed above for
28261 the row where the highlight begins. */
28264 if (!r2
->reversed_p
)
28266 glyph
= r2
->glyphs
[TEXT_AREA
];
28267 end
= glyph
+ r2
->used
[TEXT_AREA
];
28272 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28273 glyph
= end
+ r2
->used
[TEXT_AREA
];
28277 if (!r2
->reversed_p
)
28279 /* Skip truncation and continuation glyphs near the end of the
28280 row, and also blanks and stretch glyphs inserted by
28281 extend_face_to_end_of_line. */
28283 && INTEGERP ((end
- 1)->object
))
28285 /* Scan the rest of the glyph row from the end, looking for the
28286 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28287 DISP_STRING, or whose position is between START_CHARPOS
28291 && !INTEGERP (end
->object
)
28292 && !EQ (end
->object
, disp_string
)
28293 && !(BUFFERP (end
->object
)
28294 && (end
->charpos
>= start_charpos
28295 && end
->charpos
< end_charpos
));
28298 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28299 are present at buffer positions between START_CHARPOS and
28300 END_CHARPOS, or if they come from an overlay. */
28301 if (EQ (end
->object
, before_string
))
28303 pos
= string_buffer_position (before_string
, start_charpos
);
28304 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28307 else if (EQ (end
->object
, after_string
))
28309 pos
= string_buffer_position (after_string
, end_charpos
);
28310 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28314 /* Find the X coordinate of the last glyph to be highlighted. */
28315 for (; glyph
<= end
; ++glyph
)
28316 x
+= glyph
->pixel_width
;
28318 hlinfo
->mouse_face_end_x
= x
;
28319 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28323 /* Skip truncation and continuation glyphs near the end of the
28324 row, and also blanks and stretch glyphs inserted by
28325 extend_face_to_end_of_line. */
28329 && INTEGERP (end
->object
))
28331 x
+= end
->pixel_width
;
28334 /* Scan the rest of the glyph row from the end, looking for the
28335 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28336 DISP_STRING, or whose position is between START_CHARPOS
28340 && !INTEGERP (end
->object
)
28341 && !EQ (end
->object
, disp_string
)
28342 && !(BUFFERP (end
->object
)
28343 && (end
->charpos
>= start_charpos
28344 && end
->charpos
< end_charpos
));
28347 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28348 are present at buffer positions between START_CHARPOS and
28349 END_CHARPOS, or if they come from an overlay. */
28350 if (EQ (end
->object
, before_string
))
28352 pos
= string_buffer_position (before_string
, start_charpos
);
28353 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28356 else if (EQ (end
->object
, after_string
))
28358 pos
= string_buffer_position (after_string
, end_charpos
);
28359 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28362 x
+= end
->pixel_width
;
28364 /* If we exited the above loop because we arrived at the last
28365 glyph of the row, and its buffer position is still not in
28366 range, it means the last character in range is the preceding
28367 newline. Bump the end column and x values to get past the
28370 && BUFFERP (end
->object
)
28371 && (end
->charpos
< start_charpos
28372 || end
->charpos
>= end_charpos
))
28374 x
+= end
->pixel_width
;
28377 hlinfo
->mouse_face_end_x
= x
;
28378 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28381 hlinfo
->mouse_face_window
= window
;
28382 hlinfo
->mouse_face_face_id
28383 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28385 !hlinfo
->mouse_face_hidden
, -1);
28386 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28389 /* The following function is not used anymore (replaced with
28390 mouse_face_from_string_pos), but I leave it here for the time
28391 being, in case someone would. */
28393 #if 0 /* not used */
28395 /* Find the position of the glyph for position POS in OBJECT in
28396 window W's current matrix, and return in *X, *Y the pixel
28397 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28399 RIGHT_P non-zero means return the position of the right edge of the
28400 glyph, RIGHT_P zero means return the left edge position.
28402 If no glyph for POS exists in the matrix, return the position of
28403 the glyph with the next smaller position that is in the matrix, if
28404 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28405 exists in the matrix, return the position of the glyph with the
28406 next larger position in OBJECT.
28408 Value is non-zero if a glyph was found. */
28411 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28412 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28414 int yb
= window_text_bottom_y (w
);
28415 struct glyph_row
*r
;
28416 struct glyph
*best_glyph
= NULL
;
28417 struct glyph_row
*best_row
= NULL
;
28420 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28421 r
->enabled_p
&& r
->y
< yb
;
28424 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28425 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28428 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28429 if (EQ (g
->object
, object
))
28431 if (g
->charpos
== pos
)
28438 else if (best_glyph
== NULL
28439 || ((eabs (g
->charpos
- pos
)
28440 < eabs (best_glyph
->charpos
- pos
))
28443 : g
->charpos
> pos
)))
28457 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28461 *x
+= best_glyph
->pixel_width
;
28466 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28469 return best_glyph
!= NULL
;
28471 #endif /* not used */
28473 /* Find the positions of the first and the last glyphs in window W's
28474 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28475 (assumed to be a string), and return in HLINFO's mouse_face_*
28476 members the pixel and column/row coordinates of those glyphs. */
28479 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28480 Lisp_Object object
,
28481 ptrdiff_t startpos
, ptrdiff_t endpos
)
28483 int yb
= window_text_bottom_y (w
);
28484 struct glyph_row
*r
;
28485 struct glyph
*g
, *e
;
28489 /* Find the glyph row with at least one position in the range
28490 [STARTPOS..ENDPOS), and the first glyph in that row whose
28491 position belongs to that range. */
28492 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28493 r
->enabled_p
&& r
->y
< yb
;
28496 if (!r
->reversed_p
)
28498 g
= r
->glyphs
[TEXT_AREA
];
28499 e
= g
+ r
->used
[TEXT_AREA
];
28500 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28501 if (EQ (g
->object
, object
)
28502 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28504 hlinfo
->mouse_face_beg_row
28505 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28506 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28507 hlinfo
->mouse_face_beg_x
= gx
;
28516 e
= r
->glyphs
[TEXT_AREA
];
28517 g
= e
+ r
->used
[TEXT_AREA
];
28518 for ( ; g
> e
; --g
)
28519 if (EQ ((g
-1)->object
, object
)
28520 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28522 hlinfo
->mouse_face_beg_row
28523 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28524 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28525 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28526 gx
+= g1
->pixel_width
;
28527 hlinfo
->mouse_face_beg_x
= gx
;
28539 /* Starting with the next row, look for the first row which does NOT
28540 include any glyphs whose positions are in the range. */
28541 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28543 g
= r
->glyphs
[TEXT_AREA
];
28544 e
= g
+ r
->used
[TEXT_AREA
];
28546 for ( ; g
< e
; ++g
)
28547 if (EQ (g
->object
, object
)
28548 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28557 /* The highlighted region ends on the previous row. */
28560 /* Set the end row. */
28561 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28563 /* Compute and set the end column and the end column's horizontal
28564 pixel coordinate. */
28565 if (!r
->reversed_p
)
28567 g
= r
->glyphs
[TEXT_AREA
];
28568 e
= g
+ r
->used
[TEXT_AREA
];
28569 for ( ; e
> g
; --e
)
28570 if (EQ ((e
-1)->object
, object
)
28571 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28573 hlinfo
->mouse_face_end_col
= e
- g
;
28575 for (gx
= r
->x
; g
< e
; ++g
)
28576 gx
+= g
->pixel_width
;
28577 hlinfo
->mouse_face_end_x
= gx
;
28581 e
= r
->glyphs
[TEXT_AREA
];
28582 g
= e
+ r
->used
[TEXT_AREA
];
28583 for (gx
= r
->x
; e
< g
; ++e
)
28585 if (EQ (e
->object
, object
)
28586 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28588 gx
+= e
->pixel_width
;
28590 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28591 hlinfo
->mouse_face_end_x
= gx
;
28595 #ifdef HAVE_WINDOW_SYSTEM
28597 /* See if position X, Y is within a hot-spot of an image. */
28600 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28602 if (!CONSP (hot_spot
))
28605 if (EQ (XCAR (hot_spot
), Qrect
))
28607 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28608 Lisp_Object rect
= XCDR (hot_spot
);
28612 if (!CONSP (XCAR (rect
)))
28614 if (!CONSP (XCDR (rect
)))
28616 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28618 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28620 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28622 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28626 else if (EQ (XCAR (hot_spot
), Qcircle
))
28628 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28629 Lisp_Object circ
= XCDR (hot_spot
);
28630 Lisp_Object lr
, lx0
, ly0
;
28632 && CONSP (XCAR (circ
))
28633 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28634 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28635 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28637 double r
= XFLOATINT (lr
);
28638 double dx
= XINT (lx0
) - x
;
28639 double dy
= XINT (ly0
) - y
;
28640 return (dx
* dx
+ dy
* dy
<= r
* r
);
28643 else if (EQ (XCAR (hot_spot
), Qpoly
))
28645 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28646 if (VECTORP (XCDR (hot_spot
)))
28648 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28649 Lisp_Object
*poly
= v
->contents
;
28650 ptrdiff_t n
= v
->header
.size
;
28653 Lisp_Object lx
, ly
;
28656 /* Need an even number of coordinates, and at least 3 edges. */
28657 if (n
< 6 || n
& 1)
28660 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28661 If count is odd, we are inside polygon. Pixels on edges
28662 may or may not be included depending on actual geometry of the
28664 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28665 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28667 x0
= XINT (lx
), y0
= XINT (ly
);
28668 for (i
= 0; i
< n
; i
+= 2)
28670 int x1
= x0
, y1
= y0
;
28671 if ((lx
= poly
[i
], !INTEGERP (lx
))
28672 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28674 x0
= XINT (lx
), y0
= XINT (ly
);
28676 /* Does this segment cross the X line? */
28684 if (y
> y0
&& y
> y1
)
28686 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28696 find_hot_spot (Lisp_Object map
, int x
, int y
)
28698 while (CONSP (map
))
28700 if (CONSP (XCAR (map
))
28701 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28709 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28711 doc
: /* Lookup in image map MAP coordinates X and Y.
28712 An image map is an alist where each element has the format (AREA ID PLIST).
28713 An AREA is specified as either a rectangle, a circle, or a polygon:
28714 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28715 pixel coordinates of the upper left and bottom right corners.
28716 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28717 and the radius of the circle; r may be a float or integer.
28718 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28719 vector describes one corner in the polygon.
28720 Returns the alist element for the first matching AREA in MAP. */)
28721 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28729 return find_hot_spot (map
,
28730 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28731 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28735 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28737 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28739 /* Do not change cursor shape while dragging mouse. */
28740 if (!NILP (do_mouse_tracking
))
28743 if (!NILP (pointer
))
28745 if (EQ (pointer
, Qarrow
))
28746 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28747 else if (EQ (pointer
, Qhand
))
28748 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28749 else if (EQ (pointer
, Qtext
))
28750 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28751 else if (EQ (pointer
, intern ("hdrag")))
28752 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28753 else if (EQ (pointer
, intern ("nhdrag")))
28754 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28755 #ifdef HAVE_X_WINDOWS
28756 else if (EQ (pointer
, intern ("vdrag")))
28757 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28759 else if (EQ (pointer
, intern ("hourglass")))
28760 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28761 else if (EQ (pointer
, Qmodeline
))
28762 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28764 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28767 if (cursor
!= No_Cursor
)
28768 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28771 #endif /* HAVE_WINDOW_SYSTEM */
28773 /* Take proper action when mouse has moved to the mode or header line
28774 or marginal area AREA of window W, x-position X and y-position Y.
28775 X is relative to the start of the text display area of W, so the
28776 width of bitmap areas and scroll bars must be subtracted to get a
28777 position relative to the start of the mode line. */
28780 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28781 enum window_part area
)
28783 struct window
*w
= XWINDOW (window
);
28784 struct frame
*f
= XFRAME (w
->frame
);
28785 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28786 #ifdef HAVE_WINDOW_SYSTEM
28787 Display_Info
*dpyinfo
;
28789 Cursor cursor
= No_Cursor
;
28790 Lisp_Object pointer
= Qnil
;
28791 int dx
, dy
, width
, height
;
28793 Lisp_Object string
, object
= Qnil
;
28794 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28796 Lisp_Object mouse_face
;
28797 int original_x_pixel
= x
;
28798 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28799 struct glyph_row
*row
IF_LINT (= 0);
28801 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28806 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28807 returns them in row/column units! */
28808 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28809 &object
, &dx
, &dy
, &width
, &height
);
28811 row
= (area
== ON_MODE_LINE
28812 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28813 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28815 /* Find the glyph under the mouse pointer. */
28816 if (row
->mode_line_p
&& row
->enabled_p
)
28818 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28819 end
= glyph
+ row
->used
[TEXT_AREA
];
28821 for (x0
= original_x_pixel
;
28822 glyph
< end
&& x0
>= glyph
->pixel_width
;
28824 x0
-= glyph
->pixel_width
;
28832 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28833 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28834 returns them in row/column units! */
28835 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28836 &object
, &dx
, &dy
, &width
, &height
);
28841 #ifdef HAVE_WINDOW_SYSTEM
28842 if (IMAGEP (object
))
28844 Lisp_Object image_map
, hotspot
;
28845 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28847 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28849 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28853 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28854 If so, we could look for mouse-enter, mouse-leave
28855 properties in PLIST (and do something...). */
28856 hotspot
= XCDR (hotspot
);
28857 if (CONSP (hotspot
)
28858 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28860 pointer
= Fplist_get (plist
, Qpointer
);
28861 if (NILP (pointer
))
28863 help
= Fplist_get (plist
, Qhelp_echo
);
28866 help_echo_string
= help
;
28867 XSETWINDOW (help_echo_window
, w
);
28868 help_echo_object
= w
->contents
;
28869 help_echo_pos
= charpos
;
28873 if (NILP (pointer
))
28874 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28876 #endif /* HAVE_WINDOW_SYSTEM */
28878 if (STRINGP (string
))
28879 pos
= make_number (charpos
);
28881 /* Set the help text and mouse pointer. If the mouse is on a part
28882 of the mode line without any text (e.g. past the right edge of
28883 the mode line text), use the default help text and pointer. */
28884 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28886 /* Arrange to display the help by setting the global variables
28887 help_echo_string, help_echo_object, and help_echo_pos. */
28890 if (STRINGP (string
))
28891 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28895 help_echo_string
= help
;
28896 XSETWINDOW (help_echo_window
, w
);
28897 help_echo_object
= string
;
28898 help_echo_pos
= charpos
;
28900 else if (area
== ON_MODE_LINE
)
28902 Lisp_Object default_help
28903 = buffer_local_value_1 (Qmode_line_default_help_echo
,
28906 if (STRINGP (default_help
))
28908 help_echo_string
= default_help
;
28909 XSETWINDOW (help_echo_window
, w
);
28910 help_echo_object
= Qnil
;
28911 help_echo_pos
= -1;
28916 #ifdef HAVE_WINDOW_SYSTEM
28917 /* Change the mouse pointer according to what is under it. */
28918 if (FRAME_WINDOW_P (f
))
28920 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28922 || NILP (Vresize_mini_windows
));
28924 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28925 if (STRINGP (string
))
28927 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28929 if (NILP (pointer
))
28930 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28932 /* Change the mouse pointer according to what is under X/Y. */
28934 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28937 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28938 if (!KEYMAPP (map
))
28939 map
= Fget_text_property (pos
, Qkeymap
, string
);
28940 if (!KEYMAPP (map
) && draggable
)
28941 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28944 else if (draggable
)
28945 /* Default mode-line pointer. */
28946 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28951 /* Change the mouse face according to what is under X/Y. */
28952 if (STRINGP (string
))
28954 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28955 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28956 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28961 struct glyph
* tmp_glyph
;
28965 int total_pixel_width
;
28966 ptrdiff_t begpos
, endpos
, ignore
;
28970 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28971 Qmouse_face
, string
, Qnil
);
28977 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28979 endpos
= SCHARS (string
);
28983 /* Calculate the glyph position GPOS of GLYPH in the
28984 displayed string, relative to the beginning of the
28985 highlighted part of the string.
28987 Note: GPOS is different from CHARPOS. CHARPOS is the
28988 position of GLYPH in the internal string object. A mode
28989 line string format has structures which are converted to
28990 a flattened string by the Emacs Lisp interpreter. The
28991 internal string is an element of those structures. The
28992 displayed string is the flattened string. */
28993 tmp_glyph
= row_start_glyph
;
28994 while (tmp_glyph
< glyph
28995 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28996 && begpos
<= tmp_glyph
->charpos
28997 && tmp_glyph
->charpos
< endpos
)))
28999 gpos
= glyph
- tmp_glyph
;
29001 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29002 the highlighted part of the displayed string to which
29003 GLYPH belongs. Note: GSEQ_LENGTH is different from
29004 SCHARS (STRING), because the latter returns the length of
29005 the internal string. */
29006 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29008 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29009 && begpos
<= tmp_glyph
->charpos
29010 && tmp_glyph
->charpos
< endpos
));
29013 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29015 /* Calculate the total pixel width of all the glyphs between
29016 the beginning of the highlighted area and GLYPH. */
29017 total_pixel_width
= 0;
29018 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29019 total_pixel_width
+= tmp_glyph
->pixel_width
;
29021 /* Pre calculation of re-rendering position. Note: X is in
29022 column units here, after the call to mode_line_string or
29023 marginal_area_string. */
29025 vpos
= (area
== ON_MODE_LINE
29026 ? (w
->current_matrix
)->nrows
- 1
29029 /* If GLYPH's position is included in the region that is
29030 already drawn in mouse face, we have nothing to do. */
29031 if ( EQ (window
, hlinfo
->mouse_face_window
)
29032 && (!row
->reversed_p
29033 ? (hlinfo
->mouse_face_beg_col
<= hpos
29034 && hpos
< hlinfo
->mouse_face_end_col
)
29035 /* In R2L rows we swap BEG and END, see below. */
29036 : (hlinfo
->mouse_face_end_col
<= hpos
29037 && hpos
< hlinfo
->mouse_face_beg_col
))
29038 && hlinfo
->mouse_face_beg_row
== vpos
)
29041 if (clear_mouse_face (hlinfo
))
29042 cursor
= No_Cursor
;
29044 if (!row
->reversed_p
)
29046 hlinfo
->mouse_face_beg_col
= hpos
;
29047 hlinfo
->mouse_face_beg_x
= original_x_pixel
29048 - (total_pixel_width
+ dx
);
29049 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29050 hlinfo
->mouse_face_end_x
= 0;
29054 /* In R2L rows, show_mouse_face expects BEG and END
29055 coordinates to be swapped. */
29056 hlinfo
->mouse_face_end_col
= hpos
;
29057 hlinfo
->mouse_face_end_x
= original_x_pixel
29058 - (total_pixel_width
+ dx
);
29059 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29060 hlinfo
->mouse_face_beg_x
= 0;
29063 hlinfo
->mouse_face_beg_row
= vpos
;
29064 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29065 hlinfo
->mouse_face_past_end
= 0;
29066 hlinfo
->mouse_face_window
= window
;
29068 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29073 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29075 if (NILP (pointer
))
29078 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29079 clear_mouse_face (hlinfo
);
29081 #ifdef HAVE_WINDOW_SYSTEM
29082 if (FRAME_WINDOW_P (f
))
29083 define_frame_cursor1 (f
, cursor
, pointer
);
29089 Take proper action when the mouse has moved to position X, Y on
29090 frame F with regards to highlighting portions of display that have
29091 mouse-face properties. Also de-highlight portions of display where
29092 the mouse was before, set the mouse pointer shape as appropriate
29093 for the mouse coordinates, and activate help echo (tooltips).
29094 X and Y can be negative or out of range. */
29097 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29099 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29100 enum window_part part
= ON_NOTHING
;
29101 Lisp_Object window
;
29103 Cursor cursor
= No_Cursor
;
29104 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29107 /* When a menu is active, don't highlight because this looks odd. */
29108 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29109 if (popup_activated ())
29113 if (!f
->glyphs_initialized_p
29114 || f
->pointer_invisible
)
29117 hlinfo
->mouse_face_mouse_x
= x
;
29118 hlinfo
->mouse_face_mouse_y
= y
;
29119 hlinfo
->mouse_face_mouse_frame
= f
;
29121 if (hlinfo
->mouse_face_defer
)
29124 /* Which window is that in? */
29125 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29127 /* If displaying active text in another window, clear that. */
29128 if (! EQ (window
, hlinfo
->mouse_face_window
)
29129 /* Also clear if we move out of text area in same window. */
29130 || (!NILP (hlinfo
->mouse_face_window
)
29133 && part
!= ON_MODE_LINE
29134 && part
!= ON_HEADER_LINE
))
29135 clear_mouse_face (hlinfo
);
29137 /* Not on a window -> return. */
29138 if (!WINDOWP (window
))
29141 /* Reset help_echo_string. It will get recomputed below. */
29142 help_echo_string
= Qnil
;
29144 /* Convert to window-relative pixel coordinates. */
29145 w
= XWINDOW (window
);
29146 frame_to_window_pixel_xy (w
, &x
, &y
);
29148 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29149 /* Handle tool-bar window differently since it doesn't display a
29151 if (EQ (window
, f
->tool_bar_window
))
29153 note_tool_bar_highlight (f
, x
, y
);
29158 /* Mouse is on the mode, header line or margin? */
29159 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29160 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29162 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29164 #ifdef HAVE_WINDOW_SYSTEM
29165 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29167 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29168 /* Show non-text cursor (Bug#16647). */
29176 #ifdef HAVE_WINDOW_SYSTEM
29177 if (part
== ON_VERTICAL_BORDER
)
29179 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29180 help_echo_string
= build_string ("drag-mouse-1: resize");
29182 else if (part
== ON_RIGHT_DIVIDER
)
29184 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29185 help_echo_string
= build_string ("drag-mouse-1: resize");
29187 else if (part
== ON_BOTTOM_DIVIDER
)
29188 if (! WINDOW_BOTTOMMOST_P (w
)
29190 || NILP (Vresize_mini_windows
))
29192 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29193 help_echo_string
= build_string ("drag-mouse-1: resize");
29196 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29197 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29198 || part
== ON_SCROLL_BAR
)
29199 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29201 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29204 /* Are we in a window whose display is up to date?
29205 And verify the buffer's text has not changed. */
29206 b
= XBUFFER (w
->contents
);
29207 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29209 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29211 struct glyph
*glyph
;
29212 Lisp_Object object
;
29213 Lisp_Object mouse_face
= Qnil
, position
;
29214 Lisp_Object
*overlay_vec
= NULL
;
29215 ptrdiff_t i
, noverlays
;
29216 struct buffer
*obuf
;
29217 ptrdiff_t obegv
, ozv
;
29220 /* Find the glyph under X/Y. */
29221 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29223 #ifdef HAVE_WINDOW_SYSTEM
29224 /* Look for :pointer property on image. */
29225 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29227 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29228 if (img
!= NULL
&& IMAGEP (img
->spec
))
29230 Lisp_Object image_map
, hotspot
;
29231 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29233 && (hotspot
= find_hot_spot (image_map
,
29234 glyph
->slice
.img
.x
+ dx
,
29235 glyph
->slice
.img
.y
+ dy
),
29237 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29241 /* Could check XCAR (hotspot) to see if we enter/leave
29243 If so, we could look for mouse-enter, mouse-leave
29244 properties in PLIST (and do something...). */
29245 hotspot
= XCDR (hotspot
);
29246 if (CONSP (hotspot
)
29247 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29249 pointer
= Fplist_get (plist
, Qpointer
);
29250 if (NILP (pointer
))
29252 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29253 if (!NILP (help_echo_string
))
29255 help_echo_window
= window
;
29256 help_echo_object
= glyph
->object
;
29257 help_echo_pos
= glyph
->charpos
;
29261 if (NILP (pointer
))
29262 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29265 #endif /* HAVE_WINDOW_SYSTEM */
29267 /* Clear mouse face if X/Y not over text. */
29269 || area
!= TEXT_AREA
29270 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29271 /* Glyph's OBJECT is an integer for glyphs inserted by the
29272 display engine for its internal purposes, like truncation
29273 and continuation glyphs and blanks beyond the end of
29274 line's text on text terminals. If we are over such a
29275 glyph, we are not over any text. */
29276 || INTEGERP (glyph
->object
)
29277 /* R2L rows have a stretch glyph at their front, which
29278 stands for no text, whereas L2R rows have no glyphs at
29279 all beyond the end of text. Treat such stretch glyphs
29280 like we do with NULL glyphs in L2R rows. */
29281 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29282 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29283 && glyph
->type
== STRETCH_GLYPH
29284 && glyph
->avoid_cursor_p
))
29286 if (clear_mouse_face (hlinfo
))
29287 cursor
= No_Cursor
;
29288 #ifdef HAVE_WINDOW_SYSTEM
29289 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29291 if (area
!= TEXT_AREA
)
29292 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29294 pointer
= Vvoid_text_area_pointer
;
29300 pos
= glyph
->charpos
;
29301 object
= glyph
->object
;
29302 if (!STRINGP (object
) && !BUFFERP (object
))
29305 /* If we get an out-of-range value, return now; avoid an error. */
29306 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29309 /* Make the window's buffer temporarily current for
29310 overlays_at and compute_char_face. */
29311 obuf
= current_buffer
;
29312 current_buffer
= b
;
29318 /* Is this char mouse-active or does it have help-echo? */
29319 position
= make_number (pos
);
29321 if (BUFFERP (object
))
29323 /* Put all the overlays we want in a vector in overlay_vec. */
29324 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29325 /* Sort overlays into increasing priority order. */
29326 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29331 if (NILP (Vmouse_highlight
))
29333 clear_mouse_face (hlinfo
);
29334 goto check_help_echo
;
29337 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29340 cursor
= No_Cursor
;
29342 /* Check mouse-face highlighting. */
29344 /* If there exists an overlay with mouse-face overlapping
29345 the one we are currently highlighting, we have to
29346 check if we enter the overlapping overlay, and then
29347 highlight only that. */
29348 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29349 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29351 /* Find the highest priority overlay with a mouse-face. */
29352 Lisp_Object overlay
= Qnil
;
29353 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29355 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29356 if (!NILP (mouse_face
))
29357 overlay
= overlay_vec
[i
];
29360 /* If we're highlighting the same overlay as before, there's
29361 no need to do that again. */
29362 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29363 goto check_help_echo
;
29364 hlinfo
->mouse_face_overlay
= overlay
;
29366 /* Clear the display of the old active region, if any. */
29367 if (clear_mouse_face (hlinfo
))
29368 cursor
= No_Cursor
;
29370 /* If no overlay applies, get a text property. */
29371 if (NILP (overlay
))
29372 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29374 /* Next, compute the bounds of the mouse highlighting and
29376 if (!NILP (mouse_face
) && STRINGP (object
))
29378 /* The mouse-highlighting comes from a display string
29379 with a mouse-face. */
29383 s
= Fprevious_single_property_change
29384 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29385 e
= Fnext_single_property_change
29386 (position
, Qmouse_face
, object
, Qnil
);
29388 s
= make_number (0);
29390 e
= make_number (SCHARS (object
));
29391 mouse_face_from_string_pos (w
, hlinfo
, object
,
29392 XINT (s
), XINT (e
));
29393 hlinfo
->mouse_face_past_end
= 0;
29394 hlinfo
->mouse_face_window
= window
;
29395 hlinfo
->mouse_face_face_id
29396 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29397 glyph
->face_id
, 1);
29398 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29399 cursor
= No_Cursor
;
29403 /* The mouse-highlighting, if any, comes from an overlay
29404 or text property in the buffer. */
29405 Lisp_Object buffer
IF_LINT (= Qnil
);
29406 Lisp_Object disp_string
IF_LINT (= Qnil
);
29408 if (STRINGP (object
))
29410 /* If we are on a display string with no mouse-face,
29411 check if the text under it has one. */
29412 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29413 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29414 pos
= string_buffer_position (object
, start
);
29417 mouse_face
= get_char_property_and_overlay
29418 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29419 buffer
= w
->contents
;
29420 disp_string
= object
;
29426 disp_string
= Qnil
;
29429 if (!NILP (mouse_face
))
29431 Lisp_Object before
, after
;
29432 Lisp_Object before_string
, after_string
;
29433 /* To correctly find the limits of mouse highlight
29434 in a bidi-reordered buffer, we must not use the
29435 optimization of limiting the search in
29436 previous-single-property-change and
29437 next-single-property-change, because
29438 rows_from_pos_range needs the real start and end
29439 positions to DTRT in this case. That's because
29440 the first row visible in a window does not
29441 necessarily display the character whose position
29442 is the smallest. */
29444 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29445 ? Fmarker_position (w
->start
)
29448 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29449 ? make_number (BUF_Z (XBUFFER (buffer
))
29450 - w
->window_end_pos
)
29453 if (NILP (overlay
))
29455 /* Handle the text property case. */
29456 before
= Fprevious_single_property_change
29457 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29458 after
= Fnext_single_property_change
29459 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29460 before_string
= after_string
= Qnil
;
29464 /* Handle the overlay case. */
29465 before
= Foverlay_start (overlay
);
29466 after
= Foverlay_end (overlay
);
29467 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29468 after_string
= Foverlay_get (overlay
, Qafter_string
);
29470 if (!STRINGP (before_string
)) before_string
= Qnil
;
29471 if (!STRINGP (after_string
)) after_string
= Qnil
;
29474 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29477 : XFASTINT (before
),
29479 ? BUF_Z (XBUFFER (buffer
))
29480 : XFASTINT (after
),
29481 before_string
, after_string
,
29483 cursor
= No_Cursor
;
29490 /* Look for a `help-echo' property. */
29491 if (NILP (help_echo_string
)) {
29492 Lisp_Object help
, overlay
;
29494 /* Check overlays first. */
29495 help
= overlay
= Qnil
;
29496 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29498 overlay
= overlay_vec
[i
];
29499 help
= Foverlay_get (overlay
, Qhelp_echo
);
29504 help_echo_string
= help
;
29505 help_echo_window
= window
;
29506 help_echo_object
= overlay
;
29507 help_echo_pos
= pos
;
29511 Lisp_Object obj
= glyph
->object
;
29512 ptrdiff_t charpos
= glyph
->charpos
;
29514 /* Try text properties. */
29517 && charpos
< SCHARS (obj
))
29519 help
= Fget_text_property (make_number (charpos
),
29523 /* If the string itself doesn't specify a help-echo,
29524 see if the buffer text ``under'' it does. */
29525 struct glyph_row
*r
29526 = MATRIX_ROW (w
->current_matrix
, vpos
);
29527 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29528 ptrdiff_t p
= string_buffer_position (obj
, start
);
29531 help
= Fget_char_property (make_number (p
),
29532 Qhelp_echo
, w
->contents
);
29541 else if (BUFFERP (obj
)
29544 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29549 help_echo_string
= help
;
29550 help_echo_window
= window
;
29551 help_echo_object
= obj
;
29552 help_echo_pos
= charpos
;
29557 #ifdef HAVE_WINDOW_SYSTEM
29558 /* Look for a `pointer' property. */
29559 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29561 /* Check overlays first. */
29562 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29563 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29565 if (NILP (pointer
))
29567 Lisp_Object obj
= glyph
->object
;
29568 ptrdiff_t charpos
= glyph
->charpos
;
29570 /* Try text properties. */
29573 && charpos
< SCHARS (obj
))
29575 pointer
= Fget_text_property (make_number (charpos
),
29577 if (NILP (pointer
))
29579 /* If the string itself doesn't specify a pointer,
29580 see if the buffer text ``under'' it does. */
29581 struct glyph_row
*r
29582 = MATRIX_ROW (w
->current_matrix
, vpos
);
29583 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29584 ptrdiff_t p
= string_buffer_position (obj
, start
);
29586 pointer
= Fget_char_property (make_number (p
),
29587 Qpointer
, w
->contents
);
29590 else if (BUFFERP (obj
)
29593 pointer
= Fget_text_property (make_number (charpos
),
29597 #endif /* HAVE_WINDOW_SYSTEM */
29601 current_buffer
= obuf
;
29606 #ifdef HAVE_WINDOW_SYSTEM
29607 if (FRAME_WINDOW_P (f
))
29608 define_frame_cursor1 (f
, cursor
, pointer
);
29610 /* This is here to prevent a compiler error, about "label at end of
29611 compound statement". */
29618 Clear any mouse-face on window W. This function is part of the
29619 redisplay interface, and is called from try_window_id and similar
29620 functions to ensure the mouse-highlight is off. */
29623 x_clear_window_mouse_face (struct window
*w
)
29625 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29626 Lisp_Object window
;
29629 XSETWINDOW (window
, w
);
29630 if (EQ (window
, hlinfo
->mouse_face_window
))
29631 clear_mouse_face (hlinfo
);
29637 Just discard the mouse face information for frame F, if any.
29638 This is used when the size of F is changed. */
29641 cancel_mouse_face (struct frame
*f
)
29643 Lisp_Object window
;
29644 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29646 window
= hlinfo
->mouse_face_window
;
29647 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29648 reset_mouse_highlight (hlinfo
);
29653 /***********************************************************************
29655 ***********************************************************************/
29657 #ifdef HAVE_WINDOW_SYSTEM
29659 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29660 which intersects rectangle R. R is in window-relative coordinates. */
29663 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29664 enum glyph_row_area area
)
29666 struct glyph
*first
= row
->glyphs
[area
];
29667 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29668 struct glyph
*last
;
29669 int first_x
, start_x
, x
;
29671 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29672 /* If row extends face to end of line write the whole line. */
29673 draw_glyphs (w
, 0, row
, area
,
29674 0, row
->used
[area
],
29675 DRAW_NORMAL_TEXT
, 0);
29678 /* Set START_X to the window-relative start position for drawing glyphs of
29679 AREA. The first glyph of the text area can be partially visible.
29680 The first glyphs of other areas cannot. */
29681 start_x
= window_box_left_offset (w
, area
);
29683 if (area
== TEXT_AREA
)
29686 /* Find the first glyph that must be redrawn. */
29688 && x
+ first
->pixel_width
< r
->x
)
29690 x
+= first
->pixel_width
;
29694 /* Find the last one. */
29698 && x
< r
->x
+ r
->width
)
29700 x
+= last
->pixel_width
;
29706 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29707 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29708 DRAW_NORMAL_TEXT
, 0);
29713 /* Redraw the parts of the glyph row ROW on window W intersecting
29714 rectangle R. R is in window-relative coordinates. Value is
29715 non-zero if mouse-face was overwritten. */
29718 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29720 eassert (row
->enabled_p
);
29722 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29723 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29724 0, row
->used
[TEXT_AREA
],
29725 DRAW_NORMAL_TEXT
, 0);
29728 if (row
->used
[LEFT_MARGIN_AREA
])
29729 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29730 if (row
->used
[TEXT_AREA
])
29731 expose_area (w
, row
, r
, TEXT_AREA
);
29732 if (row
->used
[RIGHT_MARGIN_AREA
])
29733 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29734 draw_row_fringe_bitmaps (w
, row
);
29737 return row
->mouse_face_p
;
29741 /* Redraw those parts of glyphs rows during expose event handling that
29742 overlap other rows. Redrawing of an exposed line writes over parts
29743 of lines overlapping that exposed line; this function fixes that.
29745 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29746 row in W's current matrix that is exposed and overlaps other rows.
29747 LAST_OVERLAPPING_ROW is the last such row. */
29750 expose_overlaps (struct window
*w
,
29751 struct glyph_row
*first_overlapping_row
,
29752 struct glyph_row
*last_overlapping_row
,
29755 struct glyph_row
*row
;
29757 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29758 if (row
->overlapping_p
)
29760 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29763 if (row
->used
[LEFT_MARGIN_AREA
])
29764 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29766 if (row
->used
[TEXT_AREA
])
29767 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29769 if (row
->used
[RIGHT_MARGIN_AREA
])
29770 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29776 /* Return non-zero if W's cursor intersects rectangle R. */
29779 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29781 XRectangle cr
, result
;
29782 struct glyph
*cursor_glyph
;
29783 struct glyph_row
*row
;
29785 if (w
->phys_cursor
.vpos
>= 0
29786 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29787 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29789 && row
->cursor_in_fringe_p
)
29791 /* Cursor is in the fringe. */
29792 cr
.x
= window_box_right_offset (w
,
29793 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29794 ? RIGHT_MARGIN_AREA
29797 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29798 cr
.height
= row
->height
;
29799 return x_intersect_rectangles (&cr
, r
, &result
);
29802 cursor_glyph
= get_phys_cursor_glyph (w
);
29805 /* r is relative to W's box, but w->phys_cursor.x is relative
29806 to left edge of W's TEXT area. Adjust it. */
29807 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29808 cr
.y
= w
->phys_cursor
.y
;
29809 cr
.width
= cursor_glyph
->pixel_width
;
29810 cr
.height
= w
->phys_cursor_height
;
29811 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29812 I assume the effect is the same -- and this is portable. */
29813 return x_intersect_rectangles (&cr
, r
, &result
);
29815 /* If we don't understand the format, pretend we're not in the hot-spot. */
29821 Draw a vertical window border to the right of window W if W doesn't
29822 have vertical scroll bars. */
29825 x_draw_vertical_border (struct window
*w
)
29827 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29829 /* We could do better, if we knew what type of scroll-bar the adjacent
29830 windows (on either side) have... But we don't :-(
29831 However, I think this works ok. ++KFS 2003-04-25 */
29833 /* Redraw borders between horizontally adjacent windows. Don't
29834 do it for frames with vertical scroll bars because either the
29835 right scroll bar of a window, or the left scroll bar of its
29836 neighbor will suffice as a border. */
29837 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29840 /* Note: It is necessary to redraw both the left and the right
29841 borders, for when only this single window W is being
29843 if (!WINDOW_RIGHTMOST_P (w
)
29844 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29846 int x0
, x1
, y0
, y1
;
29848 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29851 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29854 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29857 if (!WINDOW_LEFTMOST_P (w
)
29858 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29860 int x0
, x1
, y0
, y1
;
29862 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29865 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29868 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29873 /* Draw window dividers for window W. */
29876 x_draw_right_divider (struct window
*w
)
29878 struct frame
*f
= WINDOW_XFRAME (w
);
29880 if (w
->mini
|| w
->pseudo_window_p
)
29882 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29884 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29885 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29886 int y0
= WINDOW_TOP_EDGE_Y (w
);
29887 /* The bottom divider prevails. */
29888 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29890 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29895 x_draw_bottom_divider (struct window
*w
)
29897 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29899 if (w
->mini
|| w
->pseudo_window_p
)
29901 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29903 int x0
= WINDOW_LEFT_EDGE_X (w
);
29904 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29905 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29906 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29908 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29912 /* Redraw the part of window W intersection rectangle FR. Pixel
29913 coordinates in FR are frame-relative. Call this function with
29914 input blocked. Value is non-zero if the exposure overwrites
29918 expose_window (struct window
*w
, XRectangle
*fr
)
29920 struct frame
*f
= XFRAME (w
->frame
);
29922 int mouse_face_overwritten_p
= 0;
29924 /* If window is not yet fully initialized, do nothing. This can
29925 happen when toolkit scroll bars are used and a window is split.
29926 Reconfiguring the scroll bar will generate an expose for a newly
29928 if (w
->current_matrix
== NULL
)
29931 /* When we're currently updating the window, display and current
29932 matrix usually don't agree. Arrange for a thorough display
29934 if (w
->must_be_updated_p
)
29936 SET_FRAME_GARBAGED (f
);
29940 /* Frame-relative pixel rectangle of W. */
29941 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29942 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29943 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29944 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29946 if (x_intersect_rectangles (fr
, &wr
, &r
))
29948 int yb
= window_text_bottom_y (w
);
29949 struct glyph_row
*row
;
29950 int cursor_cleared_p
, phys_cursor_on_p
;
29951 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29953 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29954 r
.x
, r
.y
, r
.width
, r
.height
));
29956 /* Convert to window coordinates. */
29957 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29958 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29960 /* Turn off the cursor. */
29961 if (!w
->pseudo_window_p
29962 && phys_cursor_in_rect_p (w
, &r
))
29964 x_clear_cursor (w
);
29965 cursor_cleared_p
= 1;
29968 cursor_cleared_p
= 0;
29970 /* If the row containing the cursor extends face to end of line,
29971 then expose_area might overwrite the cursor outside the
29972 rectangle and thus notice_overwritten_cursor might clear
29973 w->phys_cursor_on_p. We remember the original value and
29974 check later if it is changed. */
29975 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29977 /* Update lines intersecting rectangle R. */
29978 first_overlapping_row
= last_overlapping_row
= NULL
;
29979 for (row
= w
->current_matrix
->rows
;
29984 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29986 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29987 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29988 || (r
.y
>= y0
&& r
.y
< y1
)
29989 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29991 /* A header line may be overlapping, but there is no need
29992 to fix overlapping areas for them. KFS 2005-02-12 */
29993 if (row
->overlapping_p
&& !row
->mode_line_p
)
29995 if (first_overlapping_row
== NULL
)
29996 first_overlapping_row
= row
;
29997 last_overlapping_row
= row
;
30001 if (expose_line (w
, row
, &r
))
30002 mouse_face_overwritten_p
= 1;
30005 else if (row
->overlapping_p
)
30007 /* We must redraw a row overlapping the exposed area. */
30009 ? y0
+ row
->phys_height
> r
.y
30010 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30012 if (first_overlapping_row
== NULL
)
30013 first_overlapping_row
= row
;
30014 last_overlapping_row
= row
;
30022 /* Display the mode line if there is one. */
30023 if (WINDOW_WANTS_MODELINE_P (w
)
30024 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30026 && row
->y
< r
.y
+ r
.height
)
30028 if (expose_line (w
, row
, &r
))
30029 mouse_face_overwritten_p
= 1;
30032 if (!w
->pseudo_window_p
)
30034 /* Fix the display of overlapping rows. */
30035 if (first_overlapping_row
)
30036 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30039 /* Draw border between windows. */
30040 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30041 x_draw_right_divider (w
);
30043 x_draw_vertical_border (w
);
30045 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30046 x_draw_bottom_divider (w
);
30048 /* Turn the cursor on again. */
30049 if (cursor_cleared_p
30050 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30051 update_window_cursor (w
, 1);
30055 return mouse_face_overwritten_p
;
30060 /* Redraw (parts) of all windows in the window tree rooted at W that
30061 intersect R. R contains frame pixel coordinates. Value is
30062 non-zero if the exposure overwrites mouse-face. */
30065 expose_window_tree (struct window
*w
, XRectangle
*r
)
30067 struct frame
*f
= XFRAME (w
->frame
);
30068 int mouse_face_overwritten_p
= 0;
30070 while (w
&& !FRAME_GARBAGED_P (f
))
30072 if (WINDOWP (w
->contents
))
30073 mouse_face_overwritten_p
30074 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30076 mouse_face_overwritten_p
|= expose_window (w
, r
);
30078 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30081 return mouse_face_overwritten_p
;
30086 Redisplay an exposed area of frame F. X and Y are the upper-left
30087 corner of the exposed rectangle. W and H are width and height of
30088 the exposed area. All are pixel values. W or H zero means redraw
30089 the entire frame. */
30092 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30095 int mouse_face_overwritten_p
= 0;
30097 TRACE ((stderr
, "expose_frame "));
30099 /* No need to redraw if frame will be redrawn soon. */
30100 if (FRAME_GARBAGED_P (f
))
30102 TRACE ((stderr
, " garbaged\n"));
30106 /* If basic faces haven't been realized yet, there is no point in
30107 trying to redraw anything. This can happen when we get an expose
30108 event while Emacs is starting, e.g. by moving another window. */
30109 if (FRAME_FACE_CACHE (f
) == NULL
30110 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30112 TRACE ((stderr
, " no faces\n"));
30116 if (w
== 0 || h
== 0)
30119 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
30120 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
30130 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30131 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30133 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30134 if (WINDOWP (f
->tool_bar_window
))
30135 mouse_face_overwritten_p
30136 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30139 #ifdef HAVE_X_WINDOWS
30141 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30142 if (WINDOWP (f
->menu_bar_window
))
30143 mouse_face_overwritten_p
30144 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30145 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30149 /* Some window managers support a focus-follows-mouse style with
30150 delayed raising of frames. Imagine a partially obscured frame,
30151 and moving the mouse into partially obscured mouse-face on that
30152 frame. The visible part of the mouse-face will be highlighted,
30153 then the WM raises the obscured frame. With at least one WM, KDE
30154 2.1, Emacs is not getting any event for the raising of the frame
30155 (even tried with SubstructureRedirectMask), only Expose events.
30156 These expose events will draw text normally, i.e. not
30157 highlighted. Which means we must redo the highlight here.
30158 Subsume it under ``we love X''. --gerd 2001-08-15 */
30159 /* Included in Windows version because Windows most likely does not
30160 do the right thing if any third party tool offers
30161 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30162 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30164 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30165 if (f
== hlinfo
->mouse_face_mouse_frame
)
30167 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30168 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30169 clear_mouse_face (hlinfo
);
30170 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30177 Determine the intersection of two rectangles R1 and R2. Return
30178 the intersection in *RESULT. Value is non-zero if RESULT is not
30182 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30184 XRectangle
*left
, *right
;
30185 XRectangle
*upper
, *lower
;
30186 int intersection_p
= 0;
30188 /* Rearrange so that R1 is the left-most rectangle. */
30190 left
= r1
, right
= r2
;
30192 left
= r2
, right
= r1
;
30194 /* X0 of the intersection is right.x0, if this is inside R1,
30195 otherwise there is no intersection. */
30196 if (right
->x
<= left
->x
+ left
->width
)
30198 result
->x
= right
->x
;
30200 /* The right end of the intersection is the minimum of
30201 the right ends of left and right. */
30202 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30205 /* Same game for Y. */
30207 upper
= r1
, lower
= r2
;
30209 upper
= r2
, lower
= r1
;
30211 /* The upper end of the intersection is lower.y0, if this is inside
30212 of upper. Otherwise, there is no intersection. */
30213 if (lower
->y
<= upper
->y
+ upper
->height
)
30215 result
->y
= lower
->y
;
30217 /* The lower end of the intersection is the minimum of the lower
30218 ends of upper and lower. */
30219 result
->height
= (min (lower
->y
+ lower
->height
,
30220 upper
->y
+ upper
->height
)
30222 intersection_p
= 1;
30226 return intersection_p
;
30229 #endif /* HAVE_WINDOW_SYSTEM */
30232 /***********************************************************************
30234 ***********************************************************************/
30237 syms_of_xdisp (void)
30239 Vwith_echo_area_save_vector
= Qnil
;
30240 staticpro (&Vwith_echo_area_save_vector
);
30242 Vmessage_stack
= Qnil
;
30243 staticpro (&Vmessage_stack
);
30245 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30246 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30248 message_dolog_marker1
= Fmake_marker ();
30249 staticpro (&message_dolog_marker1
);
30250 message_dolog_marker2
= Fmake_marker ();
30251 staticpro (&message_dolog_marker2
);
30252 message_dolog_marker3
= Fmake_marker ();
30253 staticpro (&message_dolog_marker3
);
30256 defsubr (&Sdump_frame_glyph_matrix
);
30257 defsubr (&Sdump_glyph_matrix
);
30258 defsubr (&Sdump_glyph_row
);
30259 defsubr (&Sdump_tool_bar_row
);
30260 defsubr (&Strace_redisplay
);
30261 defsubr (&Strace_to_stderr
);
30263 #ifdef HAVE_WINDOW_SYSTEM
30264 defsubr (&Stool_bar_height
);
30265 defsubr (&Slookup_image_map
);
30267 defsubr (&Sline_pixel_height
);
30268 defsubr (&Sformat_mode_line
);
30269 defsubr (&Sinvisible_p
);
30270 defsubr (&Scurrent_bidi_paragraph_direction
);
30271 defsubr (&Swindow_text_pixel_size
);
30272 defsubr (&Smove_point_visually
);
30274 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30275 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30276 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30277 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30278 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30279 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30280 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30281 DEFSYM (Qeval
, "eval");
30282 DEFSYM (QCdata
, ":data");
30283 DEFSYM (Qdisplay
, "display");
30284 DEFSYM (Qspace_width
, "space-width");
30285 DEFSYM (Qraise
, "raise");
30286 DEFSYM (Qslice
, "slice");
30287 DEFSYM (Qspace
, "space");
30288 DEFSYM (Qmargin
, "margin");
30289 DEFSYM (Qpointer
, "pointer");
30290 DEFSYM (Qleft_margin
, "left-margin");
30291 DEFSYM (Qright_margin
, "right-margin");
30292 DEFSYM (Qcenter
, "center");
30293 DEFSYM (Qline_height
, "line-height");
30294 DEFSYM (QCalign_to
, ":align-to");
30295 DEFSYM (QCrelative_width
, ":relative-width");
30296 DEFSYM (QCrelative_height
, ":relative-height");
30297 DEFSYM (QCeval
, ":eval");
30298 DEFSYM (QCpropertize
, ":propertize");
30299 DEFSYM (QCfile
, ":file");
30300 DEFSYM (Qfontified
, "fontified");
30301 DEFSYM (Qfontification_functions
, "fontification-functions");
30302 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30303 DEFSYM (Qescape_glyph
, "escape-glyph");
30304 DEFSYM (Qnobreak_space
, "nobreak-space");
30305 DEFSYM (Qimage
, "image");
30306 DEFSYM (Qtext
, "text");
30307 DEFSYM (Qboth
, "both");
30308 DEFSYM (Qboth_horiz
, "both-horiz");
30309 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30310 DEFSYM (QCmap
, ":map");
30311 DEFSYM (QCpointer
, ":pointer");
30312 DEFSYM (Qrect
, "rect");
30313 DEFSYM (Qcircle
, "circle");
30314 DEFSYM (Qpoly
, "poly");
30315 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30316 DEFSYM (Qgrow_only
, "grow-only");
30317 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30318 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30319 DEFSYM (Qposition
, "position");
30320 DEFSYM (Qbuffer_position
, "buffer-position");
30321 DEFSYM (Qobject
, "object");
30322 DEFSYM (Qbar
, "bar");
30323 DEFSYM (Qhbar
, "hbar");
30324 DEFSYM (Qbox
, "box");
30325 DEFSYM (Qhollow
, "hollow");
30326 DEFSYM (Qhand
, "hand");
30327 DEFSYM (Qarrow
, "arrow");
30328 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30330 list_of_error
= list1 (list2 (intern_c_string ("error"),
30331 intern_c_string ("void-variable")));
30332 staticpro (&list_of_error
);
30334 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30335 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30336 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30337 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30339 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30340 staticpro (&echo_buffer
[0]);
30341 staticpro (&echo_buffer
[1]);
30343 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30344 staticpro (&echo_area_buffer
[0]);
30345 staticpro (&echo_area_buffer
[1]);
30347 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30348 staticpro (&Vmessages_buffer_name
);
30350 mode_line_proptrans_alist
= Qnil
;
30351 staticpro (&mode_line_proptrans_alist
);
30352 mode_line_string_list
= Qnil
;
30353 staticpro (&mode_line_string_list
);
30354 mode_line_string_face
= Qnil
;
30355 staticpro (&mode_line_string_face
);
30356 mode_line_string_face_prop
= Qnil
;
30357 staticpro (&mode_line_string_face_prop
);
30358 Vmode_line_unwind_vector
= Qnil
;
30359 staticpro (&Vmode_line_unwind_vector
);
30361 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30363 help_echo_string
= Qnil
;
30364 staticpro (&help_echo_string
);
30365 help_echo_object
= Qnil
;
30366 staticpro (&help_echo_object
);
30367 help_echo_window
= Qnil
;
30368 staticpro (&help_echo_window
);
30369 previous_help_echo_string
= Qnil
;
30370 staticpro (&previous_help_echo_string
);
30371 help_echo_pos
= -1;
30373 DEFSYM (Qright_to_left
, "right-to-left");
30374 DEFSYM (Qleft_to_right
, "left-to-right");
30376 #ifdef HAVE_WINDOW_SYSTEM
30377 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30378 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30379 For example, if a block cursor is over a tab, it will be drawn as
30380 wide as that tab on the display. */);
30381 x_stretch_cursor_p
= 0;
30384 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30385 doc
: /* Non-nil means highlight trailing whitespace.
30386 The face used for trailing whitespace is `trailing-whitespace'. */);
30387 Vshow_trailing_whitespace
= Qnil
;
30389 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30390 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30391 If the value is t, Emacs highlights non-ASCII chars which have the
30392 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30393 or `escape-glyph' face respectively.
30395 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30396 U+2011 (non-breaking hyphen) are affected.
30398 Any other non-nil value means to display these characters as a escape
30399 glyph followed by an ordinary space or hyphen.
30401 A value of nil means no special handling of these characters. */);
30402 Vnobreak_char_display
= Qt
;
30404 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30405 doc
: /* The pointer shape to show in void text areas.
30406 A value of nil means to show the text pointer. Other options are `arrow',
30407 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30408 Vvoid_text_area_pointer
= Qarrow
;
30410 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30411 doc
: /* Non-nil means don't actually do any redisplay.
30412 This is used for internal purposes. */);
30413 Vinhibit_redisplay
= Qnil
;
30415 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30416 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30417 Vglobal_mode_string
= Qnil
;
30419 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30420 doc
: /* Marker for where to display an arrow on top of the buffer text.
30421 This must be the beginning of a line in order to work.
30422 See also `overlay-arrow-string'. */);
30423 Voverlay_arrow_position
= Qnil
;
30425 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30426 doc
: /* String to display as an arrow in non-window frames.
30427 See also `overlay-arrow-position'. */);
30428 Voverlay_arrow_string
= build_pure_c_string ("=>");
30430 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30431 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30432 The symbols on this list are examined during redisplay to determine
30433 where to display overlay arrows. */);
30434 Voverlay_arrow_variable_list
30435 = list1 (intern_c_string ("overlay-arrow-position"));
30437 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30438 doc
: /* The number of lines to try scrolling a window by when point moves out.
30439 If that fails to bring point back on frame, point is centered instead.
30440 If this is zero, point is always centered after it moves off frame.
30441 If you want scrolling to always be a line at a time, you should set
30442 `scroll-conservatively' to a large value rather than set this to 1. */);
30444 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30445 doc
: /* Scroll up to this many lines, to bring point back on screen.
30446 If point moves off-screen, redisplay will scroll by up to
30447 `scroll-conservatively' lines in order to bring point just barely
30448 onto the screen again. If that cannot be done, then redisplay
30449 recenters point as usual.
30451 If the value is greater than 100, redisplay will never recenter point,
30452 but will always scroll just enough text to bring point into view, even
30453 if you move far away.
30455 A value of zero means always recenter point if it moves off screen. */);
30456 scroll_conservatively
= 0;
30458 DEFVAR_INT ("scroll-margin", scroll_margin
,
30459 doc
: /* Number of lines of margin at the top and bottom of a window.
30460 Recenter the window whenever point gets within this many lines
30461 of the top or bottom of the window. */);
30464 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30465 doc
: /* Pixels per inch value for non-window system displays.
30466 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30467 Vdisplay_pixels_per_inch
= make_float (72.0);
30470 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30473 DEFVAR_LISP ("truncate-partial-width-windows",
30474 Vtruncate_partial_width_windows
,
30475 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30476 For an integer value, truncate lines in each window narrower than the
30477 full frame width, provided the window width is less than that integer;
30478 otherwise, respect the value of `truncate-lines'.
30480 For any other non-nil value, truncate lines in all windows that do
30481 not span the full frame width.
30483 A value of nil means to respect the value of `truncate-lines'.
30485 If `word-wrap' is enabled, you might want to reduce this. */);
30486 Vtruncate_partial_width_windows
= make_number (50);
30488 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30489 doc
: /* Maximum buffer size for which line number should be displayed.
30490 If the buffer is bigger than this, the line number does not appear
30491 in the mode line. A value of nil means no limit. */);
30492 Vline_number_display_limit
= Qnil
;
30494 DEFVAR_INT ("line-number-display-limit-width",
30495 line_number_display_limit_width
,
30496 doc
: /* Maximum line width (in characters) for line number display.
30497 If the average length of the lines near point is bigger than this, then the
30498 line number may be omitted from the mode line. */);
30499 line_number_display_limit_width
= 200;
30501 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30502 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30503 highlight_nonselected_windows
= 0;
30505 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30506 doc
: /* Non-nil if more than one frame is visible on this display.
30507 Minibuffer-only frames don't count, but iconified frames do.
30508 This variable is not guaranteed to be accurate except while processing
30509 `frame-title-format' and `icon-title-format'. */);
30511 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30512 doc
: /* Template for displaying the title bar of visible frames.
30513 \(Assuming the window manager supports this feature.)
30515 This variable has the same structure as `mode-line-format', except that
30516 the %c and %l constructs are ignored. It is used only on frames for
30517 which no explicit name has been set \(see `modify-frame-parameters'). */);
30519 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30520 doc
: /* Template for displaying the title bar of an iconified frame.
30521 \(Assuming the window manager supports this feature.)
30522 This variable has the same structure as `mode-line-format' (which see),
30523 and is used only on frames for which no explicit name has been set
30524 \(see `modify-frame-parameters'). */);
30526 = Vframe_title_format
30527 = listn (CONSTYPE_PURE
, 3,
30528 intern_c_string ("multiple-frames"),
30529 build_pure_c_string ("%b"),
30530 listn (CONSTYPE_PURE
, 4,
30531 empty_unibyte_string
,
30532 intern_c_string ("invocation-name"),
30533 build_pure_c_string ("@"),
30534 intern_c_string ("system-name")));
30536 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30537 doc
: /* Maximum number of lines to keep in the message log buffer.
30538 If nil, disable message logging. If t, log messages but don't truncate
30539 the buffer when it becomes large. */);
30540 Vmessage_log_max
= make_number (1000);
30542 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30543 doc
: /* Functions called before redisplay, if window sizes have changed.
30544 The value should be a list of functions that take one argument.
30545 Just before redisplay, for each frame, if any of its windows have changed
30546 size since the last redisplay, or have been split or deleted,
30547 all the functions in the list are called, with the frame as argument. */);
30548 Vwindow_size_change_functions
= Qnil
;
30550 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30551 doc
: /* List of functions to call before redisplaying a window with scrolling.
30552 Each function is called with two arguments, the window and its new
30553 display-start position. Note that these functions are also called by
30554 `set-window-buffer'. Also note that the value of `window-end' is not
30555 valid when these functions are called.
30557 Warning: Do not use this feature to alter the way the window
30558 is scrolled. It is not designed for that, and such use probably won't
30560 Vwindow_scroll_functions
= Qnil
;
30562 DEFVAR_LISP ("window-text-change-functions",
30563 Vwindow_text_change_functions
,
30564 doc
: /* Functions to call in redisplay when text in the window might change. */);
30565 Vwindow_text_change_functions
= Qnil
;
30567 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30568 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30569 Each function is called with two arguments, the window and the end trigger value.
30570 See `set-window-redisplay-end-trigger'. */);
30571 Vredisplay_end_trigger_functions
= Qnil
;
30573 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30574 doc
: /* Non-nil means autoselect window with mouse pointer.
30575 If nil, do not autoselect windows.
30576 A positive number means delay autoselection by that many seconds: a
30577 window is autoselected only after the mouse has remained in that
30578 window for the duration of the delay.
30579 A negative number has a similar effect, but causes windows to be
30580 autoselected only after the mouse has stopped moving. \(Because of
30581 the way Emacs compares mouse events, you will occasionally wait twice
30582 that time before the window gets selected.\)
30583 Any other value means to autoselect window instantaneously when the
30584 mouse pointer enters it.
30586 Autoselection selects the minibuffer only if it is active, and never
30587 unselects the minibuffer if it is active.
30589 When customizing this variable make sure that the actual value of
30590 `focus-follows-mouse' matches the behavior of your window manager. */);
30591 Vmouse_autoselect_window
= Qnil
;
30593 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30594 doc
: /* Non-nil means automatically resize tool-bars.
30595 This dynamically changes the tool-bar's height to the minimum height
30596 that is needed to make all tool-bar items visible.
30597 If value is `grow-only', the tool-bar's height is only increased
30598 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30599 Vauto_resize_tool_bars
= Qt
;
30601 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30602 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30603 auto_raise_tool_bar_buttons_p
= 1;
30605 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30606 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30607 make_cursor_line_fully_visible_p
= 1;
30609 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30610 doc
: /* Border below tool-bar in pixels.
30611 If an integer, use it as the height of the border.
30612 If it is one of `internal-border-width' or `border-width', use the
30613 value of the corresponding frame parameter.
30614 Otherwise, no border is added below the tool-bar. */);
30615 Vtool_bar_border
= Qinternal_border_width
;
30617 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30618 doc
: /* Margin around tool-bar buttons in pixels.
30619 If an integer, use that for both horizontal and vertical margins.
30620 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30621 HORZ specifying the horizontal margin, and VERT specifying the
30622 vertical margin. */);
30623 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30625 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30626 doc
: /* Relief thickness of tool-bar buttons. */);
30627 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30629 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30630 doc
: /* Tool bar style to use.
30632 image - show images only
30633 text - show text only
30634 both - show both, text below image
30635 both-horiz - show text to the right of the image
30636 text-image-horiz - show text to the left of the image
30637 any other - use system default or image if no system default.
30639 This variable only affects the GTK+ toolkit version of Emacs. */);
30640 Vtool_bar_style
= Qnil
;
30642 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30643 doc
: /* Maximum number of characters a label can have to be shown.
30644 The tool bar style must also show labels for this to have any effect, see
30645 `tool-bar-style'. */);
30646 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30648 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30649 doc
: /* List of functions to call to fontify regions of text.
30650 Each function is called with one argument POS. Functions must
30651 fontify a region starting at POS in the current buffer, and give
30652 fontified regions the property `fontified'. */);
30653 Vfontification_functions
= Qnil
;
30654 Fmake_variable_buffer_local (Qfontification_functions
);
30656 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30657 unibyte_display_via_language_environment
,
30658 doc
: /* Non-nil means display unibyte text according to language environment.
30659 Specifically, this means that raw bytes in the range 160-255 decimal
30660 are displayed by converting them to the equivalent multibyte characters
30661 according to the current language environment. As a result, they are
30662 displayed according to the current fontset.
30664 Note that this variable affects only how these bytes are displayed,
30665 but does not change the fact they are interpreted as raw bytes. */);
30666 unibyte_display_via_language_environment
= 0;
30668 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30669 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30670 If a float, it specifies a fraction of the mini-window frame's height.
30671 If an integer, it specifies a number of lines. */);
30672 Vmax_mini_window_height
= make_float (0.25);
30674 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30675 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30676 A value of nil means don't automatically resize mini-windows.
30677 A value of t means resize them to fit the text displayed in them.
30678 A value of `grow-only', the default, means let mini-windows grow only;
30679 they return to their normal size when the minibuffer is closed, or the
30680 echo area becomes empty. */);
30681 Vresize_mini_windows
= Qgrow_only
;
30683 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30684 doc
: /* Alist specifying how to blink the cursor off.
30685 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30686 `cursor-type' frame-parameter or variable equals ON-STATE,
30687 comparing using `equal', Emacs uses OFF-STATE to specify
30688 how to blink it off. ON-STATE and OFF-STATE are values for
30689 the `cursor-type' frame parameter.
30691 If a frame's ON-STATE has no entry in this list,
30692 the frame's other specifications determine how to blink the cursor off. */);
30693 Vblink_cursor_alist
= Qnil
;
30695 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30696 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30697 If non-nil, windows are automatically scrolled horizontally to make
30698 point visible. */);
30699 automatic_hscrolling_p
= 1;
30700 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30702 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30703 doc
: /* How many columns away from the window edge point is allowed to get
30704 before automatic hscrolling will horizontally scroll the window. */);
30705 hscroll_margin
= 5;
30707 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30708 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30709 When point is less than `hscroll-margin' columns from the window
30710 edge, automatic hscrolling will scroll the window by the amount of columns
30711 determined by this variable. If its value is a positive integer, scroll that
30712 many columns. If it's a positive floating-point number, it specifies the
30713 fraction of the window's width to scroll. If it's nil or zero, point will be
30714 centered horizontally after the scroll. Any other value, including negative
30715 numbers, are treated as if the value were zero.
30717 Automatic hscrolling always moves point outside the scroll margin, so if
30718 point was more than scroll step columns inside the margin, the window will
30719 scroll more than the value given by the scroll step.
30721 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30722 and `scroll-right' overrides this variable's effect. */);
30723 Vhscroll_step
= make_number (0);
30725 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30726 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30727 Bind this around calls to `message' to let it take effect. */);
30728 message_truncate_lines
= 0;
30730 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30731 doc
: /* Normal hook run to update the menu bar definitions.
30732 Redisplay runs this hook before it redisplays the menu bar.
30733 This is used to update menus such as Buffers, whose contents depend on
30735 Vmenu_bar_update_hook
= Qnil
;
30737 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30738 doc
: /* Frame for which we are updating a menu.
30739 The enable predicate for a menu binding should check this variable. */);
30740 Vmenu_updating_frame
= Qnil
;
30742 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30743 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30744 inhibit_menubar_update
= 0;
30746 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30747 doc
: /* Prefix prepended to all continuation lines at display time.
30748 The value may be a string, an image, or a stretch-glyph; it is
30749 interpreted in the same way as the value of a `display' text property.
30751 This variable is overridden by any `wrap-prefix' text or overlay
30754 To add a prefix to non-continuation lines, use `line-prefix'. */);
30755 Vwrap_prefix
= Qnil
;
30756 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30757 Fmake_variable_buffer_local (Qwrap_prefix
);
30759 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30760 doc
: /* Prefix prepended to all non-continuation lines at display time.
30761 The value may be a string, an image, or a stretch-glyph; it is
30762 interpreted in the same way as the value of a `display' text property.
30764 This variable is overridden by any `line-prefix' text or overlay
30767 To add a prefix to continuation lines, use `wrap-prefix'. */);
30768 Vline_prefix
= Qnil
;
30769 DEFSYM (Qline_prefix
, "line-prefix");
30770 Fmake_variable_buffer_local (Qline_prefix
);
30772 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30773 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30774 inhibit_eval_during_redisplay
= 0;
30776 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30777 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30778 inhibit_free_realized_faces
= 0;
30781 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30782 doc
: /* Inhibit try_window_id display optimization. */);
30783 inhibit_try_window_id
= 0;
30785 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30786 doc
: /* Inhibit try_window_reusing display optimization. */);
30787 inhibit_try_window_reusing
= 0;
30789 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30790 doc
: /* Inhibit try_cursor_movement display optimization. */);
30791 inhibit_try_cursor_movement
= 0;
30792 #endif /* GLYPH_DEBUG */
30794 DEFVAR_INT ("overline-margin", overline_margin
,
30795 doc
: /* Space between overline and text, in pixels.
30796 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30797 margin to the character height. */);
30798 overline_margin
= 2;
30800 DEFVAR_INT ("underline-minimum-offset",
30801 underline_minimum_offset
,
30802 doc
: /* Minimum distance between baseline and underline.
30803 This can improve legibility of underlined text at small font sizes,
30804 particularly when using variable `x-use-underline-position-properties'
30805 with fonts that specify an UNDERLINE_POSITION relatively close to the
30806 baseline. The default value is 1. */);
30807 underline_minimum_offset
= 1;
30809 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30810 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30811 This feature only works when on a window system that can change
30812 cursor shapes. */);
30813 display_hourglass_p
= 1;
30815 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30816 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30817 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30819 #ifdef HAVE_WINDOW_SYSTEM
30820 hourglass_atimer
= NULL
;
30821 hourglass_shown_p
= 0;
30822 #endif /* HAVE_WINDOW_SYSTEM */
30824 DEFSYM (Qglyphless_char
, "glyphless-char");
30825 DEFSYM (Qhex_code
, "hex-code");
30826 DEFSYM (Qempty_box
, "empty-box");
30827 DEFSYM (Qthin_space
, "thin-space");
30828 DEFSYM (Qzero_width
, "zero-width");
30830 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30831 doc
: /* Function run just before redisplay.
30832 It is called with one argument, which is the set of windows that are to
30833 be redisplayed. This set can be nil (meaning, only the selected window),
30834 or t (meaning all windows). */);
30835 Vpre_redisplay_function
= intern ("ignore");
30837 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30838 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30840 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30841 doc
: /* Char-table defining glyphless characters.
30842 Each element, if non-nil, should be one of the following:
30843 an ASCII acronym string: display this string in a box
30844 `hex-code': display the hexadecimal code of a character in a box
30845 `empty-box': display as an empty box
30846 `thin-space': display as 1-pixel width space
30847 `zero-width': don't display
30848 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30849 display method for graphical terminals and text terminals respectively.
30850 GRAPHICAL and TEXT should each have one of the values listed above.
30852 The char-table has one extra slot to control the display of a character for
30853 which no font is found. This slot only takes effect on graphical terminals.
30854 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30855 `thin-space'. The default is `empty-box'.
30857 If a character has a non-nil entry in an active display table, the
30858 display table takes effect; in this case, Emacs does not consult
30859 `glyphless-char-display' at all. */);
30860 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30861 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30864 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30865 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30866 Vdebug_on_message
= Qnil
;
30868 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30870 Vredisplay__all_windows_cause
30871 = Fmake_vector (make_number (100), make_number (0));
30873 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30875 Vredisplay__mode_lines_cause
30876 = Fmake_vector (make_number (100), make_number (0));
30880 /* Initialize this module when Emacs starts. */
30885 CHARPOS (this_line_start_pos
) = 0;
30887 if (!noninteractive
)
30889 struct window
*m
= XWINDOW (minibuf_window
);
30890 Lisp_Object frame
= m
->frame
;
30891 struct frame
*f
= XFRAME (frame
);
30892 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30893 struct window
*r
= XWINDOW (root
);
30896 echo_area_window
= minibuf_window
;
30898 r
->top_line
= FRAME_TOP_MARGIN (f
);
30899 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30900 r
->total_cols
= FRAME_COLS (f
);
30901 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30902 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30903 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30905 m
->top_line
= FRAME_LINES (f
) - 1;
30906 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30907 m
->total_cols
= FRAME_COLS (f
);
30908 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30909 m
->total_lines
= 1;
30910 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30912 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30913 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30914 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30916 /* The default ellipsis glyphs `...'. */
30917 for (i
= 0; i
< 3; ++i
)
30918 default_invis_vector
[i
] = make_number ('.');
30922 /* Allocate the buffer for frame titles.
30923 Also used for `format-mode-line'. */
30925 mode_line_noprop_buf
= xmalloc (size
);
30926 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30927 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30928 mode_line_target
= MODE_LINE_DISPLAY
;
30931 help_echo_showing_p
= 0;
30934 #ifdef HAVE_WINDOW_SYSTEM
30936 /* Platform-independent portion of hourglass implementation. */
30938 /* Cancel a currently active hourglass timer, and start a new one. */
30940 start_hourglass (void)
30942 struct timespec delay
;
30944 cancel_hourglass ();
30946 if (INTEGERP (Vhourglass_delay
)
30947 && XINT (Vhourglass_delay
) > 0)
30948 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30949 TYPE_MAXIMUM (time_t)),
30951 else if (FLOATP (Vhourglass_delay
)
30952 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30953 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30955 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30959 extern void w32_note_current_window (void);
30960 w32_note_current_window ();
30962 #endif /* HAVE_NTGUI */
30964 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30965 show_hourglass
, NULL
);
30969 /* 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
)
30984 #endif /* HAVE_WINDOW_SYSTEM */