1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
54 expose_window (asynchronous) |
56 X expose events -----+
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
91 . try_window_reusing_current_matrix
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
325 #define INFINITY 10000000
327 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
328 Lisp_Object Qwindow_scroll_functions
;
329 static Lisp_Object Qwindow_text_change_functions
;
330 static Lisp_Object Qredisplay_end_trigger_functions
;
331 Lisp_Object Qinhibit_point_motion_hooks
;
332 static Lisp_Object QCeval
, QCpropertize
;
333 Lisp_Object QCfile
, QCdata
;
334 static Lisp_Object Qfontified
;
335 static Lisp_Object Qgrow_only
;
336 static Lisp_Object Qinhibit_eval_during_redisplay
;
337 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
338 static Lisp_Object Qright_to_left
, Qleft_to_right
;
341 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
343 /* Pointer shapes. */
344 static Lisp_Object Qarrow
, Qhand
;
347 /* Holds the list (error). */
348 static Lisp_Object list_of_error
;
350 static Lisp_Object Qfontification_functions
;
352 static Lisp_Object Qwrap_prefix
;
353 static Lisp_Object Qline_prefix
;
354 static Lisp_Object Qredisplay_internal
;
356 /* Non-nil means don't actually do any redisplay. */
358 Lisp_Object Qinhibit_redisplay
;
360 /* Names of text properties relevant for redisplay. */
362 Lisp_Object Qdisplay
;
364 Lisp_Object Qspace
, QCalign_to
;
365 static Lisp_Object QCrelative_width
, QCrelative_height
;
366 Lisp_Object Qleft_margin
, Qright_margin
;
367 static Lisp_Object Qspace_width
, Qraise
;
368 static Lisp_Object Qslice
;
370 static Lisp_Object Qmargin
, Qpointer
;
371 static Lisp_Object Qline_height
;
373 #ifdef HAVE_WINDOW_SYSTEM
375 /* Test if overflow newline into fringe. Called with iterator IT
376 at or past right window margin, and with IT->current_x set. */
378 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
379 (!NILP (Voverflow_newline_into_fringe) \
380 && FRAME_WINDOW_P ((IT)->f) \
381 && ((IT)->bidi_it.paragraph_dir == R2L \
382 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
383 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
384 && (IT)->current_x == (IT)->last_visible_x)
386 #else /* !HAVE_WINDOW_SYSTEM */
387 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
388 #endif /* HAVE_WINDOW_SYSTEM */
390 /* Test if the display element loaded in IT, or the underlying buffer
391 or string character, is a space or a TAB character. This is used
392 to determine where word wrapping can occur. */
394 #define IT_DISPLAYING_WHITESPACE(it) \
395 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
396 || ((STRINGP (it->string) \
397 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
398 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
400 && (it->s[IT_BYTEPOS (*it)] == ' ' \
401 || it->s[IT_BYTEPOS (*it)] == '\t')) \
402 || (IT_BYTEPOS (*it) < ZV_BYTE \
403 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
404 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
406 /* Name of the face used to highlight trailing whitespace. */
408 static Lisp_Object Qtrailing_whitespace
;
410 /* Name and number of the face used to highlight escape glyphs. */
412 static Lisp_Object Qescape_glyph
;
414 /* Name and number of the face used to highlight non-breaking spaces. */
416 static Lisp_Object Qnobreak_space
;
418 /* The symbol `image' which is the car of the lists used to represent
419 images in Lisp. Also a tool bar style. */
423 /* The image map types. */
425 static Lisp_Object QCpointer
;
426 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
428 /* Tool bar styles */
429 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
431 /* Non-zero means print newline to stdout before next mini-buffer
434 bool noninteractive_need_newline
;
436 /* Non-zero means print newline to message log before next message. */
438 static bool message_log_need_newline
;
440 /* Three markers that message_dolog uses.
441 It could allocate them itself, but that causes trouble
442 in handling memory-full errors. */
443 static Lisp_Object message_dolog_marker1
;
444 static Lisp_Object message_dolog_marker2
;
445 static Lisp_Object message_dolog_marker3
;
447 /* The buffer position of the first character appearing entirely or
448 partially on the line of the selected window which contains the
449 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
450 redisplay optimization in redisplay_internal. */
452 static struct text_pos this_line_start_pos
;
454 /* Number of characters past the end of the line above, including the
455 terminating newline. */
457 static struct text_pos this_line_end_pos
;
459 /* The vertical positions and the height of this line. */
461 static int this_line_vpos
;
462 static int this_line_y
;
463 static int this_line_pixel_height
;
465 /* X position at which this display line starts. Usually zero;
466 negative if first character is partially visible. */
468 static int this_line_start_x
;
470 /* The smallest character position seen by move_it_* functions as they
471 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
472 hscrolled lines, see display_line. */
474 static struct text_pos this_line_min_pos
;
476 /* Buffer that this_line_.* variables are referring to. */
478 static struct buffer
*this_line_buffer
;
481 /* Values of those variables at last redisplay are stored as
482 properties on `overlay-arrow-position' symbol. However, if
483 Voverlay_arrow_position is a marker, last-arrow-position is its
484 numerical position. */
486 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
488 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
489 properties on a symbol in overlay-arrow-variable-list. */
491 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
493 Lisp_Object Qmenu_bar_update_hook
;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static bool overlay_arrow_seen
;
499 /* Vector containing glyphs for an ellipsis `...'. */
501 static Lisp_Object default_invis_vector
[3];
503 /* This is the window where the echo area message was displayed. It
504 is always a mini-buffer window, but it may not be the same window
505 currently active as a mini-buffer. */
507 Lisp_Object echo_area_window
;
509 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
510 pushes the current message and the value of
511 message_enable_multibyte on the stack, the function restore_message
512 pops the stack and displays MESSAGE again. */
514 static Lisp_Object Vmessage_stack
;
516 /* Nonzero means multibyte characters were enabled when the echo area
517 message was specified. */
519 static bool message_enable_multibyte
;
521 /* Nonzero if we should redraw the mode lines on the next redisplay.
522 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
523 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
524 (the number used is then only used to track down the cause for this
527 int update_mode_lines
;
529 /* Nonzero if window sizes or contents other than selected-window have changed
530 since last redisplay that finished.
531 If it has value REDISPLAY_SOME, then only redisplay the windows where
532 the `redisplay' bit has been set. Otherwise, redisplay all windows
533 (the number used is then only used to track down the cause for this
536 int windows_or_buffers_changed
;
538 /* Nonzero after display_mode_line if %l was used and it displayed a
541 static bool line_number_displayed
;
543 /* The name of the *Messages* buffer, a string. */
545 static Lisp_Object Vmessages_buffer_name
;
547 /* Current, index 0, and last displayed echo area message. Either
548 buffers from echo_buffers, or nil to indicate no message. */
550 Lisp_Object echo_area_buffer
[2];
552 /* The buffers referenced from echo_area_buffer. */
554 static Lisp_Object echo_buffer
[2];
556 /* A vector saved used in with_area_buffer to reduce consing. */
558 static Lisp_Object Vwith_echo_area_save_vector
;
560 /* Non-zero means display_echo_area should display the last echo area
561 message again. Set by redisplay_preserve_echo_area. */
563 static bool display_last_displayed_message_p
;
565 /* Nonzero if echo area is being used by print; zero if being used by
568 static bool message_buf_print
;
570 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
572 static Lisp_Object Qinhibit_menubar_update
;
573 static Lisp_Object Qmessage_truncate_lines
;
575 /* Set to 1 in clear_message to make redisplay_internal aware
576 of an emptied echo area. */
578 static bool message_cleared_p
;
580 /* A scratch glyph row with contents used for generating truncation
581 glyphs. Also used in direct_output_for_insert. */
583 #define MAX_SCRATCH_GLYPHS 100
584 static struct glyph_row scratch_glyph_row
;
585 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
587 /* Ascent and height of the last line processed by move_it_to. */
589 static int last_height
;
591 /* Non-zero if there's a help-echo in the echo area. */
593 bool help_echo_showing_p
;
595 /* The maximum distance to look ahead for text properties. Values
596 that are too small let us call compute_char_face and similar
597 functions too often which is expensive. Values that are too large
598 let us call compute_char_face and alike too often because we
599 might not be interested in text properties that far away. */
601 #define TEXT_PROP_DISTANCE_LIMIT 100
603 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
604 iterator state and later restore it. This is needed because the
605 bidi iterator on bidi.c keeps a stacked cache of its states, which
606 is really a singleton. When we use scratch iterator objects to
607 move around the buffer, we can cause the bidi cache to be pushed or
608 popped, and therefore we need to restore the cache state when we
609 return to the original iterator. */
610 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
613 bidi_unshelve_cache (CACHE, 1); \
615 CACHE = bidi_shelve_cache (); \
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
626 /* Functions to mark elements as needing redisplay. */
627 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
630 redisplay_other_windows (void)
632 if (!windows_or_buffers_changed
)
633 windows_or_buffers_changed
= REDISPLAY_SOME
;
637 wset_redisplay (struct window
*w
)
639 /* Beware: selected_window can be nil during early stages. */
640 if (!EQ (make_lisp_ptr (w
, Lisp_Vectorlike
), selected_window
))
641 redisplay_other_windows ();
646 fset_redisplay (struct frame
*f
)
648 redisplay_other_windows ();
653 bset_redisplay (struct buffer
*b
)
655 int count
= buffer_window_count (b
);
658 /* ... it's visible in other window than selected, */
659 if (count
> 1 || b
!= XBUFFER (XWINDOW (selected_window
)->contents
))
660 redisplay_other_windows ();
661 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
662 so that if we later set windows_or_buffers_changed, this buffer will
664 b
->text
->redisplay
= true;
669 bset_update_mode_line (struct buffer
*b
)
671 if (!update_mode_lines
)
672 update_mode_lines
= REDISPLAY_SOME
;
673 b
->text
->redisplay
= true;
678 /* Non-zero means print traces of redisplay if compiled with
679 GLYPH_DEBUG defined. */
681 bool trace_redisplay_p
;
683 #endif /* GLYPH_DEBUG */
685 #ifdef DEBUG_TRACE_MOVE
686 /* Non-zero means trace with TRACE_MOVE to stderr. */
689 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
691 #define TRACE_MOVE(x) (void) 0
694 static Lisp_Object Qauto_hscroll_mode
;
696 /* Buffer being redisplayed -- for redisplay_window_error. */
698 static struct buffer
*displayed_buffer
;
700 /* Value returned from text property handlers (see below). */
705 HANDLED_RECOMPUTE_PROPS
,
706 HANDLED_OVERLAY_STRING_CONSUMED
,
710 /* A description of text properties that redisplay is interested
715 /* The name of the property. */
718 /* A unique index for the property. */
721 /* A handler function called to set up iterator IT from the property
722 at IT's current position. Value is used to steer handle_stop. */
723 enum prop_handled (*handler
) (struct it
*it
);
726 static enum prop_handled
handle_face_prop (struct it
*);
727 static enum prop_handled
handle_invisible_prop (struct it
*);
728 static enum prop_handled
handle_display_prop (struct it
*);
729 static enum prop_handled
handle_composition_prop (struct it
*);
730 static enum prop_handled
handle_overlay_change (struct it
*);
731 static enum prop_handled
handle_fontified_prop (struct it
*);
733 /* Properties handled by iterators. */
735 static struct props it_props
[] =
737 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
738 /* Handle `face' before `display' because some sub-properties of
739 `display' need to know the face. */
740 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
741 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
742 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
743 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
747 /* Value is the position described by X. If X is a marker, value is
748 the marker_position of X. Otherwise, value is X. */
750 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
752 /* Enumeration returned by some move_it_.* functions internally. */
756 /* Not used. Undefined value. */
759 /* Move ended at the requested buffer position or ZV. */
760 MOVE_POS_MATCH_OR_ZV
,
762 /* Move ended at the requested X pixel position. */
765 /* Move within a line ended at the end of a line that must be
769 /* Move within a line ended at the end of a line that would
770 be displayed truncated. */
773 /* Move within a line ended at a line end. */
777 /* This counter is used to clear the face cache every once in a while
778 in redisplay_internal. It is incremented for each redisplay.
779 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
782 #define CLEAR_FACE_CACHE_COUNT 500
783 static int clear_face_cache_count
;
785 /* Similarly for the image cache. */
787 #ifdef HAVE_WINDOW_SYSTEM
788 #define CLEAR_IMAGE_CACHE_COUNT 101
789 static int clear_image_cache_count
;
791 /* Null glyph slice */
792 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
795 /* True while redisplay_internal is in progress. */
799 static Lisp_Object Qinhibit_free_realized_faces
;
800 static Lisp_Object Qmode_line_default_help_echo
;
802 /* If a string, XTread_socket generates an event to display that string.
803 (The display is done in read_char.) */
805 Lisp_Object help_echo_string
;
806 Lisp_Object help_echo_window
;
807 Lisp_Object help_echo_object
;
808 ptrdiff_t help_echo_pos
;
810 /* Temporary variable for XTread_socket. */
812 Lisp_Object previous_help_echo_string
;
814 /* Platform-independent portion of hourglass implementation. */
816 #ifdef HAVE_WINDOW_SYSTEM
818 /* Non-zero means an hourglass cursor is currently shown. */
819 static bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 static struct atimer
*hourglass_atimer
;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char
;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display
;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
836 /* Default number of seconds to wait before displaying an hourglass
838 #define DEFAULT_HOURGLASS_DELAY 1
840 #ifdef HAVE_WINDOW_SYSTEM
842 /* Default pixel width of `thin-space' display method. */
843 #define THIN_SPACE_WIDTH 1
845 #endif /* HAVE_WINDOW_SYSTEM */
847 /* Function prototypes. */
849 static void setup_for_ellipsis (struct it
*, int);
850 static void set_iterator_to_next (struct it
*, int);
851 static void mark_window_display_accurate_1 (struct window
*, int);
852 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
853 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
854 static int row_for_charpos_p (struct glyph_row
*, ptrdiff_t);
855 static int cursor_row_p (struct glyph_row
*);
856 static int redisplay_mode_lines (Lisp_Object
, bool);
857 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
859 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
861 static void handle_line_prefix (struct it
*);
863 static void pint2str (char *, int, ptrdiff_t);
864 static void pint2hrstr (char *, int, ptrdiff_t);
865 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
867 static int text_outside_line_unchanged_p (struct window
*,
868 ptrdiff_t, ptrdiff_t);
869 static void store_mode_line_noprop_char (char);
870 static int store_mode_line_noprop (const char *, int, int);
871 static void handle_stop (struct it
*);
872 static void handle_stop_backwards (struct it
*, ptrdiff_t);
873 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874 static void ensure_echo_area_buffers (void);
875 static void unwind_with_echo_area_buffer (Lisp_Object
);
876 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
877 static int with_echo_area_buffer (struct window
*, int,
878 int (*) (ptrdiff_t, Lisp_Object
),
879 ptrdiff_t, Lisp_Object
);
880 static void clear_garbaged_frames (void);
881 static int current_message_1 (ptrdiff_t, Lisp_Object
);
882 static int truncate_message_1 (ptrdiff_t, Lisp_Object
);
883 static void set_message (Lisp_Object
);
884 static int set_message_1 (ptrdiff_t, Lisp_Object
);
885 static int display_echo_area (struct window
*);
886 static int display_echo_area_1 (ptrdiff_t, Lisp_Object
);
887 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object
);
888 static void unwind_redisplay (void);
889 static int string_char_and_length (const unsigned char *, int *);
890 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
892 static int compute_window_start_on_continuation_line (struct window
*);
893 static void insert_left_trunc_glyphs (struct it
*);
894 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
896 static void extend_face_to_end_of_line (struct it
*);
897 static int append_space_for_newline (struct it
*, int);
898 static int cursor_row_fully_visible_p (struct window
*, int, int);
899 static int try_scrolling (Lisp_Object
, int, ptrdiff_t, ptrdiff_t, int, int);
900 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
901 static int trailing_whitespace_p (ptrdiff_t);
902 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903 static void push_it (struct it
*, struct text_pos
*);
904 static void iterate_out_of_display_property (struct it
*);
905 static void pop_it (struct it
*);
906 static void sync_frame_with_window_matrix_rows (struct window
*);
907 static void redisplay_internal (void);
908 static int echo_area_display (int);
909 static void redisplay_windows (Lisp_Object
);
910 static void redisplay_window (Lisp_Object
, bool);
911 static Lisp_Object
redisplay_window_error (Lisp_Object
);
912 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
913 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
914 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
915 struct glyph_matrix
*, ptrdiff_t, ptrdiff_t,
917 static int update_menu_bar (struct frame
*, int, int);
918 static int try_window_reusing_current_matrix (struct window
*);
919 static int try_window_id (struct window
*);
920 static int display_line (struct it
*);
921 static int display_mode_lines (struct window
*);
922 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
923 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
924 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
925 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
926 static void display_menu_bar (struct window
*);
927 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
929 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
930 ptrdiff_t, ptrdiff_t, struct it
*, int, int, int, int);
931 static void compute_line_metrics (struct it
*);
932 static void run_redisplay_end_trigger_hook (struct it
*);
933 static int get_overlay_strings (struct it
*, ptrdiff_t);
934 static int get_overlay_strings_1 (struct it
*, ptrdiff_t, int);
935 static void next_overlay_string (struct it
*);
936 static void reseat (struct it
*, struct text_pos
, int);
937 static void reseat_1 (struct it
*, struct text_pos
, int);
938 static void back_to_previous_visible_line_start (struct it
*);
939 static void reseat_at_next_visible_line_start (struct it
*, int);
940 static int next_element_from_ellipsis (struct it
*);
941 static int next_element_from_display_vector (struct it
*);
942 static int next_element_from_string (struct it
*);
943 static int next_element_from_c_string (struct it
*);
944 static int next_element_from_buffer (struct it
*);
945 static int next_element_from_composition (struct it
*);
946 static int next_element_from_image (struct it
*);
947 static int next_element_from_stretch (struct it
*);
948 static void load_overlay_strings (struct it
*, ptrdiff_t);
949 static int init_from_display_pos (struct it
*, struct window
*,
950 struct display_pos
*);
951 static void reseat_to_string (struct it
*, const char *,
952 Lisp_Object
, ptrdiff_t, ptrdiff_t, int, int);
953 static int get_next_display_element (struct it
*);
954 static enum move_it_result
955 move_it_in_display_line_to (struct it
*, ptrdiff_t, int,
956 enum move_operation_enum
);
957 static void get_visually_first_element (struct it
*);
958 static void init_to_row_start (struct it
*, struct window
*,
960 static int init_to_row_end (struct it
*, struct window
*,
962 static void back_to_previous_line_start (struct it
*);
963 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
964 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
965 Lisp_Object
, ptrdiff_t);
966 static struct text_pos
string_pos (ptrdiff_t, Lisp_Object
);
967 static struct text_pos
c_string_pos (ptrdiff_t, const char *, bool);
968 static ptrdiff_t number_of_chars (const char *, bool);
969 static void compute_stop_pos (struct it
*);
970 static void compute_string_pos (struct text_pos
*, struct text_pos
,
972 static int face_before_or_after_it_pos (struct it
*, int);
973 static ptrdiff_t next_overlay_change (ptrdiff_t);
974 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
975 Lisp_Object
, struct text_pos
*, ptrdiff_t, int);
976 static int handle_single_display_spec (struct it
*, Lisp_Object
,
977 Lisp_Object
, Lisp_Object
,
978 struct text_pos
*, ptrdiff_t, int, int);
979 static int underlying_face_id (struct it
*);
980 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
983 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
984 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
986 #ifdef HAVE_WINDOW_SYSTEM
988 static void x_consider_frame_title (Lisp_Object
);
989 static void update_tool_bar (struct frame
*, int);
990 static int redisplay_tool_bar (struct frame
*);
991 static void x_draw_bottom_divider (struct window
*w
);
992 static void notice_overwritten_cursor (struct window
*,
995 static void append_stretch_glyph (struct it
*, Lisp_Object
,
999 #endif /* HAVE_WINDOW_SYSTEM */
1001 static void produce_special_glyphs (struct it
*, enum display_element_type
);
1002 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
1003 static bool coords_in_mouse_face_p (struct window
*, int, int);
1007 /***********************************************************************
1008 Window display dimensions
1009 ***********************************************************************/
1011 /* Return the bottom boundary y-position for text lines in window W.
1012 This is the first y position at which a line cannot start.
1013 It is relative to the top of the window.
1015 This is the height of W minus the height of a mode line, if any. */
1018 window_text_bottom_y (struct window
*w
)
1020 int height
= WINDOW_PIXEL_HEIGHT (w
);
1022 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1025 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
1027 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1032 /* Return the pixel width of display area AREA of window W.
1033 ANY_AREA means return the total width of W, not including
1034 fringes to the left and right of the window. */
1037 window_box_width (struct window
*w
, enum glyph_row_area area
)
1039 int width
= w
->pixel_width
;
1041 if (!w
->pseudo_window_p
)
1043 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1044 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1046 if (area
== TEXT_AREA
)
1047 width
-= (WINDOW_MARGINS_WIDTH (w
)
1048 + WINDOW_FRINGES_WIDTH (w
));
1049 else if (area
== LEFT_MARGIN_AREA
)
1050 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1051 else if (area
== RIGHT_MARGIN_AREA
)
1052 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1055 /* With wide margins, fringes, etc. we might end up with a negative
1056 width, correct that here. */
1057 return max (0, width
);
1061 /* Return the pixel height of the display area of window W, not
1062 including mode lines of W, if any. */
1065 window_box_height (struct window
*w
)
1067 struct frame
*f
= XFRAME (w
->frame
);
1068 int height
= WINDOW_PIXEL_HEIGHT (w
);
1070 eassert (height
>= 0);
1072 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1073 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1075 /* Note: the code below that determines the mode-line/header-line
1076 height is essentially the same as that contained in the macro
1077 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1078 the appropriate glyph row has its `mode_line_p' flag set,
1079 and if it doesn't, uses estimate_mode_line_height instead. */
1081 if (WINDOW_WANTS_MODELINE_P (w
))
1083 struct glyph_row
*ml_row
1084 = (w
->current_matrix
&& w
->current_matrix
->rows
1085 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1087 if (ml_row
&& ml_row
->mode_line_p
)
1088 height
-= ml_row
->height
;
1090 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1093 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1095 struct glyph_row
*hl_row
1096 = (w
->current_matrix
&& w
->current_matrix
->rows
1097 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1099 if (hl_row
&& hl_row
->mode_line_p
)
1100 height
-= hl_row
->height
;
1102 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1105 /* With a very small font and a mode-line that's taller than
1106 default, we might end up with a negative height. */
1107 return max (0, height
);
1110 /* Return the window-relative coordinate of the left edge of display
1111 area AREA of window W. ANY_AREA means return the left edge of the
1112 whole window, to the right of the left fringe of W. */
1115 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1119 if (w
->pseudo_window_p
)
1122 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1124 if (area
== TEXT_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
));
1127 else if (area
== RIGHT_MARGIN_AREA
)
1128 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1129 + window_box_width (w
, LEFT_MARGIN_AREA
)
1130 + window_box_width (w
, TEXT_AREA
)
1131 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1133 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1134 else if (area
== LEFT_MARGIN_AREA
1135 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1136 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1138 /* Don't return more than the window's pixel width. */
1139 return min (x
, w
->pixel_width
);
1143 /* Return the window-relative coordinate of the right edge of display
1144 area AREA of window W. ANY_AREA means return the right edge of the
1145 whole window, to the left of the right fringe of W. */
1148 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1150 /* Don't return more than the window's pixel width. */
1151 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1155 /* Return the frame-relative coordinate of the left edge of display
1156 area AREA of window W. ANY_AREA means return the left edge of the
1157 whole window, to the right of the left fringe of W. */
1160 window_box_left (struct window
*w
, enum glyph_row_area area
)
1162 struct frame
*f
= XFRAME (w
->frame
);
1165 if (w
->pseudo_window_p
)
1166 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1168 x
= (WINDOW_LEFT_EDGE_X (w
)
1169 + window_box_left_offset (w
, area
));
1175 /* Return the frame-relative coordinate of the right edge of display
1176 area AREA of window W. ANY_AREA means return the right edge of the
1177 whole window, to the left of the right fringe of W. */
1180 window_box_right (struct window
*w
, enum glyph_row_area area
)
1182 return window_box_left (w
, area
) + window_box_width (w
, area
);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines, in frame-relative coordinates. ANY_AREA means the
1187 whole window, not including the left and right fringes of
1188 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1189 coordinates of the upper-left corner of the box. Return in
1190 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1193 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1194 int *box_y
, int *box_width
, int *box_height
)
1197 *box_width
= window_box_width (w
, area
);
1199 *box_height
= window_box_height (w
);
1201 *box_x
= window_box_left (w
, area
);
1204 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 #ifdef HAVE_WINDOW_SYSTEM
1212 /* Get the bounding box of the display area AREA of window W, without
1213 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1220 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1221 int *bottom_right_x
, int *bottom_right_y
)
1223 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1224 bottom_right_x
, bottom_right_y
);
1225 *bottom_right_x
+= *top_left_x
;
1226 *bottom_right_y
+= *top_left_y
;
1229 #endif /* HAVE_WINDOW_SYSTEM */
1231 /***********************************************************************
1233 ***********************************************************************/
1235 /* Return the bottom y-position of the line the iterator IT is in.
1236 This can modify IT's settings. */
1239 line_bottom_y (struct it
*it
)
1241 int line_height
= it
->max_ascent
+ it
->max_descent
;
1242 int line_top_y
= it
->current_y
;
1244 if (line_height
== 0)
1247 line_height
= last_height
;
1248 else if (IT_CHARPOS (*it
) < ZV
)
1250 move_it_by_lines (it
, 1);
1251 line_height
= (it
->max_ascent
|| it
->max_descent
1252 ? it
->max_ascent
+ it
->max_descent
1257 struct glyph_row
*row
= it
->glyph_row
;
1259 /* Use the default character height. */
1260 it
->glyph_row
= NULL
;
1261 it
->what
= IT_CHARACTER
;
1264 PRODUCE_GLYPHS (it
);
1265 line_height
= it
->ascent
+ it
->descent
;
1266 it
->glyph_row
= row
;
1270 return line_top_y
+ line_height
;
1273 DEFUN ("line-pixel-height", Fline_pixel_height
,
1274 Sline_pixel_height
, 0, 0, 0,
1275 doc
: /* Return height in pixels of text line in the selected window.
1277 Value is the height in pixels of the line at point. */)
1282 struct window
*w
= XWINDOW (selected_window
);
1283 struct buffer
*old_buffer
= NULL
;
1286 if (XBUFFER (w
->contents
) != current_buffer
)
1288 old_buffer
= current_buffer
;
1289 set_buffer_internal_1 (XBUFFER (w
->contents
));
1291 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1292 start_display (&it
, w
, pt
);
1293 it
.vpos
= it
.current_y
= 0;
1295 result
= make_number (line_bottom_y (&it
));
1297 set_buffer_internal_1 (old_buffer
);
1302 /* Return the default pixel height of text lines in window W. The
1303 value is the canonical height of the W frame's default font, plus
1304 any extra space required by the line-spacing variable or frame
1307 Implementation note: this ignores any line-spacing text properties
1308 put on the newline characters. This is because those properties
1309 only affect the _screen_ line ending in the newline (i.e., in a
1310 continued line, only the last screen line will be affected), which
1311 means only a small number of lines in a buffer can ever use this
1312 feature. Since this function is used to compute the default pixel
1313 equivalent of text lines in a window, we can safely ignore those
1314 few lines. For the same reasons, we ignore the line-height
1317 default_line_pixel_height (struct window
*w
)
1319 struct frame
*f
= WINDOW_XFRAME (w
);
1320 int height
= FRAME_LINE_HEIGHT (f
);
1322 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1324 struct buffer
*b
= XBUFFER (w
->contents
);
1325 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1328 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1331 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1332 height
+= XFASTINT (val
);
1333 else if (FLOATP (val
))
1335 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1342 height
+= f
->extra_line_spacing
;
1348 /* Subroutine of pos_visible_p below. Extracts a display string, if
1349 any, from the display spec given as its argument. */
1351 string_from_display_spec (Lisp_Object spec
)
1355 while (CONSP (spec
))
1357 if (STRINGP (XCAR (spec
)))
1362 else if (VECTORP (spec
))
1366 for (i
= 0; i
< ASIZE (spec
); i
++)
1368 if (STRINGP (AREF (spec
, i
)))
1369 return AREF (spec
, i
);
1378 /* Limit insanely large values of W->hscroll on frame F to the largest
1379 value that will still prevent first_visible_x and last_visible_x of
1380 'struct it' from overflowing an int. */
1382 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1384 ptrdiff_t window_hscroll
= w
->hscroll
;
1385 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1386 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1388 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1389 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1391 return window_hscroll
;
1394 /* Return 1 if position CHARPOS is visible in window W.
1395 CHARPOS < 0 means return info about WINDOW_END position.
1396 If visible, set *X and *Y to pixel coordinates of top left corner.
1397 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1398 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1401 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1402 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1405 void *itdata
= bidi_shelve_cache ();
1406 struct text_pos top
;
1408 struct buffer
*old_buffer
= NULL
;
1410 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1413 if (XBUFFER (w
->contents
) != current_buffer
)
1415 old_buffer
= current_buffer
;
1416 set_buffer_internal_1 (XBUFFER (w
->contents
));
1419 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1420 /* Scrolling a minibuffer window via scroll bar when the echo area
1421 shows long text sometimes resets the minibuffer contents behind
1423 if (CHARPOS (top
) > ZV
)
1424 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1426 /* Compute exact mode line heights. */
1427 if (WINDOW_WANTS_MODELINE_P (w
))
1429 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1430 BVAR (current_buffer
, mode_line_format
));
1432 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1433 w
->header_line_height
1434 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1435 BVAR (current_buffer
, header_line_format
));
1437 start_display (&it
, w
, top
);
1438 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1439 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1442 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1443 && IT_CHARPOS (it
) >= charpos
)
1444 /* When scanning backwards under bidi iteration, move_it_to
1445 stops at or _before_ CHARPOS, because it stops at or to
1446 the _right_ of the character at CHARPOS. */
1447 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1448 && IT_CHARPOS (it
) <= charpos
)))
1450 /* We have reached CHARPOS, or passed it. How the call to
1451 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1452 or covered by a display property, move_it_to stops at the end
1453 of the invisible text, to the right of CHARPOS. (ii) If
1454 CHARPOS is in a display vector, move_it_to stops on its last
1456 int top_x
= it
.current_x
;
1457 int top_y
= it
.current_y
;
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1461 void *save_it_data
= NULL
;
1463 /* Calling line_bottom_y may change it.method, it.position, etc. */
1464 SAVE_IT (save_it
, it
, save_it_data
);
1466 bottom_y
= line_bottom_y (&it
);
1467 if (top_y
< window_top_y
)
1468 visible_p
= bottom_y
> window_top_y
;
1469 else if (top_y
< it
.last_visible_y
)
1471 if (bottom_y
>= it
.last_visible_y
1472 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1473 && IT_CHARPOS (it
) < charpos
)
1475 /* When the last line of the window is scanned backwards
1476 under bidi iteration, we could be duped into thinking
1477 that we have passed CHARPOS, when in fact move_it_to
1478 simply stopped short of CHARPOS because it reached
1479 last_visible_y. To see if that's what happened, we call
1480 move_it_to again with a slightly larger vertical limit,
1481 and see if it actually moved vertically; if it did, we
1482 didn't really reach CHARPOS, which is beyond window end. */
1483 /* Why 10? because we don't know how many canonical lines
1484 will the height of the next line(s) be. So we guess. */
1485 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1487 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1488 MOVE_TO_POS
| MOVE_TO_Y
);
1489 if (it
.current_y
> top_y
)
1493 RESTORE_IT (&it
, &save_it
, save_it_data
);
1496 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1498 /* We stopped on the last glyph of a display vector.
1499 Try and recompute. Hack alert! */
1500 if (charpos
< 2 || top
.charpos
>= charpos
)
1501 top_x
= it
.glyph_row
->x
;
1504 struct it it2
, it2_prev
;
1505 /* The idea is to get to the previous buffer
1506 position, consume the character there, and use
1507 the pixel coordinates we get after that. But if
1508 the previous buffer position is also displayed
1509 from a display vector, we need to consume all of
1510 the glyphs from that display vector. */
1511 start_display (&it2
, w
, top
);
1512 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1513 /* If we didn't get to CHARPOS - 1, there's some
1514 replacing display property at that position, and
1515 we stopped after it. That is exactly the place
1516 whose coordinates we want. */
1517 if (IT_CHARPOS (it2
) != charpos
- 1)
1521 /* Iterate until we get out of the display
1522 vector that displays the character at
1525 get_next_display_element (&it2
);
1526 PRODUCE_GLYPHS (&it2
);
1528 set_iterator_to_next (&it2
, 1);
1529 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1530 && IT_CHARPOS (it2
) < charpos
);
1532 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1533 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1534 top_x
= it
.glyph_row
->x
;
1537 top_x
= it2_prev
.current_x
;
1538 top_y
= it2_prev
.current_y
;
1542 else if (IT_CHARPOS (it
) != charpos
)
1544 Lisp_Object cpos
= make_number (charpos
);
1545 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1546 Lisp_Object string
= string_from_display_spec (spec
);
1547 struct text_pos tpos
;
1548 int replacing_spec_p
;
1549 bool newline_in_string
1551 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1553 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1556 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1557 charpos
, FRAME_WINDOW_P (it
.f
)));
1558 /* The tricky code below is needed because there's a
1559 discrepancy between move_it_to and how we set cursor
1560 when PT is at the beginning of a portion of text
1561 covered by a display property or an overlay with a
1562 display property, or the display line ends in a
1563 newline from a display string. move_it_to will stop
1564 _after_ such display strings, whereas
1565 set_cursor_from_row conspires with cursor_row_p to
1566 place the cursor on the first glyph produced from the
1569 /* We have overshoot PT because it is covered by a
1570 display property that replaces the text it covers.
1571 If the string includes embedded newlines, we are also
1572 in the wrong display line. Backtrack to the correct
1573 line, where the display property begins. */
1574 if (replacing_spec_p
)
1576 Lisp_Object startpos
, endpos
;
1577 EMACS_INT start
, end
;
1581 /* Find the first and the last buffer positions
1582 covered by the display string. */
1584 Fnext_single_char_property_change (cpos
, Qdisplay
,
1587 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1589 start
= XFASTINT (startpos
);
1590 end
= XFASTINT (endpos
);
1591 /* Move to the last buffer position before the
1592 display property. */
1593 start_display (&it3
, w
, top
);
1594 if (start
> CHARPOS (top
))
1595 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1596 /* Move forward one more line if the position before
1597 the display string is a newline or if it is the
1598 rightmost character on a line that is
1599 continued or word-wrapped. */
1600 if (it3
.method
== GET_FROM_BUFFER
1602 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1603 move_it_by_lines (&it3
, 1);
1604 else if (move_it_in_display_line_to (&it3
, -1,
1608 == MOVE_LINE_CONTINUED
)
1610 move_it_by_lines (&it3
, 1);
1611 /* When we are under word-wrap, the #$@%!
1612 move_it_by_lines moves 2 lines, so we need to
1614 if (it3
.line_wrap
== WORD_WRAP
)
1615 move_it_by_lines (&it3
, -1);
1618 /* Record the vertical coordinate of the display
1619 line where we wound up. */
1620 top_y
= it3
.current_y
;
1623 /* When characters are reordered for display,
1624 the character displayed to the left of the
1625 display string could be _after_ the display
1626 property in the logical order. Use the
1627 smallest vertical position of these two. */
1628 start_display (&it3
, w
, top
);
1629 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1630 if (it3
.current_y
< top_y
)
1631 top_y
= it3
.current_y
;
1633 /* Move from the top of the window to the beginning
1634 of the display line where the display string
1636 start_display (&it3
, w
, top
);
1637 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1638 /* If it3_moved stays zero after the 'while' loop
1639 below, that means we already were at a newline
1640 before the loop (e.g., the display string begins
1641 with a newline), so we don't need to (and cannot)
1642 inspect the glyphs of it3.glyph_row, because
1643 PRODUCE_GLYPHS will not produce anything for a
1644 newline, and thus it3.glyph_row stays at its
1645 stale content it got at top of the window. */
1647 /* Finally, advance the iterator until we hit the
1648 first display element whose character position is
1649 CHARPOS, or until the first newline from the
1650 display string, which signals the end of the
1652 while (get_next_display_element (&it3
))
1654 PRODUCE_GLYPHS (&it3
);
1655 if (IT_CHARPOS (it3
) == charpos
1656 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1659 set_iterator_to_next (&it3
, 0);
1661 top_x
= it3
.current_x
- it3
.pixel_width
;
1662 /* Normally, we would exit the above loop because we
1663 found the display element whose character
1664 position is CHARPOS. For the contingency that we
1665 didn't, and stopped at the first newline from the
1666 display string, move back over the glyphs
1667 produced from the string, until we find the
1668 rightmost glyph not from the string. */
1670 && newline_in_string
1671 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1673 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1674 + it3
.glyph_row
->used
[TEXT_AREA
];
1676 while (EQ ((g
- 1)->object
, string
))
1679 top_x
-= g
->pixel_width
;
1681 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1682 + it3
.glyph_row
->used
[TEXT_AREA
]);
1688 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1689 *rtop
= max (0, window_top_y
- top_y
);
1690 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1691 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1692 - max (top_y
, window_top_y
)));
1698 /* Either we were asked to provide info about WINDOW_END, or
1699 CHARPOS is in the partially visible glyph row at end of
1702 void *it2data
= NULL
;
1704 SAVE_IT (it2
, it
, it2data
);
1705 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1706 move_it_by_lines (&it
, 1);
1707 if (charpos
< IT_CHARPOS (it
)
1708 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1711 RESTORE_IT (&it2
, &it2
, it2data
);
1712 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1714 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1715 *rtop
= max (0, -it2
.current_y
);
1716 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1717 - it
.last_visible_y
));
1718 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1720 - max (it2
.current_y
,
1721 WINDOW_HEADER_LINE_HEIGHT (w
))));
1725 bidi_unshelve_cache (it2data
, 1);
1727 bidi_unshelve_cache (itdata
, 0);
1730 set_buffer_internal_1 (old_buffer
);
1732 if (visible_p
&& w
->hscroll
> 0)
1734 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1735 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1738 /* Debugging code. */
1740 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1741 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1743 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1750 /* Return the next character from STR. Return in *LEN the length of
1751 the character. This is like STRING_CHAR_AND_LENGTH but never
1752 returns an invalid character. If we find one, we return a `?', but
1753 with the length of the invalid character. */
1756 string_char_and_length (const unsigned char *str
, int *len
)
1760 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1761 if (!CHAR_VALID_P (c
))
1762 /* We may not change the length here because other places in Emacs
1763 don't use this function, i.e. they silently accept invalid
1772 /* Given a position POS containing a valid character and byte position
1773 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1775 static struct text_pos
1776 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1778 eassert (STRINGP (string
) && nchars
>= 0);
1780 if (STRING_MULTIBYTE (string
))
1782 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1787 string_char_and_length (p
, &len
);
1790 BYTEPOS (pos
) += len
;
1794 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1800 /* Value is the text position, i.e. character and byte position,
1801 for character position CHARPOS in STRING. */
1803 static struct text_pos
1804 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1806 struct text_pos pos
;
1807 eassert (STRINGP (string
));
1808 eassert (charpos
>= 0);
1809 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1814 /* Value is a text position, i.e. character and byte position, for
1815 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1816 means recognize multibyte characters. */
1818 static struct text_pos
1819 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1821 struct text_pos pos
;
1823 eassert (s
!= NULL
);
1824 eassert (charpos
>= 0);
1830 SET_TEXT_POS (pos
, 0, 0);
1833 string_char_and_length ((const unsigned char *) s
, &len
);
1836 BYTEPOS (pos
) += len
;
1840 SET_TEXT_POS (pos
, charpos
, charpos
);
1846 /* Value is the number of characters in C string S. MULTIBYTE_P
1847 non-zero means recognize multibyte characters. */
1850 number_of_chars (const char *s
, bool multibyte_p
)
1856 ptrdiff_t rest
= strlen (s
);
1858 const unsigned char *p
= (const unsigned char *) s
;
1860 for (nchars
= 0; rest
> 0; ++nchars
)
1862 string_char_and_length (p
, &len
);
1863 rest
-= len
, p
+= len
;
1867 nchars
= strlen (s
);
1873 /* Compute byte position NEWPOS->bytepos corresponding to
1874 NEWPOS->charpos. POS is a known position in string STRING.
1875 NEWPOS->charpos must be >= POS.charpos. */
1878 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1880 eassert (STRINGP (string
));
1881 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1883 if (STRING_MULTIBYTE (string
))
1884 *newpos
= string_pos_nchars_ahead (pos
, string
,
1885 CHARPOS (*newpos
) - CHARPOS (pos
));
1887 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1891 Return an estimation of the pixel height of mode or header lines on
1892 frame F. FACE_ID specifies what line's height to estimate. */
1895 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1897 #ifdef HAVE_WINDOW_SYSTEM
1898 if (FRAME_WINDOW_P (f
))
1900 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1902 /* This function is called so early when Emacs starts that the face
1903 cache and mode line face are not yet initialized. */
1904 if (FRAME_FACE_CACHE (f
))
1906 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1910 height
= FONT_HEIGHT (face
->font
);
1911 if (face
->box_line_width
> 0)
1912 height
+= 2 * face
->box_line_width
;
1923 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1924 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1925 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1926 not force the value into range. */
1929 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1930 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1933 #ifdef HAVE_WINDOW_SYSTEM
1934 if (FRAME_WINDOW_P (f
))
1936 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1937 even for negative values. */
1939 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1941 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1943 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1944 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1947 STORE_NATIVE_RECT (*bounds
,
1948 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1949 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1950 FRAME_COLUMN_WIDTH (f
) - 1,
1951 FRAME_LINE_HEIGHT (f
) - 1);
1953 /* PXW: Should we clip pixels before converting to columns/lines? */
1958 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1959 pix_x
= FRAME_TOTAL_COLS (f
);
1963 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1964 pix_y
= FRAME_TOTAL_LINES (f
);
1974 /* Find the glyph under window-relative coordinates X/Y in window W.
1975 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1976 strings. Return in *HPOS and *VPOS the row and column number of
1977 the glyph found. Return in *AREA the glyph area containing X.
1978 Value is a pointer to the glyph found or null if X/Y is not on
1979 text, or we can't tell because W's current matrix is not up to
1982 static struct glyph
*
1983 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1984 int *dx
, int *dy
, int *area
)
1986 struct glyph
*glyph
, *end
;
1987 struct glyph_row
*row
= NULL
;
1990 /* Find row containing Y. Give up if some row is not enabled. */
1991 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1993 row
= MATRIX_ROW (w
->current_matrix
, i
);
1994 if (!row
->enabled_p
)
1996 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2003 /* Give up if Y is not in the window. */
2004 if (i
== w
->current_matrix
->nrows
)
2007 /* Get the glyph area containing X. */
2008 if (w
->pseudo_window_p
)
2015 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2017 *area
= LEFT_MARGIN_AREA
;
2018 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2020 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2023 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2027 *area
= RIGHT_MARGIN_AREA
;
2028 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2032 /* Find glyph containing X. */
2033 glyph
= row
->glyphs
[*area
];
2034 end
= glyph
+ row
->used
[*area
];
2036 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2038 x
-= glyph
->pixel_width
;
2048 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2051 *hpos
= glyph
- row
->glyphs
[*area
];
2055 /* Convert frame-relative x/y to coordinates relative to window W.
2056 Takes pseudo-windows into account. */
2059 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2061 if (w
->pseudo_window_p
)
2063 /* A pseudo-window is always full-width, and starts at the
2064 left edge of the frame, plus a frame border. */
2065 struct frame
*f
= XFRAME (w
->frame
);
2066 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2067 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2071 *x
-= WINDOW_LEFT_EDGE_X (w
);
2072 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2076 #ifdef HAVE_WINDOW_SYSTEM
2079 Return in RECTS[] at most N clipping rectangles for glyph string S.
2080 Return the number of stored rectangles. */
2083 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2090 if (s
->row
->full_width_p
)
2092 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2093 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2094 if (s
->row
->mode_line_p
)
2095 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2097 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2099 /* Unless displaying a mode or menu bar line, which are always
2100 fully visible, clip to the visible part of the row. */
2101 if (s
->w
->pseudo_window_p
)
2102 r
.height
= s
->row
->visible_height
;
2104 r
.height
= s
->height
;
2108 /* This is a text line that may be partially visible. */
2109 r
.x
= window_box_left (s
->w
, s
->area
);
2110 r
.width
= window_box_width (s
->w
, s
->area
);
2111 r
.height
= s
->row
->visible_height
;
2115 if (r
.x
< s
->clip_head
->x
)
2117 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2118 r
.width
-= s
->clip_head
->x
- r
.x
;
2121 r
.x
= s
->clip_head
->x
;
2124 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2126 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2127 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2132 /* If S draws overlapping rows, it's sufficient to use the top and
2133 bottom of the window for clipping because this glyph string
2134 intentionally draws over other lines. */
2135 if (s
->for_overlaps
)
2137 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2138 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2140 /* Alas, the above simple strategy does not work for the
2141 environments with anti-aliased text: if the same text is
2142 drawn onto the same place multiple times, it gets thicker.
2143 If the overlap we are processing is for the erased cursor, we
2144 take the intersection with the rectangle of the cursor. */
2145 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2147 XRectangle rc
, r_save
= r
;
2149 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2150 rc
.y
= s
->w
->phys_cursor
.y
;
2151 rc
.width
= s
->w
->phys_cursor_width
;
2152 rc
.height
= s
->w
->phys_cursor_height
;
2154 x_intersect_rectangles (&r_save
, &rc
, &r
);
2159 /* Don't use S->y for clipping because it doesn't take partially
2160 visible lines into account. For example, it can be negative for
2161 partially visible lines at the top of a window. */
2162 if (!s
->row
->full_width_p
2163 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2164 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2166 r
.y
= max (0, s
->row
->y
);
2169 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2171 /* If drawing the cursor, don't let glyph draw outside its
2172 advertised boundaries. Cleartype does this under some circumstances. */
2173 if (s
->hl
== DRAW_CURSOR
)
2175 struct glyph
*glyph
= s
->first_glyph
;
2180 if (r
.width
>= s
->x
- r
.x
)
2181 r
.width
-= s
->x
- r
.x
;
2182 else /* R2L hscrolled row with cursor outside text area */
2186 r
.width
= min (r
.width
, glyph
->pixel_width
);
2188 /* If r.y is below window bottom, ensure that we still see a cursor. */
2189 height
= min (glyph
->ascent
+ glyph
->descent
,
2190 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2191 max_y
= window_text_bottom_y (s
->w
) - height
;
2192 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2193 if (s
->ybase
- glyph
->ascent
> max_y
)
2200 /* Don't draw cursor glyph taller than our actual glyph. */
2201 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2202 if (height
< r
.height
)
2204 max_y
= r
.y
+ r
.height
;
2205 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2206 r
.height
= min (max_y
- r
.y
, height
);
2213 XRectangle r_save
= r
;
2215 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2219 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2220 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2222 #ifdef CONVERT_FROM_XRECT
2223 CONVERT_FROM_XRECT (r
, *rects
);
2231 /* If we are processing overlapping and allowed to return
2232 multiple clipping rectangles, we exclude the row of the glyph
2233 string from the clipping rectangle. This is to avoid drawing
2234 the same text on the environment with anti-aliasing. */
2235 #ifdef CONVERT_FROM_XRECT
2238 XRectangle
*rs
= rects
;
2240 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2242 if (s
->for_overlaps
& OVERLAPS_PRED
)
2245 if (r
.y
+ r
.height
> row_y
)
2248 rs
[i
].height
= row_y
- r
.y
;
2254 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2257 if (r
.y
< row_y
+ s
->row
->visible_height
)
2259 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2261 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2262 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2271 #ifdef CONVERT_FROM_XRECT
2272 for (i
= 0; i
< n
; i
++)
2273 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2280 Return in *NR the clipping rectangle for glyph string S. */
2283 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2285 get_glyph_string_clip_rects (s
, nr
, 1);
2290 Return the position and height of the phys cursor in window W.
2291 Set w->phys_cursor_width to width of phys cursor.
2295 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2296 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2299 int x
, y
, wd
, h
, h0
, y0
;
2301 /* Compute the width of the rectangle to draw. If on a stretch
2302 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2303 rectangle as wide as the glyph, but use a canonical character
2305 wd
= glyph
->pixel_width
- 1;
2306 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2310 x
= w
->phys_cursor
.x
;
2317 if (glyph
->type
== STRETCH_GLYPH
2318 && !x_stretch_cursor_p
)
2319 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2320 w
->phys_cursor_width
= wd
;
2322 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2324 /* If y is below window bottom, ensure that we still see a cursor. */
2325 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2327 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2328 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2330 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2333 h
= max (h
- (y0
- y
) + 1, h0
);
2338 y0
= window_text_bottom_y (w
) - h0
;
2346 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2347 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2352 * Remember which glyph the mouse is over.
2356 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2360 struct glyph_row
*r
, *gr
, *end_row
;
2361 enum window_part part
;
2362 enum glyph_row_area area
;
2363 int x
, y
, width
, height
;
2365 /* Try to determine frame pixel position and size of the glyph under
2366 frame pixel coordinates X/Y on frame F. */
2368 if (window_resize_pixelwise
)
2373 else if (!f
->glyphs_initialized_p
2374 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2377 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2378 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2382 w
= XWINDOW (window
);
2383 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2384 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2386 x
= window_relative_x_coord (w
, part
, gx
);
2387 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2389 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2390 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2392 if (w
->pseudo_window_p
)
2395 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2401 case ON_LEFT_MARGIN
:
2402 area
= LEFT_MARGIN_AREA
;
2405 case ON_RIGHT_MARGIN
:
2406 area
= RIGHT_MARGIN_AREA
;
2409 case ON_HEADER_LINE
:
2411 gr
= (part
== ON_HEADER_LINE
2412 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2413 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2416 goto text_glyph_row_found
;
2423 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2424 if (r
->y
+ r
->height
> y
)
2430 text_glyph_row_found
:
2433 struct glyph
*g
= gr
->glyphs
[area
];
2434 struct glyph
*end
= g
+ gr
->used
[area
];
2436 height
= gr
->height
;
2437 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2438 if (gx
+ g
->pixel_width
> x
)
2443 if (g
->type
== IMAGE_GLYPH
)
2445 /* Don't remember when mouse is over image, as
2446 image may have hot-spots. */
2447 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2450 width
= g
->pixel_width
;
2454 /* Use nominal char spacing at end of line. */
2456 gx
+= (x
/ width
) * width
;
2459 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2461 gx
+= window_box_left_offset (w
, area
);
2462 /* Don't expand over the modeline to make sure the vertical
2463 drag cursor is shown early enough. */
2464 height
= min (height
,
2465 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2470 /* Use nominal line height at end of window. */
2471 gx
= (x
/ width
) * width
;
2473 gy
+= (y
/ height
) * height
;
2474 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2475 /* See comment above. */
2476 height
= min (height
,
2477 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2481 case ON_LEFT_FRINGE
:
2482 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2483 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2484 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2485 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2488 case ON_RIGHT_FRINGE
:
2489 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2490 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2491 : window_box_right_offset (w
, TEXT_AREA
));
2492 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2493 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2494 && !WINDOW_RIGHTMOST_P (w
))
2495 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2496 /* Make sure the vertical border can get her own glyph to the
2497 right of the one we build here. */
2498 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2500 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2502 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2506 case ON_VERTICAL_BORDER
:
2507 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2510 case ON_VERTICAL_SCROLL_BAR
:
2511 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2513 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2514 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2515 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2517 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2521 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2522 if (r
->y
+ r
->height
> y
)
2529 height
= gr
->height
;
2532 /* Use nominal line height at end of window. */
2534 gy
+= (y
/ height
) * height
;
2538 case ON_RIGHT_DIVIDER
:
2539 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2540 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2542 /* The bottom divider prevails. */
2543 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2546 case ON_BOTTOM_DIVIDER
:
2548 width
= WINDOW_PIXEL_WIDTH (w
);
2549 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2550 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2556 /* If there is no glyph under the mouse, then we divide the screen
2557 into a grid of the smallest glyph in the frame, and use that
2560 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2561 round down even for negative values. */
2567 gx
= (gx
/ width
) * width
;
2568 gy
= (gy
/ height
) * height
;
2574 gx
+= WINDOW_LEFT_EDGE_X (w
);
2575 gy
+= WINDOW_TOP_EDGE_Y (w
);
2578 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2580 /* Visible feedback for debugging. */
2583 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2584 f
->output_data
.x
->normal_gc
,
2585 gx
, gy
, width
, height
);
2591 #endif /* HAVE_WINDOW_SYSTEM */
2594 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2597 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2598 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2600 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2603 /***********************************************************************
2604 Lisp form evaluation
2605 ***********************************************************************/
2607 /* Error handler for safe_eval and safe_call. */
2610 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2612 add_to_log ("Error during redisplay: %S signaled %S",
2613 Flist (nargs
, args
), arg
);
2617 /* Call function FUNC with the rest of NARGS - 1 arguments
2618 following. Return the result, or nil if something went
2619 wrong. Prevent redisplay during the evaluation. */
2622 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2626 if (inhibit_eval_during_redisplay
)
2631 ptrdiff_t count
= SPECPDL_INDEX ();
2634 SAFE_ALLOCA_LISP (args
, nargs
);
2637 for (i
= 1; i
< nargs
; i
++)
2638 args
[i
] = va_arg (ap
, Lisp_Object
);
2640 specbind (Qinhibit_redisplay
, Qt
);
2642 specbind (Qinhibit_quit
, Qt
);
2643 /* Use Qt to ensure debugger does not run,
2644 so there is no possibility of wanting to redisplay. */
2645 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2648 val
= unbind_to (count
, val
);
2655 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2660 va_start (ap
, func
);
2661 retval
= safe__call (false, nargs
, func
, ap
);
2666 /* Call function FN with one argument ARG.
2667 Return the result, or nil if something went wrong. */
2670 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2672 return safe_call (2, fn
, arg
);
2676 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2682 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2687 static Lisp_Object Qeval
;
2690 safe_eval (Lisp_Object sexpr
)
2692 return safe__call1 (false, Qeval
, sexpr
);
2696 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2698 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2701 /* Call function FN with two arguments ARG1 and ARG2.
2702 Return the result, or nil if something went wrong. */
2705 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2707 return safe_call (3, fn
, arg1
, arg2
);
2712 /***********************************************************************
2714 ***********************************************************************/
2718 /* Define CHECK_IT to perform sanity checks on iterators.
2719 This is for debugging. It is too slow to do unconditionally. */
2722 check_it (struct it
*it
)
2724 if (it
->method
== GET_FROM_STRING
)
2726 eassert (STRINGP (it
->string
));
2727 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2731 eassert (IT_STRING_CHARPOS (*it
) < 0);
2732 if (it
->method
== GET_FROM_BUFFER
)
2734 /* Check that character and byte positions agree. */
2735 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2740 eassert (it
->current
.dpvec_index
>= 0);
2742 eassert (it
->current
.dpvec_index
< 0);
2745 #define CHECK_IT(IT) check_it ((IT))
2749 #define CHECK_IT(IT) (void) 0
2754 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2756 /* Check that the window end of window W is what we expect it
2757 to be---the last row in the current matrix displaying text. */
2760 check_window_end (struct window
*w
)
2762 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2764 struct glyph_row
*row
;
2765 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2767 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2768 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2772 #define CHECK_WINDOW_END(W) check_window_end ((W))
2776 #define CHECK_WINDOW_END(W) (void) 0
2778 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2780 /***********************************************************************
2781 Iterator initialization
2782 ***********************************************************************/
2784 /* Initialize IT for displaying current_buffer in window W, starting
2785 at character position CHARPOS. CHARPOS < 0 means that no buffer
2786 position is specified which is useful when the iterator is assigned
2787 a position later. BYTEPOS is the byte position corresponding to
2790 If ROW is not null, calls to produce_glyphs with IT as parameter
2791 will produce glyphs in that row.
2793 BASE_FACE_ID is the id of a base face to use. It must be one of
2794 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2795 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2796 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2798 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2799 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2800 will be initialized to use the corresponding mode line glyph row of
2801 the desired matrix of W. */
2804 init_iterator (struct it
*it
, struct window
*w
,
2805 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2806 struct glyph_row
*row
, enum face_id base_face_id
)
2808 enum face_id remapped_base_face_id
= base_face_id
;
2810 /* Some precondition checks. */
2811 eassert (w
!= NULL
&& it
!= NULL
);
2812 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2815 /* If face attributes have been changed since the last redisplay,
2816 free realized faces now because they depend on face definitions
2817 that might have changed. Don't free faces while there might be
2818 desired matrices pending which reference these faces. */
2819 if (face_change_count
&& !inhibit_free_realized_faces
)
2821 face_change_count
= 0;
2822 free_all_realized_faces (Qnil
);
2825 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2826 if (! NILP (Vface_remapping_alist
))
2827 remapped_base_face_id
2828 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2830 /* Use one of the mode line rows of W's desired matrix if
2834 if (base_face_id
== MODE_LINE_FACE_ID
2835 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2836 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2837 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2838 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2842 memset (it
, 0, sizeof *it
);
2843 it
->current
.overlay_string_index
= -1;
2844 it
->current
.dpvec_index
= -1;
2845 it
->base_face_id
= remapped_base_face_id
;
2847 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2848 it
->paragraph_embedding
= L2R
;
2849 it
->bidi_it
.string
.lstring
= Qnil
;
2850 it
->bidi_it
.string
.s
= NULL
;
2851 it
->bidi_it
.string
.bufpos
= 0;
2854 /* The window in which we iterate over current_buffer: */
2855 XSETWINDOW (it
->window
, w
);
2857 it
->f
= XFRAME (w
->frame
);
2861 /* Extra space between lines (on window systems only). */
2862 if (base_face_id
== DEFAULT_FACE_ID
2863 && FRAME_WINDOW_P (it
->f
))
2865 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2866 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2867 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2868 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2869 * FRAME_LINE_HEIGHT (it
->f
));
2870 else if (it
->f
->extra_line_spacing
> 0)
2871 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2872 it
->max_extra_line_spacing
= 0;
2875 /* If realized faces have been removed, e.g. because of face
2876 attribute changes of named faces, recompute them. When running
2877 in batch mode, the face cache of the initial frame is null. If
2878 we happen to get called, make a dummy face cache. */
2879 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2880 init_frame_faces (it
->f
);
2881 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2882 recompute_basic_faces (it
->f
);
2884 /* Current value of the `slice', `space-width', and 'height' properties. */
2885 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2886 it
->space_width
= Qnil
;
2887 it
->font_height
= Qnil
;
2888 it
->override_ascent
= -1;
2890 /* Are control characters displayed as `^C'? */
2891 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2893 /* -1 means everything between a CR and the following line end
2894 is invisible. >0 means lines indented more than this value are
2896 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2898 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2900 : (!NILP (BVAR (current_buffer
, selective_display
))
2902 it
->selective_display_ellipsis_p
2903 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2905 /* Display table to use. */
2906 it
->dp
= window_display_table (w
);
2908 /* Are multibyte characters enabled in current_buffer? */
2909 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2911 /* Get the position at which the redisplay_end_trigger hook should
2912 be run, if it is to be run at all. */
2913 if (MARKERP (w
->redisplay_end_trigger
)
2914 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2915 it
->redisplay_end_trigger_charpos
2916 = marker_position (w
->redisplay_end_trigger
);
2917 else if (INTEGERP (w
->redisplay_end_trigger
))
2918 it
->redisplay_end_trigger_charpos
2919 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2922 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2924 /* Are lines in the display truncated? */
2925 if (base_face_id
!= DEFAULT_FACE_ID
2927 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2928 && ((!NILP (Vtruncate_partial_width_windows
)
2929 && !INTEGERP (Vtruncate_partial_width_windows
))
2930 || (INTEGERP (Vtruncate_partial_width_windows
)
2931 /* PXW: Shall we do something about this? */
2932 && (WINDOW_TOTAL_COLS (it
->w
)
2933 < XINT (Vtruncate_partial_width_windows
))))))
2934 it
->line_wrap
= TRUNCATE
;
2935 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2936 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2937 ? WINDOW_WRAP
: WORD_WRAP
;
2939 it
->line_wrap
= TRUNCATE
;
2941 /* Get dimensions of truncation and continuation glyphs. These are
2942 displayed as fringe bitmaps under X, but we need them for such
2943 frames when the fringes are turned off. But leave the dimensions
2944 zero for tooltip frames, as these glyphs look ugly there and also
2945 sabotage calculations of tooltip dimensions in x-show-tip. */
2946 #ifdef HAVE_WINDOW_SYSTEM
2947 if (!(FRAME_WINDOW_P (it
->f
)
2948 && FRAMEP (tip_frame
)
2949 && it
->f
== XFRAME (tip_frame
)))
2952 if (it
->line_wrap
== TRUNCATE
)
2954 /* We will need the truncation glyph. */
2955 eassert (it
->glyph_row
== NULL
);
2956 produce_special_glyphs (it
, IT_TRUNCATION
);
2957 it
->truncation_pixel_width
= it
->pixel_width
;
2961 /* We will need the continuation glyph. */
2962 eassert (it
->glyph_row
== NULL
);
2963 produce_special_glyphs (it
, IT_CONTINUATION
);
2964 it
->continuation_pixel_width
= it
->pixel_width
;
2968 /* Reset these values to zero because the produce_special_glyphs
2969 above has changed them. */
2970 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2971 it
->phys_ascent
= it
->phys_descent
= 0;
2973 /* Set this after getting the dimensions of truncation and
2974 continuation glyphs, so that we don't produce glyphs when calling
2975 produce_special_glyphs, above. */
2976 it
->glyph_row
= row
;
2977 it
->area
= TEXT_AREA
;
2979 /* Get the dimensions of the display area. The display area
2980 consists of the visible window area plus a horizontally scrolled
2981 part to the left of the window. All x-values are relative to the
2982 start of this total display area. */
2983 if (base_face_id
!= DEFAULT_FACE_ID
)
2985 /* Mode lines, menu bar in terminal frames. */
2986 it
->first_visible_x
= 0;
2987 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2992 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2993 it
->last_visible_x
= (it
->first_visible_x
2994 + window_box_width (w
, TEXT_AREA
));
2996 /* If we truncate lines, leave room for the truncation glyph(s) at
2997 the right margin. Otherwise, leave room for the continuation
2998 glyph(s). Done only if the window has no right fringe. */
2999 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
3001 if (it
->line_wrap
== TRUNCATE
)
3002 it
->last_visible_x
-= it
->truncation_pixel_width
;
3004 it
->last_visible_x
-= it
->continuation_pixel_width
;
3007 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3008 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3011 /* Leave room for a border glyph. */
3012 if (!FRAME_WINDOW_P (it
->f
)
3013 && !WINDOW_RIGHTMOST_P (it
->w
))
3014 it
->last_visible_x
-= 1;
3016 it
->last_visible_y
= window_text_bottom_y (w
);
3018 /* For mode lines and alike, arrange for the first glyph having a
3019 left box line if the face specifies a box. */
3020 if (base_face_id
!= DEFAULT_FACE_ID
)
3024 it
->face_id
= remapped_base_face_id
;
3026 /* If we have a boxed mode line, make the first character appear
3027 with a left box line. */
3028 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3029 if (face
&& face
->box
!= FACE_NO_BOX
)
3030 it
->start_of_box_run_p
= true;
3033 /* If a buffer position was specified, set the iterator there,
3034 getting overlays and face properties from that position. */
3035 if (charpos
>= BUF_BEG (current_buffer
))
3037 it
->stop_charpos
= charpos
;
3038 it
->end_charpos
= ZV
;
3039 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3040 IT_CHARPOS (*it
) = charpos
;
3041 IT_BYTEPOS (*it
) = bytepos
;
3043 /* We will rely on `reseat' to set this up properly, via
3044 handle_face_prop. */
3045 it
->face_id
= it
->base_face_id
;
3047 it
->start
= it
->current
;
3048 /* Do we need to reorder bidirectional text? Not if this is a
3049 unibyte buffer: by definition, none of the single-byte
3050 characters are strong R2L, so no reordering is needed. And
3051 bidi.c doesn't support unibyte buffers anyway. Also, don't
3052 reorder while we are loading loadup.el, since the tables of
3053 character properties needed for reordering are not yet
3057 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3060 /* If we are to reorder bidirectional text, init the bidi
3064 /* Since we don't know at this point whether there will be
3065 any R2L lines in the window, we reserve space for
3066 truncation/continuation glyphs even if only the left
3067 fringe is absent. */
3068 if (base_face_id
== DEFAULT_FACE_ID
3069 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
3070 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
3072 if (it
->line_wrap
== TRUNCATE
)
3073 it
->last_visible_x
-= it
->truncation_pixel_width
;
3075 it
->last_visible_x
-= it
->continuation_pixel_width
;
3077 /* Note the paragraph direction that this buffer wants to
3079 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3081 it
->paragraph_embedding
= L2R
;
3082 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3084 it
->paragraph_embedding
= R2L
;
3086 it
->paragraph_embedding
= NEUTRAL_DIR
;
3087 bidi_unshelve_cache (NULL
, 0);
3088 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3092 /* Compute faces etc. */
3093 reseat (it
, it
->current
.pos
, 1);
3100 /* Initialize IT for the display of window W with window start POS. */
3103 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3105 struct glyph_row
*row
;
3106 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3108 row
= w
->desired_matrix
->rows
+ first_vpos
;
3109 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3110 it
->first_vpos
= first_vpos
;
3112 /* Don't reseat to previous visible line start if current start
3113 position is in a string or image. */
3114 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3116 int start_at_line_beg_p
;
3117 int first_y
= it
->current_y
;
3119 /* If window start is not at a line start, skip forward to POS to
3120 get the correct continuation lines width. */
3121 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3122 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3123 if (!start_at_line_beg_p
)
3127 reseat_at_previous_visible_line_start (it
);
3128 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3130 new_x
= it
->current_x
+ it
->pixel_width
;
3132 /* If lines are continued, this line may end in the middle
3133 of a multi-glyph character (e.g. a control character
3134 displayed as \003, or in the middle of an overlay
3135 string). In this case move_it_to above will not have
3136 taken us to the start of the continuation line but to the
3137 end of the continued line. */
3138 if (it
->current_x
> 0
3139 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3140 && (/* And glyph doesn't fit on the line. */
3141 new_x
> it
->last_visible_x
3142 /* Or it fits exactly and we're on a window
3144 || (new_x
== it
->last_visible_x
3145 && FRAME_WINDOW_P (it
->f
)
3146 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3147 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3148 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3150 if ((it
->current
.dpvec_index
>= 0
3151 || it
->current
.overlay_string_index
>= 0)
3152 /* If we are on a newline from a display vector or
3153 overlay string, then we are already at the end of
3154 a screen line; no need to go to the next line in
3155 that case, as this line is not really continued.
3156 (If we do go to the next line, C-e will not DTRT.) */
3159 set_iterator_to_next (it
, 1);
3160 move_it_in_display_line_to (it
, -1, -1, 0);
3163 it
->continuation_lines_width
+= it
->current_x
;
3165 /* If the character at POS is displayed via a display
3166 vector, move_it_to above stops at the final glyph of
3167 IT->dpvec. To make the caller redisplay that character
3168 again (a.k.a. start at POS), we need to reset the
3169 dpvec_index to the beginning of IT->dpvec. */
3170 else if (it
->current
.dpvec_index
>= 0)
3171 it
->current
.dpvec_index
= 0;
3173 /* We're starting a new display line, not affected by the
3174 height of the continued line, so clear the appropriate
3175 fields in the iterator structure. */
3176 it
->max_ascent
= it
->max_descent
= 0;
3177 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3179 it
->current_y
= first_y
;
3181 it
->current_x
= it
->hpos
= 0;
3187 /* Return 1 if POS is a position in ellipses displayed for invisible
3188 text. W is the window we display, for text property lookup. */
3191 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3193 Lisp_Object prop
, window
;
3195 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3197 /* If POS specifies a position in a display vector, this might
3198 be for an ellipsis displayed for invisible text. We won't
3199 get the iterator set up for delivering that ellipsis unless
3200 we make sure that it gets aware of the invisible text. */
3201 if (pos
->dpvec_index
>= 0
3202 && pos
->overlay_string_index
< 0
3203 && CHARPOS (pos
->string_pos
) < 0
3205 && (XSETWINDOW (window
, w
),
3206 prop
= Fget_char_property (make_number (charpos
),
3207 Qinvisible
, window
),
3208 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3210 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3212 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3219 /* Initialize IT for stepping through current_buffer in window W,
3220 starting at position POS that includes overlay string and display
3221 vector/ control character translation position information. Value
3222 is zero if there are overlay strings with newlines at POS. */
3225 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3227 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3228 int i
, overlay_strings_with_newlines
= 0;
3230 /* If POS specifies a position in a display vector, this might
3231 be for an ellipsis displayed for invisible text. We won't
3232 get the iterator set up for delivering that ellipsis unless
3233 we make sure that it gets aware of the invisible text. */
3234 if (in_ellipses_for_invisible_text_p (pos
, w
))
3240 /* Keep in mind: the call to reseat in init_iterator skips invisible
3241 text, so we might end up at a position different from POS. This
3242 is only a problem when POS is a row start after a newline and an
3243 overlay starts there with an after-string, and the overlay has an
3244 invisible property. Since we don't skip invisible text in
3245 display_line and elsewhere immediately after consuming the
3246 newline before the row start, such a POS will not be in a string,
3247 but the call to init_iterator below will move us to the
3249 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3251 /* This only scans the current chunk -- it should scan all chunks.
3252 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3253 to 16 in 22.1 to make this a lesser problem. */
3254 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3256 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3257 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3259 while (s
< e
&& *s
!= '\n')
3264 overlay_strings_with_newlines
= 1;
3269 /* If position is within an overlay string, set up IT to the right
3271 if (pos
->overlay_string_index
>= 0)
3275 /* If the first overlay string happens to have a `display'
3276 property for an image, the iterator will be set up for that
3277 image, and we have to undo that setup first before we can
3278 correct the overlay string index. */
3279 if (it
->method
== GET_FROM_IMAGE
)
3282 /* We already have the first chunk of overlay strings in
3283 IT->overlay_strings. Load more until the one for
3284 pos->overlay_string_index is in IT->overlay_strings. */
3285 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3287 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3288 it
->current
.overlay_string_index
= 0;
3291 load_overlay_strings (it
, 0);
3292 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3296 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3297 relative_index
= (it
->current
.overlay_string_index
3298 % OVERLAY_STRING_CHUNK_SIZE
);
3299 it
->string
= it
->overlay_strings
[relative_index
];
3300 eassert (STRINGP (it
->string
));
3301 it
->current
.string_pos
= pos
->string_pos
;
3302 it
->method
= GET_FROM_STRING
;
3303 it
->end_charpos
= SCHARS (it
->string
);
3304 /* Set up the bidi iterator for this overlay string. */
3307 it
->bidi_it
.string
.lstring
= it
->string
;
3308 it
->bidi_it
.string
.s
= NULL
;
3309 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3310 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3311 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3312 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3313 it
->bidi_it
.w
= it
->w
;
3314 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3315 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3317 /* Synchronize the state of the bidi iterator with
3318 pos->string_pos. For any string position other than
3319 zero, this will be done automagically when we resume
3320 iteration over the string and get_visually_first_element
3321 is called. But if string_pos is zero, and the string is
3322 to be reordered for display, we need to resync manually,
3323 since it could be that the iteration state recorded in
3324 pos ended at string_pos of 0 moving backwards in string. */
3325 if (CHARPOS (pos
->string_pos
) == 0)
3327 get_visually_first_element (it
);
3328 if (IT_STRING_CHARPOS (*it
) != 0)
3331 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3332 bidi_move_to_visually_next (&it
->bidi_it
);
3333 } while (it
->bidi_it
.charpos
!= 0);
3335 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3336 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3340 if (CHARPOS (pos
->string_pos
) >= 0)
3342 /* Recorded position is not in an overlay string, but in another
3343 string. This can only be a string from a `display' property.
3344 IT should already be filled with that string. */
3345 it
->current
.string_pos
= pos
->string_pos
;
3346 eassert (STRINGP (it
->string
));
3348 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3349 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3352 /* Restore position in display vector translations, control
3353 character translations or ellipses. */
3354 if (pos
->dpvec_index
>= 0)
3356 if (it
->dpvec
== NULL
)
3357 get_next_display_element (it
);
3358 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3359 it
->current
.dpvec_index
= pos
->dpvec_index
;
3363 return !overlay_strings_with_newlines
;
3367 /* Initialize IT for stepping through current_buffer in window W
3368 starting at ROW->start. */
3371 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3373 init_from_display_pos (it
, w
, &row
->start
);
3374 it
->start
= row
->start
;
3375 it
->continuation_lines_width
= row
->continuation_lines_width
;
3380 /* Initialize IT for stepping through current_buffer in window W
3381 starting in the line following ROW, i.e. starting at ROW->end.
3382 Value is zero if there are overlay strings with newlines at ROW's
3386 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3390 if (init_from_display_pos (it
, w
, &row
->end
))
3392 if (row
->continued_p
)
3393 it
->continuation_lines_width
3394 = row
->continuation_lines_width
+ row
->pixel_width
;
3405 /***********************************************************************
3407 ***********************************************************************/
3409 /* Called when IT reaches IT->stop_charpos. Handle text property and
3410 overlay changes. Set IT->stop_charpos to the next position where
3414 handle_stop (struct it
*it
)
3416 enum prop_handled handled
;
3417 int handle_overlay_change_p
;
3421 it
->current
.dpvec_index
= -1;
3422 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3423 it
->ignore_overlay_strings_at_pos_p
= 0;
3426 /* Use face of preceding text for ellipsis (if invisible) */
3427 if (it
->selective_display_ellipsis_p
)
3428 it
->saved_face_id
= it
->face_id
;
3430 /* Here's the description of the semantics of, and the logic behind,
3431 the various HANDLED_* statuses:
3433 HANDLED_NORMALLY means the handler did its job, and the loop
3434 should proceed to calling the next handler in order.
3436 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3437 change in the properties and overlays at current position, so the
3438 loop should be restarted, to re-invoke the handlers that were
3439 already called. This happens when fontification-functions were
3440 called by handle_fontified_prop, and actually fontified
3441 something. Another case where HANDLED_RECOMPUTE_PROPS is
3442 returned is when we discover overlay strings that need to be
3443 displayed right away. The loop below will continue for as long
3444 as the status is HANDLED_RECOMPUTE_PROPS.
3446 HANDLED_RETURN means return immediately to the caller, to
3447 continue iteration without calling any further handlers. This is
3448 used when we need to act on some property right away, for example
3449 when we need to display the ellipsis or a replacing display
3450 property, such as display string or image.
3452 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3453 consumed, and the handler switched to the next overlay string.
3454 This signals the loop below to refrain from looking for more
3455 overlays before all the overlay strings of the current overlay
3458 Some of the handlers called by the loop push the iterator state
3459 onto the stack (see 'push_it'), and arrange for the iteration to
3460 continue with another object, such as an image, a display string,
3461 or an overlay string. In most such cases, it->stop_charpos is
3462 set to the first character of the string, so that when the
3463 iteration resumes, this function will immediately be called
3464 again, to examine the properties at the beginning of the string.
3466 When a display or overlay string is exhausted, the iterator state
3467 is popped (see 'pop_it'), and iteration continues with the
3468 previous object. Again, in many such cases this function is
3469 called again to find the next position where properties might
3474 handled
= HANDLED_NORMALLY
;
3476 /* Call text property handlers. */
3477 for (p
= it_props
; p
->handler
; ++p
)
3479 handled
= p
->handler (it
);
3481 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3483 else if (handled
== HANDLED_RETURN
)
3485 /* We still want to show before and after strings from
3486 overlays even if the actual buffer text is replaced. */
3487 if (!handle_overlay_change_p
3489 /* Don't call get_overlay_strings_1 if we already
3490 have overlay strings loaded, because doing so
3491 will load them again and push the iterator state
3492 onto the stack one more time, which is not
3493 expected by the rest of the code that processes
3495 || (it
->current
.overlay_string_index
< 0
3496 ? !get_overlay_strings_1 (it
, 0, 0)
3500 setup_for_ellipsis (it
, 0);
3501 /* When handling a display spec, we might load an
3502 empty string. In that case, discard it here. We
3503 used to discard it in handle_single_display_spec,
3504 but that causes get_overlay_strings_1, above, to
3505 ignore overlay strings that we must check. */
3506 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3510 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3514 it
->ignore_overlay_strings_at_pos_p
= true;
3515 it
->string_from_display_prop_p
= 0;
3516 it
->from_disp_prop_p
= 0;
3517 handle_overlay_change_p
= 0;
3519 handled
= HANDLED_RECOMPUTE_PROPS
;
3522 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3523 handle_overlay_change_p
= 0;
3526 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3528 /* Don't check for overlay strings below when set to deliver
3529 characters from a display vector. */
3530 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3531 handle_overlay_change_p
= 0;
3533 /* Handle overlay changes.
3534 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3535 if it finds overlays. */
3536 if (handle_overlay_change_p
)
3537 handled
= handle_overlay_change (it
);
3542 setup_for_ellipsis (it
, 0);
3546 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3548 /* Determine where to stop next. */
3549 if (handled
== HANDLED_NORMALLY
)
3550 compute_stop_pos (it
);
3554 /* Compute IT->stop_charpos from text property and overlay change
3555 information for IT's current position. */
3558 compute_stop_pos (struct it
*it
)
3560 register INTERVAL iv
, next_iv
;
3561 Lisp_Object object
, limit
, position
;
3562 ptrdiff_t charpos
, bytepos
;
3564 if (STRINGP (it
->string
))
3566 /* Strings are usually short, so don't limit the search for
3568 it
->stop_charpos
= it
->end_charpos
;
3569 object
= it
->string
;
3571 charpos
= IT_STRING_CHARPOS (*it
);
3572 bytepos
= IT_STRING_BYTEPOS (*it
);
3578 /* If end_charpos is out of range for some reason, such as a
3579 misbehaving display function, rationalize it (Bug#5984). */
3580 if (it
->end_charpos
> ZV
)
3581 it
->end_charpos
= ZV
;
3582 it
->stop_charpos
= it
->end_charpos
;
3584 /* If next overlay change is in front of the current stop pos
3585 (which is IT->end_charpos), stop there. Note: value of
3586 next_overlay_change is point-max if no overlay change
3588 charpos
= IT_CHARPOS (*it
);
3589 bytepos
= IT_BYTEPOS (*it
);
3590 pos
= next_overlay_change (charpos
);
3591 if (pos
< it
->stop_charpos
)
3592 it
->stop_charpos
= pos
;
3594 /* Set up variables for computing the stop position from text
3595 property changes. */
3596 XSETBUFFER (object
, current_buffer
);
3597 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3600 /* Get the interval containing IT's position. Value is a null
3601 interval if there isn't such an interval. */
3602 position
= make_number (charpos
);
3603 iv
= validate_interval_range (object
, &position
, &position
, 0);
3606 Lisp_Object values_here
[LAST_PROP_IDX
];
3609 /* Get properties here. */
3610 for (p
= it_props
; p
->handler
; ++p
)
3611 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3613 /* Look for an interval following iv that has different
3615 for (next_iv
= next_interval (iv
);
3618 || XFASTINT (limit
) > next_iv
->position
));
3619 next_iv
= next_interval (next_iv
))
3621 for (p
= it_props
; p
->handler
; ++p
)
3623 Lisp_Object new_value
;
3625 new_value
= textget (next_iv
->plist
, *p
->name
);
3626 if (!EQ (values_here
[p
->idx
], new_value
))
3636 if (INTEGERP (limit
)
3637 && next_iv
->position
>= XFASTINT (limit
))
3638 /* No text property change up to limit. */
3639 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3641 /* Text properties change in next_iv. */
3642 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3646 if (it
->cmp_it
.id
< 0)
3648 ptrdiff_t stoppos
= it
->end_charpos
;
3650 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3652 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3653 stoppos
, it
->string
);
3656 eassert (STRINGP (it
->string
)
3657 || (it
->stop_charpos
>= BEGV
3658 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3662 /* Return the position of the next overlay change after POS in
3663 current_buffer. Value is point-max if no overlay change
3664 follows. This is like `next-overlay-change' but doesn't use
3668 next_overlay_change (ptrdiff_t pos
)
3670 ptrdiff_t i
, noverlays
;
3672 Lisp_Object
*overlays
;
3675 /* Get all overlays at the given position. */
3676 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3678 /* If any of these overlays ends before endpos,
3679 use its ending point instead. */
3680 for (i
= 0; i
< noverlays
; ++i
)
3685 oend
= OVERLAY_END (overlays
[i
]);
3686 oendpos
= OVERLAY_POSITION (oend
);
3687 endpos
= min (endpos
, oendpos
);
3694 /* How many characters forward to search for a display property or
3695 display string. Searching too far forward makes the bidi display
3696 sluggish, especially in small windows. */
3697 #define MAX_DISP_SCAN 250
3699 /* Return the character position of a display string at or after
3700 position specified by POSITION. If no display string exists at or
3701 after POSITION, return ZV. A display string is either an overlay
3702 with `display' property whose value is a string, or a `display'
3703 text property whose value is a string. STRING is data about the
3704 string to iterate; if STRING->lstring is nil, we are iterating a
3705 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3706 on a GUI frame. DISP_PROP is set to zero if we searched
3707 MAX_DISP_SCAN characters forward without finding any display
3708 strings, non-zero otherwise. It is set to 2 if the display string
3709 uses any kind of `(space ...)' spec that will produce a stretch of
3710 white space in the text area. */
3712 compute_display_string_pos (struct text_pos
*position
,
3713 struct bidi_string_data
*string
,
3715 int frame_window_p
, int *disp_prop
)
3717 /* OBJECT = nil means current buffer. */
3718 Lisp_Object object
, object1
;
3719 Lisp_Object pos
, spec
, limpos
;
3720 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3721 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3722 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3723 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3725 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3726 struct text_pos tpos
;
3729 if (string
&& STRINGP (string
->lstring
))
3730 object1
= object
= string
->lstring
;
3731 else if (w
&& !string_p
)
3733 XSETWINDOW (object
, w
);
3737 object1
= object
= Qnil
;
3742 /* We don't support display properties whose values are strings
3743 that have display string properties. */
3744 || string
->from_disp_str
3745 /* C strings cannot have display properties. */
3746 || (string
->s
&& !STRINGP (object
)))
3752 /* If the character at CHARPOS is where the display string begins,
3754 pos
= make_number (charpos
);
3755 if (STRINGP (object
))
3756 bufpos
= string
->bufpos
;
3760 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3762 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3765 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3773 /* Look forward for the first character with a `display' property
3774 that will replace the underlying text when displayed. */
3775 limpos
= make_number (lim
);
3777 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3778 CHARPOS (tpos
) = XFASTINT (pos
);
3779 if (CHARPOS (tpos
) >= lim
)
3784 if (STRINGP (object
))
3785 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3787 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3788 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3789 if (!STRINGP (object
))
3790 bufpos
= CHARPOS (tpos
);
3791 } while (NILP (spec
)
3792 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3793 bufpos
, frame_window_p
)));
3797 return CHARPOS (tpos
);
3800 /* Return the character position of the end of the display string that
3801 started at CHARPOS. If there's no display string at CHARPOS,
3802 return -1. A display string is either an overlay with `display'
3803 property whose value is a string or a `display' text property whose
3804 value is a string. */
3806 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3808 /* OBJECT = nil means current buffer. */
3809 Lisp_Object object
=
3810 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3811 Lisp_Object pos
= make_number (charpos
);
3813 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3815 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3818 /* It could happen that the display property or overlay was removed
3819 since we found it in compute_display_string_pos above. One way
3820 this can happen is if JIT font-lock was called (through
3821 handle_fontified_prop), and jit-lock-functions remove text
3822 properties or overlays from the portion of buffer that includes
3823 CHARPOS. Muse mode is known to do that, for example. In this
3824 case, we return -1 to the caller, to signal that no display
3825 string is actually present at CHARPOS. See bidi_fetch_char for
3826 how this is handled.
3828 An alternative would be to never look for display properties past
3829 it->stop_charpos. But neither compute_display_string_pos nor
3830 bidi_fetch_char that calls it know or care where the next
3832 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3835 /* Look forward for the first character where the `display' property
3837 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3839 return XFASTINT (pos
);
3844 /***********************************************************************
3846 ***********************************************************************/
3848 /* Handle changes in the `fontified' property of the current buffer by
3849 calling hook functions from Qfontification_functions to fontify
3852 static enum prop_handled
3853 handle_fontified_prop (struct it
*it
)
3855 Lisp_Object prop
, pos
;
3856 enum prop_handled handled
= HANDLED_NORMALLY
;
3858 if (!NILP (Vmemory_full
))
3861 /* Get the value of the `fontified' property at IT's current buffer
3862 position. (The `fontified' property doesn't have a special
3863 meaning in strings.) If the value is nil, call functions from
3864 Qfontification_functions. */
3865 if (!STRINGP (it
->string
)
3867 && !NILP (Vfontification_functions
)
3868 && !NILP (Vrun_hooks
)
3869 && (pos
= make_number (IT_CHARPOS (*it
)),
3870 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3871 /* Ignore the special cased nil value always present at EOB since
3872 no amount of fontifying will be able to change it. */
3873 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3875 ptrdiff_t count
= SPECPDL_INDEX ();
3877 struct buffer
*obuf
= current_buffer
;
3878 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3879 bool old_clip_changed
= current_buffer
->clip_changed
;
3881 val
= Vfontification_functions
;
3882 specbind (Qfontification_functions
, Qnil
);
3884 eassert (it
->end_charpos
== ZV
);
3886 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3887 safe_call1 (val
, pos
);
3890 Lisp_Object fns
, fn
;
3891 struct gcpro gcpro1
, gcpro2
;
3896 for (; CONSP (val
); val
= XCDR (val
))
3902 /* A value of t indicates this hook has a local
3903 binding; it means to run the global binding too.
3904 In a global value, t should not occur. If it
3905 does, we must ignore it to avoid an endless
3907 for (fns
= Fdefault_value (Qfontification_functions
);
3913 safe_call1 (fn
, pos
);
3917 safe_call1 (fn
, pos
);
3923 unbind_to (count
, Qnil
);
3925 /* Fontification functions routinely call `save-restriction'.
3926 Normally, this tags clip_changed, which can confuse redisplay
3927 (see discussion in Bug#6671). Since we don't perform any
3928 special handling of fontification changes in the case where
3929 `save-restriction' isn't called, there's no point doing so in
3930 this case either. So, if the buffer's restrictions are
3931 actually left unchanged, reset clip_changed. */
3932 if (obuf
== current_buffer
)
3934 if (begv
== BEGV
&& zv
== ZV
)
3935 current_buffer
->clip_changed
= old_clip_changed
;
3937 /* There isn't much we can reasonably do to protect against
3938 misbehaving fontification, but here's a fig leaf. */
3939 else if (BUFFER_LIVE_P (obuf
))
3940 set_buffer_internal_1 (obuf
);
3942 /* The fontification code may have added/removed text.
3943 It could do even a lot worse, but let's at least protect against
3944 the most obvious case where only the text past `pos' gets changed',
3945 as is/was done in grep.el where some escapes sequences are turned
3946 into face properties (bug#7876). */
3947 it
->end_charpos
= ZV
;
3949 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3950 something. This avoids an endless loop if they failed to
3951 fontify the text for which reason ever. */
3952 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3953 handled
= HANDLED_RECOMPUTE_PROPS
;
3961 /***********************************************************************
3963 ***********************************************************************/
3965 /* Set up iterator IT from face properties at its current position.
3966 Called from handle_stop. */
3968 static enum prop_handled
3969 handle_face_prop (struct it
*it
)
3972 ptrdiff_t next_stop
;
3974 if (!STRINGP (it
->string
))
3977 = face_at_buffer_position (it
->w
,
3981 + TEXT_PROP_DISTANCE_LIMIT
),
3982 0, it
->base_face_id
);
3984 /* Is this a start of a run of characters with box face?
3985 Caveat: this can be called for a freshly initialized
3986 iterator; face_id is -1 in this case. We know that the new
3987 face will not change until limit, i.e. if the new face has a
3988 box, all characters up to limit will have one. But, as
3989 usual, we don't know whether limit is really the end. */
3990 if (new_face_id
!= it
->face_id
)
3992 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3993 /* If it->face_id is -1, old_face below will be NULL, see
3994 the definition of FACE_FROM_ID. This will happen if this
3995 is the initial call that gets the face. */
3996 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3998 /* If the value of face_id of the iterator is -1, we have to
3999 look in front of IT's position and see whether there is a
4000 face there that's different from new_face_id. */
4001 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4003 int prev_face_id
= face_before_it_pos (it
);
4005 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4008 /* If the new face has a box, but the old face does not,
4009 this is the start of a run of characters with box face,
4010 i.e. this character has a shadow on the left side. */
4011 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4012 && (old_face
== NULL
|| !old_face
->box
));
4013 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4021 Lisp_Object from_overlay
4022 = (it
->current
.overlay_string_index
>= 0
4023 ? it
->string_overlays
[it
->current
.overlay_string_index
4024 % OVERLAY_STRING_CHUNK_SIZE
]
4027 /* See if we got to this string directly or indirectly from
4028 an overlay property. That includes the before-string or
4029 after-string of an overlay, strings in display properties
4030 provided by an overlay, their text properties, etc.
4032 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4033 if (! NILP (from_overlay
))
4034 for (i
= it
->sp
- 1; i
>= 0; i
--)
4036 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4038 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4039 % OVERLAY_STRING_CHUNK_SIZE
];
4040 else if (! NILP (it
->stack
[i
].from_overlay
))
4041 from_overlay
= it
->stack
[i
].from_overlay
;
4043 if (!NILP (from_overlay
))
4047 if (! NILP (from_overlay
))
4049 bufpos
= IT_CHARPOS (*it
);
4050 /* For a string from an overlay, the base face depends
4051 only on text properties and ignores overlays. */
4053 = face_for_overlay_string (it
->w
,
4057 + TEXT_PROP_DISTANCE_LIMIT
),
4065 /* For strings from a `display' property, use the face at
4066 IT's current buffer position as the base face to merge
4067 with, so that overlay strings appear in the same face as
4068 surrounding text, unless they specify their own faces.
4069 For strings from wrap-prefix and line-prefix properties,
4070 use the default face, possibly remapped via
4071 Vface_remapping_alist. */
4072 /* Note that the fact that we use the face at _buffer_
4073 position means that a 'display' property on an overlay
4074 string will not inherit the face of that overlay string,
4075 but will instead revert to the face of buffer text
4076 covered by the overlay. This is visible, e.g., when the
4077 overlay specifies a box face, but neither the buffer nor
4078 the display string do. This sounds like a design bug,
4079 but Emacs always did that since v21.1, so changing that
4080 might be a big deal. */
4081 base_face_id
= it
->string_from_prefix_prop_p
4082 ? (!NILP (Vface_remapping_alist
)
4083 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4085 : underlying_face_id (it
);
4088 new_face_id
= face_at_string_position (it
->w
,
4090 IT_STRING_CHARPOS (*it
),
4095 /* Is this a start of a run of characters with box? Caveat:
4096 this can be called for a freshly allocated iterator; face_id
4097 is -1 is this case. We know that the new face will not
4098 change until the next check pos, i.e. if the new face has a
4099 box, all characters up to that position will have a
4100 box. But, as usual, we don't know whether that position
4101 is really the end. */
4102 if (new_face_id
!= it
->face_id
)
4104 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4105 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4107 /* If new face has a box but old face hasn't, this is the
4108 start of a run of characters with box, i.e. it has a
4109 shadow on the left side. */
4110 it
->start_of_box_run_p
4111 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4112 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4116 it
->face_id
= new_face_id
;
4117 return HANDLED_NORMALLY
;
4121 /* Return the ID of the face ``underlying'' IT's current position,
4122 which is in a string. If the iterator is associated with a
4123 buffer, return the face at IT's current buffer position.
4124 Otherwise, use the iterator's base_face_id. */
4127 underlying_face_id (struct it
*it
)
4129 int face_id
= it
->base_face_id
, i
;
4131 eassert (STRINGP (it
->string
));
4133 for (i
= it
->sp
- 1; i
>= 0; --i
)
4134 if (NILP (it
->stack
[i
].string
))
4135 face_id
= it
->stack
[i
].face_id
;
4141 /* Compute the face one character before or after the current position
4142 of IT, in the visual order. BEFORE_P non-zero means get the face
4143 in front (to the left in L2R paragraphs, to the right in R2L
4144 paragraphs) of IT's screen position. Value is the ID of the face. */
4147 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4150 ptrdiff_t next_check_charpos
;
4152 void *it_copy_data
= NULL
;
4154 eassert (it
->s
== NULL
);
4156 if (STRINGP (it
->string
))
4158 ptrdiff_t bufpos
, charpos
;
4161 /* No face change past the end of the string (for the case
4162 we are padding with spaces). No face change before the
4164 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4165 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4170 /* Set charpos to the position before or after IT's current
4171 position, in the logical order, which in the non-bidi
4172 case is the same as the visual order. */
4174 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4175 else if (it
->what
== IT_COMPOSITION
)
4176 /* For composition, we must check the character after the
4178 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4180 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4186 /* With bidi iteration, the character before the current
4187 in the visual order cannot be found by simple
4188 iteration, because "reverse" reordering is not
4189 supported. Instead, we need to use the move_it_*
4190 family of functions. */
4191 /* Ignore face changes before the first visible
4192 character on this display line. */
4193 if (it
->current_x
<= it
->first_visible_x
)
4195 SAVE_IT (it_copy
, *it
, it_copy_data
);
4196 /* Implementation note: Since move_it_in_display_line
4197 works in the iterator geometry, and thinks the first
4198 character is always the leftmost, even in R2L lines,
4199 we don't need to distinguish between the R2L and L2R
4201 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4202 it_copy
.current_x
- 1, MOVE_TO_X
);
4203 charpos
= IT_STRING_CHARPOS (it_copy
);
4204 RESTORE_IT (it
, it
, it_copy_data
);
4208 /* Set charpos to the string position of the character
4209 that comes after IT's current position in the visual
4211 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4215 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4217 charpos
= it_copy
.bidi_it
.charpos
;
4220 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4222 if (it
->current
.overlay_string_index
>= 0)
4223 bufpos
= IT_CHARPOS (*it
);
4227 base_face_id
= underlying_face_id (it
);
4229 /* Get the face for ASCII, or unibyte. */
4230 face_id
= face_at_string_position (it
->w
,
4234 &next_check_charpos
,
4237 /* Correct the face for charsets different from ASCII. Do it
4238 for the multibyte case only. The face returned above is
4239 suitable for unibyte text if IT->string is unibyte. */
4240 if (STRING_MULTIBYTE (it
->string
))
4242 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4243 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4245 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4247 c
= string_char_and_length (p
, &len
);
4248 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4253 struct text_pos pos
;
4255 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4256 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4259 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4260 pos
= it
->current
.pos
;
4265 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4268 if (it
->what
== IT_COMPOSITION
)
4270 /* For composition, we must check the position after
4272 pos
.charpos
+= it
->cmp_it
.nchars
;
4273 pos
.bytepos
+= it
->len
;
4276 INC_TEXT_POS (pos
, it
->multibyte_p
);
4283 /* With bidi iteration, the character before the current
4284 in the visual order cannot be found by simple
4285 iteration, because "reverse" reordering is not
4286 supported. Instead, we need to use the move_it_*
4287 family of functions. */
4288 /* Ignore face changes before the first visible
4289 character on this display line. */
4290 if (it
->current_x
<= it
->first_visible_x
)
4292 SAVE_IT (it_copy
, *it
, it_copy_data
);
4293 /* Implementation note: Since move_it_in_display_line
4294 works in the iterator geometry, and thinks the first
4295 character is always the leftmost, even in R2L lines,
4296 we don't need to distinguish between the R2L and L2R
4298 move_it_in_display_line (&it_copy
, ZV
,
4299 it_copy
.current_x
- 1, MOVE_TO_X
);
4300 pos
= it_copy
.current
.pos
;
4301 RESTORE_IT (it
, it
, it_copy_data
);
4305 /* Set charpos to the buffer position of the character
4306 that comes after IT's current position in the visual
4308 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4312 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4315 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4318 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4320 /* Determine face for CHARSET_ASCII, or unibyte. */
4321 face_id
= face_at_buffer_position (it
->w
,
4323 &next_check_charpos
,
4326 /* Correct the face for charsets different from ASCII. Do it
4327 for the multibyte case only. The face returned above is
4328 suitable for unibyte text if current_buffer is unibyte. */
4329 if (it
->multibyte_p
)
4331 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4332 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4333 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4342 /***********************************************************************
4344 ***********************************************************************/
4346 /* Set up iterator IT from invisible properties at its current
4347 position. Called from handle_stop. */
4349 static enum prop_handled
4350 handle_invisible_prop (struct it
*it
)
4352 enum prop_handled handled
= HANDLED_NORMALLY
;
4356 if (STRINGP (it
->string
))
4358 Lisp_Object end_charpos
, limit
, charpos
;
4360 /* Get the value of the invisible text property at the
4361 current position. Value will be nil if there is no such
4363 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4364 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4365 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4367 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4369 /* Record whether we have to display an ellipsis for the
4371 int display_ellipsis_p
= (invis_p
== 2);
4372 ptrdiff_t len
, endpos
;
4374 handled
= HANDLED_RECOMPUTE_PROPS
;
4376 /* Get the position at which the next visible text can be
4377 found in IT->string, if any. */
4378 endpos
= len
= SCHARS (it
->string
);
4379 XSETINT (limit
, len
);
4382 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4384 if (INTEGERP (end_charpos
))
4386 endpos
= XFASTINT (end_charpos
);
4387 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4388 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4390 display_ellipsis_p
= true;
4393 while (invis_p
&& endpos
< len
);
4395 if (display_ellipsis_p
)
4396 it
->ellipsis_p
= true;
4400 /* Text at END_CHARPOS is visible. Move IT there. */
4401 struct text_pos old
;
4404 old
= it
->current
.string_pos
;
4405 oldpos
= CHARPOS (old
);
4408 if (it
->bidi_it
.first_elt
4409 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4410 bidi_paragraph_init (it
->paragraph_embedding
,
4412 /* Bidi-iterate out of the invisible text. */
4415 bidi_move_to_visually_next (&it
->bidi_it
);
4417 while (oldpos
<= it
->bidi_it
.charpos
4418 && it
->bidi_it
.charpos
< endpos
);
4420 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4421 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4422 if (IT_CHARPOS (*it
) >= endpos
)
4423 it
->prev_stop
= endpos
;
4427 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4428 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4433 /* The rest of the string is invisible. If this is an
4434 overlay string, proceed with the next overlay string
4435 or whatever comes and return a character from there. */
4436 if (it
->current
.overlay_string_index
>= 0
4437 && !display_ellipsis_p
)
4439 next_overlay_string (it
);
4440 /* Don't check for overlay strings when we just
4441 finished processing them. */
4442 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4446 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4447 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4454 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4455 Lisp_Object pos
, overlay
;
4457 /* First of all, is there invisible text at this position? */
4458 tem
= start_charpos
= IT_CHARPOS (*it
);
4459 pos
= make_number (tem
);
4460 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4462 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4464 /* If we are on invisible text, skip over it. */
4465 if (invis_p
&& start_charpos
< it
->end_charpos
)
4467 /* Record whether we have to display an ellipsis for the
4469 int display_ellipsis_p
= invis_p
== 2;
4471 handled
= HANDLED_RECOMPUTE_PROPS
;
4473 /* Loop skipping over invisible text. The loop is left at
4474 ZV or with IT on the first char being visible again. */
4477 /* Try to skip some invisible text. Return value is the
4478 position reached which can be equal to where we start
4479 if there is nothing invisible there. This skips both
4480 over invisible text properties and overlays with
4481 invisible property. */
4482 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4484 /* If we skipped nothing at all we weren't at invisible
4485 text in the first place. If everything to the end of
4486 the buffer was skipped, end the loop. */
4487 if (newpos
== tem
|| newpos
>= ZV
)
4491 /* We skipped some characters but not necessarily
4492 all there are. Check if we ended up on visible
4493 text. Fget_char_property returns the property of
4494 the char before the given position, i.e. if we
4495 get invis_p = 0, this means that the char at
4496 newpos is visible. */
4497 pos
= make_number (newpos
);
4498 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4499 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4502 /* If we ended up on invisible text, proceed to
4503 skip starting with next_stop. */
4507 /* If there are adjacent invisible texts, don't lose the
4508 second one's ellipsis. */
4510 display_ellipsis_p
= true;
4514 /* The position newpos is now either ZV or on visible text. */
4517 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4519 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4521 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4523 /* If the invisible text ends on a newline or on a
4524 character after a newline, we can avoid the costly,
4525 character by character, bidi iteration to NEWPOS, and
4526 instead simply reseat the iterator there. That's
4527 because all bidi reordering information is tossed at
4528 the newline. This is a big win for modes that hide
4529 complete lines, like Outline, Org, etc. */
4530 if (on_newline
|| after_newline
)
4532 struct text_pos tpos
;
4533 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4535 SET_TEXT_POS (tpos
, newpos
, bpos
);
4536 reseat_1 (it
, tpos
, 0);
4537 /* If we reseat on a newline/ZV, we need to prep the
4538 bidi iterator for advancing to the next character
4539 after the newline/EOB, keeping the current paragraph
4540 direction (so that PRODUCE_GLYPHS does TRT wrt
4541 prepending/appending glyphs to a glyph row). */
4544 it
->bidi_it
.first_elt
= 0;
4545 it
->bidi_it
.paragraph_dir
= pdir
;
4546 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4547 it
->bidi_it
.nchars
= 1;
4548 it
->bidi_it
.ch_len
= 1;
4551 else /* Must use the slow method. */
4553 /* With bidi iteration, the region of invisible text
4554 could start and/or end in the middle of a
4555 non-base embedding level. Therefore, we need to
4556 skip invisible text using the bidi iterator,
4557 starting at IT's current position, until we find
4558 ourselves outside of the invisible text.
4559 Skipping invisible text _after_ bidi iteration
4560 avoids affecting the visual order of the
4561 displayed text when invisible properties are
4562 added or removed. */
4563 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4565 /* If we were `reseat'ed to a new paragraph,
4566 determine the paragraph base direction. We
4567 need to do it now because
4568 next_element_from_buffer may not have a
4569 chance to do it, if we are going to skip any
4570 text at the beginning, which resets the
4572 bidi_paragraph_init (it
->paragraph_embedding
,
4577 bidi_move_to_visually_next (&it
->bidi_it
);
4579 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4580 && it
->bidi_it
.charpos
< newpos
);
4581 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4582 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4583 /* If we overstepped NEWPOS, record its position in
4584 the iterator, so that we skip invisible text if
4585 later the bidi iteration lands us in the
4586 invisible region again. */
4587 if (IT_CHARPOS (*it
) >= newpos
)
4588 it
->prev_stop
= newpos
;
4593 IT_CHARPOS (*it
) = newpos
;
4594 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4597 /* If there are before-strings at the start of invisible
4598 text, and the text is invisible because of a text
4599 property, arrange to show before-strings because 20.x did
4600 it that way. (If the text is invisible because of an
4601 overlay property instead of a text property, this is
4602 already handled in the overlay code.) */
4604 && get_overlay_strings (it
, it
->stop_charpos
))
4606 handled
= HANDLED_RECOMPUTE_PROPS
;
4609 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4610 /* The call to get_overlay_strings above recomputes
4611 it->stop_charpos, but it only considers changes
4612 in properties and overlays beyond iterator's
4613 current position. This causes us to miss changes
4614 that happen exactly where the invisible property
4615 ended. So we play it safe here and force the
4616 iterator to check for potential stop positions
4617 immediately after the invisible text. Note that
4618 if get_overlay_strings returns non-zero, it
4619 normally also pushed the iterator stack, so we
4620 need to update the stop position in the slot
4621 below the current one. */
4622 it
->stack
[it
->sp
- 1].stop_charpos
4623 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4626 else if (display_ellipsis_p
)
4628 /* Make sure that the glyphs of the ellipsis will get
4629 correct `charpos' values. If we would not update
4630 it->position here, the glyphs would belong to the
4631 last visible character _before_ the invisible
4632 text, which confuses `set_cursor_from_row'.
4634 We use the last invisible position instead of the
4635 first because this way the cursor is always drawn on
4636 the first "." of the ellipsis, whenever PT is inside
4637 the invisible text. Otherwise the cursor would be
4638 placed _after_ the ellipsis when the point is after the
4639 first invisible character. */
4640 if (!STRINGP (it
->object
))
4642 it
->position
.charpos
= newpos
- 1;
4643 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4645 it
->ellipsis_p
= true;
4646 /* Let the ellipsis display before
4647 considering any properties of the following char.
4648 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4649 handled
= HANDLED_RETURN
;
4658 /* Make iterator IT return `...' next.
4659 Replaces LEN characters from buffer. */
4662 setup_for_ellipsis (struct it
*it
, int len
)
4664 /* Use the display table definition for `...'. Invalid glyphs
4665 will be handled by the method returning elements from dpvec. */
4666 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4668 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4669 it
->dpvec
= v
->contents
;
4670 it
->dpend
= v
->contents
+ v
->header
.size
;
4674 /* Default `...'. */
4675 it
->dpvec
= default_invis_vector
;
4676 it
->dpend
= default_invis_vector
+ 3;
4679 it
->dpvec_char_len
= len
;
4680 it
->current
.dpvec_index
= 0;
4681 it
->dpvec_face_id
= -1;
4683 /* Remember the current face id in case glyphs specify faces.
4684 IT's face is restored in set_iterator_to_next.
4685 saved_face_id was set to preceding char's face in handle_stop. */
4686 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4687 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4689 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4690 it
->ellipsis_p
= true;
4695 /***********************************************************************
4697 ***********************************************************************/
4699 /* Set up iterator IT from `display' property at its current position.
4700 Called from handle_stop.
4701 We return HANDLED_RETURN if some part of the display property
4702 overrides the display of the buffer text itself.
4703 Otherwise we return HANDLED_NORMALLY. */
4705 static enum prop_handled
4706 handle_display_prop (struct it
*it
)
4708 Lisp_Object propval
, object
, overlay
;
4709 struct text_pos
*position
;
4711 /* Nonzero if some property replaces the display of the text itself. */
4712 int display_replaced_p
= 0;
4714 if (STRINGP (it
->string
))
4716 object
= it
->string
;
4717 position
= &it
->current
.string_pos
;
4718 bufpos
= CHARPOS (it
->current
.pos
);
4722 XSETWINDOW (object
, it
->w
);
4723 position
= &it
->current
.pos
;
4724 bufpos
= CHARPOS (*position
);
4727 /* Reset those iterator values set from display property values. */
4728 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4729 it
->space_width
= Qnil
;
4730 it
->font_height
= Qnil
;
4733 /* We don't support recursive `display' properties, i.e. string
4734 values that have a string `display' property, that have a string
4735 `display' property etc. */
4736 if (!it
->string_from_display_prop_p
)
4737 it
->area
= TEXT_AREA
;
4739 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4740 Qdisplay
, object
, &overlay
);
4742 return HANDLED_NORMALLY
;
4743 /* Now OVERLAY is the overlay that gave us this property, or nil
4744 if it was a text property. */
4746 if (!STRINGP (it
->string
))
4747 object
= it
->w
->contents
;
4749 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4751 FRAME_WINDOW_P (it
->f
));
4753 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4756 /* Subroutine of handle_display_prop. Returns non-zero if the display
4757 specification in SPEC is a replacing specification, i.e. it would
4758 replace the text covered by `display' property with something else,
4759 such as an image or a display string. If SPEC includes any kind or
4760 `(space ...) specification, the value is 2; this is used by
4761 compute_display_string_pos, which see.
4763 See handle_single_display_spec for documentation of arguments.
4764 frame_window_p is non-zero if the window being redisplayed is on a
4765 GUI frame; this argument is used only if IT is NULL, see below.
4767 IT can be NULL, if this is called by the bidi reordering code
4768 through compute_display_string_pos, which see. In that case, this
4769 function only examines SPEC, but does not otherwise "handle" it, in
4770 the sense that it doesn't set up members of IT from the display
4773 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4774 Lisp_Object overlay
, struct text_pos
*position
,
4775 ptrdiff_t bufpos
, int frame_window_p
)
4777 int replacing_p
= 0;
4781 /* Simple specifications. */
4782 && !EQ (XCAR (spec
), Qimage
)
4783 && !EQ (XCAR (spec
), Qspace
)
4784 && !EQ (XCAR (spec
), Qwhen
)
4785 && !EQ (XCAR (spec
), Qslice
)
4786 && !EQ (XCAR (spec
), Qspace_width
)
4787 && !EQ (XCAR (spec
), Qheight
)
4788 && !EQ (XCAR (spec
), Qraise
)
4789 /* Marginal area specifications. */
4790 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4791 && !EQ (XCAR (spec
), Qleft_fringe
)
4792 && !EQ (XCAR (spec
), Qright_fringe
)
4793 && !NILP (XCAR (spec
)))
4795 for (; CONSP (spec
); spec
= XCDR (spec
))
4797 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4798 overlay
, position
, bufpos
,
4799 replacing_p
, frame_window_p
)))
4802 /* If some text in a string is replaced, `position' no
4803 longer points to the position of `object'. */
4804 if (!it
|| STRINGP (object
))
4809 else if (VECTORP (spec
))
4812 for (i
= 0; i
< ASIZE (spec
); ++i
)
4813 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4814 overlay
, position
, bufpos
,
4815 replacing_p
, frame_window_p
)))
4818 /* If some text in a string is replaced, `position' no
4819 longer points to the position of `object'. */
4820 if (!it
|| STRINGP (object
))
4826 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4827 position
, bufpos
, 0,
4835 /* Value is the position of the end of the `display' property starting
4836 at START_POS in OBJECT. */
4838 static struct text_pos
4839 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4842 struct text_pos end_pos
;
4844 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4845 Qdisplay
, object
, Qnil
);
4846 CHARPOS (end_pos
) = XFASTINT (end
);
4847 if (STRINGP (object
))
4848 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4850 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4856 /* Set up IT from a single `display' property specification SPEC. OBJECT
4857 is the object in which the `display' property was found. *POSITION
4858 is the position in OBJECT at which the `display' property was found.
4859 BUFPOS is the buffer position of OBJECT (different from POSITION if
4860 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4861 previously saw a display specification which already replaced text
4862 display with something else, for example an image; we ignore such
4863 properties after the first one has been processed.
4865 OVERLAY is the overlay this `display' property came from,
4866 or nil if it was a text property.
4868 If SPEC is a `space' or `image' specification, and in some other
4869 cases too, set *POSITION to the position where the `display'
4872 If IT is NULL, only examine the property specification in SPEC, but
4873 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4874 is intended to be displayed in a window on a GUI frame.
4876 Value is non-zero if something was found which replaces the display
4877 of buffer or string text. */
4880 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4881 Lisp_Object overlay
, struct text_pos
*position
,
4882 ptrdiff_t bufpos
, int display_replaced_p
,
4886 Lisp_Object location
, value
;
4887 struct text_pos start_pos
= *position
;
4890 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4891 If the result is non-nil, use VALUE instead of SPEC. */
4893 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4902 if (!NILP (form
) && !EQ (form
, Qt
))
4904 ptrdiff_t count
= SPECPDL_INDEX ();
4905 struct gcpro gcpro1
;
4907 /* Bind `object' to the object having the `display' property, a
4908 buffer or string. Bind `position' to the position in the
4909 object where the property was found, and `buffer-position'
4910 to the current position in the buffer. */
4913 XSETBUFFER (object
, current_buffer
);
4914 specbind (Qobject
, object
);
4915 specbind (Qposition
, make_number (CHARPOS (*position
)));
4916 specbind (Qbuffer_position
, make_number (bufpos
));
4918 form
= safe_eval (form
);
4920 unbind_to (count
, Qnil
);
4926 /* Handle `(height HEIGHT)' specifications. */
4928 && EQ (XCAR (spec
), Qheight
)
4929 && CONSP (XCDR (spec
)))
4933 if (!FRAME_WINDOW_P (it
->f
))
4936 it
->font_height
= XCAR (XCDR (spec
));
4937 if (!NILP (it
->font_height
))
4939 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4940 int new_height
= -1;
4942 if (CONSP (it
->font_height
)
4943 && (EQ (XCAR (it
->font_height
), Qplus
)
4944 || EQ (XCAR (it
->font_height
), Qminus
))
4945 && CONSP (XCDR (it
->font_height
))
4946 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4948 /* `(+ N)' or `(- N)' where N is an integer. */
4949 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4950 if (EQ (XCAR (it
->font_height
), Qplus
))
4952 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4954 else if (FUNCTIONP (it
->font_height
))
4956 /* Call function with current height as argument.
4957 Value is the new height. */
4959 height
= safe_call1 (it
->font_height
,
4960 face
->lface
[LFACE_HEIGHT_INDEX
]);
4961 if (NUMBERP (height
))
4962 new_height
= XFLOATINT (height
);
4964 else if (NUMBERP (it
->font_height
))
4966 /* Value is a multiple of the canonical char height. */
4969 f
= FACE_FROM_ID (it
->f
,
4970 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4971 new_height
= (XFLOATINT (it
->font_height
)
4972 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4976 /* Evaluate IT->font_height with `height' bound to the
4977 current specified height to get the new height. */
4978 ptrdiff_t count
= SPECPDL_INDEX ();
4980 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4981 value
= safe_eval (it
->font_height
);
4982 unbind_to (count
, Qnil
);
4984 if (NUMBERP (value
))
4985 new_height
= XFLOATINT (value
);
4989 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4996 /* Handle `(space-width WIDTH)'. */
4998 && EQ (XCAR (spec
), Qspace_width
)
4999 && CONSP (XCDR (spec
)))
5003 if (!FRAME_WINDOW_P (it
->f
))
5006 value
= XCAR (XCDR (spec
));
5007 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5008 it
->space_width
= value
;
5014 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5016 && EQ (XCAR (spec
), Qslice
))
5022 if (!FRAME_WINDOW_P (it
->f
))
5025 if (tem
= XCDR (spec
), CONSP (tem
))
5027 it
->slice
.x
= XCAR (tem
);
5028 if (tem
= XCDR (tem
), CONSP (tem
))
5030 it
->slice
.y
= XCAR (tem
);
5031 if (tem
= XCDR (tem
), CONSP (tem
))
5033 it
->slice
.width
= XCAR (tem
);
5034 if (tem
= XCDR (tem
), CONSP (tem
))
5035 it
->slice
.height
= XCAR (tem
);
5044 /* Handle `(raise FACTOR)'. */
5046 && EQ (XCAR (spec
), Qraise
)
5047 && CONSP (XCDR (spec
)))
5051 if (!FRAME_WINDOW_P (it
->f
))
5054 #ifdef HAVE_WINDOW_SYSTEM
5055 value
= XCAR (XCDR (spec
));
5056 if (NUMBERP (value
))
5058 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5059 it
->voffset
= - (XFLOATINT (value
)
5060 * (FONT_HEIGHT (face
->font
)));
5062 #endif /* HAVE_WINDOW_SYSTEM */
5068 /* Don't handle the other kinds of display specifications
5069 inside a string that we got from a `display' property. */
5070 if (it
&& it
->string_from_display_prop_p
)
5073 /* Characters having this form of property are not displayed, so
5074 we have to find the end of the property. */
5077 start_pos
= *position
;
5078 *position
= display_prop_end (it
, object
, start_pos
);
5082 /* Stop the scan at that end position--we assume that all
5083 text properties change there. */
5085 it
->stop_charpos
= position
->charpos
;
5087 /* Handle `(left-fringe BITMAP [FACE])'
5088 and `(right-fringe BITMAP [FACE])'. */
5090 && (EQ (XCAR (spec
), Qleft_fringe
)
5091 || EQ (XCAR (spec
), Qright_fringe
))
5092 && CONSP (XCDR (spec
)))
5098 if (!FRAME_WINDOW_P (it
->f
))
5099 /* If we return here, POSITION has been advanced
5100 across the text with this property. */
5102 /* Synchronize the bidi iterator with POSITION. This is
5103 needed because we are not going to push the iterator
5104 on behalf of this display property, so there will be
5105 no pop_it call to do this synchronization for us. */
5108 it
->position
= *position
;
5109 iterate_out_of_display_property (it
);
5110 *position
= it
->position
;
5115 else if (!frame_window_p
)
5118 #ifdef HAVE_WINDOW_SYSTEM
5119 value
= XCAR (XCDR (spec
));
5120 if (!SYMBOLP (value
)
5121 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5122 /* If we return here, POSITION has been advanced
5123 across the text with this property. */
5125 if (it
&& it
->bidi_p
)
5127 it
->position
= *position
;
5128 iterate_out_of_display_property (it
);
5129 *position
= it
->position
;
5136 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5138 if (CONSP (XCDR (XCDR (spec
))))
5140 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5141 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5147 /* Save current settings of IT so that we can restore them
5148 when we are finished with the glyph property value. */
5149 push_it (it
, position
);
5151 it
->area
= TEXT_AREA
;
5152 it
->what
= IT_IMAGE
;
5153 it
->image_id
= -1; /* no image */
5154 it
->position
= start_pos
;
5155 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5156 it
->method
= GET_FROM_IMAGE
;
5157 it
->from_overlay
= Qnil
;
5158 it
->face_id
= face_id
;
5159 it
->from_disp_prop_p
= true;
5161 /* Say that we haven't consumed the characters with
5162 `display' property yet. The call to pop_it in
5163 set_iterator_to_next will clean this up. */
5164 *position
= start_pos
;
5166 if (EQ (XCAR (spec
), Qleft_fringe
))
5168 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5169 it
->left_user_fringe_face_id
= face_id
;
5173 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5174 it
->right_user_fringe_face_id
= face_id
;
5177 #endif /* HAVE_WINDOW_SYSTEM */
5181 /* Prepare to handle `((margin left-margin) ...)',
5182 `((margin right-margin) ...)' and `((margin nil) ...)'
5183 prefixes for display specifications. */
5184 location
= Qunbound
;
5185 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5189 value
= XCDR (spec
);
5191 value
= XCAR (value
);
5194 if (EQ (XCAR (tem
), Qmargin
)
5195 && (tem
= XCDR (tem
),
5196 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5198 || EQ (tem
, Qleft_margin
)
5199 || EQ (tem
, Qright_margin
))))
5203 if (EQ (location
, Qunbound
))
5209 /* After this point, VALUE is the property after any
5210 margin prefix has been stripped. It must be a string,
5211 an image specification, or `(space ...)'.
5213 LOCATION specifies where to display: `left-margin',
5214 `right-margin' or nil. */
5216 valid_p
= (STRINGP (value
)
5217 #ifdef HAVE_WINDOW_SYSTEM
5218 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5219 && valid_image_p (value
))
5220 #endif /* not HAVE_WINDOW_SYSTEM */
5221 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5223 if (valid_p
&& !display_replaced_p
)
5229 /* Callers need to know whether the display spec is any kind
5230 of `(space ...)' spec that is about to affect text-area
5232 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5237 /* Save current settings of IT so that we can restore them
5238 when we are finished with the glyph property value. */
5239 push_it (it
, position
);
5240 it
->from_overlay
= overlay
;
5241 it
->from_disp_prop_p
= true;
5243 if (NILP (location
))
5244 it
->area
= TEXT_AREA
;
5245 else if (EQ (location
, Qleft_margin
))
5246 it
->area
= LEFT_MARGIN_AREA
;
5248 it
->area
= RIGHT_MARGIN_AREA
;
5250 if (STRINGP (value
))
5253 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5254 it
->current
.overlay_string_index
= -1;
5255 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5256 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5257 it
->method
= GET_FROM_STRING
;
5258 it
->stop_charpos
= 0;
5260 it
->base_level_stop
= 0;
5261 it
->string_from_display_prop_p
= true;
5262 /* Say that we haven't consumed the characters with
5263 `display' property yet. The call to pop_it in
5264 set_iterator_to_next will clean this up. */
5265 if (BUFFERP (object
))
5266 *position
= start_pos
;
5268 /* Force paragraph direction to be that of the parent
5269 object. If the parent object's paragraph direction is
5270 not yet determined, default to L2R. */
5271 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5272 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5274 it
->paragraph_embedding
= L2R
;
5276 /* Set up the bidi iterator for this display string. */
5279 it
->bidi_it
.string
.lstring
= it
->string
;
5280 it
->bidi_it
.string
.s
= NULL
;
5281 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5282 it
->bidi_it
.string
.bufpos
= bufpos
;
5283 it
->bidi_it
.string
.from_disp_str
= 1;
5284 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5285 it
->bidi_it
.w
= it
->w
;
5286 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5289 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5291 it
->method
= GET_FROM_STRETCH
;
5293 *position
= it
->position
= start_pos
;
5294 retval
= 1 + (it
->area
== TEXT_AREA
);
5296 #ifdef HAVE_WINDOW_SYSTEM
5299 it
->what
= IT_IMAGE
;
5300 it
->image_id
= lookup_image (it
->f
, value
);
5301 it
->position
= start_pos
;
5302 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5303 it
->method
= GET_FROM_IMAGE
;
5305 /* Say that we haven't consumed the characters with
5306 `display' property yet. The call to pop_it in
5307 set_iterator_to_next will clean this up. */
5308 *position
= start_pos
;
5310 #endif /* HAVE_WINDOW_SYSTEM */
5315 /* Invalid property or property not supported. Restore
5316 POSITION to what it was before. */
5317 *position
= start_pos
;
5321 /* Check if PROP is a display property value whose text should be
5322 treated as intangible. OVERLAY is the overlay from which PROP
5323 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5324 specify the buffer position covered by PROP. */
5327 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5328 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5330 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5331 struct text_pos position
;
5333 SET_TEXT_POS (position
, charpos
, bytepos
);
5334 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5335 &position
, charpos
, frame_window_p
);
5339 /* Return 1 if PROP is a display sub-property value containing STRING.
5341 Implementation note: this and the following function are really
5342 special cases of handle_display_spec and
5343 handle_single_display_spec, and should ideally use the same code.
5344 Until they do, these two pairs must be consistent and must be
5345 modified in sync. */
5348 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5350 if (EQ (string
, prop
))
5353 /* Skip over `when FORM'. */
5354 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5359 /* Actually, the condition following `when' should be eval'ed,
5360 like handle_single_display_spec does, and we should return
5361 zero if it evaluates to nil. However, this function is
5362 called only when the buffer was already displayed and some
5363 glyph in the glyph matrix was found to come from a display
5364 string. Therefore, the condition was already evaluated, and
5365 the result was non-nil, otherwise the display string wouldn't
5366 have been displayed and we would have never been called for
5367 this property. Thus, we can skip the evaluation and assume
5368 its result is non-nil. */
5373 /* Skip over `margin LOCATION'. */
5374 if (EQ (XCAR (prop
), Qmargin
))
5385 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5389 /* Return 1 if STRING appears in the `display' property PROP. */
5392 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5395 && !EQ (XCAR (prop
), Qwhen
)
5396 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5398 /* A list of sub-properties. */
5399 while (CONSP (prop
))
5401 if (single_display_spec_string_p (XCAR (prop
), string
))
5406 else if (VECTORP (prop
))
5408 /* A vector of sub-properties. */
5410 for (i
= 0; i
< ASIZE (prop
); ++i
)
5411 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5415 return single_display_spec_string_p (prop
, string
);
5420 /* Look for STRING in overlays and text properties in the current
5421 buffer, between character positions FROM and TO (excluding TO).
5422 BACK_P non-zero means look back (in this case, TO is supposed to be
5424 Value is the first character position where STRING was found, or
5425 zero if it wasn't found before hitting TO.
5427 This function may only use code that doesn't eval because it is
5428 called asynchronously from note_mouse_highlight. */
5431 string_buffer_position_lim (Lisp_Object string
,
5432 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5434 Lisp_Object limit
, prop
, pos
;
5437 pos
= make_number (max (from
, BEGV
));
5439 if (!back_p
) /* looking forward */
5441 limit
= make_number (min (to
, ZV
));
5442 while (!found
&& !EQ (pos
, limit
))
5444 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5445 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5448 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5452 else /* looking back */
5454 limit
= make_number (max (to
, BEGV
));
5455 while (!found
&& !EQ (pos
, limit
))
5457 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5458 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5461 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5466 return found
? XINT (pos
) : 0;
5469 /* Determine which buffer position in current buffer STRING comes from.
5470 AROUND_CHARPOS is an approximate position where it could come from.
5471 Value is the buffer position or 0 if it couldn't be determined.
5473 This function is necessary because we don't record buffer positions
5474 in glyphs generated from strings (to keep struct glyph small).
5475 This function may only use code that doesn't eval because it is
5476 called asynchronously from note_mouse_highlight. */
5479 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5481 const int MAX_DISTANCE
= 1000;
5482 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5483 around_charpos
+ MAX_DISTANCE
,
5487 found
= string_buffer_position_lim (string
, around_charpos
,
5488 around_charpos
- MAX_DISTANCE
, 1);
5494 /***********************************************************************
5495 `composition' property
5496 ***********************************************************************/
5498 /* Set up iterator IT from `composition' property at its current
5499 position. Called from handle_stop. */
5501 static enum prop_handled
5502 handle_composition_prop (struct it
*it
)
5504 Lisp_Object prop
, string
;
5505 ptrdiff_t pos
, pos_byte
, start
, end
;
5507 if (STRINGP (it
->string
))
5511 pos
= IT_STRING_CHARPOS (*it
);
5512 pos_byte
= IT_STRING_BYTEPOS (*it
);
5513 string
= it
->string
;
5514 s
= SDATA (string
) + pos_byte
;
5515 it
->c
= STRING_CHAR (s
);
5519 pos
= IT_CHARPOS (*it
);
5520 pos_byte
= IT_BYTEPOS (*it
);
5522 it
->c
= FETCH_CHAR (pos_byte
);
5525 /* If there's a valid composition and point is not inside of the
5526 composition (in the case that the composition is from the current
5527 buffer), draw a glyph composed from the composition components. */
5528 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5529 && composition_valid_p (start
, end
, prop
)
5530 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5533 /* As we can't handle this situation (perhaps font-lock added
5534 a new composition), we just return here hoping that next
5535 redisplay will detect this composition much earlier. */
5536 return HANDLED_NORMALLY
;
5539 if (STRINGP (it
->string
))
5540 pos_byte
= string_char_to_byte (it
->string
, start
);
5542 pos_byte
= CHAR_TO_BYTE (start
);
5544 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5547 if (it
->cmp_it
.id
>= 0)
5550 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5551 it
->cmp_it
.nglyphs
= -1;
5555 return HANDLED_NORMALLY
;
5560 /***********************************************************************
5562 ***********************************************************************/
5564 /* The following structure is used to record overlay strings for
5565 later sorting in load_overlay_strings. */
5567 struct overlay_entry
5569 Lisp_Object overlay
;
5576 /* Set up iterator IT from overlay strings at its current position.
5577 Called from handle_stop. */
5579 static enum prop_handled
5580 handle_overlay_change (struct it
*it
)
5582 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5583 return HANDLED_RECOMPUTE_PROPS
;
5585 return HANDLED_NORMALLY
;
5589 /* Set up the next overlay string for delivery by IT, if there is an
5590 overlay string to deliver. Called by set_iterator_to_next when the
5591 end of the current overlay string is reached. If there are more
5592 overlay strings to display, IT->string and
5593 IT->current.overlay_string_index are set appropriately here.
5594 Otherwise IT->string is set to nil. */
5597 next_overlay_string (struct it
*it
)
5599 ++it
->current
.overlay_string_index
;
5600 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5602 /* No more overlay strings. Restore IT's settings to what
5603 they were before overlay strings were processed, and
5604 continue to deliver from current_buffer. */
5606 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5609 || (NILP (it
->string
)
5610 && it
->method
== GET_FROM_BUFFER
5611 && it
->stop_charpos
>= BEGV
5612 && it
->stop_charpos
<= it
->end_charpos
));
5613 it
->current
.overlay_string_index
= -1;
5614 it
->n_overlay_strings
= 0;
5615 it
->overlay_strings_charpos
= -1;
5616 /* If there's an empty display string on the stack, pop the
5617 stack, to resync the bidi iterator with IT's position. Such
5618 empty strings are pushed onto the stack in
5619 get_overlay_strings_1. */
5620 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5623 /* If we're at the end of the buffer, record that we have
5624 processed the overlay strings there already, so that
5625 next_element_from_buffer doesn't try it again. */
5626 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5627 it
->overlay_strings_at_end_processed_p
= true;
5631 /* There are more overlay strings to process. If
5632 IT->current.overlay_string_index has advanced to a position
5633 where we must load IT->overlay_strings with more strings, do
5634 it. We must load at the IT->overlay_strings_charpos where
5635 IT->n_overlay_strings was originally computed; when invisible
5636 text is present, this might not be IT_CHARPOS (Bug#7016). */
5637 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5639 if (it
->current
.overlay_string_index
&& i
== 0)
5640 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5642 /* Initialize IT to deliver display elements from the overlay
5644 it
->string
= it
->overlay_strings
[i
];
5645 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5646 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5647 it
->method
= GET_FROM_STRING
;
5648 it
->stop_charpos
= 0;
5649 it
->end_charpos
= SCHARS (it
->string
);
5650 if (it
->cmp_it
.stop_pos
>= 0)
5651 it
->cmp_it
.stop_pos
= 0;
5653 it
->base_level_stop
= 0;
5655 /* Set up the bidi iterator for this overlay string. */
5658 it
->bidi_it
.string
.lstring
= it
->string
;
5659 it
->bidi_it
.string
.s
= NULL
;
5660 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5661 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5662 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5663 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5664 it
->bidi_it
.w
= it
->w
;
5665 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5673 /* Compare two overlay_entry structures E1 and E2. Used as a
5674 comparison function for qsort in load_overlay_strings. Overlay
5675 strings for the same position are sorted so that
5677 1. All after-strings come in front of before-strings, except
5678 when they come from the same overlay.
5680 2. Within after-strings, strings are sorted so that overlay strings
5681 from overlays with higher priorities come first.
5683 2. Within before-strings, strings are sorted so that overlay
5684 strings from overlays with higher priorities come last.
5686 Value is analogous to strcmp. */
5690 compare_overlay_entries (const void *e1
, const void *e2
)
5692 struct overlay_entry
const *entry1
= e1
;
5693 struct overlay_entry
const *entry2
= e2
;
5696 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5698 /* Let after-strings appear in front of before-strings if
5699 they come from different overlays. */
5700 if (EQ (entry1
->overlay
, entry2
->overlay
))
5701 result
= entry1
->after_string_p
? 1 : -1;
5703 result
= entry1
->after_string_p
? -1 : 1;
5705 else if (entry1
->priority
!= entry2
->priority
)
5707 if (entry1
->after_string_p
)
5708 /* After-strings sorted in order of decreasing priority. */
5709 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5711 /* Before-strings sorted in order of increasing priority. */
5712 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5721 /* Load the vector IT->overlay_strings with overlay strings from IT's
5722 current buffer position, or from CHARPOS if that is > 0. Set
5723 IT->n_overlays to the total number of overlay strings found.
5725 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5726 a time. On entry into load_overlay_strings,
5727 IT->current.overlay_string_index gives the number of overlay
5728 strings that have already been loaded by previous calls to this
5731 IT->add_overlay_start contains an additional overlay start
5732 position to consider for taking overlay strings from, if non-zero.
5733 This position comes into play when the overlay has an `invisible'
5734 property, and both before and after-strings. When we've skipped to
5735 the end of the overlay, because of its `invisible' property, we
5736 nevertheless want its before-string to appear.
5737 IT->add_overlay_start will contain the overlay start position
5740 Overlay strings are sorted so that after-string strings come in
5741 front of before-string strings. Within before and after-strings,
5742 strings are sorted by overlay priority. See also function
5743 compare_overlay_entries. */
5746 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5748 Lisp_Object overlay
, window
, str
, invisible
;
5749 struct Lisp_Overlay
*ov
;
5750 ptrdiff_t start
, end
;
5751 ptrdiff_t n
= 0, i
, j
;
5753 struct overlay_entry entriesbuf
[20];
5754 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5755 struct overlay_entry
*entries
= entriesbuf
;
5759 charpos
= IT_CHARPOS (*it
);
5761 /* Append the overlay string STRING of overlay OVERLAY to vector
5762 `entries' which has size `size' and currently contains `n'
5763 elements. AFTER_P non-zero means STRING is an after-string of
5765 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5768 Lisp_Object priority; \
5772 struct overlay_entry *old = entries; \
5773 SAFE_NALLOCA (entries, 2, size); \
5774 memcpy (entries, old, size * sizeof *entries); \
5778 entries[n].string = (STRING); \
5779 entries[n].overlay = (OVERLAY); \
5780 priority = Foverlay_get ((OVERLAY), Qpriority); \
5781 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5782 entries[n].after_string_p = (AFTER_P); \
5787 /* Process overlay before the overlay center. */
5788 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5790 XSETMISC (overlay
, ov
);
5791 eassert (OVERLAYP (overlay
));
5792 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5793 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5798 /* Skip this overlay if it doesn't start or end at IT's current
5800 if (end
!= charpos
&& start
!= charpos
)
5803 /* Skip this overlay if it doesn't apply to IT->w. */
5804 window
= Foverlay_get (overlay
, Qwindow
);
5805 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5808 /* If the text ``under'' the overlay is invisible, both before-
5809 and after-strings from this overlay are visible; start and
5810 end position are indistinguishable. */
5811 invisible
= Foverlay_get (overlay
, Qinvisible
);
5812 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5814 /* If overlay has a non-empty before-string, record it. */
5815 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5816 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5818 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5820 /* If overlay has a non-empty after-string, record it. */
5821 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5822 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5824 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5827 /* Process overlays after the overlay center. */
5828 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5830 XSETMISC (overlay
, ov
);
5831 eassert (OVERLAYP (overlay
));
5832 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5833 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5835 if (start
> charpos
)
5838 /* Skip this overlay if it doesn't start or end at IT's current
5840 if (end
!= charpos
&& start
!= charpos
)
5843 /* Skip this overlay if it doesn't apply to IT->w. */
5844 window
= Foverlay_get (overlay
, Qwindow
);
5845 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5848 /* If the text ``under'' the overlay is invisible, it has a zero
5849 dimension, and both before- and after-strings apply. */
5850 invisible
= Foverlay_get (overlay
, Qinvisible
);
5851 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5853 /* If overlay has a non-empty before-string, record it. */
5854 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5855 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5857 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5859 /* If overlay has a non-empty after-string, record it. */
5860 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5861 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5863 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5866 #undef RECORD_OVERLAY_STRING
5870 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5872 /* Record number of overlay strings, and where we computed it. */
5873 it
->n_overlay_strings
= n
;
5874 it
->overlay_strings_charpos
= charpos
;
5876 /* IT->current.overlay_string_index is the number of overlay strings
5877 that have already been consumed by IT. Copy some of the
5878 remaining overlay strings to IT->overlay_strings. */
5880 j
= it
->current
.overlay_string_index
;
5881 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5883 it
->overlay_strings
[i
] = entries
[j
].string
;
5884 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5892 /* Get the first chunk of overlay strings at IT's current buffer
5893 position, or at CHARPOS if that is > 0. Value is non-zero if at
5894 least one overlay string was found. */
5897 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5899 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5900 process. This fills IT->overlay_strings with strings, and sets
5901 IT->n_overlay_strings to the total number of strings to process.
5902 IT->pos.overlay_string_index has to be set temporarily to zero
5903 because load_overlay_strings needs this; it must be set to -1
5904 when no overlay strings are found because a zero value would
5905 indicate a position in the first overlay string. */
5906 it
->current
.overlay_string_index
= 0;
5907 load_overlay_strings (it
, charpos
);
5909 /* If we found overlay strings, set up IT to deliver display
5910 elements from the first one. Otherwise set up IT to deliver
5911 from current_buffer. */
5912 if (it
->n_overlay_strings
)
5914 /* Make sure we know settings in current_buffer, so that we can
5915 restore meaningful values when we're done with the overlay
5918 compute_stop_pos (it
);
5919 eassert (it
->face_id
>= 0);
5921 /* Save IT's settings. They are restored after all overlay
5922 strings have been processed. */
5923 eassert (!compute_stop_p
|| it
->sp
== 0);
5925 /* When called from handle_stop, there might be an empty display
5926 string loaded. In that case, don't bother saving it. But
5927 don't use this optimization with the bidi iterator, since we
5928 need the corresponding pop_it call to resync the bidi
5929 iterator's position with IT's position, after we are done
5930 with the overlay strings. (The corresponding call to pop_it
5931 in case of an empty display string is in
5932 next_overlay_string.) */
5934 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5937 /* Set up IT to deliver display elements from the first overlay
5939 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5940 it
->string
= it
->overlay_strings
[0];
5941 it
->from_overlay
= Qnil
;
5942 it
->stop_charpos
= 0;
5943 eassert (STRINGP (it
->string
));
5944 it
->end_charpos
= SCHARS (it
->string
);
5946 it
->base_level_stop
= 0;
5947 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5948 it
->method
= GET_FROM_STRING
;
5949 it
->from_disp_prop_p
= 0;
5951 /* Force paragraph direction to be that of the parent
5953 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5954 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5956 it
->paragraph_embedding
= L2R
;
5958 /* Set up the bidi iterator for this overlay string. */
5961 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5963 it
->bidi_it
.string
.lstring
= it
->string
;
5964 it
->bidi_it
.string
.s
= NULL
;
5965 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5966 it
->bidi_it
.string
.bufpos
= pos
;
5967 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5968 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5969 it
->bidi_it
.w
= it
->w
;
5970 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5975 it
->current
.overlay_string_index
= -1;
5980 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5983 it
->method
= GET_FROM_BUFFER
;
5985 (void) get_overlay_strings_1 (it
, charpos
, 1);
5989 /* Value is non-zero if we found at least one overlay string. */
5990 return STRINGP (it
->string
);
5995 /***********************************************************************
5996 Saving and restoring state
5997 ***********************************************************************/
5999 /* Save current settings of IT on IT->stack. Called, for example,
6000 before setting up IT for an overlay string, to be able to restore
6001 IT's settings to what they were after the overlay string has been
6002 processed. If POSITION is non-NULL, it is the position to save on
6003 the stack instead of IT->position. */
6006 push_it (struct it
*it
, struct text_pos
*position
)
6008 struct iterator_stack_entry
*p
;
6010 eassert (it
->sp
< IT_STACK_SIZE
);
6011 p
= it
->stack
+ it
->sp
;
6013 p
->stop_charpos
= it
->stop_charpos
;
6014 p
->prev_stop
= it
->prev_stop
;
6015 p
->base_level_stop
= it
->base_level_stop
;
6016 p
->cmp_it
= it
->cmp_it
;
6017 eassert (it
->face_id
>= 0);
6018 p
->face_id
= it
->face_id
;
6019 p
->string
= it
->string
;
6020 p
->method
= it
->method
;
6021 p
->from_overlay
= it
->from_overlay
;
6024 case GET_FROM_IMAGE
:
6025 p
->u
.image
.object
= it
->object
;
6026 p
->u
.image
.image_id
= it
->image_id
;
6027 p
->u
.image
.slice
= it
->slice
;
6029 case GET_FROM_STRETCH
:
6030 p
->u
.stretch
.object
= it
->object
;
6033 p
->position
= position
? *position
: it
->position
;
6034 p
->current
= it
->current
;
6035 p
->end_charpos
= it
->end_charpos
;
6036 p
->string_nchars
= it
->string_nchars
;
6038 p
->multibyte_p
= it
->multibyte_p
;
6039 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6040 p
->space_width
= it
->space_width
;
6041 p
->font_height
= it
->font_height
;
6042 p
->voffset
= it
->voffset
;
6043 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6044 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6045 p
->display_ellipsis_p
= 0;
6046 p
->line_wrap
= it
->line_wrap
;
6047 p
->bidi_p
= it
->bidi_p
;
6048 p
->paragraph_embedding
= it
->paragraph_embedding
;
6049 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6052 /* Save the state of the bidi iterator as well. */
6054 bidi_push_it (&it
->bidi_it
);
6058 iterate_out_of_display_property (struct it
*it
)
6060 int buffer_p
= !STRINGP (it
->string
);
6061 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6062 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6064 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6066 /* Maybe initialize paragraph direction. If we are at the beginning
6067 of a new paragraph, next_element_from_buffer may not have a
6068 chance to do that. */
6069 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6070 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6071 /* prev_stop can be zero, so check against BEGV as well. */
6072 while (it
->bidi_it
.charpos
>= bob
6073 && it
->prev_stop
<= it
->bidi_it
.charpos
6074 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6075 && it
->bidi_it
.charpos
< eob
)
6076 bidi_move_to_visually_next (&it
->bidi_it
);
6077 /* Record the stop_pos we just crossed, for when we cross it
6079 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6080 it
->prev_stop
= CHARPOS (it
->position
);
6081 /* If we ended up not where pop_it put us, resync IT's
6082 positional members with the bidi iterator. */
6083 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6084 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6086 it
->current
.pos
= it
->position
;
6088 it
->current
.string_pos
= it
->position
;
6091 /* Restore IT's settings from IT->stack. Called, for example, when no
6092 more overlay strings must be processed, and we return to delivering
6093 display elements from a buffer, or when the end of a string from a
6094 `display' property is reached and we return to delivering display
6095 elements from an overlay string, or from a buffer. */
6098 pop_it (struct it
*it
)
6100 struct iterator_stack_entry
*p
;
6101 int from_display_prop
= it
->from_disp_prop_p
;
6103 eassert (it
->sp
> 0);
6105 p
= it
->stack
+ it
->sp
;
6106 it
->stop_charpos
= p
->stop_charpos
;
6107 it
->prev_stop
= p
->prev_stop
;
6108 it
->base_level_stop
= p
->base_level_stop
;
6109 it
->cmp_it
= p
->cmp_it
;
6110 it
->face_id
= p
->face_id
;
6111 it
->current
= p
->current
;
6112 it
->position
= p
->position
;
6113 it
->string
= p
->string
;
6114 it
->from_overlay
= p
->from_overlay
;
6115 if (NILP (it
->string
))
6116 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6117 it
->method
= p
->method
;
6120 case GET_FROM_IMAGE
:
6121 it
->image_id
= p
->u
.image
.image_id
;
6122 it
->object
= p
->u
.image
.object
;
6123 it
->slice
= p
->u
.image
.slice
;
6125 case GET_FROM_STRETCH
:
6126 it
->object
= p
->u
.stretch
.object
;
6128 case GET_FROM_BUFFER
:
6129 it
->object
= it
->w
->contents
;
6131 case GET_FROM_STRING
:
6133 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6135 /* Restore the face_box_p flag, since it could have been
6136 overwritten by the face of the object that we just finished
6139 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6140 it
->object
= it
->string
;
6143 case GET_FROM_DISPLAY_VECTOR
:
6145 it
->method
= GET_FROM_C_STRING
;
6146 else if (STRINGP (it
->string
))
6147 it
->method
= GET_FROM_STRING
;
6150 it
->method
= GET_FROM_BUFFER
;
6151 it
->object
= it
->w
->contents
;
6154 it
->end_charpos
= p
->end_charpos
;
6155 it
->string_nchars
= p
->string_nchars
;
6157 it
->multibyte_p
= p
->multibyte_p
;
6158 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6159 it
->space_width
= p
->space_width
;
6160 it
->font_height
= p
->font_height
;
6161 it
->voffset
= p
->voffset
;
6162 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6163 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6164 it
->line_wrap
= p
->line_wrap
;
6165 it
->bidi_p
= p
->bidi_p
;
6166 it
->paragraph_embedding
= p
->paragraph_embedding
;
6167 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6170 bidi_pop_it (&it
->bidi_it
);
6171 /* Bidi-iterate until we get out of the portion of text, if any,
6172 covered by a `display' text property or by an overlay with
6173 `display' property. (We cannot just jump there, because the
6174 internal coherency of the bidi iterator state can not be
6175 preserved across such jumps.) We also must determine the
6176 paragraph base direction if the overlay we just processed is
6177 at the beginning of a new paragraph. */
6178 if (from_display_prop
6179 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6180 iterate_out_of_display_property (it
);
6182 eassert ((BUFFERP (it
->object
)
6183 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6184 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6185 || (STRINGP (it
->object
)
6186 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6187 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6188 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6194 /***********************************************************************
6196 ***********************************************************************/
6198 /* Set IT's current position to the previous line start. */
6201 back_to_previous_line_start (struct it
*it
)
6203 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6206 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6210 /* Move IT to the next line start.
6212 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6213 we skipped over part of the text (as opposed to moving the iterator
6214 continuously over the text). Otherwise, don't change the value
6217 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6218 iterator on the newline, if it was found.
6220 Newlines may come from buffer text, overlay strings, or strings
6221 displayed via the `display' property. That's the reason we can't
6222 simply use find_newline_no_quit.
6224 Note that this function may not skip over invisible text that is so
6225 because of text properties and immediately follows a newline. If
6226 it would, function reseat_at_next_visible_line_start, when called
6227 from set_iterator_to_next, would effectively make invisible
6228 characters following a newline part of the wrong glyph row, which
6229 leads to wrong cursor motion. */
6232 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6233 struct bidi_it
*bidi_it_prev
)
6235 ptrdiff_t old_selective
;
6236 int newline_found_p
, n
;
6237 const int MAX_NEWLINE_DISTANCE
= 500;
6239 /* If already on a newline, just consume it to avoid unintended
6240 skipping over invisible text below. */
6241 if (it
->what
== IT_CHARACTER
6243 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6245 if (it
->bidi_p
&& bidi_it_prev
)
6246 *bidi_it_prev
= it
->bidi_it
;
6247 set_iterator_to_next (it
, 0);
6252 /* Don't handle selective display in the following. It's (a)
6253 unnecessary because it's done by the caller, and (b) leads to an
6254 infinite recursion because next_element_from_ellipsis indirectly
6255 calls this function. */
6256 old_selective
= it
->selective
;
6259 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6260 from buffer text. */
6261 for (n
= newline_found_p
= 0;
6262 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6263 n
+= STRINGP (it
->string
) ? 0 : 1)
6265 if (!get_next_display_element (it
))
6267 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6268 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6269 *bidi_it_prev
= it
->bidi_it
;
6270 set_iterator_to_next (it
, 0);
6273 /* If we didn't find a newline near enough, see if we can use a
6275 if (!newline_found_p
)
6277 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6278 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6282 eassert (!STRINGP (it
->string
));
6284 /* If there isn't any `display' property in sight, and no
6285 overlays, we can just use the position of the newline in
6287 if (it
->stop_charpos
>= limit
6288 || ((pos
= Fnext_single_property_change (make_number (start
),
6290 make_number (limit
)),
6292 && next_overlay_change (start
) == ZV
))
6296 IT_CHARPOS (*it
) = limit
;
6297 IT_BYTEPOS (*it
) = bytepos
;
6301 struct bidi_it bprev
;
6303 /* Help bidi.c avoid expensive searches for display
6304 properties and overlays, by telling it that there are
6305 none up to `limit'. */
6306 if (it
->bidi_it
.disp_pos
< limit
)
6308 it
->bidi_it
.disp_pos
= limit
;
6309 it
->bidi_it
.disp_prop
= 0;
6312 bprev
= it
->bidi_it
;
6313 bidi_move_to_visually_next (&it
->bidi_it
);
6314 } while (it
->bidi_it
.charpos
!= limit
);
6315 IT_CHARPOS (*it
) = limit
;
6316 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6318 *bidi_it_prev
= bprev
;
6320 *skipped_p
= newline_found_p
= true;
6324 while (get_next_display_element (it
)
6325 && !newline_found_p
)
6327 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6328 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6329 *bidi_it_prev
= it
->bidi_it
;
6330 set_iterator_to_next (it
, 0);
6335 it
->selective
= old_selective
;
6336 return newline_found_p
;
6340 /* Set IT's current position to the previous visible line start. Skip
6341 invisible text that is so either due to text properties or due to
6342 selective display. Caution: this does not change IT->current_x and
6346 back_to_previous_visible_line_start (struct it
*it
)
6348 while (IT_CHARPOS (*it
) > BEGV
)
6350 back_to_previous_line_start (it
);
6352 if (IT_CHARPOS (*it
) <= BEGV
)
6355 /* If selective > 0, then lines indented more than its value are
6357 if (it
->selective
> 0
6358 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6362 /* Check the newline before point for invisibility. */
6365 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6366 Qinvisible
, it
->window
);
6367 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6371 if (IT_CHARPOS (*it
) <= BEGV
)
6376 void *it2data
= NULL
;
6379 Lisp_Object val
, overlay
;
6381 SAVE_IT (it2
, *it
, it2data
);
6383 /* If newline is part of a composition, continue from start of composition */
6384 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6385 && beg
< IT_CHARPOS (*it
))
6388 /* If newline is replaced by a display property, find start of overlay
6389 or interval and continue search from that point. */
6390 pos
= --IT_CHARPOS (it2
);
6393 bidi_unshelve_cache (NULL
, 0);
6394 it2
.string_from_display_prop_p
= 0;
6395 it2
.from_disp_prop_p
= 0;
6396 if (handle_display_prop (&it2
) == HANDLED_RETURN
6397 && !NILP (val
= get_char_property_and_overlay
6398 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6399 && (OVERLAYP (overlay
)
6400 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6401 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6403 RESTORE_IT (it
, it
, it2data
);
6407 /* Newline is not replaced by anything -- so we are done. */
6408 RESTORE_IT (it
, it
, it2data
);
6414 IT_CHARPOS (*it
) = beg
;
6415 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6419 it
->continuation_lines_width
= 0;
6421 eassert (IT_CHARPOS (*it
) >= BEGV
);
6422 eassert (IT_CHARPOS (*it
) == BEGV
6423 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6428 /* Reseat iterator IT at the previous visible line start. Skip
6429 invisible text that is so either due to text properties or due to
6430 selective display. At the end, update IT's overlay information,
6431 face information etc. */
6434 reseat_at_previous_visible_line_start (struct it
*it
)
6436 back_to_previous_visible_line_start (it
);
6437 reseat (it
, it
->current
.pos
, 1);
6442 /* Reseat iterator IT on the next visible line start in the current
6443 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6444 preceding the line start. Skip over invisible text that is so
6445 because of selective display. Compute faces, overlays etc at the
6446 new position. Note that this function does not skip over text that
6447 is invisible because of text properties. */
6450 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6452 int newline_found_p
, skipped_p
= 0;
6453 struct bidi_it bidi_it_prev
;
6455 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6457 /* Skip over lines that are invisible because they are indented
6458 more than the value of IT->selective. */
6459 if (it
->selective
> 0)
6460 while (IT_CHARPOS (*it
) < ZV
6461 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6464 eassert (IT_BYTEPOS (*it
) == BEGV
6465 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6467 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6470 /* Position on the newline if that's what's requested. */
6471 if (on_newline_p
&& newline_found_p
)
6473 if (STRINGP (it
->string
))
6475 if (IT_STRING_CHARPOS (*it
) > 0)
6479 --IT_STRING_CHARPOS (*it
);
6480 --IT_STRING_BYTEPOS (*it
);
6484 /* We need to restore the bidi iterator to the state
6485 it had on the newline, and resync the IT's
6486 position with that. */
6487 it
->bidi_it
= bidi_it_prev
;
6488 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6489 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6493 else if (IT_CHARPOS (*it
) > BEGV
)
6502 /* We need to restore the bidi iterator to the state it
6503 had on the newline and resync IT with that. */
6504 it
->bidi_it
= bidi_it_prev
;
6505 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6506 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6508 reseat (it
, it
->current
.pos
, 0);
6512 reseat (it
, it
->current
.pos
, 0);
6519 /***********************************************************************
6520 Changing an iterator's position
6521 ***********************************************************************/
6523 /* Change IT's current position to POS in current_buffer. If FORCE_P
6524 is non-zero, always check for text properties at the new position.
6525 Otherwise, text properties are only looked up if POS >=
6526 IT->check_charpos of a property. */
6529 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6531 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6533 reseat_1 (it
, pos
, 0);
6535 /* Determine where to check text properties. Avoid doing it
6536 where possible because text property lookup is very expensive. */
6538 || CHARPOS (pos
) > it
->stop_charpos
6539 || CHARPOS (pos
) < original_pos
)
6543 /* For bidi iteration, we need to prime prev_stop and
6544 base_level_stop with our best estimations. */
6545 /* Implementation note: Of course, POS is not necessarily a
6546 stop position, so assigning prev_pos to it is a lie; we
6547 should have called compute_stop_backwards. However, if
6548 the current buffer does not include any R2L characters,
6549 that call would be a waste of cycles, because the
6550 iterator will never move back, and thus never cross this
6551 "fake" stop position. So we delay that backward search
6552 until the time we really need it, in next_element_from_buffer. */
6553 if (CHARPOS (pos
) != it
->prev_stop
)
6554 it
->prev_stop
= CHARPOS (pos
);
6555 if (CHARPOS (pos
) < it
->base_level_stop
)
6556 it
->base_level_stop
= 0; /* meaning it's unknown */
6562 it
->prev_stop
= it
->base_level_stop
= 0;
6571 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6572 IT->stop_pos to POS, also. */
6575 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6577 /* Don't call this function when scanning a C string. */
6578 eassert (it
->s
== NULL
);
6580 /* POS must be a reasonable value. */
6581 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6583 it
->current
.pos
= it
->position
= pos
;
6584 it
->end_charpos
= ZV
;
6586 it
->current
.dpvec_index
= -1;
6587 it
->current
.overlay_string_index
= -1;
6588 IT_STRING_CHARPOS (*it
) = -1;
6589 IT_STRING_BYTEPOS (*it
) = -1;
6591 it
->method
= GET_FROM_BUFFER
;
6592 it
->object
= it
->w
->contents
;
6593 it
->area
= TEXT_AREA
;
6594 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6596 it
->string_from_display_prop_p
= 0;
6597 it
->string_from_prefix_prop_p
= 0;
6599 it
->from_disp_prop_p
= 0;
6600 it
->face_before_selective_p
= 0;
6603 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6605 bidi_unshelve_cache (NULL
, 0);
6606 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6607 it
->bidi_it
.string
.s
= NULL
;
6608 it
->bidi_it
.string
.lstring
= Qnil
;
6609 it
->bidi_it
.string
.bufpos
= 0;
6610 it
->bidi_it
.string
.from_disp_str
= 0;
6611 it
->bidi_it
.string
.unibyte
= 0;
6612 it
->bidi_it
.w
= it
->w
;
6617 it
->stop_charpos
= CHARPOS (pos
);
6618 it
->base_level_stop
= CHARPOS (pos
);
6620 /* This make the information stored in it->cmp_it invalidate. */
6625 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6626 If S is non-null, it is a C string to iterate over. Otherwise,
6627 STRING gives a Lisp string to iterate over.
6629 If PRECISION > 0, don't return more then PRECISION number of
6630 characters from the string.
6632 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6633 characters have been returned. FIELD_WIDTH < 0 means an infinite
6636 MULTIBYTE = 0 means disable processing of multibyte characters,
6637 MULTIBYTE > 0 means enable it,
6638 MULTIBYTE < 0 means use IT->multibyte_p.
6640 IT must be initialized via a prior call to init_iterator before
6641 calling this function. */
6644 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6645 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6648 /* No text property checks performed by default, but see below. */
6649 it
->stop_charpos
= -1;
6651 /* Set iterator position and end position. */
6652 memset (&it
->current
, 0, sizeof it
->current
);
6653 it
->current
.overlay_string_index
= -1;
6654 it
->current
.dpvec_index
= -1;
6655 eassert (charpos
>= 0);
6657 /* If STRING is specified, use its multibyteness, otherwise use the
6658 setting of MULTIBYTE, if specified. */
6660 it
->multibyte_p
= multibyte
> 0;
6662 /* Bidirectional reordering of strings is controlled by the default
6663 value of bidi-display-reordering. Don't try to reorder while
6664 loading loadup.el, as the necessary character property tables are
6665 not yet available. */
6668 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6672 eassert (STRINGP (string
));
6673 it
->string
= string
;
6675 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6676 it
->method
= GET_FROM_STRING
;
6677 it
->current
.string_pos
= string_pos (charpos
, string
);
6681 it
->bidi_it
.string
.lstring
= string
;
6682 it
->bidi_it
.string
.s
= NULL
;
6683 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6684 it
->bidi_it
.string
.bufpos
= 0;
6685 it
->bidi_it
.string
.from_disp_str
= 0;
6686 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6687 it
->bidi_it
.w
= it
->w
;
6688 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6689 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6694 it
->s
= (const unsigned char *) s
;
6697 /* Note that we use IT->current.pos, not it->current.string_pos,
6698 for displaying C strings. */
6699 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6700 if (it
->multibyte_p
)
6702 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6703 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6707 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6708 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6713 it
->bidi_it
.string
.lstring
= Qnil
;
6714 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6715 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6716 it
->bidi_it
.string
.bufpos
= 0;
6717 it
->bidi_it
.string
.from_disp_str
= 0;
6718 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6719 it
->bidi_it
.w
= it
->w
;
6720 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6723 it
->method
= GET_FROM_C_STRING
;
6726 /* PRECISION > 0 means don't return more than PRECISION characters
6728 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6730 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6732 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6735 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6736 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6737 FIELD_WIDTH < 0 means infinite field width. This is useful for
6738 padding with `-' at the end of a mode line. */
6739 if (field_width
< 0)
6740 field_width
= INFINITY
;
6741 /* Implementation note: We deliberately don't enlarge
6742 it->bidi_it.string.schars here to fit it->end_charpos, because
6743 the bidi iterator cannot produce characters out of thin air. */
6744 if (field_width
> it
->end_charpos
- charpos
)
6745 it
->end_charpos
= charpos
+ field_width
;
6747 /* Use the standard display table for displaying strings. */
6748 if (DISP_TABLE_P (Vstandard_display_table
))
6749 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6751 it
->stop_charpos
= charpos
;
6752 it
->prev_stop
= charpos
;
6753 it
->base_level_stop
= 0;
6756 it
->bidi_it
.first_elt
= 1;
6757 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6758 it
->bidi_it
.disp_pos
= -1;
6760 if (s
== NULL
&& it
->multibyte_p
)
6762 ptrdiff_t endpos
= SCHARS (it
->string
);
6763 if (endpos
> it
->end_charpos
)
6764 endpos
= it
->end_charpos
;
6765 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6773 /***********************************************************************
6775 ***********************************************************************/
6777 /* Map enum it_method value to corresponding next_element_from_* function. */
6779 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6781 next_element_from_buffer
,
6782 next_element_from_display_vector
,
6783 next_element_from_string
,
6784 next_element_from_c_string
,
6785 next_element_from_image
,
6786 next_element_from_stretch
6789 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6792 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6793 (possibly with the following characters). */
6795 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6796 ((IT)->cmp_it.id >= 0 \
6797 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6798 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6799 END_CHARPOS, (IT)->w, \
6800 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6804 /* Lookup the char-table Vglyphless_char_display for character C (-1
6805 if we want information for no-font case), and return the display
6806 method symbol. By side-effect, update it->what and
6807 it->glyphless_method. This function is called from
6808 get_next_display_element for each character element, and from
6809 x_produce_glyphs when no suitable font was found. */
6812 lookup_glyphless_char_display (int c
, struct it
*it
)
6814 Lisp_Object glyphless_method
= Qnil
;
6816 if (CHAR_TABLE_P (Vglyphless_char_display
)
6817 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6821 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6822 if (CONSP (glyphless_method
))
6823 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6824 ? XCAR (glyphless_method
)
6825 : XCDR (glyphless_method
);
6828 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6832 if (NILP (glyphless_method
))
6835 /* The default is to display the character by a proper font. */
6837 /* The default for the no-font case is to display an empty box. */
6838 glyphless_method
= Qempty_box
;
6840 if (EQ (glyphless_method
, Qzero_width
))
6843 return glyphless_method
;
6844 /* This method can't be used for the no-font case. */
6845 glyphless_method
= Qempty_box
;
6847 if (EQ (glyphless_method
, Qthin_space
))
6848 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6849 else if (EQ (glyphless_method
, Qempty_box
))
6850 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6851 else if (EQ (glyphless_method
, Qhex_code
))
6852 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6853 else if (STRINGP (glyphless_method
))
6854 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6857 /* Invalid value. We use the default method. */
6858 glyphless_method
= Qnil
;
6861 it
->what
= IT_GLYPHLESS
;
6862 return glyphless_method
;
6865 /* Merge escape glyph face and cache the result. */
6867 static struct frame
*last_escape_glyph_frame
= NULL
;
6868 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6869 static int last_escape_glyph_merged_face_id
= 0;
6872 merge_escape_glyph_face (struct it
*it
)
6876 if (it
->f
== last_escape_glyph_frame
6877 && it
->face_id
== last_escape_glyph_face_id
)
6878 face_id
= last_escape_glyph_merged_face_id
;
6881 /* Merge the `escape-glyph' face into the current face. */
6882 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6883 last_escape_glyph_frame
= it
->f
;
6884 last_escape_glyph_face_id
= it
->face_id
;
6885 last_escape_glyph_merged_face_id
= face_id
;
6890 /* Likewise for glyphless glyph face. */
6892 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6893 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6894 static int last_glyphless_glyph_merged_face_id
= 0;
6897 merge_glyphless_glyph_face (struct it
*it
)
6901 if (it
->f
== last_glyphless_glyph_frame
6902 && it
->face_id
== last_glyphless_glyph_face_id
)
6903 face_id
= last_glyphless_glyph_merged_face_id
;
6906 /* Merge the `glyphless-char' face into the current face. */
6907 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6908 last_glyphless_glyph_frame
= it
->f
;
6909 last_glyphless_glyph_face_id
= it
->face_id
;
6910 last_glyphless_glyph_merged_face_id
= face_id
;
6915 /* Load IT's display element fields with information about the next
6916 display element from the current position of IT. Value is zero if
6917 end of buffer (or C string) is reached. */
6920 get_next_display_element (struct it
*it
)
6922 /* Non-zero means that we found a display element. Zero means that
6923 we hit the end of what we iterate over. Performance note: the
6924 function pointer `method' used here turns out to be faster than
6925 using a sequence of if-statements. */
6929 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6931 if (it
->what
== IT_CHARACTER
)
6933 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6934 and only if (a) the resolved directionality of that character
6936 /* FIXME: Do we need an exception for characters from display
6938 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6939 it
->c
= bidi_mirror_char (it
->c
);
6940 /* Map via display table or translate control characters.
6941 IT->c, IT->len etc. have been set to the next character by
6942 the function call above. If we have a display table, and it
6943 contains an entry for IT->c, translate it. Don't do this if
6944 IT->c itself comes from a display table, otherwise we could
6945 end up in an infinite recursion. (An alternative could be to
6946 count the recursion depth of this function and signal an
6947 error when a certain maximum depth is reached.) Is it worth
6949 if (success_p
&& it
->dpvec
== NULL
)
6952 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6953 int nonascii_space_p
= 0;
6954 int nonascii_hyphen_p
= 0;
6955 int c
= it
->c
; /* This is the character to display. */
6957 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6959 eassert (SINGLE_BYTE_CHAR_P (c
));
6960 if (unibyte_display_via_language_environment
)
6962 c
= DECODE_CHAR (unibyte
, c
);
6964 c
= BYTE8_TO_CHAR (it
->c
);
6967 c
= BYTE8_TO_CHAR (it
->c
);
6971 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6974 struct Lisp_Vector
*v
= XVECTOR (dv
);
6976 /* Return the first character from the display table
6977 entry, if not empty. If empty, don't display the
6978 current character. */
6981 it
->dpvec_char_len
= it
->len
;
6982 it
->dpvec
= v
->contents
;
6983 it
->dpend
= v
->contents
+ v
->header
.size
;
6984 it
->current
.dpvec_index
= 0;
6985 it
->dpvec_face_id
= -1;
6986 it
->saved_face_id
= it
->face_id
;
6987 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6992 set_iterator_to_next (it
, 0);
6997 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6999 if (it
->what
== IT_GLYPHLESS
)
7001 /* Don't display this character. */
7002 set_iterator_to_next (it
, 0);
7006 /* If `nobreak-char-display' is non-nil, we display
7007 non-ASCII spaces and hyphens specially. */
7008 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7011 nonascii_space_p
= true;
7012 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7013 nonascii_hyphen_p
= true;
7016 /* Translate control characters into `\003' or `^C' form.
7017 Control characters coming from a display table entry are
7018 currently not translated because we use IT->dpvec to hold
7019 the translation. This could easily be changed but I
7020 don't believe that it is worth doing.
7022 The characters handled by `nobreak-char-display' must be
7025 Non-printable characters and raw-byte characters are also
7026 translated to octal form. */
7027 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7028 ? (it
->area
!= TEXT_AREA
7029 /* In mode line, treat \n, \t like other crl chars. */
7032 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7033 || (c
!= '\n' && c
!= '\t'))
7035 || nonascii_hyphen_p
7037 || ! CHAR_PRINTABLE_P (c
))))
7039 /* C is a control character, non-ASCII space/hyphen,
7040 raw-byte, or a non-printable character which must be
7041 displayed either as '\003' or as `^C' where the '\\'
7042 and '^' can be defined in the display table. Fill
7043 IT->ctl_chars with glyphs for what we have to
7044 display. Then, set IT->dpvec to these glyphs. */
7051 /* Handle control characters with ^. */
7053 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7057 g
= '^'; /* default glyph for Control */
7058 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7060 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7062 g
= GLYPH_CODE_CHAR (gc
);
7063 lface_id
= GLYPH_CODE_FACE (gc
);
7067 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7068 : merge_escape_glyph_face (it
));
7070 XSETINT (it
->ctl_chars
[0], g
);
7071 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7073 goto display_control
;
7076 /* Handle non-ascii space in the mode where it only gets
7079 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7081 /* Merge `nobreak-space' into the current face. */
7082 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7084 XSETINT (it
->ctl_chars
[0], ' ');
7086 goto display_control
;
7089 /* Handle sequences that start with the "escape glyph". */
7091 /* the default escape glyph is \. */
7092 escape_glyph
= '\\';
7095 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7097 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7098 lface_id
= GLYPH_CODE_FACE (gc
);
7102 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7103 : merge_escape_glyph_face (it
));
7105 /* Draw non-ASCII hyphen with just highlighting: */
7107 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7109 XSETINT (it
->ctl_chars
[0], '-');
7111 goto display_control
;
7114 /* Draw non-ASCII space/hyphen with escape glyph: */
7116 if (nonascii_space_p
|| nonascii_hyphen_p
)
7118 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7119 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7121 goto display_control
;
7128 if (CHAR_BYTE8_P (c
))
7129 /* Display \200 instead of \17777600. */
7130 c
= CHAR_TO_BYTE8 (c
);
7131 len
= sprintf (str
, "%03o", c
);
7133 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7134 for (i
= 0; i
< len
; i
++)
7135 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7140 /* Set up IT->dpvec and return first character from it. */
7141 it
->dpvec_char_len
= it
->len
;
7142 it
->dpvec
= it
->ctl_chars
;
7143 it
->dpend
= it
->dpvec
+ ctl_len
;
7144 it
->current
.dpvec_index
= 0;
7145 it
->dpvec_face_id
= face_id
;
7146 it
->saved_face_id
= it
->face_id
;
7147 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7151 it
->char_to_display
= c
;
7155 it
->char_to_display
= it
->c
;
7159 #ifdef HAVE_WINDOW_SYSTEM
7160 /* Adjust face id for a multibyte character. There are no multibyte
7161 character in unibyte text. */
7162 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7165 && FRAME_WINDOW_P (it
->f
))
7167 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7169 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7171 /* Automatic composition with glyph-string. */
7172 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7174 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7178 ptrdiff_t pos
= (it
->s
? -1
7179 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7180 : IT_CHARPOS (*it
));
7183 if (it
->what
== IT_CHARACTER
)
7184 c
= it
->char_to_display
;
7187 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7191 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7192 /* TAB in a composition means display glyphs with
7193 padding space on the left or right. */
7194 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7197 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7200 #endif /* HAVE_WINDOW_SYSTEM */
7203 /* Is this character the last one of a run of characters with
7204 box? If yes, set IT->end_of_box_run_p to 1. */
7208 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7210 int face_id
= underlying_face_id (it
);
7211 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7215 if (face
->box
== FACE_NO_BOX
)
7217 /* If the box comes from face properties in a
7218 display string, check faces in that string. */
7219 int string_face_id
= face_after_it_pos (it
);
7220 it
->end_of_box_run_p
7221 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7224 /* Otherwise, the box comes from the underlying face.
7225 If this is the last string character displayed, check
7226 the next buffer location. */
7227 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7228 /* n_overlay_strings is unreliable unless
7229 overlay_string_index is non-negative. */
7230 && ((it
->current
.overlay_string_index
>= 0
7231 && (it
->current
.overlay_string_index
7232 == it
->n_overlay_strings
- 1))
7233 /* A string from display property. */
7234 || it
->from_disp_prop_p
))
7238 struct text_pos pos
= it
->current
.pos
;
7240 /* For a string from a display property, the next
7241 buffer position is stored in the 'position'
7242 member of the iteration stack slot below the
7243 current one, see handle_single_display_spec. By
7244 contrast, it->current.pos was is not yet updated
7245 to point to that buffer position; that will
7246 happen in pop_it, after we finish displaying the
7247 current string. Note that we already checked
7248 above that it->sp is positive, so subtracting one
7250 if (it
->from_disp_prop_p
)
7251 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7253 INC_TEXT_POS (pos
, it
->multibyte_p
);
7255 if (CHARPOS (pos
) >= ZV
)
7256 it
->end_of_box_run_p
= true;
7259 next_face_id
= face_at_buffer_position
7260 (it
->w
, CHARPOS (pos
), &ignore
,
7261 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7262 it
->end_of_box_run_p
7263 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7269 /* next_element_from_display_vector sets this flag according to
7270 faces of the display vector glyphs, see there. */
7271 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7273 int face_id
= face_after_it_pos (it
);
7274 it
->end_of_box_run_p
7275 = (face_id
!= it
->face_id
7276 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7279 /* If we reached the end of the object we've been iterating (e.g., a
7280 display string or an overlay string), and there's something on
7281 IT->stack, proceed with what's on the stack. It doesn't make
7282 sense to return zero if there's unprocessed stuff on the stack,
7283 because otherwise that stuff will never be displayed. */
7284 if (!success_p
&& it
->sp
> 0)
7286 set_iterator_to_next (it
, 0);
7287 success_p
= get_next_display_element (it
);
7290 /* Value is 0 if end of buffer or string reached. */
7295 /* Move IT to the next display element.
7297 RESEAT_P non-zero means if called on a newline in buffer text,
7298 skip to the next visible line start.
7300 Functions get_next_display_element and set_iterator_to_next are
7301 separate because I find this arrangement easier to handle than a
7302 get_next_display_element function that also increments IT's
7303 position. The way it is we can first look at an iterator's current
7304 display element, decide whether it fits on a line, and if it does,
7305 increment the iterator position. The other way around we probably
7306 would either need a flag indicating whether the iterator has to be
7307 incremented the next time, or we would have to implement a
7308 decrement position function which would not be easy to write. */
7311 set_iterator_to_next (struct it
*it
, int reseat_p
)
7313 /* Reset flags indicating start and end of a sequence of characters
7314 with box. Reset them at the start of this function because
7315 moving the iterator to a new position might set them. */
7316 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7320 case GET_FROM_BUFFER
:
7321 /* The current display element of IT is a character from
7322 current_buffer. Advance in the buffer, and maybe skip over
7323 invisible lines that are so because of selective display. */
7324 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7325 reseat_at_next_visible_line_start (it
, 0);
7326 else if (it
->cmp_it
.id
>= 0)
7328 /* We are currently getting glyphs from a composition. */
7333 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7334 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7335 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7337 it
->cmp_it
.from
= it
->cmp_it
.to
;
7342 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7344 it
->end_charpos
, Qnil
);
7347 else if (! it
->cmp_it
.reversed_p
)
7349 /* Composition created while scanning forward. */
7350 /* Update IT's char/byte positions to point to the first
7351 character of the next grapheme cluster, or to the
7352 character visually after the current composition. */
7353 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7354 bidi_move_to_visually_next (&it
->bidi_it
);
7355 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7356 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7358 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7360 /* Proceed to the next grapheme cluster. */
7361 it
->cmp_it
.from
= it
->cmp_it
.to
;
7365 /* No more grapheme clusters in this composition.
7366 Find the next stop position. */
7367 ptrdiff_t stop
= it
->end_charpos
;
7368 if (it
->bidi_it
.scan_dir
< 0)
7369 /* Now we are scanning backward and don't know
7372 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7373 IT_BYTEPOS (*it
), stop
, Qnil
);
7378 /* Composition created while scanning backward. */
7379 /* Update IT's char/byte positions to point to the last
7380 character of the previous grapheme cluster, or the
7381 character visually after the current composition. */
7382 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7383 bidi_move_to_visually_next (&it
->bidi_it
);
7384 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7385 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7386 if (it
->cmp_it
.from
> 0)
7388 /* Proceed to the previous grapheme cluster. */
7389 it
->cmp_it
.to
= it
->cmp_it
.from
;
7393 /* No more grapheme clusters in this composition.
7394 Find the next stop position. */
7395 ptrdiff_t stop
= it
->end_charpos
;
7396 if (it
->bidi_it
.scan_dir
< 0)
7397 /* Now we are scanning backward and don't know
7400 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7401 IT_BYTEPOS (*it
), stop
, Qnil
);
7407 eassert (it
->len
!= 0);
7411 IT_BYTEPOS (*it
) += it
->len
;
7412 IT_CHARPOS (*it
) += 1;
7416 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7417 /* If this is a new paragraph, determine its base
7418 direction (a.k.a. its base embedding level). */
7419 if (it
->bidi_it
.new_paragraph
)
7420 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7421 bidi_move_to_visually_next (&it
->bidi_it
);
7422 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7423 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7424 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7426 /* As the scan direction was changed, we must
7427 re-compute the stop position for composition. */
7428 ptrdiff_t stop
= it
->end_charpos
;
7429 if (it
->bidi_it
.scan_dir
< 0)
7431 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7432 IT_BYTEPOS (*it
), stop
, Qnil
);
7435 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7439 case GET_FROM_C_STRING
:
7440 /* Current display element of IT is from a C string. */
7442 /* If the string position is beyond string's end, it means
7443 next_element_from_c_string is padding the string with
7444 blanks, in which case we bypass the bidi iterator,
7445 because it cannot deal with such virtual characters. */
7446 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7448 IT_BYTEPOS (*it
) += it
->len
;
7449 IT_CHARPOS (*it
) += 1;
7453 bidi_move_to_visually_next (&it
->bidi_it
);
7454 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7455 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7459 case GET_FROM_DISPLAY_VECTOR
:
7460 /* Current display element of IT is from a display table entry.
7461 Advance in the display table definition. Reset it to null if
7462 end reached, and continue with characters from buffers/
7464 ++it
->current
.dpvec_index
;
7466 /* Restore face of the iterator to what they were before the
7467 display vector entry (these entries may contain faces). */
7468 it
->face_id
= it
->saved_face_id
;
7470 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7472 int recheck_faces
= it
->ellipsis_p
;
7475 it
->method
= GET_FROM_C_STRING
;
7476 else if (STRINGP (it
->string
))
7477 it
->method
= GET_FROM_STRING
;
7480 it
->method
= GET_FROM_BUFFER
;
7481 it
->object
= it
->w
->contents
;
7485 it
->current
.dpvec_index
= -1;
7487 /* Skip over characters which were displayed via IT->dpvec. */
7488 if (it
->dpvec_char_len
< 0)
7489 reseat_at_next_visible_line_start (it
, 1);
7490 else if (it
->dpvec_char_len
> 0)
7492 if (it
->method
== GET_FROM_STRING
7493 && it
->current
.overlay_string_index
>= 0
7494 && it
->n_overlay_strings
> 0)
7495 it
->ignore_overlay_strings_at_pos_p
= true;
7496 it
->len
= it
->dpvec_char_len
;
7497 set_iterator_to_next (it
, reseat_p
);
7500 /* Maybe recheck faces after display vector. */
7502 it
->stop_charpos
= IT_CHARPOS (*it
);
7506 case GET_FROM_STRING
:
7507 /* Current display element is a character from a Lisp string. */
7508 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7509 /* Don't advance past string end. These conditions are true
7510 when set_iterator_to_next is called at the end of
7511 get_next_display_element, in which case the Lisp string is
7512 already exhausted, and all we want is pop the iterator
7514 if (it
->current
.overlay_string_index
>= 0)
7516 /* This is an overlay string, so there's no padding with
7517 spaces, and the number of characters in the string is
7518 where the string ends. */
7519 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7520 goto consider_string_end
;
7524 /* Not an overlay string. There could be padding, so test
7525 against it->end_charpos. */
7526 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7527 goto consider_string_end
;
7529 if (it
->cmp_it
.id
>= 0)
7535 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7536 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7537 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7538 it
->cmp_it
.from
= it
->cmp_it
.to
;
7542 composition_compute_stop_pos (&it
->cmp_it
,
7543 IT_STRING_CHARPOS (*it
),
7544 IT_STRING_BYTEPOS (*it
),
7545 it
->end_charpos
, it
->string
);
7548 else if (! it
->cmp_it
.reversed_p
)
7550 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7551 bidi_move_to_visually_next (&it
->bidi_it
);
7552 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7553 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7555 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7556 it
->cmp_it
.from
= it
->cmp_it
.to
;
7559 ptrdiff_t stop
= it
->end_charpos
;
7560 if (it
->bidi_it
.scan_dir
< 0)
7562 composition_compute_stop_pos (&it
->cmp_it
,
7563 IT_STRING_CHARPOS (*it
),
7564 IT_STRING_BYTEPOS (*it
), stop
,
7570 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7571 bidi_move_to_visually_next (&it
->bidi_it
);
7572 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7573 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7574 if (it
->cmp_it
.from
> 0)
7575 it
->cmp_it
.to
= it
->cmp_it
.from
;
7578 ptrdiff_t stop
= it
->end_charpos
;
7579 if (it
->bidi_it
.scan_dir
< 0)
7581 composition_compute_stop_pos (&it
->cmp_it
,
7582 IT_STRING_CHARPOS (*it
),
7583 IT_STRING_BYTEPOS (*it
), stop
,
7591 /* If the string position is beyond string's end, it
7592 means next_element_from_string is padding the string
7593 with blanks, in which case we bypass the bidi
7594 iterator, because it cannot deal with such virtual
7596 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7598 IT_STRING_BYTEPOS (*it
) += it
->len
;
7599 IT_STRING_CHARPOS (*it
) += 1;
7603 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7605 bidi_move_to_visually_next (&it
->bidi_it
);
7606 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7607 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7608 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7610 ptrdiff_t stop
= it
->end_charpos
;
7612 if (it
->bidi_it
.scan_dir
< 0)
7614 composition_compute_stop_pos (&it
->cmp_it
,
7615 IT_STRING_CHARPOS (*it
),
7616 IT_STRING_BYTEPOS (*it
), stop
,
7622 consider_string_end
:
7624 if (it
->current
.overlay_string_index
>= 0)
7626 /* IT->string is an overlay string. Advance to the
7627 next, if there is one. */
7628 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7631 next_overlay_string (it
);
7633 setup_for_ellipsis (it
, 0);
7638 /* IT->string is not an overlay string. If we reached
7639 its end, and there is something on IT->stack, proceed
7640 with what is on the stack. This can be either another
7641 string, this time an overlay string, or a buffer. */
7642 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7646 if (it
->method
== GET_FROM_STRING
)
7647 goto consider_string_end
;
7652 case GET_FROM_IMAGE
:
7653 case GET_FROM_STRETCH
:
7654 /* The position etc with which we have to proceed are on
7655 the stack. The position may be at the end of a string,
7656 if the `display' property takes up the whole string. */
7657 eassert (it
->sp
> 0);
7659 if (it
->method
== GET_FROM_STRING
)
7660 goto consider_string_end
;
7664 /* There are no other methods defined, so this should be a bug. */
7668 eassert (it
->method
!= GET_FROM_STRING
7669 || (STRINGP (it
->string
)
7670 && IT_STRING_CHARPOS (*it
) >= 0));
7673 /* Load IT's display element fields with information about the next
7674 display element which comes from a display table entry or from the
7675 result of translating a control character to one of the forms `^C'
7678 IT->dpvec holds the glyphs to return as characters.
7679 IT->saved_face_id holds the face id before the display vector--it
7680 is restored into IT->face_id in set_iterator_to_next. */
7683 next_element_from_display_vector (struct it
*it
)
7686 int prev_face_id
= it
->face_id
;
7690 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7692 it
->face_id
= it
->saved_face_id
;
7694 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7695 That seemed totally bogus - so I changed it... */
7696 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7698 if (GLYPH_CODE_P (gc
))
7700 struct face
*this_face
, *prev_face
, *next_face
;
7702 it
->c
= GLYPH_CODE_CHAR (gc
);
7703 it
->len
= CHAR_BYTES (it
->c
);
7705 /* The entry may contain a face id to use. Such a face id is
7706 the id of a Lisp face, not a realized face. A face id of
7707 zero means no face is specified. */
7708 if (it
->dpvec_face_id
>= 0)
7709 it
->face_id
= it
->dpvec_face_id
;
7712 int lface_id
= GLYPH_CODE_FACE (gc
);
7714 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7718 /* Glyphs in the display vector could have the box face, so we
7719 need to set the related flags in the iterator, as
7721 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7722 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7724 /* Is this character the first character of a box-face run? */
7725 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7727 || prev_face
->box
== FACE_NO_BOX
));
7729 /* For the last character of the box-face run, we need to look
7730 either at the next glyph from the display vector, or at the
7731 face we saw before the display vector. */
7732 next_face_id
= it
->saved_face_id
;
7733 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7735 if (it
->dpvec_face_id
>= 0)
7736 next_face_id
= it
->dpvec_face_id
;
7740 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7743 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7747 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7748 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7750 || next_face
->box
== FACE_NO_BOX
));
7751 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7754 /* Display table entry is invalid. Return a space. */
7755 it
->c
= ' ', it
->len
= 1;
7757 /* Don't change position and object of the iterator here. They are
7758 still the values of the character that had this display table
7759 entry or was translated, and that's what we want. */
7760 it
->what
= IT_CHARACTER
;
7764 /* Get the first element of string/buffer in the visual order, after
7765 being reseated to a new position in a string or a buffer. */
7767 get_visually_first_element (struct it
*it
)
7769 int string_p
= STRINGP (it
->string
) || it
->s
;
7770 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7771 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7773 if (STRINGP (it
->string
))
7775 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7776 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7780 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7781 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7784 if (it
->bidi_it
.charpos
== eob
)
7786 /* Nothing to do, but reset the FIRST_ELT flag, like
7787 bidi_paragraph_init does, because we are not going to
7789 it
->bidi_it
.first_elt
= 0;
7791 else if (it
->bidi_it
.charpos
== bob
7793 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7794 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7796 /* If we are at the beginning of a line/string, we can produce
7797 the next element right away. */
7798 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7799 bidi_move_to_visually_next (&it
->bidi_it
);
7803 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7805 /* We need to prime the bidi iterator starting at the line's or
7806 string's beginning, before we will be able to produce the
7809 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7811 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7812 IT_BYTEPOS (*it
), -1,
7813 &it
->bidi_it
.bytepos
);
7814 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7817 /* Now return to buffer/string position where we were asked
7818 to get the next display element, and produce that. */
7819 bidi_move_to_visually_next (&it
->bidi_it
);
7821 while (it
->bidi_it
.bytepos
!= orig_bytepos
7822 && it
->bidi_it
.charpos
< eob
);
7825 /* Adjust IT's position information to where we ended up. */
7826 if (STRINGP (it
->string
))
7828 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7829 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7833 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7834 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7837 if (STRINGP (it
->string
) || !it
->s
)
7839 ptrdiff_t stop
, charpos
, bytepos
;
7841 if (STRINGP (it
->string
))
7844 stop
= SCHARS (it
->string
);
7845 if (stop
> it
->end_charpos
)
7846 stop
= it
->end_charpos
;
7847 charpos
= IT_STRING_CHARPOS (*it
);
7848 bytepos
= IT_STRING_BYTEPOS (*it
);
7852 stop
= it
->end_charpos
;
7853 charpos
= IT_CHARPOS (*it
);
7854 bytepos
= IT_BYTEPOS (*it
);
7856 if (it
->bidi_it
.scan_dir
< 0)
7858 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7863 /* Load IT with the next display element from Lisp string IT->string.
7864 IT->current.string_pos is the current position within the string.
7865 If IT->current.overlay_string_index >= 0, the Lisp string is an
7869 next_element_from_string (struct it
*it
)
7871 struct text_pos position
;
7873 eassert (STRINGP (it
->string
));
7874 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7875 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7876 position
= it
->current
.string_pos
;
7878 /* With bidi reordering, the character to display might not be the
7879 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7880 that we were reseat()ed to a new string, whose paragraph
7881 direction is not known. */
7882 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7884 get_visually_first_element (it
);
7885 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7888 /* Time to check for invisible text? */
7889 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7891 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7894 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7895 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7897 /* With bidi non-linear iteration, we could find
7898 ourselves far beyond the last computed stop_charpos,
7899 with several other stop positions in between that we
7900 missed. Scan them all now, in buffer's logical
7901 order, until we find and handle the last stop_charpos
7902 that precedes our current position. */
7903 handle_stop_backwards (it
, it
->stop_charpos
);
7904 return GET_NEXT_DISPLAY_ELEMENT (it
);
7910 /* Take note of the stop position we just moved
7911 across, for when we will move back across it. */
7912 it
->prev_stop
= it
->stop_charpos
;
7913 /* If we are at base paragraph embedding level, take
7914 note of the last stop position seen at this
7916 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7917 it
->base_level_stop
= it
->stop_charpos
;
7921 /* Since a handler may have changed IT->method, we must
7923 return GET_NEXT_DISPLAY_ELEMENT (it
);
7927 /* If we are before prev_stop, we may have overstepped
7928 on our way backwards a stop_pos, and if so, we need
7929 to handle that stop_pos. */
7930 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7931 /* We can sometimes back up for reasons that have nothing
7932 to do with bidi reordering. E.g., compositions. The
7933 code below is only needed when we are above the base
7934 embedding level, so test for that explicitly. */
7935 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7937 /* If we lost track of base_level_stop, we have no better
7938 place for handle_stop_backwards to start from than string
7939 beginning. This happens, e.g., when we were reseated to
7940 the previous screenful of text by vertical-motion. */
7941 if (it
->base_level_stop
<= 0
7942 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7943 it
->base_level_stop
= 0;
7944 handle_stop_backwards (it
, it
->base_level_stop
);
7945 return GET_NEXT_DISPLAY_ELEMENT (it
);
7949 if (it
->current
.overlay_string_index
>= 0)
7951 /* Get the next character from an overlay string. In overlay
7952 strings, there is no field width or padding with spaces to
7954 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7959 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7960 IT_STRING_BYTEPOS (*it
),
7961 it
->bidi_it
.scan_dir
< 0
7963 : SCHARS (it
->string
))
7964 && next_element_from_composition (it
))
7968 else if (STRING_MULTIBYTE (it
->string
))
7970 const unsigned char *s
= (SDATA (it
->string
)
7971 + IT_STRING_BYTEPOS (*it
));
7972 it
->c
= string_char_and_length (s
, &it
->len
);
7976 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7982 /* Get the next character from a Lisp string that is not an
7983 overlay string. Such strings come from the mode line, for
7984 example. We may have to pad with spaces, or truncate the
7985 string. See also next_element_from_c_string. */
7986 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7991 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7993 /* Pad with spaces. */
7994 it
->c
= ' ', it
->len
= 1;
7995 CHARPOS (position
) = BYTEPOS (position
) = -1;
7997 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7998 IT_STRING_BYTEPOS (*it
),
7999 it
->bidi_it
.scan_dir
< 0
8001 : it
->string_nchars
)
8002 && next_element_from_composition (it
))
8006 else if (STRING_MULTIBYTE (it
->string
))
8008 const unsigned char *s
= (SDATA (it
->string
)
8009 + IT_STRING_BYTEPOS (*it
));
8010 it
->c
= string_char_and_length (s
, &it
->len
);
8014 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8019 /* Record what we have and where it came from. */
8020 it
->what
= IT_CHARACTER
;
8021 it
->object
= it
->string
;
8022 it
->position
= position
;
8027 /* Load IT with next display element from C string IT->s.
8028 IT->string_nchars is the maximum number of characters to return
8029 from the string. IT->end_charpos may be greater than
8030 IT->string_nchars when this function is called, in which case we
8031 may have to return padding spaces. Value is zero if end of string
8032 reached, including padding spaces. */
8035 next_element_from_c_string (struct it
*it
)
8037 bool success_p
= true;
8040 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8041 it
->what
= IT_CHARACTER
;
8042 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8045 /* With bidi reordering, the character to display might not be the
8046 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8047 we were reseated to a new string, whose paragraph direction is
8049 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8050 get_visually_first_element (it
);
8052 /* IT's position can be greater than IT->string_nchars in case a
8053 field width or precision has been specified when the iterator was
8055 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8057 /* End of the game. */
8061 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8063 /* Pad with spaces. */
8064 it
->c
= ' ', it
->len
= 1;
8065 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8067 else if (it
->multibyte_p
)
8068 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8070 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8076 /* Set up IT to return characters from an ellipsis, if appropriate.
8077 The definition of the ellipsis glyphs may come from a display table
8078 entry. This function fills IT with the first glyph from the
8079 ellipsis if an ellipsis is to be displayed. */
8082 next_element_from_ellipsis (struct it
*it
)
8084 if (it
->selective_display_ellipsis_p
)
8085 setup_for_ellipsis (it
, it
->len
);
8088 /* The face at the current position may be different from the
8089 face we find after the invisible text. Remember what it
8090 was in IT->saved_face_id, and signal that it's there by
8091 setting face_before_selective_p. */
8092 it
->saved_face_id
= it
->face_id
;
8093 it
->method
= GET_FROM_BUFFER
;
8094 it
->object
= it
->w
->contents
;
8095 reseat_at_next_visible_line_start (it
, 1);
8096 it
->face_before_selective_p
= true;
8099 return GET_NEXT_DISPLAY_ELEMENT (it
);
8103 /* Deliver an image display element. The iterator IT is already
8104 filled with image information (done in handle_display_prop). Value
8109 next_element_from_image (struct it
*it
)
8111 it
->what
= IT_IMAGE
;
8112 it
->ignore_overlay_strings_at_pos_p
= 0;
8117 /* Fill iterator IT with next display element from a stretch glyph
8118 property. IT->object is the value of the text property. Value is
8122 next_element_from_stretch (struct it
*it
)
8124 it
->what
= IT_STRETCH
;
8128 /* Scan backwards from IT's current position until we find a stop
8129 position, or until BEGV. This is called when we find ourself
8130 before both the last known prev_stop and base_level_stop while
8131 reordering bidirectional text. */
8134 compute_stop_pos_backwards (struct it
*it
)
8136 const int SCAN_BACK_LIMIT
= 1000;
8137 struct text_pos pos
;
8138 struct display_pos save_current
= it
->current
;
8139 struct text_pos save_position
= it
->position
;
8140 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8141 ptrdiff_t where_we_are
= charpos
;
8142 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8143 ptrdiff_t save_end_pos
= it
->end_charpos
;
8145 eassert (NILP (it
->string
) && !it
->s
);
8146 eassert (it
->bidi_p
);
8150 it
->end_charpos
= min (charpos
+ 1, ZV
);
8151 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8152 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8153 reseat_1 (it
, pos
, 0);
8154 compute_stop_pos (it
);
8155 /* We must advance forward, right? */
8156 if (it
->stop_charpos
<= charpos
)
8159 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8161 if (it
->stop_charpos
<= where_we_are
)
8162 it
->prev_stop
= it
->stop_charpos
;
8164 it
->prev_stop
= BEGV
;
8166 it
->current
= save_current
;
8167 it
->position
= save_position
;
8168 it
->stop_charpos
= save_stop_pos
;
8169 it
->end_charpos
= save_end_pos
;
8172 /* Scan forward from CHARPOS in the current buffer/string, until we
8173 find a stop position > current IT's position. Then handle the stop
8174 position before that. This is called when we bump into a stop
8175 position while reordering bidirectional text. CHARPOS should be
8176 the last previously processed stop_pos (or BEGV/0, if none were
8177 processed yet) whose position is less that IT's current
8181 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8183 int bufp
= !STRINGP (it
->string
);
8184 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8185 struct display_pos save_current
= it
->current
;
8186 struct text_pos save_position
= it
->position
;
8187 struct text_pos pos1
;
8188 ptrdiff_t next_stop
;
8190 /* Scan in strict logical order. */
8191 eassert (it
->bidi_p
);
8195 it
->prev_stop
= charpos
;
8198 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8199 reseat_1 (it
, pos1
, 0);
8202 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8203 compute_stop_pos (it
);
8204 /* We must advance forward, right? */
8205 if (it
->stop_charpos
<= it
->prev_stop
)
8207 charpos
= it
->stop_charpos
;
8209 while (charpos
<= where_we_are
);
8212 it
->current
= save_current
;
8213 it
->position
= save_position
;
8214 next_stop
= it
->stop_charpos
;
8215 it
->stop_charpos
= it
->prev_stop
;
8217 it
->stop_charpos
= next_stop
;
8220 /* Load IT with the next display element from current_buffer. Value
8221 is zero if end of buffer reached. IT->stop_charpos is the next
8222 position at which to stop and check for text properties or buffer
8226 next_element_from_buffer (struct it
*it
)
8228 bool success_p
= true;
8230 eassert (IT_CHARPOS (*it
) >= BEGV
);
8231 eassert (NILP (it
->string
) && !it
->s
);
8232 eassert (!it
->bidi_p
8233 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8234 && it
->bidi_it
.string
.s
== NULL
));
8236 /* With bidi reordering, the character to display might not be the
8237 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8238 we were reseat()ed to a new buffer position, which is potentially
8239 a different paragraph. */
8240 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8242 get_visually_first_element (it
);
8243 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8246 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8248 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8250 int overlay_strings_follow_p
;
8252 /* End of the game, except when overlay strings follow that
8253 haven't been returned yet. */
8254 if (it
->overlay_strings_at_end_processed_p
)
8255 overlay_strings_follow_p
= 0;
8258 it
->overlay_strings_at_end_processed_p
= true;
8259 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8262 if (overlay_strings_follow_p
)
8263 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8267 it
->position
= it
->current
.pos
;
8271 else if (!(!it
->bidi_p
8272 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8273 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8275 /* With bidi non-linear iteration, we could find ourselves
8276 far beyond the last computed stop_charpos, with several
8277 other stop positions in between that we missed. Scan
8278 them all now, in buffer's logical order, until we find
8279 and handle the last stop_charpos that precedes our
8280 current position. */
8281 handle_stop_backwards (it
, it
->stop_charpos
);
8282 return GET_NEXT_DISPLAY_ELEMENT (it
);
8288 /* Take note of the stop position we just moved across,
8289 for when we will move back across it. */
8290 it
->prev_stop
= it
->stop_charpos
;
8291 /* If we are at base paragraph embedding level, take
8292 note of the last stop position seen at this
8294 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8295 it
->base_level_stop
= it
->stop_charpos
;
8298 return GET_NEXT_DISPLAY_ELEMENT (it
);
8302 /* If we are before prev_stop, we may have overstepped on
8303 our way backwards a stop_pos, and if so, we need to
8304 handle that stop_pos. */
8305 && IT_CHARPOS (*it
) < it
->prev_stop
8306 /* We can sometimes back up for reasons that have nothing
8307 to do with bidi reordering. E.g., compositions. The
8308 code below is only needed when we are above the base
8309 embedding level, so test for that explicitly. */
8310 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8312 if (it
->base_level_stop
<= 0
8313 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8315 /* If we lost track of base_level_stop, we need to find
8316 prev_stop by looking backwards. This happens, e.g., when
8317 we were reseated to the previous screenful of text by
8319 it
->base_level_stop
= BEGV
;
8320 compute_stop_pos_backwards (it
);
8321 handle_stop_backwards (it
, it
->prev_stop
);
8324 handle_stop_backwards (it
, it
->base_level_stop
);
8325 return GET_NEXT_DISPLAY_ELEMENT (it
);
8329 /* No face changes, overlays etc. in sight, so just return a
8330 character from current_buffer. */
8334 /* Maybe run the redisplay end trigger hook. Performance note:
8335 This doesn't seem to cost measurable time. */
8336 if (it
->redisplay_end_trigger_charpos
8338 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8339 run_redisplay_end_trigger_hook (it
);
8341 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8342 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8344 && next_element_from_composition (it
))
8349 /* Get the next character, maybe multibyte. */
8350 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8351 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8352 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8354 it
->c
= *p
, it
->len
= 1;
8356 /* Record what we have and where it came from. */
8357 it
->what
= IT_CHARACTER
;
8358 it
->object
= it
->w
->contents
;
8359 it
->position
= it
->current
.pos
;
8361 /* Normally we return the character found above, except when we
8362 really want to return an ellipsis for selective display. */
8367 /* A value of selective > 0 means hide lines indented more
8368 than that number of columns. */
8369 if (it
->selective
> 0
8370 && IT_CHARPOS (*it
) + 1 < ZV
8371 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8372 IT_BYTEPOS (*it
) + 1,
8375 success_p
= next_element_from_ellipsis (it
);
8376 it
->dpvec_char_len
= -1;
8379 else if (it
->c
== '\r' && it
->selective
== -1)
8381 /* A value of selective == -1 means that everything from the
8382 CR to the end of the line is invisible, with maybe an
8383 ellipsis displayed for it. */
8384 success_p
= next_element_from_ellipsis (it
);
8385 it
->dpvec_char_len
= -1;
8390 /* Value is zero if end of buffer reached. */
8391 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8396 /* Run the redisplay end trigger hook for IT. */
8399 run_redisplay_end_trigger_hook (struct it
*it
)
8401 Lisp_Object args
[3];
8403 /* IT->glyph_row should be non-null, i.e. we should be actually
8404 displaying something, or otherwise we should not run the hook. */
8405 eassert (it
->glyph_row
);
8407 /* Set up hook arguments. */
8408 args
[0] = Qredisplay_end_trigger_functions
;
8409 args
[1] = it
->window
;
8410 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8411 it
->redisplay_end_trigger_charpos
= 0;
8413 /* Since we are *trying* to run these functions, don't try to run
8414 them again, even if they get an error. */
8415 wset_redisplay_end_trigger (it
->w
, Qnil
);
8416 Frun_hook_with_args (3, args
);
8418 /* Notice if it changed the face of the character we are on. */
8419 handle_face_prop (it
);
8423 /* Deliver a composition display element. Unlike the other
8424 next_element_from_XXX, this function is not registered in the array
8425 get_next_element[]. It is called from next_element_from_buffer and
8426 next_element_from_string when necessary. */
8429 next_element_from_composition (struct it
*it
)
8431 it
->what
= IT_COMPOSITION
;
8432 it
->len
= it
->cmp_it
.nbytes
;
8433 if (STRINGP (it
->string
))
8437 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8438 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8441 it
->position
= it
->current
.string_pos
;
8442 it
->object
= it
->string
;
8443 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8444 IT_STRING_BYTEPOS (*it
), it
->string
);
8450 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8451 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8454 if (it
->bidi_it
.new_paragraph
)
8455 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8456 /* Resync the bidi iterator with IT's new position.
8457 FIXME: this doesn't support bidirectional text. */
8458 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8459 bidi_move_to_visually_next (&it
->bidi_it
);
8463 it
->position
= it
->current
.pos
;
8464 it
->object
= it
->w
->contents
;
8465 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8466 IT_BYTEPOS (*it
), Qnil
);
8473 /***********************************************************************
8474 Moving an iterator without producing glyphs
8475 ***********************************************************************/
8477 /* Check if iterator is at a position corresponding to a valid buffer
8478 position after some move_it_ call. */
8480 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8481 ((it)->method == GET_FROM_STRING \
8482 ? IT_STRING_CHARPOS (*it) == 0 \
8486 /* Move iterator IT to a specified buffer or X position within one
8487 line on the display without producing glyphs.
8489 OP should be a bit mask including some or all of these bits:
8490 MOVE_TO_X: Stop upon reaching x-position TO_X.
8491 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8492 Regardless of OP's value, stop upon reaching the end of the display line.
8494 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8495 This means, in particular, that TO_X includes window's horizontal
8498 The return value has several possible values that
8499 say what condition caused the scan to stop:
8501 MOVE_POS_MATCH_OR_ZV
8502 - when TO_POS or ZV was reached.
8505 -when TO_X was reached before TO_POS or ZV were reached.
8508 - when we reached the end of the display area and the line must
8512 - when we reached the end of the display area and the line is
8516 - when we stopped at a line end, i.e. a newline or a CR and selective
8519 static enum move_it_result
8520 move_it_in_display_line_to (struct it
*it
,
8521 ptrdiff_t to_charpos
, int to_x
,
8522 enum move_operation_enum op
)
8524 enum move_it_result result
= MOVE_UNDEFINED
;
8525 struct glyph_row
*saved_glyph_row
;
8526 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8527 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8528 void *ppos_data
= NULL
;
8530 enum it_method prev_method
= it
->method
;
8531 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8532 int saw_smaller_pos
= prev_pos
< to_charpos
;
8534 /* Don't produce glyphs in produce_glyphs. */
8535 saved_glyph_row
= it
->glyph_row
;
8536 it
->glyph_row
= NULL
;
8538 /* Use wrap_it to save a copy of IT wherever a word wrap could
8539 occur. Use atpos_it to save a copy of IT at the desired buffer
8540 position, if found, so that we can scan ahead and check if the
8541 word later overshoots the window edge. Use atx_it similarly, for
8547 /* Use ppos_it under bidi reordering to save a copy of IT for the
8548 initial position. We restore that position in IT when we have
8549 scanned the entire display line without finding a match for
8550 TO_CHARPOS and all the character positions are greater than
8551 TO_CHARPOS. We then restart the scan from the initial position,
8552 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8553 the closest to TO_CHARPOS. */
8556 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8558 SAVE_IT (ppos_it
, *it
, ppos_data
);
8559 closest_pos
= IT_CHARPOS (*it
);
8565 #define BUFFER_POS_REACHED_P() \
8566 ((op & MOVE_TO_POS) != 0 \
8567 && BUFFERP (it->object) \
8568 && (IT_CHARPOS (*it) == to_charpos \
8570 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8571 && IT_CHARPOS (*it) > to_charpos) \
8572 || (it->what == IT_COMPOSITION \
8573 && ((IT_CHARPOS (*it) > to_charpos \
8574 && to_charpos >= it->cmp_it.charpos) \
8575 || (IT_CHARPOS (*it) < to_charpos \
8576 && to_charpos <= it->cmp_it.charpos)))) \
8577 && (it->method == GET_FROM_BUFFER \
8578 || (it->method == GET_FROM_DISPLAY_VECTOR \
8579 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8581 /* If there's a line-/wrap-prefix, handle it. */
8582 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8583 && it
->current_y
< it
->last_visible_y
)
8584 handle_line_prefix (it
);
8586 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8587 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8591 int x
, i
, ascent
= 0, descent
= 0;
8593 /* Utility macro to reset an iterator with x, ascent, and descent. */
8594 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8595 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8596 (IT)->max_descent = descent)
8598 /* Stop if we move beyond TO_CHARPOS (after an image or a
8599 display string or stretch glyph). */
8600 if ((op
& MOVE_TO_POS
) != 0
8601 && BUFFERP (it
->object
)
8602 && it
->method
== GET_FROM_BUFFER
8604 /* When the iterator is at base embedding level, we
8605 are guaranteed that characters are delivered for
8606 display in strictly increasing order of their
8607 buffer positions. */
8608 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8609 && IT_CHARPOS (*it
) > to_charpos
)
8611 && (prev_method
== GET_FROM_IMAGE
8612 || prev_method
== GET_FROM_STRETCH
8613 || prev_method
== GET_FROM_STRING
)
8614 /* Passed TO_CHARPOS from left to right. */
8615 && ((prev_pos
< to_charpos
8616 && IT_CHARPOS (*it
) > to_charpos
)
8617 /* Passed TO_CHARPOS from right to left. */
8618 || (prev_pos
> to_charpos
8619 && IT_CHARPOS (*it
) < to_charpos
)))))
8621 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8623 result
= MOVE_POS_MATCH_OR_ZV
;
8626 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8627 /* If wrap_it is valid, the current position might be in a
8628 word that is wrapped. So, save the iterator in
8629 atpos_it and continue to see if wrapping happens. */
8630 SAVE_IT (atpos_it
, *it
, atpos_data
);
8633 /* Stop when ZV reached.
8634 We used to stop here when TO_CHARPOS reached as well, but that is
8635 too soon if this glyph does not fit on this line. So we handle it
8636 explicitly below. */
8637 if (!get_next_display_element (it
))
8639 result
= MOVE_POS_MATCH_OR_ZV
;
8643 if (it
->line_wrap
== TRUNCATE
)
8645 if (BUFFER_POS_REACHED_P ())
8647 result
= MOVE_POS_MATCH_OR_ZV
;
8653 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8655 if (IT_DISPLAYING_WHITESPACE (it
))
8659 /* We have reached a glyph that follows one or more
8660 whitespace characters. If the position is
8661 already found, we are done. */
8662 if (atpos_it
.sp
>= 0)
8664 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8665 result
= MOVE_POS_MATCH_OR_ZV
;
8670 RESTORE_IT (it
, &atx_it
, atx_data
);
8671 result
= MOVE_X_REACHED
;
8674 /* Otherwise, we can wrap here. */
8675 SAVE_IT (wrap_it
, *it
, wrap_data
);
8681 /* Remember the line height for the current line, in case
8682 the next element doesn't fit on the line. */
8683 ascent
= it
->max_ascent
;
8684 descent
= it
->max_descent
;
8686 /* The call to produce_glyphs will get the metrics of the
8687 display element IT is loaded with. Record the x-position
8688 before this display element, in case it doesn't fit on the
8692 PRODUCE_GLYPHS (it
);
8694 if (it
->area
!= TEXT_AREA
)
8696 prev_method
= it
->method
;
8697 if (it
->method
== GET_FROM_BUFFER
)
8698 prev_pos
= IT_CHARPOS (*it
);
8699 set_iterator_to_next (it
, 1);
8700 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8701 SET_TEXT_POS (this_line_min_pos
,
8702 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8704 && (op
& MOVE_TO_POS
)
8705 && IT_CHARPOS (*it
) > to_charpos
8706 && IT_CHARPOS (*it
) < closest_pos
)
8707 closest_pos
= IT_CHARPOS (*it
);
8711 /* The number of glyphs we get back in IT->nglyphs will normally
8712 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8713 character on a terminal frame, or (iii) a line end. For the
8714 second case, IT->nglyphs - 1 padding glyphs will be present.
8715 (On X frames, there is only one glyph produced for a
8716 composite character.)
8718 The behavior implemented below means, for continuation lines,
8719 that as many spaces of a TAB as fit on the current line are
8720 displayed there. For terminal frames, as many glyphs of a
8721 multi-glyph character are displayed in the current line, too.
8722 This is what the old redisplay code did, and we keep it that
8723 way. Under X, the whole shape of a complex character must
8724 fit on the line or it will be completely displayed in the
8727 Note that both for tabs and padding glyphs, all glyphs have
8731 /* More than one glyph or glyph doesn't fit on line. All
8732 glyphs have the same width. */
8733 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8735 int x_before_this_char
= x
;
8736 int hpos_before_this_char
= it
->hpos
;
8738 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8740 new_x
= x
+ single_glyph_width
;
8742 /* We want to leave anything reaching TO_X to the caller. */
8743 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8745 if (BUFFER_POS_REACHED_P ())
8747 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8748 goto buffer_pos_reached
;
8749 if (atpos_it
.sp
< 0)
8751 SAVE_IT (atpos_it
, *it
, atpos_data
);
8752 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8757 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8760 result
= MOVE_X_REACHED
;
8765 SAVE_IT (atx_it
, *it
, atx_data
);
8766 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8771 if (/* Lines are continued. */
8772 it
->line_wrap
!= TRUNCATE
8773 && (/* And glyph doesn't fit on the line. */
8774 new_x
> it
->last_visible_x
8775 /* Or it fits exactly and we're on a window
8777 || (new_x
== it
->last_visible_x
8778 && FRAME_WINDOW_P (it
->f
)
8779 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8780 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8781 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8783 if (/* IT->hpos == 0 means the very first glyph
8784 doesn't fit on the line, e.g. a wide image. */
8786 || (new_x
== it
->last_visible_x
8787 && FRAME_WINDOW_P (it
->f
)
8788 /* When word-wrap is ON and we have a valid
8789 wrap point, we don't allow the last glyph
8790 to "just barely fit" on the line. */
8791 && (it
->line_wrap
!= WORD_WRAP
8792 || wrap_it
.sp
< 0)))
8795 it
->current_x
= new_x
;
8797 /* The character's last glyph just barely fits
8799 if (i
== it
->nglyphs
- 1)
8801 /* If this is the destination position,
8802 return a position *before* it in this row,
8803 now that we know it fits in this row. */
8804 if (BUFFER_POS_REACHED_P ())
8806 if (it
->line_wrap
!= WORD_WRAP
8809 it
->hpos
= hpos_before_this_char
;
8810 it
->current_x
= x_before_this_char
;
8811 result
= MOVE_POS_MATCH_OR_ZV
;
8814 if (it
->line_wrap
== WORD_WRAP
8817 SAVE_IT (atpos_it
, *it
, atpos_data
);
8818 atpos_it
.current_x
= x_before_this_char
;
8819 atpos_it
.hpos
= hpos_before_this_char
;
8823 prev_method
= it
->method
;
8824 if (it
->method
== GET_FROM_BUFFER
)
8825 prev_pos
= IT_CHARPOS (*it
);
8826 set_iterator_to_next (it
, 1);
8827 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8828 SET_TEXT_POS (this_line_min_pos
,
8829 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8830 /* On graphical terminals, newlines may
8831 "overflow" into the fringe if
8832 overflow-newline-into-fringe is non-nil.
8833 On text terminals, and on graphical
8834 terminals with no right margin, newlines
8835 may overflow into the last glyph on the
8837 if (!FRAME_WINDOW_P (it
->f
)
8839 && it
->bidi_it
.paragraph_dir
== R2L
)
8840 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8841 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8842 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8844 if (!get_next_display_element (it
))
8846 result
= MOVE_POS_MATCH_OR_ZV
;
8849 if (BUFFER_POS_REACHED_P ())
8851 if (ITERATOR_AT_END_OF_LINE_P (it
))
8852 result
= MOVE_POS_MATCH_OR_ZV
;
8854 result
= MOVE_LINE_CONTINUED
;
8857 if (ITERATOR_AT_END_OF_LINE_P (it
)
8858 && (it
->line_wrap
!= WORD_WRAP
8861 result
= MOVE_NEWLINE_OR_CR
;
8868 IT_RESET_X_ASCENT_DESCENT (it
);
8870 if (wrap_it
.sp
>= 0)
8872 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8877 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8879 result
= MOVE_LINE_CONTINUED
;
8883 if (BUFFER_POS_REACHED_P ())
8885 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8886 goto buffer_pos_reached
;
8887 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8889 SAVE_IT (atpos_it
, *it
, atpos_data
);
8890 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8894 if (new_x
> it
->first_visible_x
)
8896 /* Glyph is visible. Increment number of glyphs that
8897 would be displayed. */
8902 if (result
!= MOVE_UNDEFINED
)
8905 else if (BUFFER_POS_REACHED_P ())
8908 IT_RESET_X_ASCENT_DESCENT (it
);
8909 result
= MOVE_POS_MATCH_OR_ZV
;
8912 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8914 /* Stop when TO_X specified and reached. This check is
8915 necessary here because of lines consisting of a line end,
8916 only. The line end will not produce any glyphs and we
8917 would never get MOVE_X_REACHED. */
8918 eassert (it
->nglyphs
== 0);
8919 result
= MOVE_X_REACHED
;
8923 /* Is this a line end? If yes, we're done. */
8924 if (ITERATOR_AT_END_OF_LINE_P (it
))
8926 /* If we are past TO_CHARPOS, but never saw any character
8927 positions smaller than TO_CHARPOS, return
8928 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8930 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8932 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8934 if (closest_pos
< ZV
)
8936 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8937 /* Don't recurse if closest_pos is equal to
8938 to_charpos, since we have just tried that. */
8939 if (closest_pos
!= to_charpos
)
8940 move_it_in_display_line_to (it
, closest_pos
, -1,
8942 result
= MOVE_POS_MATCH_OR_ZV
;
8945 goto buffer_pos_reached
;
8947 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8948 && IT_CHARPOS (*it
) > to_charpos
)
8949 goto buffer_pos_reached
;
8951 result
= MOVE_NEWLINE_OR_CR
;
8954 result
= MOVE_NEWLINE_OR_CR
;
8958 prev_method
= it
->method
;
8959 if (it
->method
== GET_FROM_BUFFER
)
8960 prev_pos
= IT_CHARPOS (*it
);
8961 /* The current display element has been consumed. Advance
8963 set_iterator_to_next (it
, 1);
8964 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8965 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8966 if (IT_CHARPOS (*it
) < to_charpos
)
8967 saw_smaller_pos
= 1;
8969 && (op
& MOVE_TO_POS
)
8970 && IT_CHARPOS (*it
) >= to_charpos
8971 && IT_CHARPOS (*it
) < closest_pos
)
8972 closest_pos
= IT_CHARPOS (*it
);
8974 /* Stop if lines are truncated and IT's current x-position is
8975 past the right edge of the window now. */
8976 if (it
->line_wrap
== TRUNCATE
8977 && it
->current_x
>= it
->last_visible_x
)
8979 if (!FRAME_WINDOW_P (it
->f
)
8980 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8981 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8982 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8983 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8987 if ((at_eob_p
= !get_next_display_element (it
))
8988 || BUFFER_POS_REACHED_P ()
8989 /* If we are past TO_CHARPOS, but never saw any
8990 character positions smaller than TO_CHARPOS,
8991 return MOVE_POS_MATCH_OR_ZV, like the
8992 unidirectional display did. */
8993 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8995 && IT_CHARPOS (*it
) > to_charpos
))
8998 && !BUFFER_POS_REACHED_P ()
8999 && !at_eob_p
&& closest_pos
< ZV
)
9001 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9002 if (closest_pos
!= to_charpos
)
9003 move_it_in_display_line_to (it
, closest_pos
, -1,
9006 result
= MOVE_POS_MATCH_OR_ZV
;
9009 if (ITERATOR_AT_END_OF_LINE_P (it
))
9011 result
= MOVE_NEWLINE_OR_CR
;
9015 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9017 && IT_CHARPOS (*it
) > to_charpos
)
9019 if (closest_pos
< ZV
)
9021 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9022 if (closest_pos
!= to_charpos
)
9023 move_it_in_display_line_to (it
, closest_pos
, -1,
9026 result
= MOVE_POS_MATCH_OR_ZV
;
9029 result
= MOVE_LINE_TRUNCATED
;
9032 #undef IT_RESET_X_ASCENT_DESCENT
9035 #undef BUFFER_POS_REACHED_P
9037 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9038 restore the saved iterator. */
9039 if (atpos_it
.sp
>= 0)
9040 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9041 else if (atx_it
.sp
>= 0)
9042 RESTORE_IT (it
, &atx_it
, atx_data
);
9047 bidi_unshelve_cache (atpos_data
, 1);
9049 bidi_unshelve_cache (atx_data
, 1);
9051 bidi_unshelve_cache (wrap_data
, 1);
9053 bidi_unshelve_cache (ppos_data
, 1);
9055 /* Restore the iterator settings altered at the beginning of this
9057 it
->glyph_row
= saved_glyph_row
;
9061 /* For external use. */
9063 move_it_in_display_line (struct it
*it
,
9064 ptrdiff_t to_charpos
, int to_x
,
9065 enum move_operation_enum op
)
9067 if (it
->line_wrap
== WORD_WRAP
9068 && (op
& MOVE_TO_X
))
9071 void *save_data
= NULL
;
9074 SAVE_IT (save_it
, *it
, save_data
);
9075 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9076 /* When word-wrap is on, TO_X may lie past the end
9077 of a wrapped line. Then it->current is the
9078 character on the next line, so backtrack to the
9079 space before the wrap point. */
9080 if (skip
== MOVE_LINE_CONTINUED
)
9082 int prev_x
= max (it
->current_x
- 1, 0);
9083 RESTORE_IT (it
, &save_it
, save_data
);
9084 move_it_in_display_line_to
9085 (it
, -1, prev_x
, MOVE_TO_X
);
9088 bidi_unshelve_cache (save_data
, 1);
9091 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9095 /* Move IT forward until it satisfies one or more of the criteria in
9096 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9098 OP is a bit-mask that specifies where to stop, and in particular,
9099 which of those four position arguments makes a difference. See the
9100 description of enum move_operation_enum.
9102 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9103 screen line, this function will set IT to the next position that is
9104 displayed to the right of TO_CHARPOS on the screen.
9106 Return the maximum pixel length of any line scanned but never more
9107 than it.last_visible_x. */
9110 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9112 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9113 int line_height
, line_start_x
= 0, reached
= 0;
9114 int max_current_x
= 0;
9115 void *backup_data
= NULL
;
9119 if (op
& MOVE_TO_VPOS
)
9121 /* If no TO_CHARPOS and no TO_X specified, stop at the
9122 start of the line TO_VPOS. */
9123 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9125 if (it
->vpos
== to_vpos
)
9131 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9135 /* TO_VPOS >= 0 means stop at TO_X in the line at
9136 TO_VPOS, or at TO_POS, whichever comes first. */
9137 if (it
->vpos
== to_vpos
)
9143 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9145 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9150 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9152 /* We have reached TO_X but not in the line we want. */
9153 skip
= move_it_in_display_line_to (it
, to_charpos
,
9155 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9163 else if (op
& MOVE_TO_Y
)
9165 struct it it_backup
;
9167 if (it
->line_wrap
== WORD_WRAP
)
9168 SAVE_IT (it_backup
, *it
, backup_data
);
9170 /* TO_Y specified means stop at TO_X in the line containing
9171 TO_Y---or at TO_CHARPOS if this is reached first. The
9172 problem is that we can't really tell whether the line
9173 contains TO_Y before we have completely scanned it, and
9174 this may skip past TO_X. What we do is to first scan to
9177 If TO_X is not specified, use a TO_X of zero. The reason
9178 is to make the outcome of this function more predictable.
9179 If we didn't use TO_X == 0, we would stop at the end of
9180 the line which is probably not what a caller would expect
9182 skip
= move_it_in_display_line_to
9183 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9184 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9186 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9187 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9189 else if (skip
== MOVE_X_REACHED
)
9191 /* If TO_X was reached, we want to know whether TO_Y is
9192 in the line. We know this is the case if the already
9193 scanned glyphs make the line tall enough. Otherwise,
9194 we must check by scanning the rest of the line. */
9195 line_height
= it
->max_ascent
+ it
->max_descent
;
9196 if (to_y
>= it
->current_y
9197 && to_y
< it
->current_y
+ line_height
)
9202 SAVE_IT (it_backup
, *it
, backup_data
);
9203 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9204 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9206 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9207 line_height
= it
->max_ascent
+ it
->max_descent
;
9208 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9210 if (to_y
>= it
->current_y
9211 && to_y
< it
->current_y
+ line_height
)
9213 /* If TO_Y is in this line and TO_X was reached
9214 above, we scanned too far. We have to restore
9215 IT's settings to the ones before skipping. But
9216 keep the more accurate values of max_ascent and
9217 max_descent we've found while skipping the rest
9218 of the line, for the sake of callers, such as
9219 pos_visible_p, that need to know the line
9221 int max_ascent
= it
->max_ascent
;
9222 int max_descent
= it
->max_descent
;
9224 RESTORE_IT (it
, &it_backup
, backup_data
);
9225 it
->max_ascent
= max_ascent
;
9226 it
->max_descent
= max_descent
;
9232 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9238 /* Check whether TO_Y is in this line. */
9239 line_height
= it
->max_ascent
+ it
->max_descent
;
9240 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9242 if (to_y
>= it
->current_y
9243 && to_y
< it
->current_y
+ line_height
)
9245 if (to_y
> it
->current_y
)
9246 max_current_x
= max (it
->current_x
, max_current_x
);
9248 /* When word-wrap is on, TO_X may lie past the end
9249 of a wrapped line. Then it->current is the
9250 character on the next line, so backtrack to the
9251 space before the wrap point. */
9252 if (skip
== MOVE_LINE_CONTINUED
9253 && it
->line_wrap
== WORD_WRAP
)
9255 int prev_x
= max (it
->current_x
- 1, 0);
9256 RESTORE_IT (it
, &it_backup
, backup_data
);
9257 skip
= move_it_in_display_line_to
9258 (it
, -1, prev_x
, MOVE_TO_X
);
9267 max_current_x
= max (it
->current_x
, max_current_x
);
9271 else if (BUFFERP (it
->object
)
9272 && (it
->method
== GET_FROM_BUFFER
9273 || it
->method
== GET_FROM_STRETCH
)
9274 && IT_CHARPOS (*it
) >= to_charpos
9275 /* Under bidi iteration, a call to set_iterator_to_next
9276 can scan far beyond to_charpos if the initial
9277 portion of the next line needs to be reordered. In
9278 that case, give move_it_in_display_line_to another
9281 && it
->bidi_it
.scan_dir
== -1))
9282 skip
= MOVE_POS_MATCH_OR_ZV
;
9284 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9288 case MOVE_POS_MATCH_OR_ZV
:
9289 max_current_x
= max (it
->current_x
, max_current_x
);
9293 case MOVE_NEWLINE_OR_CR
:
9294 max_current_x
= max (it
->current_x
, max_current_x
);
9295 set_iterator_to_next (it
, 1);
9296 it
->continuation_lines_width
= 0;
9299 case MOVE_LINE_TRUNCATED
:
9300 max_current_x
= it
->last_visible_x
;
9301 it
->continuation_lines_width
= 0;
9302 reseat_at_next_visible_line_start (it
, 0);
9303 if ((op
& MOVE_TO_POS
) != 0
9304 && IT_CHARPOS (*it
) > to_charpos
)
9311 case MOVE_LINE_CONTINUED
:
9312 max_current_x
= it
->last_visible_x
;
9313 /* For continued lines ending in a tab, some of the glyphs
9314 associated with the tab are displayed on the current
9315 line. Since it->current_x does not include these glyphs,
9316 we use it->last_visible_x instead. */
9319 it
->continuation_lines_width
+= it
->last_visible_x
;
9320 /* When moving by vpos, ensure that the iterator really
9321 advances to the next line (bug#847, bug#969). Fixme:
9322 do we need to do this in other circumstances? */
9323 if (it
->current_x
!= it
->last_visible_x
9324 && (op
& MOVE_TO_VPOS
)
9325 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9327 line_start_x
= it
->current_x
+ it
->pixel_width
9328 - it
->last_visible_x
;
9329 if (FRAME_WINDOW_P (it
->f
))
9331 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9332 struct font
*face_font
= face
->font
;
9334 /* When display_line produces a continued line
9335 that ends in a TAB, it skips a tab stop that
9336 is closer than the font's space character
9337 width (see x_produce_glyphs where it produces
9338 the stretch glyph which represents a TAB).
9339 We need to reproduce the same logic here. */
9340 eassert (face_font
);
9343 if (line_start_x
< face_font
->space_width
)
9345 += it
->tab_width
* face_font
->space_width
;
9348 set_iterator_to_next (it
, 0);
9352 it
->continuation_lines_width
+= it
->current_x
;
9359 /* Reset/increment for the next run. */
9360 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9361 it
->current_x
= line_start_x
;
9364 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9366 last_height
= it
->max_ascent
+ it
->max_descent
;
9367 it
->max_ascent
= it
->max_descent
= 0;
9372 /* On text terminals, we may stop at the end of a line in the middle
9373 of a multi-character glyph. If the glyph itself is continued,
9374 i.e. it is actually displayed on the next line, don't treat this
9375 stopping point as valid; move to the next line instead (unless
9376 that brings us offscreen). */
9377 if (!FRAME_WINDOW_P (it
->f
)
9379 && IT_CHARPOS (*it
) == to_charpos
9380 && it
->what
== IT_CHARACTER
9382 && it
->line_wrap
== WINDOW_WRAP
9383 && it
->current_x
== it
->last_visible_x
- 1
9386 && it
->vpos
< it
->w
->window_end_vpos
)
9388 it
->continuation_lines_width
+= it
->current_x
;
9389 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9390 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9392 last_height
= it
->max_ascent
+ it
->max_descent
;
9396 bidi_unshelve_cache (backup_data
, 1);
9398 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9400 return max_current_x
;
9404 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9406 If DY > 0, move IT backward at least that many pixels. DY = 0
9407 means move IT backward to the preceding line start or BEGV. This
9408 function may move over more than DY pixels if IT->current_y - DY
9409 ends up in the middle of a line; in this case IT->current_y will be
9410 set to the top of the line moved to. */
9413 move_it_vertically_backward (struct it
*it
, int dy
)
9417 void *it2data
= NULL
, *it3data
= NULL
;
9418 ptrdiff_t start_pos
;
9420 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9421 ptrdiff_t pos_limit
;
9426 start_pos
= IT_CHARPOS (*it
);
9428 /* Estimate how many newlines we must move back. */
9429 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9430 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9433 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9435 /* Set the iterator's position that many lines back. But don't go
9436 back more than NLINES full screen lines -- this wins a day with
9437 buffers which have very long lines. */
9438 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9439 back_to_previous_visible_line_start (it
);
9441 /* Reseat the iterator here. When moving backward, we don't want
9442 reseat to skip forward over invisible text, set up the iterator
9443 to deliver from overlay strings at the new position etc. So,
9444 use reseat_1 here. */
9445 reseat_1 (it
, it
->current
.pos
, 1);
9447 /* We are now surely at a line start. */
9448 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9449 reordering is in effect. */
9450 it
->continuation_lines_width
= 0;
9452 /* Move forward and see what y-distance we moved. First move to the
9453 start of the next line so that we get its height. We need this
9454 height to be able to tell whether we reached the specified
9456 SAVE_IT (it2
, *it
, it2data
);
9457 it2
.max_ascent
= it2
.max_descent
= 0;
9460 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9461 MOVE_TO_POS
| MOVE_TO_VPOS
);
9463 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9464 /* If we are in a display string which starts at START_POS,
9465 and that display string includes a newline, and we are
9466 right after that newline (i.e. at the beginning of a
9467 display line), exit the loop, because otherwise we will
9468 infloop, since move_it_to will see that it is already at
9469 START_POS and will not move. */
9470 || (it2
.method
== GET_FROM_STRING
9471 && IT_CHARPOS (it2
) == start_pos
9472 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9473 eassert (IT_CHARPOS (*it
) >= BEGV
);
9474 SAVE_IT (it3
, it2
, it3data
);
9476 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9477 eassert (IT_CHARPOS (*it
) >= BEGV
);
9478 /* H is the actual vertical distance from the position in *IT
9479 and the starting position. */
9480 h
= it2
.current_y
- it
->current_y
;
9481 /* NLINES is the distance in number of lines. */
9482 nlines
= it2
.vpos
- it
->vpos
;
9484 /* Correct IT's y and vpos position
9485 so that they are relative to the starting point. */
9491 /* DY == 0 means move to the start of the screen line. The
9492 value of nlines is > 0 if continuation lines were involved,
9493 or if the original IT position was at start of a line. */
9494 RESTORE_IT (it
, it
, it2data
);
9496 move_it_by_lines (it
, nlines
);
9497 /* The above code moves us to some position NLINES down,
9498 usually to its first glyph (leftmost in an L2R line), but
9499 that's not necessarily the start of the line, under bidi
9500 reordering. We want to get to the character position
9501 that is immediately after the newline of the previous
9504 && !it
->continuation_lines_width
9505 && !STRINGP (it
->string
)
9506 && IT_CHARPOS (*it
) > BEGV
9507 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9509 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9512 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9513 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9515 bidi_unshelve_cache (it3data
, 1);
9519 /* The y-position we try to reach, relative to *IT.
9520 Note that H has been subtracted in front of the if-statement. */
9521 int target_y
= it
->current_y
+ h
- dy
;
9522 int y0
= it3
.current_y
;
9526 RESTORE_IT (&it3
, &it3
, it3data
);
9527 y1
= line_bottom_y (&it3
);
9528 line_height
= y1
- y0
;
9529 RESTORE_IT (it
, it
, it2data
);
9530 /* If we did not reach target_y, try to move further backward if
9531 we can. If we moved too far backward, try to move forward. */
9532 if (target_y
< it
->current_y
9533 /* This is heuristic. In a window that's 3 lines high, with
9534 a line height of 13 pixels each, recentering with point
9535 on the bottom line will try to move -39/2 = 19 pixels
9536 backward. Try to avoid moving into the first line. */
9537 && (it
->current_y
- target_y
9538 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9539 && IT_CHARPOS (*it
) > BEGV
)
9541 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9542 target_y
- it
->current_y
));
9543 dy
= it
->current_y
- target_y
;
9544 goto move_further_back
;
9546 else if (target_y
>= it
->current_y
+ line_height
9547 && IT_CHARPOS (*it
) < ZV
)
9549 /* Should move forward by at least one line, maybe more.
9551 Note: Calling move_it_by_lines can be expensive on
9552 terminal frames, where compute_motion is used (via
9553 vmotion) to do the job, when there are very long lines
9554 and truncate-lines is nil. That's the reason for
9555 treating terminal frames specially here. */
9557 if (!FRAME_WINDOW_P (it
->f
))
9558 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9563 move_it_by_lines (it
, 1);
9565 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9572 /* Move IT by a specified amount of pixel lines DY. DY negative means
9573 move backwards. DY = 0 means move to start of screen line. At the
9574 end, IT will be on the start of a screen line. */
9577 move_it_vertically (struct it
*it
, int dy
)
9580 move_it_vertically_backward (it
, -dy
);
9583 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9584 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9585 MOVE_TO_POS
| MOVE_TO_Y
);
9586 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9588 /* If buffer ends in ZV without a newline, move to the start of
9589 the line to satisfy the post-condition. */
9590 if (IT_CHARPOS (*it
) == ZV
9592 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9593 move_it_by_lines (it
, 0);
9598 /* Move iterator IT past the end of the text line it is in. */
9601 move_it_past_eol (struct it
*it
)
9603 enum move_it_result rc
;
9605 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9606 if (rc
== MOVE_NEWLINE_OR_CR
)
9607 set_iterator_to_next (it
, 0);
9611 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9612 negative means move up. DVPOS == 0 means move to the start of the
9615 Optimization idea: If we would know that IT->f doesn't use
9616 a face with proportional font, we could be faster for
9617 truncate-lines nil. */
9620 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9623 /* The commented-out optimization uses vmotion on terminals. This
9624 gives bad results, because elements like it->what, on which
9625 callers such as pos_visible_p rely, aren't updated. */
9626 /* struct position pos;
9627 if (!FRAME_WINDOW_P (it->f))
9629 struct text_pos textpos;
9631 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9632 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9633 reseat (it, textpos, 1);
9634 it->vpos += pos.vpos;
9635 it->current_y += pos.vpos;
9641 /* DVPOS == 0 means move to the start of the screen line. */
9642 move_it_vertically_backward (it
, 0);
9643 /* Let next call to line_bottom_y calculate real line height. */
9648 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9649 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9651 /* Only move to the next buffer position if we ended up in a
9652 string from display property, not in an overlay string
9653 (before-string or after-string). That is because the
9654 latter don't conceal the underlying buffer position, so
9655 we can ask to move the iterator to the exact position we
9656 are interested in. Note that, even if we are already at
9657 IT_CHARPOS (*it), the call below is not a no-op, as it
9658 will detect that we are at the end of the string, pop the
9659 iterator, and compute it->current_x and it->hpos
9661 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9662 -1, -1, -1, MOVE_TO_POS
);
9668 void *it2data
= NULL
;
9669 ptrdiff_t start_charpos
, i
;
9671 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9672 bool hit_pos_limit
= false;
9673 ptrdiff_t pos_limit
;
9675 /* Start at the beginning of the screen line containing IT's
9676 position. This may actually move vertically backwards,
9677 in case of overlays, so adjust dvpos accordingly. */
9679 move_it_vertically_backward (it
, 0);
9682 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9683 screen lines, and reseat the iterator there. */
9684 start_charpos
= IT_CHARPOS (*it
);
9685 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9688 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9690 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9691 back_to_previous_visible_line_start (it
);
9692 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9693 hit_pos_limit
= true;
9694 reseat (it
, it
->current
.pos
, 1);
9696 /* Move further back if we end up in a string or an image. */
9697 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9699 /* First try to move to start of display line. */
9701 move_it_vertically_backward (it
, 0);
9703 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9705 /* If start of line is still in string or image,
9706 move further back. */
9707 back_to_previous_visible_line_start (it
);
9708 reseat (it
, it
->current
.pos
, 1);
9712 it
->current_x
= it
->hpos
= 0;
9714 /* Above call may have moved too far if continuation lines
9715 are involved. Scan forward and see if it did. */
9716 SAVE_IT (it2
, *it
, it2data
);
9717 it2
.vpos
= it2
.current_y
= 0;
9718 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9719 it
->vpos
-= it2
.vpos
;
9720 it
->current_y
-= it2
.current_y
;
9721 it
->current_x
= it
->hpos
= 0;
9723 /* If we moved too far back, move IT some lines forward. */
9724 if (it2
.vpos
> -dvpos
)
9726 int delta
= it2
.vpos
+ dvpos
;
9728 RESTORE_IT (&it2
, &it2
, it2data
);
9729 SAVE_IT (it2
, *it
, it2data
);
9730 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9731 /* Move back again if we got too far ahead. */
9732 if (IT_CHARPOS (*it
) >= start_charpos
)
9733 RESTORE_IT (it
, &it2
, it2data
);
9735 bidi_unshelve_cache (it2data
, 1);
9737 else if (hit_pos_limit
&& pos_limit
> BEGV
9738 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9740 /* If we hit the limit, but still didn't make it far enough
9741 back, that means there's a display string with a newline
9742 covering a large chunk of text, and that caused
9743 back_to_previous_visible_line_start try to go too far.
9744 Punish those who commit such atrocities by going back
9745 until we've reached DVPOS, after lifting the limit, which
9746 could make it slow for very long lines. "If it hurts,
9749 RESTORE_IT (it
, it
, it2data
);
9750 for (i
= -dvpos
; i
> 0; --i
)
9752 back_to_previous_visible_line_start (it
);
9757 RESTORE_IT (it
, it
, it2data
);
9761 /* Return true if IT points into the middle of a display vector. */
9764 in_display_vector_p (struct it
*it
)
9766 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9767 && it
->current
.dpvec_index
> 0
9768 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9771 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9772 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9773 WINDOW must be a live window and defaults to the selected one. The
9774 return value is a cons of the maximum pixel-width of any text line and
9775 the maximum pixel-height of all text lines.
9777 The optional argument FROM, if non-nil, specifies the first text
9778 position and defaults to the minimum accessible position of the buffer.
9779 If FROM is t, use the minimum accessible position that is not a newline
9780 character. TO, if non-nil, specifies the last text position and
9781 defaults to the maximum accessible position of the buffer. If TO is t,
9782 use the maximum accessible position that is not a newline character.
9784 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9785 width that can be returned. X-LIMIT nil or omitted, means to use the
9786 pixel-width of WINDOW's body; use this if you do not intend to change
9787 the width of WINDOW. Use the maximum width WINDOW may assume if you
9788 intend to change WINDOW's width. In any case, text whose x-coordinate
9789 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9790 can take some time, it's always a good idea to make this argument as
9791 small as possible; in particular, if the buffer contains long lines that
9792 shall be truncated anyway.
9794 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9795 height that can be returned. Text lines whose y-coordinate is beyond
9796 Y-LIMIT are ignored. Since calculating the text height of a large
9797 buffer can take some time, it makes sense to specify this argument if
9798 the size of the buffer is unknown.
9800 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9801 include the height of the mode- or header-line of WINDOW in the return
9802 value. If it is either the symbol `mode-line' or `header-line', include
9803 only the height of that line, if present, in the return value. If t,
9804 include the height of both, if present, in the return value. */)
9805 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9806 Lisp_Object mode_and_header_line
)
9808 struct window
*w
= decode_live_window (window
);
9812 struct buffer
*old_buffer
= NULL
;
9813 ptrdiff_t start
, end
, pos
;
9814 struct text_pos startp
;
9815 void *itdata
= NULL
;
9816 int c
, max_y
= -1, x
= 0, y
= 0;
9822 if (b
!= current_buffer
)
9824 old_buffer
= current_buffer
;
9825 set_buffer_internal (b
);
9830 else if (EQ (from
, Qt
))
9833 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9834 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9836 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9841 CHECK_NUMBER_COERCE_MARKER (from
);
9842 start
= min (max (XINT (from
), BEGV
), ZV
);
9847 else if (EQ (to
, Qt
))
9850 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9851 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9853 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9858 CHECK_NUMBER_COERCE_MARKER (to
);
9859 end
= max (start
, min (XINT (to
), ZV
));
9862 if (!NILP (y_limit
))
9864 CHECK_NUMBER (y_limit
);
9865 max_y
= min (XINT (y_limit
), INT_MAX
);
9868 itdata
= bidi_shelve_cache ();
9869 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9870 start_display (&it
, w
, startp
);
9873 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9876 CHECK_NUMBER (x_limit
);
9877 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9878 /* Actually, we never want move_it_to stop at to_x. But to make
9879 sure that move_it_in_display_line_to always moves far enough,
9880 we set it to INT_MAX and specify MOVE_TO_X. */
9881 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9882 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9885 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9887 if (!EQ (mode_and_header_line
, Qheader_line
)
9888 && !EQ (mode_and_header_line
, Qt
))
9889 /* Do not count the header-line which was counted automatically by
9891 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9893 if (EQ (mode_and_header_line
, Qmode_line
)
9894 || EQ (mode_and_header_line
, Qt
))
9895 /* Do count the mode-line which is not included automatically by
9897 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9899 bidi_unshelve_cache (itdata
, 0);
9902 set_buffer_internal (old_buffer
);
9904 return Fcons (make_number (x
), make_number (y
));
9907 /***********************************************************************
9909 ***********************************************************************/
9912 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9916 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9918 Lisp_Object args
[3];
9919 Lisp_Object msg
, fmt
;
9922 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9926 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9928 args
[0] = fmt
= build_string (format
);
9931 msg
= Fformat (3, args
);
9933 len
= SBYTES (msg
) + 1;
9934 buffer
= SAFE_ALLOCA (len
);
9935 memcpy (buffer
, SDATA (msg
), len
);
9937 message_dolog (buffer
, len
- 1, 1, 0);
9944 /* Output a newline in the *Messages* buffer if "needs" one. */
9947 message_log_maybe_newline (void)
9949 if (message_log_need_newline
)
9950 message_dolog ("", 0, 1, 0);
9954 /* Add a string M of length NBYTES to the message log, optionally
9955 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9956 true, means interpret the contents of M as multibyte. This
9957 function calls low-level routines in order to bypass text property
9958 hooks, etc. which might not be safe to run.
9960 This may GC (insert may run before/after change hooks),
9961 so the buffer M must NOT point to a Lisp string. */
9964 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9966 const unsigned char *msg
= (const unsigned char *) m
;
9968 if (!NILP (Vmemory_full
))
9971 if (!NILP (Vmessage_log_max
))
9973 struct buffer
*oldbuf
;
9974 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9975 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9976 ptrdiff_t point_at_end
= 0;
9977 ptrdiff_t zv_at_end
= 0;
9978 Lisp_Object old_deactivate_mark
;
9979 struct gcpro gcpro1
;
9981 old_deactivate_mark
= Vdeactivate_mark
;
9982 oldbuf
= current_buffer
;
9984 /* Ensure the Messages buffer exists, and switch to it.
9985 If we created it, set the major-mode. */
9988 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9990 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9993 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9994 call0 (intern ("messages-buffer-mode"));
9997 bset_undo_list (current_buffer
, Qt
);
9998 bset_cache_long_scans (current_buffer
, Qnil
);
10000 oldpoint
= message_dolog_marker1
;
10001 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10002 oldbegv
= message_dolog_marker2
;
10003 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10004 oldzv
= message_dolog_marker3
;
10005 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10006 GCPRO1 (old_deactivate_mark
);
10014 BEGV_BYTE
= BEG_BYTE
;
10017 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10019 /* Insert the string--maybe converting multibyte to single byte
10020 or vice versa, so that all the text fits the buffer. */
10022 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10028 /* Convert a multibyte string to single-byte
10029 for the *Message* buffer. */
10030 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10032 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10033 work
[0] = CHAR_TO_BYTE8 (c
);
10034 insert_1_both (work
, 1, 1, 1, 0, 0);
10037 else if (! multibyte
10038 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10042 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10043 /* Convert a single-byte string to multibyte
10044 for the *Message* buffer. */
10045 for (i
= 0; i
< nbytes
; i
++)
10048 MAKE_CHAR_MULTIBYTE (c
);
10049 char_bytes
= CHAR_STRING (c
, str
);
10050 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10054 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10058 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10061 insert_1_both ("\n", 1, 1, 1, 0, 0);
10063 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10065 this_bol_byte
= PT_BYTE
;
10067 /* See if this line duplicates the previous one.
10068 If so, combine duplicates. */
10069 if (this_bol
> BEG
)
10071 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10073 prev_bol_byte
= PT_BYTE
;
10075 dups
= message_log_check_duplicate (prev_bol_byte
,
10079 del_range_both (prev_bol
, prev_bol_byte
,
10080 this_bol
, this_bol_byte
, 0);
10083 char dupstr
[sizeof " [ times]"
10084 + INT_STRLEN_BOUND (printmax_t
)];
10086 /* If you change this format, don't forget to also
10087 change message_log_check_duplicate. */
10088 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10089 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10090 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10095 /* If we have more than the desired maximum number of lines
10096 in the *Messages* buffer now, delete the oldest ones.
10097 This is safe because we don't have undo in this buffer. */
10099 if (NATNUMP (Vmessage_log_max
))
10101 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10102 -XFASTINT (Vmessage_log_max
) - 1, 0);
10103 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10106 BEGV
= marker_position (oldbegv
);
10107 BEGV_BYTE
= marker_byte_position (oldbegv
);
10116 ZV
= marker_position (oldzv
);
10117 ZV_BYTE
= marker_byte_position (oldzv
);
10121 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10123 /* We can't do Fgoto_char (oldpoint) because it will run some
10125 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10126 marker_byte_position (oldpoint
));
10129 unchain_marker (XMARKER (oldpoint
));
10130 unchain_marker (XMARKER (oldbegv
));
10131 unchain_marker (XMARKER (oldzv
));
10133 /* We called insert_1_both above with its 5th argument (PREPARE)
10134 zero, which prevents insert_1_both from calling
10135 prepare_to_modify_buffer, which in turns prevents us from
10136 incrementing windows_or_buffers_changed even if *Messages* is
10137 shown in some window. So we must manually set
10138 windows_or_buffers_changed here to make up for that. */
10139 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10140 bset_redisplay (current_buffer
);
10142 set_buffer_internal (oldbuf
);
10144 message_log_need_newline
= !nlflag
;
10145 Vdeactivate_mark
= old_deactivate_mark
;
10150 /* We are at the end of the buffer after just having inserted a newline.
10151 (Note: We depend on the fact we won't be crossing the gap.)
10152 Check to see if the most recent message looks a lot like the previous one.
10153 Return 0 if different, 1 if the new one should just replace it, or a
10154 value N > 1 if we should also append " [N times]". */
10157 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10160 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10162 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10163 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10165 for (i
= 0; i
< len
; i
++)
10167 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10169 if (p1
[i
] != p2
[i
])
10175 if (*p1
++ == ' ' && *p1
++ == '[')
10178 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10179 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10186 /* Display an echo area message M with a specified length of NBYTES
10187 bytes. The string may include null characters. If M is not a
10188 string, clear out any existing message, and let the mini-buffer
10191 This function cancels echoing. */
10194 message3 (Lisp_Object m
)
10196 struct gcpro gcpro1
;
10199 clear_message (true, true);
10202 /* First flush out any partial line written with print. */
10203 message_log_maybe_newline ();
10206 ptrdiff_t nbytes
= SBYTES (m
);
10207 bool multibyte
= STRING_MULTIBYTE (m
);
10210 SAFE_ALLOCA_STRING (buffer
, m
);
10211 message_dolog (buffer
, nbytes
, 1, multibyte
);
10214 message3_nolog (m
);
10220 /* The non-logging version of message3.
10221 This does not cancel echoing, because it is used for echoing.
10222 Perhaps we need to make a separate function for echoing
10223 and make this cancel echoing. */
10226 message3_nolog (Lisp_Object m
)
10228 struct frame
*sf
= SELECTED_FRAME ();
10230 if (FRAME_INITIAL_P (sf
))
10232 if (noninteractive_need_newline
)
10233 putc ('\n', stderr
);
10234 noninteractive_need_newline
= 0;
10237 Lisp_Object s
= ENCODE_SYSTEM (m
);
10239 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10241 if (cursor_in_echo_area
== 0)
10242 fprintf (stderr
, "\n");
10245 /* Error messages get reported properly by cmd_error, so this must be just an
10246 informative message; if the frame hasn't really been initialized yet, just
10248 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10250 /* Get the frame containing the mini-buffer
10251 that the selected frame is using. */
10252 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10253 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10254 struct frame
*f
= XFRAME (frame
);
10256 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10257 Fmake_frame_visible (frame
);
10259 if (STRINGP (m
) && SCHARS (m
) > 0)
10262 if (minibuffer_auto_raise
)
10263 Fraise_frame (frame
);
10264 /* Assume we are not echoing.
10265 (If we are, echo_now will override this.) */
10266 echo_message_buffer
= Qnil
;
10269 clear_message (true, true);
10271 do_pending_window_change (0);
10272 echo_area_display (1);
10273 do_pending_window_change (0);
10274 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10275 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10280 /* Display a null-terminated echo area message M. If M is 0, clear
10281 out any existing message, and let the mini-buffer text show through.
10283 The buffer M must continue to exist until after the echo area gets
10284 cleared or some other message gets displayed there. Do not pass
10285 text that is stored in a Lisp string. Do not pass text in a buffer
10286 that was alloca'd. */
10289 message1 (const char *m
)
10291 message3 (m
? build_unibyte_string (m
) : Qnil
);
10295 /* The non-logging counterpart of message1. */
10298 message1_nolog (const char *m
)
10300 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10303 /* Display a message M which contains a single %s
10304 which gets replaced with STRING. */
10307 message_with_string (const char *m
, Lisp_Object string
, int log
)
10309 CHECK_STRING (string
);
10311 if (noninteractive
)
10315 /* ENCODE_SYSTEM below can GC and/or relocate the
10316 Lisp data, so make sure we don't use it here. */
10317 eassert (relocatable_string_data_p (m
) != 1);
10319 if (noninteractive_need_newline
)
10320 putc ('\n', stderr
);
10321 noninteractive_need_newline
= 0;
10322 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10323 if (!cursor_in_echo_area
)
10324 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
);
10413 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10415 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10417 message3 (make_string (message_buf
, len
));
10423 /* Print should start at the beginning of the message
10424 buffer next time. */
10425 message_buf_print
= 0;
10431 message (const char *m
, ...)
10441 /* The non-logging version of message. */
10444 message_nolog (const char *m
, ...)
10446 Lisp_Object old_log_max
;
10449 old_log_max
= Vmessage_log_max
;
10450 Vmessage_log_max
= Qnil
;
10452 Vmessage_log_max
= old_log_max
;
10458 /* Display the current message in the current mini-buffer. This is
10459 only called from error handlers in process.c, and is not time
10463 update_echo_area (void)
10465 if (!NILP (echo_area_buffer
[0]))
10467 Lisp_Object string
;
10468 string
= Fcurrent_message ();
10474 /* Make sure echo area buffers in `echo_buffers' are live.
10475 If they aren't, make new ones. */
10478 ensure_echo_area_buffers (void)
10482 for (i
= 0; i
< 2; ++i
)
10483 if (!BUFFERP (echo_buffer
[i
])
10484 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10487 Lisp_Object old_buffer
;
10490 old_buffer
= echo_buffer
[i
];
10491 echo_buffer
[i
] = Fget_buffer_create
10492 (make_formatted_string (name
, " *Echo Area %d*", i
));
10493 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10494 /* to force word wrap in echo area -
10495 it was decided to postpone this*/
10496 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10498 for (j
= 0; j
< 2; ++j
)
10499 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10500 echo_area_buffer
[j
] = echo_buffer
[i
];
10505 /* Call FN with args A1..A2 with either the current or last displayed
10506 echo_area_buffer as current buffer.
10508 WHICH zero means use the current message buffer
10509 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10510 from echo_buffer[] and clear it.
10512 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10513 suitable buffer from echo_buffer[] and clear it.
10515 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10516 that the current message becomes the last displayed one, make
10517 choose a suitable buffer for echo_area_buffer[0], and clear it.
10519 Value is what FN returns. */
10522 with_echo_area_buffer (struct window
*w
, int which
,
10523 int (*fn
) (ptrdiff_t, Lisp_Object
),
10524 ptrdiff_t a1
, Lisp_Object a2
)
10526 Lisp_Object buffer
;
10527 int this_one
, the_other
, clear_buffer_p
, rc
;
10528 ptrdiff_t count
= SPECPDL_INDEX ();
10530 /* If buffers aren't live, make new ones. */
10531 ensure_echo_area_buffers ();
10533 clear_buffer_p
= 0;
10536 this_one
= 0, the_other
= 1;
10537 else if (which
> 0)
10538 this_one
= 1, the_other
= 0;
10541 this_one
= 0, the_other
= 1;
10542 clear_buffer_p
= true;
10544 /* We need a fresh one in case the current echo buffer equals
10545 the one containing the last displayed echo area message. */
10546 if (!NILP (echo_area_buffer
[this_one
])
10547 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10548 echo_area_buffer
[this_one
] = Qnil
;
10551 /* Choose a suitable buffer from echo_buffer[] is we don't
10553 if (NILP (echo_area_buffer
[this_one
]))
10555 echo_area_buffer
[this_one
]
10556 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10557 ? echo_buffer
[the_other
]
10558 : echo_buffer
[this_one
]);
10559 clear_buffer_p
= true;
10562 buffer
= echo_area_buffer
[this_one
];
10564 /* Don't get confused by reusing the buffer used for echoing
10565 for a different purpose. */
10566 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10569 record_unwind_protect (unwind_with_echo_area_buffer
,
10570 with_echo_area_buffer_unwind_data (w
));
10572 /* Make the echo area buffer current. Note that for display
10573 purposes, it is not necessary that the displayed window's buffer
10574 == current_buffer, except for text property lookup. So, let's
10575 only set that buffer temporarily here without doing a full
10576 Fset_window_buffer. We must also change w->pointm, though,
10577 because otherwise an assertions in unshow_buffer fails, and Emacs
10579 set_buffer_internal_1 (XBUFFER (buffer
));
10582 wset_buffer (w
, buffer
);
10583 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10584 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10587 bset_undo_list (current_buffer
, Qt
);
10588 bset_read_only (current_buffer
, Qnil
);
10589 specbind (Qinhibit_read_only
, Qt
);
10590 specbind (Qinhibit_modification_hooks
, Qt
);
10592 if (clear_buffer_p
&& Z
> BEG
)
10593 del_range (BEG
, Z
);
10595 eassert (BEGV
>= BEG
);
10596 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10600 eassert (BEGV
>= BEG
);
10601 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10603 unbind_to (count
, Qnil
);
10608 /* Save state that should be preserved around the call to the function
10609 FN called in with_echo_area_buffer. */
10612 with_echo_area_buffer_unwind_data (struct window
*w
)
10615 Lisp_Object vector
, tmp
;
10617 /* Reduce consing by keeping one vector in
10618 Vwith_echo_area_save_vector. */
10619 vector
= Vwith_echo_area_save_vector
;
10620 Vwith_echo_area_save_vector
= Qnil
;
10623 vector
= Fmake_vector (make_number (11), Qnil
);
10625 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10626 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10627 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10631 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10632 ASET (vector
, i
, w
->contents
); ++i
;
10633 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10634 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10635 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10636 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10637 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10638 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10643 for (; i
< end
; ++i
)
10644 ASET (vector
, i
, Qnil
);
10647 eassert (i
== ASIZE (vector
));
10652 /* Restore global state from VECTOR which was created by
10653 with_echo_area_buffer_unwind_data. */
10656 unwind_with_echo_area_buffer (Lisp_Object vector
)
10658 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10659 Vdeactivate_mark
= AREF (vector
, 1);
10660 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10662 if (WINDOWP (AREF (vector
, 3)))
10665 Lisp_Object buffer
;
10667 w
= XWINDOW (AREF (vector
, 3));
10668 buffer
= AREF (vector
, 4);
10670 wset_buffer (w
, buffer
);
10671 set_marker_both (w
->pointm
, buffer
,
10672 XFASTINT (AREF (vector
, 5)),
10673 XFASTINT (AREF (vector
, 6)));
10674 set_marker_both (w
->old_pointm
, buffer
,
10675 XFASTINT (AREF (vector
, 7)),
10676 XFASTINT (AREF (vector
, 8)));
10677 set_marker_both (w
->start
, buffer
,
10678 XFASTINT (AREF (vector
, 9)),
10679 XFASTINT (AREF (vector
, 10)));
10682 Vwith_echo_area_save_vector
= vector
;
10686 /* Set up the echo area for use by print functions. MULTIBYTE_P
10687 non-zero means we will print multibyte. */
10690 setup_echo_area_for_printing (int multibyte_p
)
10692 /* If we can't find an echo area any more, exit. */
10693 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10694 Fkill_emacs (Qnil
);
10696 ensure_echo_area_buffers ();
10698 if (!message_buf_print
)
10700 /* A message has been output since the last time we printed.
10701 Choose a fresh echo area buffer. */
10702 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10703 echo_area_buffer
[0] = echo_buffer
[1];
10705 echo_area_buffer
[0] = echo_buffer
[0];
10707 /* Switch to that buffer and clear it. */
10708 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10709 bset_truncate_lines (current_buffer
, Qnil
);
10713 ptrdiff_t count
= SPECPDL_INDEX ();
10714 specbind (Qinhibit_read_only
, Qt
);
10715 /* Note that undo recording is always disabled. */
10716 del_range (BEG
, Z
);
10717 unbind_to (count
, Qnil
);
10719 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10721 /* Set up the buffer for the multibyteness we need. */
10723 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10724 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10726 /* Raise the frame containing the echo area. */
10727 if (minibuffer_auto_raise
)
10729 struct frame
*sf
= SELECTED_FRAME ();
10730 Lisp_Object mini_window
;
10731 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10732 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10735 message_log_maybe_newline ();
10736 message_buf_print
= 1;
10740 if (NILP (echo_area_buffer
[0]))
10742 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10743 echo_area_buffer
[0] = echo_buffer
[1];
10745 echo_area_buffer
[0] = echo_buffer
[0];
10748 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10750 /* Someone switched buffers between print requests. */
10751 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10752 bset_truncate_lines (current_buffer
, Qnil
);
10758 /* Display an echo area message in window W. Value is non-zero if W's
10759 height is changed. If display_last_displayed_message_p is
10760 non-zero, display the message that was last displayed, otherwise
10761 display the current message. */
10764 display_echo_area (struct window
*w
)
10766 int i
, no_message_p
, window_height_changed_p
;
10768 /* Temporarily disable garbage collections while displaying the echo
10769 area. This is done because a GC can print a message itself.
10770 That message would modify the echo area buffer's contents while a
10771 redisplay of the buffer is going on, and seriously confuse
10773 ptrdiff_t count
= inhibit_garbage_collection ();
10775 /* If there is no message, we must call display_echo_area_1
10776 nevertheless because it resizes the window. But we will have to
10777 reset the echo_area_buffer in question to nil at the end because
10778 with_echo_area_buffer will sets it to an empty buffer. */
10779 i
= display_last_displayed_message_p
? 1 : 0;
10780 no_message_p
= NILP (echo_area_buffer
[i
]);
10782 window_height_changed_p
10783 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10784 display_echo_area_1
,
10785 (intptr_t) w
, Qnil
);
10788 echo_area_buffer
[i
] = Qnil
;
10790 unbind_to (count
, Qnil
);
10791 return window_height_changed_p
;
10795 /* Helper for display_echo_area. Display the current buffer which
10796 contains the current echo area message in window W, a mini-window,
10797 a pointer to which is passed in A1. A2..A4 are currently not used.
10798 Change the height of W so that all of the message is displayed.
10799 Value is non-zero if height of W was changed. */
10802 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10805 struct window
*w
= (struct window
*) i1
;
10806 Lisp_Object window
;
10807 struct text_pos start
;
10808 int window_height_changed_p
= 0;
10810 /* Do this before displaying, so that we have a large enough glyph
10811 matrix for the display. If we can't get enough space for the
10812 whole text, display the last N lines. That works by setting w->start. */
10813 window_height_changed_p
= resize_mini_window (w
, 0);
10815 /* Use the starting position chosen by resize_mini_window. */
10816 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10819 clear_glyph_matrix (w
->desired_matrix
);
10820 XSETWINDOW (window
, w
);
10821 try_window (window
, start
, 0);
10823 return window_height_changed_p
;
10827 /* Resize the echo area window to exactly the size needed for the
10828 currently displayed message, if there is one. If a mini-buffer
10829 is active, don't shrink it. */
10832 resize_echo_area_exactly (void)
10834 if (BUFFERP (echo_area_buffer
[0])
10835 && WINDOWP (echo_area_window
))
10837 struct window
*w
= XWINDOW (echo_area_window
);
10838 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10839 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10840 (intptr_t) w
, resize_exactly
);
10843 windows_or_buffers_changed
= 42;
10844 update_mode_lines
= 30;
10845 redisplay_internal ();
10851 /* Callback function for with_echo_area_buffer, when used from
10852 resize_echo_area_exactly. A1 contains a pointer to the window to
10853 resize, EXACTLY non-nil means resize the mini-window exactly to the
10854 size of the text displayed. A3 and A4 are not used. Value is what
10855 resize_mini_window returns. */
10858 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10861 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10865 /* Resize mini-window W to fit the size of its contents. EXACT_P
10866 means size the window exactly to the size needed. Otherwise, it's
10867 only enlarged until W's buffer is empty.
10869 Set W->start to the right place to begin display. If the whole
10870 contents fit, start at the beginning. Otherwise, start so as
10871 to make the end of the contents appear. This is particularly
10872 important for y-or-n-p, but seems desirable generally.
10874 Value is non-zero if the window height has been changed. */
10877 resize_mini_window (struct window
*w
, int exact_p
)
10879 struct frame
*f
= XFRAME (w
->frame
);
10880 int window_height_changed_p
= 0;
10882 eassert (MINI_WINDOW_P (w
));
10884 /* By default, start display at the beginning. */
10885 set_marker_both (w
->start
, w
->contents
,
10886 BUF_BEGV (XBUFFER (w
->contents
)),
10887 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10889 /* Don't resize windows while redisplaying a window; it would
10890 confuse redisplay functions when the size of the window they are
10891 displaying changes from under them. Such a resizing can happen,
10892 for instance, when which-func prints a long message while
10893 we are running fontification-functions. We're running these
10894 functions with safe_call which binds inhibit-redisplay to t. */
10895 if (!NILP (Vinhibit_redisplay
))
10898 /* Nil means don't try to resize. */
10899 if (NILP (Vresize_mini_windows
)
10900 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10903 if (!FRAME_MINIBUF_ONLY_P (f
))
10906 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10907 + WINDOW_PIXEL_HEIGHT (w
));
10908 int unit
= FRAME_LINE_HEIGHT (f
);
10909 int height
, max_height
;
10910 struct text_pos start
;
10911 struct buffer
*old_current_buffer
= NULL
;
10913 if (current_buffer
!= XBUFFER (w
->contents
))
10915 old_current_buffer
= current_buffer
;
10916 set_buffer_internal (XBUFFER (w
->contents
));
10919 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10921 /* Compute the max. number of lines specified by the user. */
10922 if (FLOATP (Vmax_mini_window_height
))
10923 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10924 else if (INTEGERP (Vmax_mini_window_height
))
10925 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10927 max_height
= total_height
/ 4;
10929 /* Correct that max. height if it's bogus. */
10930 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10932 /* Find out the height of the text in the window. */
10933 if (it
.line_wrap
== TRUNCATE
)
10938 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10939 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10940 height
= it
.current_y
+ last_height
;
10942 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10943 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10946 /* Compute a suitable window start. */
10947 if (height
> max_height
)
10949 height
= (max_height
/ unit
) * unit
;
10950 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10951 move_it_vertically_backward (&it
, height
- unit
);
10952 start
= it
.current
.pos
;
10955 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10956 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10958 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10960 /* Let it grow only, until we display an empty message, in which
10961 case the window shrinks again. */
10962 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10964 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10966 FRAME_WINDOWS_FROZEN (f
) = 1;
10967 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10968 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10970 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10971 && (exact_p
|| BEGV
== ZV
))
10973 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10975 FRAME_WINDOWS_FROZEN (f
) = 0;
10976 shrink_mini_window (w
, 1);
10977 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10982 /* Always resize to exact size needed. */
10983 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10985 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10987 FRAME_WINDOWS_FROZEN (f
) = 1;
10988 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10989 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10991 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10993 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10995 FRAME_WINDOWS_FROZEN (f
) = 0;
10996 shrink_mini_window (w
, 1);
11000 FRAME_WINDOWS_FROZEN (f
) = 1;
11001 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
11004 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11008 if (old_current_buffer
)
11009 set_buffer_internal (old_current_buffer
);
11012 return window_height_changed_p
;
11016 /* Value is the current message, a string, or nil if there is no
11017 current message. */
11020 current_message (void)
11024 if (!BUFFERP (echo_area_buffer
[0]))
11028 with_echo_area_buffer (0, 0, current_message_1
,
11029 (intptr_t) &msg
, Qnil
);
11031 echo_area_buffer
[0] = Qnil
;
11039 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11042 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11045 *msg
= make_buffer_string (BEG
, Z
, 1);
11052 /* Push the current message on Vmessage_stack for later restoration
11053 by restore_message. Value is non-zero if the current message isn't
11054 empty. This is a relatively infrequent operation, so it's not
11055 worth optimizing. */
11058 push_message (void)
11060 Lisp_Object msg
= current_message ();
11061 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11062 return STRINGP (msg
);
11066 /* Restore message display from the top of Vmessage_stack. */
11069 restore_message (void)
11071 eassert (CONSP (Vmessage_stack
));
11072 message3_nolog (XCAR (Vmessage_stack
));
11076 /* Handler for unwind-protect calling pop_message. */
11079 pop_message_unwind (void)
11081 /* Pop the top-most entry off Vmessage_stack. */
11082 eassert (CONSP (Vmessage_stack
));
11083 Vmessage_stack
= XCDR (Vmessage_stack
);
11087 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11088 exits. If the stack is not empty, we have a missing pop_message
11092 check_message_stack (void)
11094 if (!NILP (Vmessage_stack
))
11099 /* Truncate to NCHARS what will be displayed in the echo area the next
11100 time we display it---but don't redisplay it now. */
11103 truncate_echo_area (ptrdiff_t nchars
)
11106 echo_area_buffer
[0] = Qnil
;
11107 else if (!noninteractive
11109 && !NILP (echo_area_buffer
[0]))
11111 struct frame
*sf
= SELECTED_FRAME ();
11112 /* Error messages get reported properly by cmd_error, so this must be
11113 just an informative message; if the frame hasn't really been
11114 initialized yet, just toss it. */
11115 if (sf
->glyphs_initialized_p
)
11116 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11121 /* Helper function for truncate_echo_area. Truncate the current
11122 message to at most NCHARS characters. */
11125 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11127 if (BEG
+ nchars
< Z
)
11128 del_range (BEG
+ nchars
, Z
);
11130 echo_area_buffer
[0] = Qnil
;
11134 /* Set the current message to STRING. */
11137 set_message (Lisp_Object string
)
11139 eassert (STRINGP (string
));
11141 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11143 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11144 message_buf_print
= 0;
11145 help_echo_showing_p
= 0;
11147 if (STRINGP (Vdebug_on_message
)
11148 && STRINGP (string
)
11149 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11150 call_debugger (list2 (Qerror
, string
));
11154 /* Helper function for set_message. First argument is ignored and second
11155 argument has the same meaning as for set_message.
11156 This function is called with the echo area buffer being current. */
11159 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11161 eassert (STRINGP (string
));
11163 /* Change multibyteness of the echo buffer appropriately. */
11164 if (message_enable_multibyte
11165 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11166 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11168 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11169 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11170 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11172 /* Insert new message at BEG. */
11173 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11175 /* This function takes care of single/multibyte conversion.
11176 We just have to ensure that the echo area buffer has the right
11177 setting of enable_multibyte_characters. */
11178 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11184 /* Clear messages. CURRENT_P non-zero means clear the current
11185 message. LAST_DISPLAYED_P non-zero means clear the message
11189 clear_message (bool current_p
, bool last_displayed_p
)
11193 echo_area_buffer
[0] = Qnil
;
11194 message_cleared_p
= true;
11197 if (last_displayed_p
)
11198 echo_area_buffer
[1] = Qnil
;
11200 message_buf_print
= 0;
11203 /* Clear garbaged frames.
11205 This function is used where the old redisplay called
11206 redraw_garbaged_frames which in turn called redraw_frame which in
11207 turn called clear_frame. The call to clear_frame was a source of
11208 flickering. I believe a clear_frame is not necessary. It should
11209 suffice in the new redisplay to invalidate all current matrices,
11210 and ensure a complete redisplay of all windows. */
11213 clear_garbaged_frames (void)
11215 if (frame_garbaged
)
11217 Lisp_Object tail
, frame
;
11219 FOR_EACH_FRAME (tail
, frame
)
11221 struct frame
*f
= XFRAME (frame
);
11223 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11228 clear_current_matrices (f
);
11229 fset_redisplay (f
);
11230 f
->garbaged
= false;
11231 f
->resized_p
= false;
11235 frame_garbaged
= false;
11240 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11241 is non-zero update selected_frame. Value is non-zero if the
11242 mini-windows height has been changed. */
11245 echo_area_display (int update_frame_p
)
11247 Lisp_Object mini_window
;
11250 int window_height_changed_p
= 0;
11251 struct frame
*sf
= SELECTED_FRAME ();
11253 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11254 w
= XWINDOW (mini_window
);
11255 f
= XFRAME (WINDOW_FRAME (w
));
11257 /* Don't display if frame is invisible or not yet initialized. */
11258 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11261 #ifdef HAVE_WINDOW_SYSTEM
11262 /* When Emacs starts, selected_frame may be the initial terminal
11263 frame. If we let this through, a message would be displayed on
11265 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11267 #endif /* HAVE_WINDOW_SYSTEM */
11269 /* Redraw garbaged frames. */
11270 clear_garbaged_frames ();
11272 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11274 echo_area_window
= mini_window
;
11275 window_height_changed_p
= display_echo_area (w
);
11276 w
->must_be_updated_p
= true;
11278 /* Update the display, unless called from redisplay_internal.
11279 Also don't update the screen during redisplay itself. The
11280 update will happen at the end of redisplay, and an update
11281 here could cause confusion. */
11282 if (update_frame_p
&& !redisplaying_p
)
11286 /* If the display update has been interrupted by pending
11287 input, update mode lines in the frame. Due to the
11288 pending input, it might have been that redisplay hasn't
11289 been called, so that mode lines above the echo area are
11290 garbaged. This looks odd, so we prevent it here. */
11291 if (!display_completed
)
11292 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11294 if (window_height_changed_p
11295 /* Don't do this if Emacs is shutting down. Redisplay
11296 needs to run hooks. */
11297 && !NILP (Vrun_hooks
))
11299 /* Must update other windows. Likewise as in other
11300 cases, don't let this update be interrupted by
11302 ptrdiff_t count
= SPECPDL_INDEX ();
11303 specbind (Qredisplay_dont_pause
, Qt
);
11304 windows_or_buffers_changed
= 44;
11305 redisplay_internal ();
11306 unbind_to (count
, Qnil
);
11308 else if (FRAME_WINDOW_P (f
) && n
== 0)
11310 /* Window configuration is the same as before.
11311 Can do with a display update of the echo area,
11312 unless we displayed some mode lines. */
11313 update_single_window (w
, 1);
11317 update_frame (f
, 1, 1);
11319 /* If cursor is in the echo area, make sure that the next
11320 redisplay displays the minibuffer, so that the cursor will
11321 be replaced with what the minibuffer wants. */
11322 if (cursor_in_echo_area
)
11323 wset_redisplay (XWINDOW (mini_window
));
11326 else if (!EQ (mini_window
, selected_window
))
11327 wset_redisplay (XWINDOW (mini_window
));
11329 /* Last displayed message is now the current message. */
11330 echo_area_buffer
[1] = echo_area_buffer
[0];
11331 /* Inform read_char that we're not echoing. */
11332 echo_message_buffer
= Qnil
;
11334 /* Prevent redisplay optimization in redisplay_internal by resetting
11335 this_line_start_pos. This is done because the mini-buffer now
11336 displays the message instead of its buffer text. */
11337 if (EQ (mini_window
, selected_window
))
11338 CHARPOS (this_line_start_pos
) = 0;
11340 return window_height_changed_p
;
11343 /* Nonzero if W's buffer was changed but not saved. */
11346 window_buffer_changed (struct window
*w
)
11348 struct buffer
*b
= XBUFFER (w
->contents
);
11350 eassert (BUFFER_LIVE_P (b
));
11352 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11355 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11358 mode_line_update_needed (struct window
*w
)
11360 return (w
->column_number_displayed
!= -1
11361 && !(PT
== w
->last_point
&& !window_outdated (w
))
11362 && (w
->column_number_displayed
!= current_column ()));
11365 /* Nonzero if window start of W is frozen and may not be changed during
11369 window_frozen_p (struct window
*w
)
11371 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11373 Lisp_Object window
;
11375 XSETWINDOW (window
, w
);
11376 if (MINI_WINDOW_P (w
))
11378 else if (EQ (window
, selected_window
))
11380 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11381 && EQ (window
, Vminibuf_scroll_window
))
11382 /* This special window can't be frozen too. */
11390 /***********************************************************************
11391 Mode Lines and Frame Titles
11392 ***********************************************************************/
11394 /* A buffer for constructing non-propertized mode-line strings and
11395 frame titles in it; allocated from the heap in init_xdisp and
11396 resized as needed in store_mode_line_noprop_char. */
11398 static char *mode_line_noprop_buf
;
11400 /* The buffer's end, and a current output position in it. */
11402 static char *mode_line_noprop_buf_end
;
11403 static char *mode_line_noprop_ptr
;
11405 #define MODE_LINE_NOPROP_LEN(start) \
11406 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11409 MODE_LINE_DISPLAY
= 0,
11413 } mode_line_target
;
11415 /* Alist that caches the results of :propertize.
11416 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11417 static Lisp_Object mode_line_proptrans_alist
;
11419 /* List of strings making up the mode-line. */
11420 static Lisp_Object mode_line_string_list
;
11422 /* Base face property when building propertized mode line string. */
11423 static Lisp_Object mode_line_string_face
;
11424 static Lisp_Object mode_line_string_face_prop
;
11427 /* Unwind data for mode line strings */
11429 static Lisp_Object Vmode_line_unwind_vector
;
11432 format_mode_line_unwind_data (struct frame
*target_frame
,
11433 struct buffer
*obuf
,
11435 int save_proptrans
)
11437 Lisp_Object vector
, tmp
;
11439 /* Reduce consing by keeping one vector in
11440 Vwith_echo_area_save_vector. */
11441 vector
= Vmode_line_unwind_vector
;
11442 Vmode_line_unwind_vector
= Qnil
;
11445 vector
= Fmake_vector (make_number (10), Qnil
);
11447 ASET (vector
, 0, make_number (mode_line_target
));
11448 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11449 ASET (vector
, 2, mode_line_string_list
);
11450 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11451 ASET (vector
, 4, mode_line_string_face
);
11452 ASET (vector
, 5, mode_line_string_face_prop
);
11455 XSETBUFFER (tmp
, obuf
);
11458 ASET (vector
, 6, tmp
);
11459 ASET (vector
, 7, owin
);
11462 /* Similarly to `with-selected-window', if the operation selects
11463 a window on another frame, we must restore that frame's
11464 selected window, and (for a tty) the top-frame. */
11465 ASET (vector
, 8, target_frame
->selected_window
);
11466 if (FRAME_TERMCAP_P (target_frame
))
11467 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11474 unwind_format_mode_line (Lisp_Object vector
)
11476 Lisp_Object old_window
= AREF (vector
, 7);
11477 Lisp_Object target_frame_window
= AREF (vector
, 8);
11478 Lisp_Object old_top_frame
= AREF (vector
, 9);
11480 mode_line_target
= XINT (AREF (vector
, 0));
11481 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11482 mode_line_string_list
= AREF (vector
, 2);
11483 if (! EQ (AREF (vector
, 3), Qt
))
11484 mode_line_proptrans_alist
= AREF (vector
, 3);
11485 mode_line_string_face
= AREF (vector
, 4);
11486 mode_line_string_face_prop
= AREF (vector
, 5);
11488 /* Select window before buffer, since it may change the buffer. */
11489 if (!NILP (old_window
))
11491 /* If the operation that we are unwinding had selected a window
11492 on a different frame, reset its frame-selected-window. For a
11493 text terminal, reset its top-frame if necessary. */
11494 if (!NILP (target_frame_window
))
11497 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11499 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11500 Fselect_window (target_frame_window
, Qt
);
11502 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11503 Fselect_frame (old_top_frame
, Qt
);
11506 Fselect_window (old_window
, Qt
);
11509 if (!NILP (AREF (vector
, 6)))
11511 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11512 ASET (vector
, 6, Qnil
);
11515 Vmode_line_unwind_vector
= vector
;
11519 /* Store a single character C for the frame title in mode_line_noprop_buf.
11520 Re-allocate mode_line_noprop_buf if necessary. */
11523 store_mode_line_noprop_char (char c
)
11525 /* If output position has reached the end of the allocated buffer,
11526 increase the buffer's size. */
11527 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11529 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11530 ptrdiff_t size
= len
;
11531 mode_line_noprop_buf
=
11532 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11533 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11534 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11537 *mode_line_noprop_ptr
++ = c
;
11541 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11542 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11543 characters that yield more columns than PRECISION; PRECISION <= 0
11544 means copy the whole string. Pad with spaces until FIELD_WIDTH
11545 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11546 pad. Called from display_mode_element when it is used to build a
11550 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11552 const unsigned char *str
= (const unsigned char *) string
;
11554 ptrdiff_t dummy
, nbytes
;
11556 /* Copy at most PRECISION chars from STR. */
11557 nbytes
= strlen (string
);
11558 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11560 store_mode_line_noprop_char (*str
++);
11562 /* Fill up with spaces until FIELD_WIDTH reached. */
11563 while (field_width
> 0
11564 && n
< field_width
)
11566 store_mode_line_noprop_char (' ');
11573 /***********************************************************************
11575 ***********************************************************************/
11577 #ifdef HAVE_WINDOW_SYSTEM
11579 /* Set the title of FRAME, if it has changed. The title format is
11580 Vicon_title_format if FRAME is iconified, otherwise it is
11581 frame_title_format. */
11584 x_consider_frame_title (Lisp_Object frame
)
11586 struct frame
*f
= XFRAME (frame
);
11588 if (FRAME_WINDOW_P (f
)
11589 || FRAME_MINIBUF_ONLY_P (f
)
11590 || f
->explicit_name
)
11592 /* Do we have more than one visible frame on this X display? */
11593 Lisp_Object tail
, other_frame
, fmt
;
11594 ptrdiff_t title_start
;
11598 ptrdiff_t count
= SPECPDL_INDEX ();
11600 FOR_EACH_FRAME (tail
, other_frame
)
11602 struct frame
*tf
= XFRAME (other_frame
);
11605 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11606 && !FRAME_MINIBUF_ONLY_P (tf
)
11607 && !EQ (other_frame
, tip_frame
)
11608 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11612 /* Set global variable indicating that multiple frames exist. */
11613 multiple_frames
= CONSP (tail
);
11615 /* Switch to the buffer of selected window of the frame. Set up
11616 mode_line_target so that display_mode_element will output into
11617 mode_line_noprop_buf; then display the title. */
11618 record_unwind_protect (unwind_format_mode_line
,
11619 format_mode_line_unwind_data
11620 (f
, current_buffer
, selected_window
, 0));
11622 Fselect_window (f
->selected_window
, Qt
);
11623 set_buffer_internal_1
11624 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11625 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11627 mode_line_target
= MODE_LINE_TITLE
;
11628 title_start
= MODE_LINE_NOPROP_LEN (0);
11629 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11630 NULL
, DEFAULT_FACE_ID
);
11631 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11632 len
= MODE_LINE_NOPROP_LEN (title_start
);
11633 title
= mode_line_noprop_buf
+ title_start
;
11634 unbind_to (count
, Qnil
);
11636 /* Set the title only if it's changed. This avoids consing in
11637 the common case where it hasn't. (If it turns out that we've
11638 already wasted too much time by walking through the list with
11639 display_mode_element, then we might need to optimize at a
11640 higher level than this.) */
11641 if (! STRINGP (f
->name
)
11642 || SBYTES (f
->name
) != len
11643 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11644 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11648 #endif /* not HAVE_WINDOW_SYSTEM */
11651 /***********************************************************************
11653 ***********************************************************************/
11655 /* Non-zero if we will not redisplay all visible windows. */
11656 #define REDISPLAY_SOME_P() \
11657 ((windows_or_buffers_changed == 0 \
11658 || windows_or_buffers_changed == REDISPLAY_SOME) \
11659 && (update_mode_lines == 0 \
11660 || update_mode_lines == REDISPLAY_SOME))
11662 /* Prepare for redisplay by updating menu-bar item lists when
11663 appropriate. This can call eval. */
11666 prepare_menu_bars (void)
11668 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11669 bool some_windows
= REDISPLAY_SOME_P ();
11670 struct gcpro gcpro1
, gcpro2
;
11671 Lisp_Object tooltip_frame
;
11673 #ifdef HAVE_WINDOW_SYSTEM
11674 tooltip_frame
= tip_frame
;
11676 tooltip_frame
= Qnil
;
11679 if (FUNCTIONP (Vpre_redisplay_function
))
11681 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11682 if (all_windows
&& some_windows
)
11684 Lisp_Object ws
= window_list ();
11685 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11687 Lisp_Object
this = XCAR (ws
);
11688 struct window
*w
= XWINDOW (this);
11690 || XFRAME (w
->frame
)->redisplay
11691 || XBUFFER (w
->contents
)->text
->redisplay
)
11693 windows
= Fcons (this, windows
);
11697 safe__call1 (true, Vpre_redisplay_function
, windows
);
11700 /* Update all frame titles based on their buffer names, etc. We do
11701 this before the menu bars so that the buffer-menu will show the
11702 up-to-date frame titles. */
11703 #ifdef HAVE_WINDOW_SYSTEM
11706 Lisp_Object tail
, frame
;
11708 FOR_EACH_FRAME (tail
, frame
)
11710 struct frame
*f
= XFRAME (frame
);
11711 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11715 && !XBUFFER (w
->contents
)->text
->redisplay
)
11718 if (!EQ (frame
, tooltip_frame
)
11719 && (FRAME_ICONIFIED_P (f
)
11720 || FRAME_VISIBLE_P (f
) == 1
11721 /* Exclude TTY frames that are obscured because they
11722 are not the top frame on their console. This is
11723 because x_consider_frame_title actually switches
11724 to the frame, which for TTY frames means it is
11725 marked as garbaged, and will be completely
11726 redrawn on the next redisplay cycle. This causes
11727 TTY frames to be completely redrawn, when there
11728 are more than one of them, even though nothing
11729 should be changed on display. */
11730 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11731 x_consider_frame_title (frame
);
11734 #endif /* HAVE_WINDOW_SYSTEM */
11736 /* Update the menu bar item lists, if appropriate. This has to be
11737 done before any actual redisplay or generation of display lines. */
11741 Lisp_Object tail
, frame
;
11742 ptrdiff_t count
= SPECPDL_INDEX ();
11743 /* 1 means that update_menu_bar has run its hooks
11744 so any further calls to update_menu_bar shouldn't do so again. */
11745 int menu_bar_hooks_run
= 0;
11747 record_unwind_save_match_data ();
11749 FOR_EACH_FRAME (tail
, frame
)
11751 struct frame
*f
= XFRAME (frame
);
11752 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11754 /* Ignore tooltip frame. */
11755 if (EQ (frame
, tooltip_frame
))
11761 && !XBUFFER (w
->contents
)->text
->redisplay
)
11764 /* If a window on this frame changed size, report that to
11765 the user and clear the size-change flag. */
11766 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11768 Lisp_Object functions
;
11770 /* Clear flag first in case we get an error below. */
11771 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11772 functions
= Vwindow_size_change_functions
;
11773 GCPRO2 (tail
, functions
);
11775 while (CONSP (functions
))
11777 if (!EQ (XCAR (functions
), Qt
))
11778 call1 (XCAR (functions
), frame
);
11779 functions
= XCDR (functions
);
11785 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11786 #ifdef HAVE_WINDOW_SYSTEM
11787 update_tool_bar (f
, 0);
11790 if (windows_or_buffers_changed
11793 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11798 unbind_to (count
, Qnil
);
11802 struct frame
*sf
= SELECTED_FRAME ();
11803 update_menu_bar (sf
, 1, 0);
11804 #ifdef HAVE_WINDOW_SYSTEM
11805 update_tool_bar (sf
, 1);
11811 /* Update the menu bar item list for frame F. This has to be done
11812 before we start to fill in any display lines, because it can call
11815 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11817 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11818 already ran the menu bar hooks for this redisplay, so there
11819 is no need to run them again. The return value is the
11820 updated value of this flag, to pass to the next call. */
11823 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11825 Lisp_Object window
;
11826 register struct window
*w
;
11828 /* If called recursively during a menu update, do nothing. This can
11829 happen when, for instance, an activate-menubar-hook causes a
11831 if (inhibit_menubar_update
)
11834 window
= FRAME_SELECTED_WINDOW (f
);
11835 w
= XWINDOW (window
);
11837 if (FRAME_WINDOW_P (f
)
11839 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11840 || defined (HAVE_NS) || defined (USE_GTK)
11841 FRAME_EXTERNAL_MENU_BAR (f
)
11843 FRAME_MENU_BAR_LINES (f
) > 0
11845 : FRAME_MENU_BAR_LINES (f
) > 0)
11847 /* If the user has switched buffers or windows, we need to
11848 recompute to reflect the new bindings. But we'll
11849 recompute when update_mode_lines is set too; that means
11850 that people can use force-mode-line-update to request
11851 that the menu bar be recomputed. The adverse effect on
11852 the rest of the redisplay algorithm is about the same as
11853 windows_or_buffers_changed anyway. */
11854 if (windows_or_buffers_changed
11855 /* This used to test w->update_mode_line, but we believe
11856 there is no need to recompute the menu in that case. */
11857 || update_mode_lines
11858 || window_buffer_changed (w
))
11860 struct buffer
*prev
= current_buffer
;
11861 ptrdiff_t count
= SPECPDL_INDEX ();
11863 specbind (Qinhibit_menubar_update
, Qt
);
11865 set_buffer_internal_1 (XBUFFER (w
->contents
));
11866 if (save_match_data
)
11867 record_unwind_save_match_data ();
11868 if (NILP (Voverriding_local_map_menu_flag
))
11870 specbind (Qoverriding_terminal_local_map
, Qnil
);
11871 specbind (Qoverriding_local_map
, Qnil
);
11876 /* Run the Lucid hook. */
11877 safe_run_hooks (Qactivate_menubar_hook
);
11879 /* If it has changed current-menubar from previous value,
11880 really recompute the menu-bar from the value. */
11881 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11882 call0 (Qrecompute_lucid_menubar
);
11884 safe_run_hooks (Qmenu_bar_update_hook
);
11889 XSETFRAME (Vmenu_updating_frame
, f
);
11890 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11892 /* Redisplay the menu bar in case we changed it. */
11893 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11894 || defined (HAVE_NS) || defined (USE_GTK)
11895 if (FRAME_WINDOW_P (f
))
11897 #if defined (HAVE_NS)
11898 /* All frames on Mac OS share the same menubar. So only
11899 the selected frame should be allowed to set it. */
11900 if (f
== SELECTED_FRAME ())
11902 set_frame_menubar (f
, 0, 0);
11905 /* On a terminal screen, the menu bar is an ordinary screen
11906 line, and this makes it get updated. */
11907 w
->update_mode_line
= 1;
11908 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11909 /* In the non-toolkit version, the menu bar is an ordinary screen
11910 line, and this makes it get updated. */
11911 w
->update_mode_line
= 1;
11912 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11914 unbind_to (count
, Qnil
);
11915 set_buffer_internal_1 (prev
);
11922 /***********************************************************************
11924 ***********************************************************************/
11926 #ifdef HAVE_WINDOW_SYSTEM
11928 /* Select `frame' temporarily without running all the code in
11930 FIXME: Maybe do_switch_frame should be trimmed down similarly
11931 when `norecord' is set. */
11933 fast_set_selected_frame (Lisp_Object frame
)
11935 if (!EQ (selected_frame
, frame
))
11937 selected_frame
= frame
;
11938 selected_window
= XFRAME (frame
)->selected_window
;
11942 /* Update the tool-bar item list for frame F. This has to be done
11943 before we start to fill in any display lines. Called from
11944 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11945 and restore it here. */
11948 update_tool_bar (struct frame
*f
, int save_match_data
)
11950 #if defined (USE_GTK) || defined (HAVE_NS)
11951 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11953 int do_update
= (WINDOWP (f
->tool_bar_window
)
11954 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11959 Lisp_Object window
;
11962 window
= FRAME_SELECTED_WINDOW (f
);
11963 w
= XWINDOW (window
);
11965 /* If the user has switched buffers or windows, we need to
11966 recompute to reflect the new bindings. But we'll
11967 recompute when update_mode_lines is set too; that means
11968 that people can use force-mode-line-update to request
11969 that the menu bar be recomputed. The adverse effect on
11970 the rest of the redisplay algorithm is about the same as
11971 windows_or_buffers_changed anyway. */
11972 if (windows_or_buffers_changed
11973 || w
->update_mode_line
11974 || update_mode_lines
11975 || window_buffer_changed (w
))
11977 struct buffer
*prev
= current_buffer
;
11978 ptrdiff_t count
= SPECPDL_INDEX ();
11979 Lisp_Object frame
, new_tool_bar
;
11980 int new_n_tool_bar
;
11981 struct gcpro gcpro1
;
11983 /* Set current_buffer to the buffer of the selected
11984 window of the frame, so that we get the right local
11986 set_buffer_internal_1 (XBUFFER (w
->contents
));
11988 /* Save match data, if we must. */
11989 if (save_match_data
)
11990 record_unwind_save_match_data ();
11992 /* Make sure that we don't accidentally use bogus keymaps. */
11993 if (NILP (Voverriding_local_map_menu_flag
))
11995 specbind (Qoverriding_terminal_local_map
, Qnil
);
11996 specbind (Qoverriding_local_map
, Qnil
);
11999 GCPRO1 (new_tool_bar
);
12001 /* We must temporarily set the selected frame to this frame
12002 before calling tool_bar_items, because the calculation of
12003 the tool-bar keymap uses the selected frame (see
12004 `tool-bar-make-keymap' in tool-bar.el). */
12005 eassert (EQ (selected_window
,
12006 /* Since we only explicitly preserve selected_frame,
12007 check that selected_window would be redundant. */
12008 XFRAME (selected_frame
)->selected_window
));
12009 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12010 XSETFRAME (frame
, f
);
12011 fast_set_selected_frame (frame
);
12013 /* Build desired tool-bar items from keymaps. */
12015 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12018 /* Redisplay the tool-bar if we changed it. */
12019 if (new_n_tool_bar
!= f
->n_tool_bar_items
12020 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12022 /* Redisplay that happens asynchronously due to an expose event
12023 may access f->tool_bar_items. Make sure we update both
12024 variables within BLOCK_INPUT so no such event interrupts. */
12026 fset_tool_bar_items (f
, new_tool_bar
);
12027 f
->n_tool_bar_items
= new_n_tool_bar
;
12028 w
->update_mode_line
= 1;
12034 unbind_to (count
, Qnil
);
12035 set_buffer_internal_1 (prev
);
12040 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12042 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12043 F's desired tool-bar contents. F->tool_bar_items must have
12044 been set up previously by calling prepare_menu_bars. */
12047 build_desired_tool_bar_string (struct frame
*f
)
12049 int i
, size
, size_needed
;
12050 struct gcpro gcpro1
, gcpro2
;
12051 Lisp_Object image
, plist
;
12053 image
= plist
= Qnil
;
12054 GCPRO2 (image
, plist
);
12056 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12057 Otherwise, make a new string. */
12059 /* The size of the string we might be able to reuse. */
12060 size
= (STRINGP (f
->desired_tool_bar_string
)
12061 ? SCHARS (f
->desired_tool_bar_string
)
12064 /* We need one space in the string for each image. */
12065 size_needed
= f
->n_tool_bar_items
;
12067 /* Reuse f->desired_tool_bar_string, if possible. */
12068 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12069 fset_desired_tool_bar_string
12070 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12073 Lisp_Object props
= scoped_list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12074 struct gcpro gcpro1
;
12076 Fremove_text_properties (make_number (0), make_number (size
),
12077 props
, f
->desired_tool_bar_string
);
12081 /* Put a `display' property on the string for the images to display,
12082 put a `menu_item' property on tool-bar items with a value that
12083 is the index of the item in F's tool-bar item vector. */
12084 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12086 #define PROP(IDX) \
12087 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12089 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12090 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12091 int hmargin
, vmargin
, relief
, idx
, end
;
12093 /* If image is a vector, choose the image according to the
12095 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12096 if (VECTORP (image
))
12100 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12101 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12104 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12105 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12107 eassert (ASIZE (image
) >= idx
);
12108 image
= AREF (image
, idx
);
12113 /* Ignore invalid image specifications. */
12114 if (!valid_image_p (image
))
12117 /* Display the tool-bar button pressed, or depressed. */
12118 plist
= Fcopy_sequence (XCDR (image
));
12120 /* Compute margin and relief to draw. */
12121 relief
= (tool_bar_button_relief
>= 0
12122 ? tool_bar_button_relief
12123 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12124 hmargin
= vmargin
= relief
;
12126 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12127 INT_MAX
- max (hmargin
, vmargin
)))
12129 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12130 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12132 else if (CONSP (Vtool_bar_button_margin
))
12134 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12135 INT_MAX
- hmargin
))
12136 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12138 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12139 INT_MAX
- vmargin
))
12140 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12143 if (auto_raise_tool_bar_buttons_p
)
12145 /* Add a `:relief' property to the image spec if the item is
12149 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12156 /* If image is selected, display it pressed, i.e. with a
12157 negative relief. If it's not selected, display it with a
12159 plist
= Fplist_put (plist
, QCrelief
,
12161 ? make_number (-relief
)
12162 : make_number (relief
)));
12167 /* Put a margin around the image. */
12168 if (hmargin
|| vmargin
)
12170 if (hmargin
== vmargin
)
12171 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12173 plist
= Fplist_put (plist
, QCmargin
,
12174 Fcons (make_number (hmargin
),
12175 make_number (vmargin
)));
12178 /* If button is not enabled, and we don't have special images
12179 for the disabled state, make the image appear disabled by
12180 applying an appropriate algorithm to it. */
12181 if (!enabled_p
&& idx
< 0)
12182 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12184 /* Put a `display' text property on the string for the image to
12185 display. Put a `menu-item' property on the string that gives
12186 the start of this item's properties in the tool-bar items
12188 image
= Fcons (Qimage
, plist
);
12190 = scoped_list4 (Qdisplay
, image
, Qmenu_item
,
12191 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12192 struct gcpro gcpro1
;
12195 /* Let the last image hide all remaining spaces in the tool bar
12196 string. The string can be longer than needed when we reuse a
12197 previous string. */
12198 if (i
+ 1 == f
->n_tool_bar_items
)
12199 end
= SCHARS (f
->desired_tool_bar_string
);
12202 Fadd_text_properties (make_number (i
), make_number (end
),
12203 props
, f
->desired_tool_bar_string
);
12212 /* Display one line of the tool-bar of frame IT->f.
12214 HEIGHT specifies the desired height of the tool-bar line.
12215 If the actual height of the glyph row is less than HEIGHT, the
12216 row's height is increased to HEIGHT, and the icons are centered
12217 vertically in the new height.
12219 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12220 count a final empty row in case the tool-bar width exactly matches
12225 display_tool_bar_line (struct it
*it
, int height
)
12227 struct glyph_row
*row
= it
->glyph_row
;
12228 int max_x
= it
->last_visible_x
;
12229 struct glyph
*last
;
12231 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12232 clear_glyph_row (row
);
12233 row
->enabled_p
= true;
12234 row
->y
= it
->current_y
;
12236 /* Note that this isn't made use of if the face hasn't a box,
12237 so there's no need to check the face here. */
12238 it
->start_of_box_run_p
= 1;
12240 while (it
->current_x
< max_x
)
12242 int x
, n_glyphs_before
, i
, nglyphs
;
12243 struct it it_before
;
12245 /* Get the next display element. */
12246 if (!get_next_display_element (it
))
12248 /* Don't count empty row if we are counting needed tool-bar lines. */
12249 if (height
< 0 && !it
->hpos
)
12254 /* Produce glyphs. */
12255 n_glyphs_before
= row
->used
[TEXT_AREA
];
12258 PRODUCE_GLYPHS (it
);
12260 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12262 x
= it_before
.current_x
;
12263 while (i
< nglyphs
)
12265 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12267 if (x
+ glyph
->pixel_width
> max_x
)
12269 /* Glyph doesn't fit on line. Backtrack. */
12270 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12272 /* If this is the only glyph on this line, it will never fit on the
12273 tool-bar, so skip it. But ensure there is at least one glyph,
12274 so we don't accidentally disable the tool-bar. */
12275 if (n_glyphs_before
== 0
12276 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12282 x
+= glyph
->pixel_width
;
12286 /* Stop at line end. */
12287 if (ITERATOR_AT_END_OF_LINE_P (it
))
12290 set_iterator_to_next (it
, 1);
12295 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12297 /* Use default face for the border below the tool bar.
12299 FIXME: When auto-resize-tool-bars is grow-only, there is
12300 no additional border below the possibly empty tool-bar lines.
12301 So to make the extra empty lines look "normal", we have to
12302 use the tool-bar face for the border too. */
12303 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12304 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12305 it
->face_id
= DEFAULT_FACE_ID
;
12307 extend_face_to_end_of_line (it
);
12308 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12309 last
->right_box_line_p
= 1;
12310 if (last
== row
->glyphs
[TEXT_AREA
])
12311 last
->left_box_line_p
= 1;
12313 /* Make line the desired height and center it vertically. */
12314 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12316 /* Don't add more than one line height. */
12317 height
%= FRAME_LINE_HEIGHT (it
->f
);
12318 it
->max_ascent
+= height
/ 2;
12319 it
->max_descent
+= (height
+ 1) / 2;
12322 compute_line_metrics (it
);
12324 /* If line is empty, make it occupy the rest of the tool-bar. */
12325 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12327 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12328 row
->visible_height
= row
->height
;
12329 row
->ascent
= row
->phys_ascent
= 0;
12330 row
->extra_line_spacing
= 0;
12333 row
->full_width_p
= 1;
12334 row
->continued_p
= 0;
12335 row
->truncated_on_left_p
= 0;
12336 row
->truncated_on_right_p
= 0;
12338 it
->current_x
= it
->hpos
= 0;
12339 it
->current_y
+= row
->height
;
12345 /* Value is the number of pixels needed to make all tool-bar items of
12346 frame F visible. The actual number of glyph rows needed is
12347 returned in *N_ROWS if non-NULL. */
12349 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12351 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12353 /* tool_bar_height is called from redisplay_tool_bar after building
12354 the desired matrix, so use (unused) mode-line row as temporary row to
12355 avoid destroying the first tool-bar row. */
12356 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12358 /* Initialize an iterator for iteration over
12359 F->desired_tool_bar_string in the tool-bar window of frame F. */
12360 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12361 temp_row
->reversed_p
= false;
12362 it
.first_visible_x
= 0;
12363 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12364 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12365 it
.paragraph_embedding
= L2R
;
12367 while (!ITERATOR_AT_END_P (&it
))
12369 clear_glyph_row (temp_row
);
12370 it
.glyph_row
= temp_row
;
12371 display_tool_bar_line (&it
, -1);
12373 clear_glyph_row (temp_row
);
12375 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12377 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12380 return it
.current_y
;
12382 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12385 #endif /* !USE_GTK && !HAVE_NS */
12387 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12389 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12390 If FRAME is nil or omitted, use the selected frame. Optional argument
12391 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12392 (Lisp_Object frame
, Lisp_Object pixelwise
)
12396 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12397 struct frame
*f
= decode_any_frame (frame
);
12399 if (WINDOWP (f
->tool_bar_window
)
12400 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12402 update_tool_bar (f
, 1);
12403 if (f
->n_tool_bar_items
)
12405 build_desired_tool_bar_string (f
);
12406 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12411 return make_number (height
);
12415 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12416 height should be changed. */
12418 redisplay_tool_bar (struct frame
*f
)
12420 #if defined (USE_GTK) || defined (HAVE_NS)
12422 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12423 update_frame_tool_bar (f
);
12426 #else /* !USE_GTK && !HAVE_NS */
12430 struct glyph_row
*row
;
12432 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12433 do anything. This means you must start with tool-bar-lines
12434 non-zero to get the auto-sizing effect. Or in other words, you
12435 can turn off tool-bars by specifying tool-bar-lines zero. */
12436 if (!WINDOWP (f
->tool_bar_window
)
12437 || (w
= XWINDOW (f
->tool_bar_window
),
12438 WINDOW_TOTAL_LINES (w
) == 0))
12441 /* Set up an iterator for the tool-bar window. */
12442 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12443 it
.first_visible_x
= 0;
12444 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12445 row
= it
.glyph_row
;
12446 row
->reversed_p
= false;
12448 /* Build a string that represents the contents of the tool-bar. */
12449 build_desired_tool_bar_string (f
);
12450 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12451 /* FIXME: This should be controlled by a user option. But it
12452 doesn't make sense to have an R2L tool bar if the menu bar cannot
12453 be drawn also R2L, and making the menu bar R2L is tricky due
12454 toolkit-specific code that implements it. If an R2L tool bar is
12455 ever supported, display_tool_bar_line should also be augmented to
12456 call unproduce_glyphs like display_line and display_string
12458 it
.paragraph_embedding
= L2R
;
12460 if (f
->n_tool_bar_rows
== 0)
12462 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12464 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12466 x_change_tool_bar_height (f
, new_height
);
12467 /* Always do that now. */
12468 clear_glyph_matrix (w
->desired_matrix
);
12469 f
->fonts_changed
= 1;
12474 /* Display as many lines as needed to display all tool-bar items. */
12476 if (f
->n_tool_bar_rows
> 0)
12478 int border
, rows
, height
, extra
;
12480 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12481 border
= XINT (Vtool_bar_border
);
12482 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12483 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12484 else if (EQ (Vtool_bar_border
, Qborder_width
))
12485 border
= f
->border_width
;
12491 rows
= f
->n_tool_bar_rows
;
12492 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12493 extra
= it
.last_visible_y
- border
- height
* rows
;
12495 while (it
.current_y
< it
.last_visible_y
)
12498 if (extra
> 0 && rows
-- > 0)
12500 h
= (extra
+ rows
- 1) / rows
;
12503 display_tool_bar_line (&it
, height
+ h
);
12508 while (it
.current_y
< it
.last_visible_y
)
12509 display_tool_bar_line (&it
, 0);
12512 /* It doesn't make much sense to try scrolling in the tool-bar
12513 window, so don't do it. */
12514 w
->desired_matrix
->no_scrolling_p
= 1;
12515 w
->must_be_updated_p
= 1;
12517 if (!NILP (Vauto_resize_tool_bars
))
12519 int change_height_p
= 0;
12521 /* If we couldn't display everything, change the tool-bar's
12522 height if there is room for more. */
12523 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12524 change_height_p
= 1;
12526 /* We subtract 1 because display_tool_bar_line advances the
12527 glyph_row pointer before returning to its caller. We want to
12528 examine the last glyph row produced by
12529 display_tool_bar_line. */
12530 row
= it
.glyph_row
- 1;
12532 /* If there are blank lines at the end, except for a partially
12533 visible blank line at the end that is smaller than
12534 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12535 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12536 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12537 change_height_p
= 1;
12539 /* If row displays tool-bar items, but is partially visible,
12540 change the tool-bar's height. */
12541 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12542 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12543 change_height_p
= 1;
12545 /* Resize windows as needed by changing the `tool-bar-lines'
12546 frame parameter. */
12547 if (change_height_p
)
12550 int new_height
= tool_bar_height (f
, &nrows
, 1);
12552 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12553 && !f
->minimize_tool_bar_window_p
)
12554 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12555 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12556 f
->minimize_tool_bar_window_p
= 0;
12558 if (change_height_p
)
12560 x_change_tool_bar_height (f
, new_height
);
12561 clear_glyph_matrix (w
->desired_matrix
);
12562 f
->n_tool_bar_rows
= nrows
;
12563 f
->fonts_changed
= 1;
12570 f
->minimize_tool_bar_window_p
= 0;
12573 #endif /* USE_GTK || HAVE_NS */
12576 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12578 /* Get information about the tool-bar item which is displayed in GLYPH
12579 on frame F. Return in *PROP_IDX the index where tool-bar item
12580 properties start in F->tool_bar_items. Value is zero if
12581 GLYPH doesn't display a tool-bar item. */
12584 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12590 /* This function can be called asynchronously, which means we must
12591 exclude any possibility that Fget_text_property signals an
12593 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12594 charpos
= max (0, charpos
);
12596 /* Get the text property `menu-item' at pos. The value of that
12597 property is the start index of this item's properties in
12598 F->tool_bar_items. */
12599 prop
= Fget_text_property (make_number (charpos
),
12600 Qmenu_item
, f
->current_tool_bar_string
);
12601 if (INTEGERP (prop
))
12603 *prop_idx
= XINT (prop
);
12613 /* Get information about the tool-bar item at position X/Y on frame F.
12614 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12615 the current matrix of the tool-bar window of F, or NULL if not
12616 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12617 item in F->tool_bar_items. Value is
12619 -1 if X/Y is not on a tool-bar item
12620 0 if X/Y is on the same item that was highlighted before.
12624 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12625 int *hpos
, int *vpos
, int *prop_idx
)
12627 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12628 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12631 /* Find the glyph under X/Y. */
12632 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12633 if (*glyph
== NULL
)
12636 /* Get the start of this tool-bar item's properties in
12637 f->tool_bar_items. */
12638 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12641 /* Is mouse on the highlighted item? */
12642 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12643 && *vpos
>= hlinfo
->mouse_face_beg_row
12644 && *vpos
<= hlinfo
->mouse_face_end_row
12645 && (*vpos
> hlinfo
->mouse_face_beg_row
12646 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12647 && (*vpos
< hlinfo
->mouse_face_end_row
12648 || *hpos
< hlinfo
->mouse_face_end_col
12649 || hlinfo
->mouse_face_past_end
))
12657 Handle mouse button event on the tool-bar of frame F, at
12658 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12659 0 for button release. MODIFIERS is event modifiers for button
12663 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12666 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12667 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12668 int hpos
, vpos
, prop_idx
;
12669 struct glyph
*glyph
;
12670 Lisp_Object enabled_p
;
12673 /* If not on the highlighted tool-bar item, and mouse-highlight is
12674 non-nil, return. This is so we generate the tool-bar button
12675 click only when the mouse button is released on the same item as
12676 where it was pressed. However, when mouse-highlight is disabled,
12677 generate the click when the button is released regardless of the
12678 highlight, since tool-bar items are not highlighted in that
12680 frame_to_window_pixel_xy (w
, &x
, &y
);
12681 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12683 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12686 /* When mouse-highlight is off, generate the click for the item
12687 where the button was pressed, disregarding where it was
12689 if (NILP (Vmouse_highlight
) && !down_p
)
12690 prop_idx
= f
->last_tool_bar_item
;
12692 /* If item is disabled, do nothing. */
12693 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12694 if (NILP (enabled_p
))
12699 /* Show item in pressed state. */
12700 if (!NILP (Vmouse_highlight
))
12701 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12702 f
->last_tool_bar_item
= prop_idx
;
12706 Lisp_Object key
, frame
;
12707 struct input_event event
;
12708 EVENT_INIT (event
);
12710 /* Show item in released state. */
12711 if (!NILP (Vmouse_highlight
))
12712 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12714 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12716 XSETFRAME (frame
, f
);
12717 event
.kind
= TOOL_BAR_EVENT
;
12718 event
.frame_or_window
= frame
;
12720 kbd_buffer_store_event (&event
);
12722 event
.kind
= TOOL_BAR_EVENT
;
12723 event
.frame_or_window
= frame
;
12725 event
.modifiers
= modifiers
;
12726 kbd_buffer_store_event (&event
);
12727 f
->last_tool_bar_item
= -1;
12732 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12733 tool-bar window-relative coordinates X/Y. Called from
12734 note_mouse_highlight. */
12737 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12739 Lisp_Object window
= f
->tool_bar_window
;
12740 struct window
*w
= XWINDOW (window
);
12741 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12742 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12744 struct glyph
*glyph
;
12745 struct glyph_row
*row
;
12747 Lisp_Object enabled_p
;
12749 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12750 int mouse_down_p
, rc
;
12752 /* Function note_mouse_highlight is called with negative X/Y
12753 values when mouse moves outside of the frame. */
12754 if (x
<= 0 || y
<= 0)
12756 clear_mouse_face (hlinfo
);
12760 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12763 /* Not on tool-bar item. */
12764 clear_mouse_face (hlinfo
);
12768 /* On same tool-bar item as before. */
12769 goto set_help_echo
;
12771 clear_mouse_face (hlinfo
);
12773 /* Mouse is down, but on different tool-bar item? */
12774 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12775 && f
== dpyinfo
->last_mouse_frame
);
12777 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12780 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12782 /* If tool-bar item is not enabled, don't highlight it. */
12783 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12784 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12786 /* Compute the x-position of the glyph. In front and past the
12787 image is a space. We include this in the highlighted area. */
12788 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12789 for (i
= x
= 0; i
< hpos
; ++i
)
12790 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12792 /* Record this as the current active region. */
12793 hlinfo
->mouse_face_beg_col
= hpos
;
12794 hlinfo
->mouse_face_beg_row
= vpos
;
12795 hlinfo
->mouse_face_beg_x
= x
;
12796 hlinfo
->mouse_face_past_end
= 0;
12798 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12799 hlinfo
->mouse_face_end_row
= vpos
;
12800 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12801 hlinfo
->mouse_face_window
= window
;
12802 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12804 /* Display it as active. */
12805 show_mouse_face (hlinfo
, draw
);
12810 /* Set help_echo_string to a help string to display for this tool-bar item.
12811 XTread_socket does the rest. */
12812 help_echo_object
= help_echo_window
= Qnil
;
12813 help_echo_pos
= -1;
12814 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12815 if (NILP (help_echo_string
))
12816 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12819 #endif /* !USE_GTK && !HAVE_NS */
12821 #endif /* HAVE_WINDOW_SYSTEM */
12825 /************************************************************************
12826 Horizontal scrolling
12827 ************************************************************************/
12829 static int hscroll_window_tree (Lisp_Object
);
12830 static int hscroll_windows (Lisp_Object
);
12832 /* For all leaf windows in the window tree rooted at WINDOW, set their
12833 hscroll value so that PT is (i) visible in the window, and (ii) so
12834 that it is not within a certain margin at the window's left and
12835 right border. Value is non-zero if any window's hscroll has been
12839 hscroll_window_tree (Lisp_Object window
)
12841 int hscrolled_p
= 0;
12842 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12843 int hscroll_step_abs
= 0;
12844 double hscroll_step_rel
= 0;
12846 if (hscroll_relative_p
)
12848 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12849 if (hscroll_step_rel
< 0)
12851 hscroll_relative_p
= 0;
12852 hscroll_step_abs
= 0;
12855 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12857 hscroll_step_abs
= XINT (Vhscroll_step
);
12858 if (hscroll_step_abs
< 0)
12859 hscroll_step_abs
= 0;
12862 hscroll_step_abs
= 0;
12864 while (WINDOWP (window
))
12866 struct window
*w
= XWINDOW (window
);
12868 if (WINDOWP (w
->contents
))
12869 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12870 else if (w
->cursor
.vpos
>= 0)
12873 int text_area_width
;
12874 struct glyph_row
*cursor_row
;
12875 struct glyph_row
*bottom_row
;
12878 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12879 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12880 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12882 cursor_row
= bottom_row
- 1;
12884 if (!cursor_row
->enabled_p
)
12886 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12887 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12888 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12890 cursor_row
= bottom_row
- 1;
12892 row_r2l_p
= cursor_row
->reversed_p
;
12894 text_area_width
= window_box_width (w
, TEXT_AREA
);
12896 /* Scroll when cursor is inside this scroll margin. */
12897 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12899 /* If the position of this window's point has explicitly
12900 changed, no more suspend auto hscrolling. */
12901 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12902 w
->suspend_auto_hscroll
= 0;
12904 /* Remember window point. */
12905 Fset_marker (w
->old_pointm
,
12906 ((w
== XWINDOW (selected_window
))
12907 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12908 : Fmarker_position (w
->pointm
)),
12911 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12912 && w
->suspend_auto_hscroll
== 0
12913 /* In some pathological cases, like restoring a window
12914 configuration into a frame that is much smaller than
12915 the one from which the configuration was saved, we
12916 get glyph rows whose start and end have zero buffer
12917 positions, which we cannot handle below. Just skip
12919 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12920 /* For left-to-right rows, hscroll when cursor is either
12921 (i) inside the right hscroll margin, or (ii) if it is
12922 inside the left margin and the window is already
12925 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12926 || (cursor_row
->enabled_p
12927 && cursor_row
->truncated_on_right_p
12928 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12929 /* For right-to-left rows, the logic is similar,
12930 except that rules for scrolling to left and right
12931 are reversed. E.g., if cursor.x <= h_margin, we
12932 need to hscroll "to the right" unconditionally,
12933 and that will scroll the screen to the left so as
12934 to reveal the next portion of the row. */
12936 && ((cursor_row
->enabled_p
12937 /* FIXME: It is confusing to set the
12938 truncated_on_right_p flag when R2L rows
12939 are actually truncated on the left. */
12940 && cursor_row
->truncated_on_right_p
12941 && w
->cursor
.x
<= h_margin
)
12943 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12947 struct buffer
*saved_current_buffer
;
12951 /* Find point in a display of infinite width. */
12952 saved_current_buffer
= current_buffer
;
12953 current_buffer
= XBUFFER (w
->contents
);
12955 if (w
== XWINDOW (selected_window
))
12958 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12960 /* Move iterator to pt starting at cursor_row->start in
12961 a line with infinite width. */
12962 init_to_row_start (&it
, w
, cursor_row
);
12963 it
.last_visible_x
= INFINITY
;
12964 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12965 current_buffer
= saved_current_buffer
;
12967 /* Position cursor in window. */
12968 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12969 hscroll
= max (0, (it
.current_x
12970 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12971 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12972 : (text_area_width
/ 2))))
12973 / FRAME_COLUMN_WIDTH (it
.f
);
12974 else if ((!row_r2l_p
12975 && w
->cursor
.x
>= text_area_width
- h_margin
)
12976 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12978 if (hscroll_relative_p
)
12979 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12982 wanted_x
= text_area_width
12983 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12986 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12990 if (hscroll_relative_p
)
12991 wanted_x
= text_area_width
* hscroll_step_rel
12994 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12997 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12999 hscroll
= max (hscroll
, w
->min_hscroll
);
13001 /* Don't prevent redisplay optimizations if hscroll
13002 hasn't changed, as it will unnecessarily slow down
13004 if (w
->hscroll
!= hscroll
)
13006 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13007 w
->hscroll
= hscroll
;
13016 /* Value is non-zero if hscroll of any leaf window has been changed. */
13017 return hscrolled_p
;
13021 /* Set hscroll so that cursor is visible and not inside horizontal
13022 scroll margins for all windows in the tree rooted at WINDOW. See
13023 also hscroll_window_tree above. Value is non-zero if any window's
13024 hscroll has been changed. If it has, desired matrices on the frame
13025 of WINDOW are cleared. */
13028 hscroll_windows (Lisp_Object window
)
13030 int hscrolled_p
= hscroll_window_tree (window
);
13032 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13033 return hscrolled_p
;
13038 /************************************************************************
13040 ************************************************************************/
13042 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13043 to a non-zero value. This is sometimes handy to have in a debugger
13048 /* First and last unchanged row for try_window_id. */
13050 static int debug_first_unchanged_at_end_vpos
;
13051 static int debug_last_unchanged_at_beg_vpos
;
13053 /* Delta vpos and y. */
13055 static int debug_dvpos
, debug_dy
;
13057 /* Delta in characters and bytes for try_window_id. */
13059 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13061 /* Values of window_end_pos and window_end_vpos at the end of
13064 static ptrdiff_t debug_end_vpos
;
13066 /* Append a string to W->desired_matrix->method. FMT is a printf
13067 format string. If trace_redisplay_p is true also printf the
13068 resulting string to stderr. */
13070 static void debug_method_add (struct window
*, char const *, ...)
13071 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13074 debug_method_add (struct window
*w
, char const *fmt
, ...)
13077 char *method
= w
->desired_matrix
->method
;
13078 int len
= strlen (method
);
13079 int size
= sizeof w
->desired_matrix
->method
;
13080 int remaining
= size
- len
- 1;
13083 if (len
&& remaining
)
13086 --remaining
, ++len
;
13089 va_start (ap
, fmt
);
13090 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13093 if (trace_redisplay_p
)
13094 fprintf (stderr
, "%p (%s): %s\n",
13096 ((BUFFERP (w
->contents
)
13097 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13098 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13103 #endif /* GLYPH_DEBUG */
13106 /* Value is non-zero if all changes in window W, which displays
13107 current_buffer, are in the text between START and END. START is a
13108 buffer position, END is given as a distance from Z. Used in
13109 redisplay_internal for display optimization. */
13112 text_outside_line_unchanged_p (struct window
*w
,
13113 ptrdiff_t start
, ptrdiff_t end
)
13115 int unchanged_p
= 1;
13117 /* If text or overlays have changed, see where. */
13118 if (window_outdated (w
))
13120 /* Gap in the line? */
13121 if (GPT
< start
|| Z
- GPT
< end
)
13124 /* Changes start in front of the line, or end after it? */
13126 && (BEG_UNCHANGED
< start
- 1
13127 || END_UNCHANGED
< end
))
13130 /* If selective display, can't optimize if changes start at the
13131 beginning of the line. */
13133 && INTEGERP (BVAR (current_buffer
, selective_display
))
13134 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13135 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13138 /* If there are overlays at the start or end of the line, these
13139 may have overlay strings with newlines in them. A change at
13140 START, for instance, may actually concern the display of such
13141 overlay strings as well, and they are displayed on different
13142 lines. So, quickly rule out this case. (For the future, it
13143 might be desirable to implement something more telling than
13144 just BEG/END_UNCHANGED.) */
13147 if (BEG
+ BEG_UNCHANGED
== start
13148 && overlay_touches_p (start
))
13150 if (END_UNCHANGED
== end
13151 && overlay_touches_p (Z
- end
))
13155 /* Under bidi reordering, adding or deleting a character in the
13156 beginning of a paragraph, before the first strong directional
13157 character, can change the base direction of the paragraph (unless
13158 the buffer specifies a fixed paragraph direction), which will
13159 require to redisplay the whole paragraph. It might be worthwhile
13160 to find the paragraph limits and widen the range of redisplayed
13161 lines to that, but for now just give up this optimization. */
13162 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13163 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13167 return unchanged_p
;
13171 /* Do a frame update, taking possible shortcuts into account. This is
13172 the main external entry point for redisplay.
13174 If the last redisplay displayed an echo area message and that message
13175 is no longer requested, we clear the echo area or bring back the
13176 mini-buffer if that is in use. */
13181 redisplay_internal ();
13186 overlay_arrow_string_or_property (Lisp_Object var
)
13190 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13193 return Voverlay_arrow_string
;
13196 /* Return 1 if there are any overlay-arrows in current_buffer. */
13198 overlay_arrow_in_current_buffer_p (void)
13202 for (vlist
= Voverlay_arrow_variable_list
;
13204 vlist
= XCDR (vlist
))
13206 Lisp_Object var
= XCAR (vlist
);
13209 if (!SYMBOLP (var
))
13211 val
= find_symbol_value (var
);
13213 && current_buffer
== XMARKER (val
)->buffer
)
13220 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13224 overlay_arrows_changed_p (void)
13228 for (vlist
= Voverlay_arrow_variable_list
;
13230 vlist
= XCDR (vlist
))
13232 Lisp_Object var
= XCAR (vlist
);
13233 Lisp_Object val
, pstr
;
13235 if (!SYMBOLP (var
))
13237 val
= find_symbol_value (var
);
13238 if (!MARKERP (val
))
13240 if (! EQ (COERCE_MARKER (val
),
13241 Fget (var
, Qlast_arrow_position
))
13242 || ! (pstr
= overlay_arrow_string_or_property (var
),
13243 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13249 /* Mark overlay arrows to be updated on next redisplay. */
13252 update_overlay_arrows (int up_to_date
)
13256 for (vlist
= Voverlay_arrow_variable_list
;
13258 vlist
= XCDR (vlist
))
13260 Lisp_Object var
= XCAR (vlist
);
13262 if (!SYMBOLP (var
))
13265 if (up_to_date
> 0)
13267 Lisp_Object val
= find_symbol_value (var
);
13268 Fput (var
, Qlast_arrow_position
,
13269 COERCE_MARKER (val
));
13270 Fput (var
, Qlast_arrow_string
,
13271 overlay_arrow_string_or_property (var
));
13273 else if (up_to_date
< 0
13274 || !NILP (Fget (var
, Qlast_arrow_position
)))
13276 Fput (var
, Qlast_arrow_position
, Qt
);
13277 Fput (var
, Qlast_arrow_string
, Qt
);
13283 /* Return overlay arrow string to display at row.
13284 Return integer (bitmap number) for arrow bitmap in left fringe.
13285 Return nil if no overlay arrow. */
13288 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13292 for (vlist
= Voverlay_arrow_variable_list
;
13294 vlist
= XCDR (vlist
))
13296 Lisp_Object var
= XCAR (vlist
);
13299 if (!SYMBOLP (var
))
13302 val
= find_symbol_value (var
);
13305 && current_buffer
== XMARKER (val
)->buffer
13306 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13308 if (FRAME_WINDOW_P (it
->f
)
13309 /* FIXME: if ROW->reversed_p is set, this should test
13310 the right fringe, not the left one. */
13311 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13313 #ifdef HAVE_WINDOW_SYSTEM
13314 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13317 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13318 return make_number (fringe_bitmap
);
13321 return make_number (-1); /* Use default arrow bitmap. */
13323 return overlay_arrow_string_or_property (var
);
13330 /* Return 1 if point moved out of or into a composition. Otherwise
13331 return 0. PREV_BUF and PREV_PT are the last point buffer and
13332 position. BUF and PT are the current point buffer and position. */
13335 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13336 struct buffer
*buf
, ptrdiff_t pt
)
13338 ptrdiff_t start
, end
;
13340 Lisp_Object buffer
;
13342 XSETBUFFER (buffer
, buf
);
13343 /* Check a composition at the last point if point moved within the
13345 if (prev_buf
== buf
)
13348 /* Point didn't move. */
13351 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13352 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13353 && composition_valid_p (start
, end
, prop
)
13354 && start
< prev_pt
&& end
> prev_pt
)
13355 /* The last point was within the composition. Return 1 iff
13356 point moved out of the composition. */
13357 return (pt
<= start
|| pt
>= end
);
13360 /* Check a composition at the current point. */
13361 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13362 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13363 && composition_valid_p (start
, end
, prop
)
13364 && start
< pt
&& end
> pt
);
13367 /* Reconsider the clip changes of buffer which is displayed in W. */
13370 reconsider_clip_changes (struct window
*w
)
13372 struct buffer
*b
= XBUFFER (w
->contents
);
13374 if (b
->clip_changed
13375 && w
->window_end_valid
13376 && w
->current_matrix
->buffer
== b
13377 && w
->current_matrix
->zv
== BUF_ZV (b
)
13378 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13379 b
->clip_changed
= 0;
13381 /* If display wasn't paused, and W is not a tool bar window, see if
13382 point has been moved into or out of a composition. In that case,
13383 we set b->clip_changed to 1 to force updating the screen. If
13384 b->clip_changed has already been set to 1, we can skip this
13386 if (!b
->clip_changed
&& w
->window_end_valid
)
13388 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13389 ? PT
: marker_position (w
->pointm
));
13391 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13392 && check_point_in_composition (w
->current_matrix
->buffer
,
13393 w
->last_point
, b
, pt
))
13394 b
->clip_changed
= 1;
13399 propagate_buffer_redisplay (void)
13400 { /* Resetting b->text->redisplay is problematic!
13401 We can't just reset it in the case that some window that displays
13402 it has not been redisplayed; and such a window can stay
13403 unredisplayed for a long time if it's currently invisible.
13404 But we do want to reset it at the end of redisplay otherwise
13405 its displayed windows will keep being redisplayed over and over
13407 So we copy all b->text->redisplay flags up to their windows here,
13408 such that mark_window_display_accurate can safely reset
13409 b->text->redisplay. */
13410 Lisp_Object ws
= window_list ();
13411 for (; CONSP (ws
); ws
= XCDR (ws
))
13413 struct window
*thisw
= XWINDOW (XCAR (ws
));
13414 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13415 if (thisb
->text
->redisplay
)
13416 thisw
->redisplay
= true;
13420 #define STOP_POLLING \
13421 do { if (! polling_stopped_here) stop_polling (); \
13422 polling_stopped_here = 1; } while (0)
13424 #define RESUME_POLLING \
13425 do { if (polling_stopped_here) start_polling (); \
13426 polling_stopped_here = 0; } while (0)
13429 /* Perhaps in the future avoid recentering windows if it
13430 is not necessary; currently that causes some problems. */
13433 redisplay_internal (void)
13435 struct window
*w
= XWINDOW (selected_window
);
13439 bool must_finish
= 0, match_p
;
13440 struct text_pos tlbufpos
, tlendpos
;
13441 int number_of_visible_frames
;
13444 int polling_stopped_here
= 0;
13445 Lisp_Object tail
, frame
;
13447 /* True means redisplay has to consider all windows on all
13448 frames. False, only selected_window is considered. */
13449 bool consider_all_windows_p
;
13451 /* True means redisplay has to redisplay the miniwindow. */
13452 bool update_miniwindow_p
= false;
13454 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13456 /* No redisplay if running in batch mode or frame is not yet fully
13457 initialized, or redisplay is explicitly turned off by setting
13458 Vinhibit_redisplay. */
13459 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13460 || !NILP (Vinhibit_redisplay
))
13463 /* Don't examine these until after testing Vinhibit_redisplay.
13464 When Emacs is shutting down, perhaps because its connection to
13465 X has dropped, we should not look at them at all. */
13466 fr
= XFRAME (w
->frame
);
13467 sf
= SELECTED_FRAME ();
13469 if (!fr
->glyphs_initialized_p
)
13472 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13473 if (popup_activated ())
13477 /* I don't think this happens but let's be paranoid. */
13478 if (redisplaying_p
)
13481 /* Record a function that clears redisplaying_p
13482 when we leave this function. */
13483 count
= SPECPDL_INDEX ();
13484 record_unwind_protect_void (unwind_redisplay
);
13485 redisplaying_p
= 1;
13486 specbind (Qinhibit_free_realized_faces
, Qnil
);
13488 /* Record this function, so it appears on the profiler's backtraces. */
13489 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13491 FOR_EACH_FRAME (tail
, frame
)
13492 XFRAME (frame
)->already_hscrolled_p
= 0;
13495 /* Remember the currently selected window. */
13499 last_escape_glyph_frame
= NULL
;
13500 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13501 last_glyphless_glyph_frame
= NULL
;
13502 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13504 /* If face_change_count is non-zero, init_iterator will free all
13505 realized faces, which includes the faces referenced from current
13506 matrices. So, we can't reuse current matrices in this case. */
13507 if (face_change_count
)
13508 windows_or_buffers_changed
= 47;
13510 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13511 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13513 /* Since frames on a single ASCII terminal share the same
13514 display area, displaying a different frame means redisplay
13515 the whole thing. */
13516 SET_FRAME_GARBAGED (sf
);
13518 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13520 FRAME_TTY (sf
)->previous_frame
= sf
;
13523 /* Set the visible flags for all frames. Do this before checking for
13524 resized or garbaged frames; they want to know if their frames are
13525 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13526 number_of_visible_frames
= 0;
13528 FOR_EACH_FRAME (tail
, frame
)
13530 struct frame
*f
= XFRAME (frame
);
13532 if (FRAME_VISIBLE_P (f
))
13534 ++number_of_visible_frames
;
13535 /* Adjust matrices for visible frames only. */
13536 if (f
->fonts_changed
)
13538 adjust_frame_glyphs (f
);
13539 f
->fonts_changed
= 0;
13541 /* If cursor type has been changed on the frame
13542 other than selected, consider all frames. */
13543 if (f
!= sf
&& f
->cursor_type_changed
)
13544 update_mode_lines
= 31;
13546 clear_desired_matrices (f
);
13549 /* Notice any pending interrupt request to change frame size. */
13550 do_pending_window_change (1);
13552 /* do_pending_window_change could change the selected_window due to
13553 frame resizing which makes the selected window too small. */
13554 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13557 /* Clear frames marked as garbaged. */
13558 clear_garbaged_frames ();
13560 /* Build menubar and tool-bar items. */
13561 if (NILP (Vmemory_full
))
13562 prepare_menu_bars ();
13564 reconsider_clip_changes (w
);
13566 /* In most cases selected window displays current buffer. */
13567 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13570 /* Detect case that we need to write or remove a star in the mode line. */
13571 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13572 w
->update_mode_line
= 1;
13574 if (mode_line_update_needed (w
))
13575 w
->update_mode_line
= 1;
13577 /* If reconsider_clip_changes above decided that the narrowing
13578 in the current buffer changed, make sure all other windows
13579 showing that buffer will be redisplayed. */
13580 if (current_buffer
->clip_changed
)
13581 bset_update_mode_line (current_buffer
);
13584 /* Normally the message* functions will have already displayed and
13585 updated the echo area, but the frame may have been trashed, or
13586 the update may have been preempted, so display the echo area
13587 again here. Checking message_cleared_p captures the case that
13588 the echo area should be cleared. */
13589 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13590 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13591 || (message_cleared_p
13592 && minibuf_level
== 0
13593 /* If the mini-window is currently selected, this means the
13594 echo-area doesn't show through. */
13595 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13597 int window_height_changed_p
= echo_area_display (0);
13599 if (message_cleared_p
)
13600 update_miniwindow_p
= true;
13604 /* If we don't display the current message, don't clear the
13605 message_cleared_p flag, because, if we did, we wouldn't clear
13606 the echo area in the next redisplay which doesn't preserve
13608 if (!display_last_displayed_message_p
)
13609 message_cleared_p
= 0;
13611 if (window_height_changed_p
)
13613 windows_or_buffers_changed
= 50;
13615 /* If window configuration was changed, frames may have been
13616 marked garbaged. Clear them or we will experience
13617 surprises wrt scrolling. */
13618 clear_garbaged_frames ();
13621 else if (EQ (selected_window
, minibuf_window
)
13622 && (current_buffer
->clip_changed
|| window_outdated (w
))
13623 && resize_mini_window (w
, 0))
13625 /* Resized active mini-window to fit the size of what it is
13626 showing if its contents might have changed. */
13629 /* If window configuration was changed, frames may have been
13630 marked garbaged. Clear them or we will experience
13631 surprises wrt scrolling. */
13632 clear_garbaged_frames ();
13635 if (windows_or_buffers_changed
&& !update_mode_lines
)
13636 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13637 only the windows's contents needs to be refreshed, or whether the
13638 mode-lines also need a refresh. */
13639 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13640 ? REDISPLAY_SOME
: 32);
13642 /* If specs for an arrow have changed, do thorough redisplay
13643 to ensure we remove any arrow that should no longer exist. */
13644 if (overlay_arrows_changed_p ())
13645 /* Apparently, this is the only case where we update other windows,
13646 without updating other mode-lines. */
13647 windows_or_buffers_changed
= 49;
13649 consider_all_windows_p
= (update_mode_lines
13650 || windows_or_buffers_changed
);
13652 #define AINC(a,i) \
13653 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13654 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13656 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13657 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13659 /* Optimize the case that only the line containing the cursor in the
13660 selected window has changed. Variables starting with this_ are
13661 set in display_line and record information about the line
13662 containing the cursor. */
13663 tlbufpos
= this_line_start_pos
;
13664 tlendpos
= this_line_end_pos
;
13665 if (!consider_all_windows_p
13666 && CHARPOS (tlbufpos
) > 0
13667 && !w
->update_mode_line
13668 && !current_buffer
->clip_changed
13669 && !current_buffer
->prevent_redisplay_optimizations_p
13670 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13671 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13672 && !XFRAME (w
->frame
)->cursor_type_changed
13673 /* Make sure recorded data applies to current buffer, etc. */
13674 && this_line_buffer
== current_buffer
13677 && !w
->optional_new_start
13678 /* Point must be on the line that we have info recorded about. */
13679 && PT
>= CHARPOS (tlbufpos
)
13680 && PT
<= Z
- CHARPOS (tlendpos
)
13681 /* All text outside that line, including its final newline,
13682 must be unchanged. */
13683 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13684 CHARPOS (tlendpos
)))
13686 if (CHARPOS (tlbufpos
) > BEGV
13687 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13688 && (CHARPOS (tlbufpos
) == ZV
13689 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13690 /* Former continuation line has disappeared by becoming empty. */
13692 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13694 /* We have to handle the case of continuation around a
13695 wide-column character (see the comment in indent.c around
13698 For instance, in the following case:
13700 -------- Insert --------
13701 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13702 J_I_ ==> J_I_ `^^' are cursors.
13706 As we have to redraw the line above, we cannot use this
13710 int line_height_before
= this_line_pixel_height
;
13712 /* Note that start_display will handle the case that the
13713 line starting at tlbufpos is a continuation line. */
13714 start_display (&it
, w
, tlbufpos
);
13716 /* Implementation note: It this still necessary? */
13717 if (it
.current_x
!= this_line_start_x
)
13720 TRACE ((stderr
, "trying display optimization 1\n"));
13721 w
->cursor
.vpos
= -1;
13722 overlay_arrow_seen
= 0;
13723 it
.vpos
= this_line_vpos
;
13724 it
.current_y
= this_line_y
;
13725 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13726 display_line (&it
);
13728 /* If line contains point, is not continued,
13729 and ends at same distance from eob as before, we win. */
13730 if (w
->cursor
.vpos
>= 0
13731 /* Line is not continued, otherwise this_line_start_pos
13732 would have been set to 0 in display_line. */
13733 && CHARPOS (this_line_start_pos
)
13734 /* Line ends as before. */
13735 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13736 /* Line has same height as before. Otherwise other lines
13737 would have to be shifted up or down. */
13738 && this_line_pixel_height
== line_height_before
)
13740 /* If this is not the window's last line, we must adjust
13741 the charstarts of the lines below. */
13742 if (it
.current_y
< it
.last_visible_y
)
13744 struct glyph_row
*row
13745 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13746 ptrdiff_t delta
, delta_bytes
;
13748 /* We used to distinguish between two cases here,
13749 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13750 when the line ends in a newline or the end of the
13751 buffer's accessible portion. But both cases did
13752 the same, so they were collapsed. */
13754 - CHARPOS (tlendpos
)
13755 - MATRIX_ROW_START_CHARPOS (row
));
13756 delta_bytes
= (Z_BYTE
13757 - BYTEPOS (tlendpos
)
13758 - MATRIX_ROW_START_BYTEPOS (row
));
13760 increment_matrix_positions (w
->current_matrix
,
13761 this_line_vpos
+ 1,
13762 w
->current_matrix
->nrows
,
13763 delta
, delta_bytes
);
13766 /* If this row displays text now but previously didn't,
13767 or vice versa, w->window_end_vpos may have to be
13769 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13771 if (w
->window_end_vpos
< this_line_vpos
)
13772 w
->window_end_vpos
= this_line_vpos
;
13774 else if (w
->window_end_vpos
== this_line_vpos
13775 && this_line_vpos
> 0)
13776 w
->window_end_vpos
= this_line_vpos
- 1;
13777 w
->window_end_valid
= 0;
13779 /* Update hint: No need to try to scroll in update_window. */
13780 w
->desired_matrix
->no_scrolling_p
= 1;
13783 *w
->desired_matrix
->method
= 0;
13784 debug_method_add (w
, "optimization 1");
13786 #ifdef HAVE_WINDOW_SYSTEM
13787 update_window_fringes (w
, 0);
13794 else if (/* Cursor position hasn't changed. */
13795 PT
== w
->last_point
13796 /* Make sure the cursor was last displayed
13797 in this window. Otherwise we have to reposition it. */
13799 /* PXW: Must be converted to pixels, probably. */
13800 && 0 <= w
->cursor
.vpos
13801 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13805 do_pending_window_change (1);
13806 /* If selected_window changed, redisplay again. */
13807 if (WINDOWP (selected_window
)
13808 && (w
= XWINDOW (selected_window
)) != sw
)
13811 /* We used to always goto end_of_redisplay here, but this
13812 isn't enough if we have a blinking cursor. */
13813 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13814 goto end_of_redisplay
;
13818 /* If highlighting the region, or if the cursor is in the echo area,
13819 then we can't just move the cursor. */
13820 else if (NILP (Vshow_trailing_whitespace
)
13821 && !cursor_in_echo_area
)
13824 struct glyph_row
*row
;
13826 /* Skip from tlbufpos to PT and see where it is. Note that
13827 PT may be in invisible text. If so, we will end at the
13828 next visible position. */
13829 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13830 NULL
, DEFAULT_FACE_ID
);
13831 it
.current_x
= this_line_start_x
;
13832 it
.current_y
= this_line_y
;
13833 it
.vpos
= this_line_vpos
;
13835 /* The call to move_it_to stops in front of PT, but
13836 moves over before-strings. */
13837 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13839 if (it
.vpos
== this_line_vpos
13840 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13843 eassert (this_line_vpos
== it
.vpos
);
13844 eassert (this_line_y
== it
.current_y
);
13845 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13847 *w
->desired_matrix
->method
= 0;
13848 debug_method_add (w
, "optimization 3");
13857 /* Text changed drastically or point moved off of line. */
13858 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13861 CHARPOS (this_line_start_pos
) = 0;
13862 ++clear_face_cache_count
;
13863 #ifdef HAVE_WINDOW_SYSTEM
13864 ++clear_image_cache_count
;
13867 /* Build desired matrices, and update the display. If
13868 consider_all_windows_p is non-zero, do it for all windows on all
13869 frames. Otherwise do it for selected_window, only. */
13871 if (consider_all_windows_p
)
13873 FOR_EACH_FRAME (tail
, frame
)
13874 XFRAME (frame
)->updated_p
= 0;
13876 propagate_buffer_redisplay ();
13878 FOR_EACH_FRAME (tail
, frame
)
13880 struct frame
*f
= XFRAME (frame
);
13882 /* We don't have to do anything for unselected terminal
13884 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13885 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13890 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13893 /* Only GC scrollbars when we redisplay the whole frame. */
13894 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13895 /* Mark all the scroll bars to be removed; we'll redeem
13896 the ones we want when we redisplay their windows. */
13897 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13898 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13900 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13901 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13902 /* Remember that the invisible frames need to be redisplayed next
13903 time they're visible. */
13904 else if (!REDISPLAY_SOME_P ())
13905 f
->redisplay
= true;
13907 /* The X error handler may have deleted that frame. */
13908 if (!FRAME_LIVE_P (f
))
13911 /* Any scroll bars which redisplay_windows should have
13912 nuked should now go away. */
13913 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13914 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13916 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13918 /* If fonts changed on visible frame, display again. */
13919 if (f
->fonts_changed
)
13921 adjust_frame_glyphs (f
);
13922 f
->fonts_changed
= 0;
13926 /* See if we have to hscroll. */
13927 if (!f
->already_hscrolled_p
)
13929 f
->already_hscrolled_p
= 1;
13930 if (hscroll_windows (f
->root_window
))
13934 /* Prevent various kinds of signals during display
13935 update. stdio is not robust about handling
13936 signals, which can cause an apparent I/O error. */
13937 if (interrupt_input
)
13938 unrequest_sigio ();
13941 pending
|= update_frame (f
, 0, 0);
13942 f
->cursor_type_changed
= 0;
13948 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13952 /* Do the mark_window_display_accurate after all windows have
13953 been redisplayed because this call resets flags in buffers
13954 which are needed for proper redisplay. */
13955 FOR_EACH_FRAME (tail
, frame
)
13957 struct frame
*f
= XFRAME (frame
);
13960 f
->redisplay
= false;
13961 mark_window_display_accurate (f
->root_window
, 1);
13962 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13963 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13968 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13970 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13971 struct frame
*mini_frame
;
13973 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13974 /* Use list_of_error, not Qerror, so that
13975 we catch only errors and don't run the debugger. */
13976 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13978 redisplay_window_error
);
13979 if (update_miniwindow_p
)
13980 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13982 redisplay_window_error
);
13984 /* Compare desired and current matrices, perform output. */
13987 /* If fonts changed, display again. */
13988 if (sf
->fonts_changed
)
13991 /* Prevent various kinds of signals during display update.
13992 stdio is not robust about handling signals,
13993 which can cause an apparent I/O error. */
13994 if (interrupt_input
)
13995 unrequest_sigio ();
13998 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
14000 if (hscroll_windows (selected_window
))
14003 XWINDOW (selected_window
)->must_be_updated_p
= true;
14004 pending
= update_frame (sf
, 0, 0);
14005 sf
->cursor_type_changed
= 0;
14008 /* We may have called echo_area_display at the top of this
14009 function. If the echo area is on another frame, that may
14010 have put text on a frame other than the selected one, so the
14011 above call to update_frame would not have caught it. Catch
14013 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14014 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14016 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14018 XWINDOW (mini_window
)->must_be_updated_p
= true;
14019 pending
|= update_frame (mini_frame
, 0, 0);
14020 mini_frame
->cursor_type_changed
= 0;
14021 if (!pending
&& hscroll_windows (mini_window
))
14026 /* If display was paused because of pending input, make sure we do a
14027 thorough update the next time. */
14030 /* Prevent the optimization at the beginning of
14031 redisplay_internal that tries a single-line update of the
14032 line containing the cursor in the selected window. */
14033 CHARPOS (this_line_start_pos
) = 0;
14035 /* Let the overlay arrow be updated the next time. */
14036 update_overlay_arrows (0);
14038 /* If we pause after scrolling, some rows in the current
14039 matrices of some windows are not valid. */
14040 if (!WINDOW_FULL_WIDTH_P (w
)
14041 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14042 update_mode_lines
= 36;
14046 if (!consider_all_windows_p
)
14048 /* This has already been done above if
14049 consider_all_windows_p is set. */
14050 if (XBUFFER (w
->contents
)->text
->redisplay
14051 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14052 /* This can happen if b->text->redisplay was set during
14054 propagate_buffer_redisplay ();
14055 mark_window_display_accurate_1 (w
, 1);
14057 /* Say overlay arrows are up to date. */
14058 update_overlay_arrows (1);
14060 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14061 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14064 update_mode_lines
= 0;
14065 windows_or_buffers_changed
= 0;
14068 /* Start SIGIO interrupts coming again. Having them off during the
14069 code above makes it less likely one will discard output, but not
14070 impossible, since there might be stuff in the system buffer here.
14071 But it is much hairier to try to do anything about that. */
14072 if (interrupt_input
)
14076 /* If a frame has become visible which was not before, redisplay
14077 again, so that we display it. Expose events for such a frame
14078 (which it gets when becoming visible) don't call the parts of
14079 redisplay constructing glyphs, so simply exposing a frame won't
14080 display anything in this case. So, we have to display these
14081 frames here explicitly. */
14086 FOR_EACH_FRAME (tail
, frame
)
14088 if (XFRAME (frame
)->visible
)
14092 if (new_count
!= number_of_visible_frames
)
14093 windows_or_buffers_changed
= 52;
14096 /* Change frame size now if a change is pending. */
14097 do_pending_window_change (1);
14099 /* If we just did a pending size change, or have additional
14100 visible frames, or selected_window changed, redisplay again. */
14101 if ((windows_or_buffers_changed
&& !pending
)
14102 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14105 /* Clear the face and image caches.
14107 We used to do this only if consider_all_windows_p. But the cache
14108 needs to be cleared if a timer creates images in the current
14109 buffer (e.g. the test case in Bug#6230). */
14111 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14113 clear_face_cache (0);
14114 clear_face_cache_count
= 0;
14117 #ifdef HAVE_WINDOW_SYSTEM
14118 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14120 clear_image_caches (Qnil
);
14121 clear_image_cache_count
= 0;
14123 #endif /* HAVE_WINDOW_SYSTEM */
14126 if (interrupt_input
&& interrupts_deferred
)
14129 unbind_to (count
, Qnil
);
14134 /* Redisplay, but leave alone any recent echo area message unless
14135 another message has been requested in its place.
14137 This is useful in situations where you need to redisplay but no
14138 user action has occurred, making it inappropriate for the message
14139 area to be cleared. See tracking_off and
14140 wait_reading_process_output for examples of these situations.
14142 FROM_WHERE is an integer saying from where this function was
14143 called. This is useful for debugging. */
14146 redisplay_preserve_echo_area (int from_where
)
14148 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14150 if (!NILP (echo_area_buffer
[1]))
14152 /* We have a previously displayed message, but no current
14153 message. Redisplay the previous message. */
14154 display_last_displayed_message_p
= 1;
14155 redisplay_internal ();
14156 display_last_displayed_message_p
= 0;
14159 redisplay_internal ();
14161 flush_frame (SELECTED_FRAME ());
14165 /* Function registered with record_unwind_protect in redisplay_internal. */
14168 unwind_redisplay (void)
14170 redisplaying_p
= 0;
14174 /* Mark the display of leaf window W as accurate or inaccurate.
14175 If ACCURATE_P is non-zero mark display of W as accurate. If
14176 ACCURATE_P is zero, arrange for W to be redisplayed the next
14177 time redisplay_internal is called. */
14180 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14182 struct buffer
*b
= XBUFFER (w
->contents
);
14184 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14185 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14186 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14190 b
->clip_changed
= false;
14191 b
->prevent_redisplay_optimizations_p
= false;
14192 eassert (buffer_window_count (b
) > 0);
14193 /* Resetting b->text->redisplay is problematic!
14194 In order to make it safer to do it here, redisplay_internal must
14195 have copied all b->text->redisplay to their respective windows. */
14196 b
->text
->redisplay
= false;
14198 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14199 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14200 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14201 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14203 w
->current_matrix
->buffer
= b
;
14204 w
->current_matrix
->begv
= BUF_BEGV (b
);
14205 w
->current_matrix
->zv
= BUF_ZV (b
);
14207 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14208 w
->last_cursor_off_p
= w
->cursor_off_p
;
14210 if (w
== XWINDOW (selected_window
))
14211 w
->last_point
= BUF_PT (b
);
14213 w
->last_point
= marker_position (w
->pointm
);
14215 w
->window_end_valid
= true;
14216 w
->update_mode_line
= false;
14219 w
->redisplay
= !accurate_p
;
14223 /* Mark the display of windows in the window tree rooted at WINDOW as
14224 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14225 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14226 be redisplayed the next time redisplay_internal is called. */
14229 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14233 for (; !NILP (window
); window
= w
->next
)
14235 w
= XWINDOW (window
);
14236 if (WINDOWP (w
->contents
))
14237 mark_window_display_accurate (w
->contents
, accurate_p
);
14239 mark_window_display_accurate_1 (w
, accurate_p
);
14243 update_overlay_arrows (1);
14245 /* Force a thorough redisplay the next time by setting
14246 last_arrow_position and last_arrow_string to t, which is
14247 unequal to any useful value of Voverlay_arrow_... */
14248 update_overlay_arrows (-1);
14252 /* Return value in display table DP (Lisp_Char_Table *) for character
14253 C. Since a display table doesn't have any parent, we don't have to
14254 follow parent. Do not call this function directly but use the
14255 macro DISP_CHAR_VECTOR. */
14258 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14262 if (ASCII_CHAR_P (c
))
14265 if (SUB_CHAR_TABLE_P (val
))
14266 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14272 XSETCHAR_TABLE (table
, dp
);
14273 val
= char_table_ref (table
, c
);
14282 /***********************************************************************
14284 ***********************************************************************/
14286 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14289 redisplay_windows (Lisp_Object window
)
14291 while (!NILP (window
))
14293 struct window
*w
= XWINDOW (window
);
14295 if (WINDOWP (w
->contents
))
14296 redisplay_windows (w
->contents
);
14297 else if (BUFFERP (w
->contents
))
14299 displayed_buffer
= XBUFFER (w
->contents
);
14300 /* Use list_of_error, not Qerror, so that
14301 we catch only errors and don't run the debugger. */
14302 internal_condition_case_1 (redisplay_window_0
, window
,
14304 redisplay_window_error
);
14312 redisplay_window_error (Lisp_Object ignore
)
14314 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14319 redisplay_window_0 (Lisp_Object window
)
14321 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14322 redisplay_window (window
, false);
14327 redisplay_window_1 (Lisp_Object window
)
14329 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14330 redisplay_window (window
, true);
14335 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14336 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14337 which positions recorded in ROW differ from current buffer
14340 Return 0 if cursor is not on this row, 1 otherwise. */
14343 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14344 struct glyph_matrix
*matrix
,
14345 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14348 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14349 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14350 struct glyph
*cursor
= NULL
;
14351 /* The last known character position in row. */
14352 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14354 ptrdiff_t pt_old
= PT
- delta
;
14355 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14356 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14357 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14358 /* A glyph beyond the edge of TEXT_AREA which we should never
14360 struct glyph
*glyphs_end
= end
;
14361 /* Non-zero means we've found a match for cursor position, but that
14362 glyph has the avoid_cursor_p flag set. */
14363 int match_with_avoid_cursor
= 0;
14364 /* Non-zero means we've seen at least one glyph that came from a
14366 int string_seen
= 0;
14367 /* Largest and smallest buffer positions seen so far during scan of
14369 ptrdiff_t bpos_max
= pos_before
;
14370 ptrdiff_t bpos_min
= pos_after
;
14371 /* Last buffer position covered by an overlay string with an integer
14372 `cursor' property. */
14373 ptrdiff_t bpos_covered
= 0;
14374 /* Non-zero means the display string on which to display the cursor
14375 comes from a text property, not from an overlay. */
14376 int string_from_text_prop
= 0;
14378 /* Don't even try doing anything if called for a mode-line or
14379 header-line row, since the rest of the code isn't prepared to
14380 deal with such calamities. */
14381 eassert (!row
->mode_line_p
);
14382 if (row
->mode_line_p
)
14385 /* Skip over glyphs not having an object at the start and the end of
14386 the row. These are special glyphs like truncation marks on
14387 terminal frames. */
14388 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14390 if (!row
->reversed_p
)
14393 && INTEGERP (glyph
->object
)
14394 && glyph
->charpos
< 0)
14396 x
+= glyph
->pixel_width
;
14400 && INTEGERP ((end
- 1)->object
)
14401 /* CHARPOS is zero for blanks and stretch glyphs
14402 inserted by extend_face_to_end_of_line. */
14403 && (end
- 1)->charpos
<= 0)
14405 glyph_before
= glyph
- 1;
14412 /* If the glyph row is reversed, we need to process it from back
14413 to front, so swap the edge pointers. */
14414 glyphs_end
= end
= glyph
- 1;
14415 glyph
+= row
->used
[TEXT_AREA
] - 1;
14417 while (glyph
> end
+ 1
14418 && INTEGERP (glyph
->object
)
14419 && glyph
->charpos
< 0)
14422 x
-= glyph
->pixel_width
;
14424 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14426 /* By default, in reversed rows we put the cursor on the
14427 rightmost (first in the reading order) glyph. */
14428 for (g
= end
+ 1; g
< glyph
; g
++)
14429 x
+= g
->pixel_width
;
14431 && INTEGERP ((end
+ 1)->object
)
14432 && (end
+ 1)->charpos
<= 0)
14434 glyph_before
= glyph
+ 1;
14438 else if (row
->reversed_p
)
14440 /* In R2L rows that don't display text, put the cursor on the
14441 rightmost glyph. Case in point: an empty last line that is
14442 part of an R2L paragraph. */
14444 /* Avoid placing the cursor on the last glyph of the row, where
14445 on terminal frames we hold the vertical border between
14446 adjacent windows. */
14447 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14448 && !WINDOW_RIGHTMOST_P (w
)
14449 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14451 x
= -1; /* will be computed below, at label compute_x */
14454 /* Step 1: Try to find the glyph whose character position
14455 corresponds to point. If that's not possible, find 2 glyphs
14456 whose character positions are the closest to point, one before
14457 point, the other after it. */
14458 if (!row
->reversed_p
)
14459 while (/* not marched to end of glyph row */
14461 /* glyph was not inserted by redisplay for internal purposes */
14462 && !INTEGERP (glyph
->object
))
14464 if (BUFFERP (glyph
->object
))
14466 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14468 if (glyph
->charpos
> bpos_max
)
14469 bpos_max
= glyph
->charpos
;
14470 if (glyph
->charpos
< bpos_min
)
14471 bpos_min
= glyph
->charpos
;
14472 if (!glyph
->avoid_cursor_p
)
14474 /* If we hit point, we've found the glyph on which to
14475 display the cursor. */
14478 match_with_avoid_cursor
= 0;
14481 /* See if we've found a better approximation to
14482 POS_BEFORE or to POS_AFTER. */
14483 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14485 pos_before
= glyph
->charpos
;
14486 glyph_before
= glyph
;
14488 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14490 pos_after
= glyph
->charpos
;
14491 glyph_after
= glyph
;
14494 else if (dpos
== 0)
14495 match_with_avoid_cursor
= 1;
14497 else if (STRINGP (glyph
->object
))
14499 Lisp_Object chprop
;
14500 ptrdiff_t glyph_pos
= glyph
->charpos
;
14502 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14504 if (!NILP (chprop
))
14506 /* If the string came from a `display' text property,
14507 look up the buffer position of that property and
14508 use that position to update bpos_max, as if we
14509 actually saw such a position in one of the row's
14510 glyphs. This helps with supporting integer values
14511 of `cursor' property on the display string in
14512 situations where most or all of the row's buffer
14513 text is completely covered by display properties,
14514 so that no glyph with valid buffer positions is
14515 ever seen in the row. */
14516 ptrdiff_t prop_pos
=
14517 string_buffer_position_lim (glyph
->object
, pos_before
,
14520 if (prop_pos
>= pos_before
)
14521 bpos_max
= prop_pos
;
14523 if (INTEGERP (chprop
))
14525 bpos_covered
= bpos_max
+ XINT (chprop
);
14526 /* If the `cursor' property covers buffer positions up
14527 to and including point, we should display cursor on
14528 this glyph. Note that, if a `cursor' property on one
14529 of the string's characters has an integer value, we
14530 will break out of the loop below _before_ we get to
14531 the position match above. IOW, integer values of
14532 the `cursor' property override the "exact match for
14533 point" strategy of positioning the cursor. */
14534 /* Implementation note: bpos_max == pt_old when, e.g.,
14535 we are in an empty line, where bpos_max is set to
14536 MATRIX_ROW_START_CHARPOS, see above. */
14537 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14546 x
+= glyph
->pixel_width
;
14549 else if (glyph
> end
) /* row is reversed */
14550 while (!INTEGERP (glyph
->object
))
14552 if (BUFFERP (glyph
->object
))
14554 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14556 if (glyph
->charpos
> bpos_max
)
14557 bpos_max
= glyph
->charpos
;
14558 if (glyph
->charpos
< bpos_min
)
14559 bpos_min
= glyph
->charpos
;
14560 if (!glyph
->avoid_cursor_p
)
14564 match_with_avoid_cursor
= 0;
14567 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14569 pos_before
= glyph
->charpos
;
14570 glyph_before
= glyph
;
14572 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14574 pos_after
= glyph
->charpos
;
14575 glyph_after
= glyph
;
14578 else if (dpos
== 0)
14579 match_with_avoid_cursor
= 1;
14581 else if (STRINGP (glyph
->object
))
14583 Lisp_Object chprop
;
14584 ptrdiff_t glyph_pos
= glyph
->charpos
;
14586 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14588 if (!NILP (chprop
))
14590 ptrdiff_t prop_pos
=
14591 string_buffer_position_lim (glyph
->object
, pos_before
,
14594 if (prop_pos
>= pos_before
)
14595 bpos_max
= prop_pos
;
14597 if (INTEGERP (chprop
))
14599 bpos_covered
= bpos_max
+ XINT (chprop
);
14600 /* If the `cursor' property covers buffer positions up
14601 to and including point, we should display cursor on
14603 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14612 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14614 x
--; /* can't use any pixel_width */
14617 x
-= glyph
->pixel_width
;
14620 /* Step 2: If we didn't find an exact match for point, we need to
14621 look for a proper place to put the cursor among glyphs between
14622 GLYPH_BEFORE and GLYPH_AFTER. */
14623 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14624 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14625 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14627 /* An empty line has a single glyph whose OBJECT is zero and
14628 whose CHARPOS is the position of a newline on that line.
14629 Note that on a TTY, there are more glyphs after that, which
14630 were produced by extend_face_to_end_of_line, but their
14631 CHARPOS is zero or negative. */
14633 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14634 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14635 /* On a TTY, continued and truncated rows also have a glyph at
14636 their end whose OBJECT is zero and whose CHARPOS is
14637 positive (the continuation and truncation glyphs), but such
14638 rows are obviously not "empty". */
14639 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14641 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14643 ptrdiff_t ellipsis_pos
;
14645 /* Scan back over the ellipsis glyphs. */
14646 if (!row
->reversed_p
)
14648 ellipsis_pos
= (glyph
- 1)->charpos
;
14649 while (glyph
> row
->glyphs
[TEXT_AREA
]
14650 && (glyph
- 1)->charpos
== ellipsis_pos
)
14651 glyph
--, x
-= glyph
->pixel_width
;
14652 /* That loop always goes one position too far, including
14653 the glyph before the ellipsis. So scan forward over
14655 x
+= glyph
->pixel_width
;
14658 else /* row is reversed */
14660 ellipsis_pos
= (glyph
+ 1)->charpos
;
14661 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14662 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14663 glyph
++, x
+= glyph
->pixel_width
;
14664 x
-= glyph
->pixel_width
;
14668 else if (match_with_avoid_cursor
)
14670 cursor
= glyph_after
;
14673 else if (string_seen
)
14675 int incr
= row
->reversed_p
? -1 : +1;
14677 /* Need to find the glyph that came out of a string which is
14678 present at point. That glyph is somewhere between
14679 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14680 positioned between POS_BEFORE and POS_AFTER in the
14682 struct glyph
*start
, *stop
;
14683 ptrdiff_t pos
= pos_before
;
14687 /* If the row ends in a newline from a display string,
14688 reordering could have moved the glyphs belonging to the
14689 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14690 in this case we extend the search to the last glyph in
14691 the row that was not inserted by redisplay. */
14692 if (row
->ends_in_newline_from_string_p
)
14695 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14698 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14699 correspond to POS_BEFORE and POS_AFTER, respectively. We
14700 need START and STOP in the order that corresponds to the
14701 row's direction as given by its reversed_p flag. If the
14702 directionality of characters between POS_BEFORE and
14703 POS_AFTER is the opposite of the row's base direction,
14704 these characters will have been reordered for display,
14705 and we need to reverse START and STOP. */
14706 if (!row
->reversed_p
)
14708 start
= min (glyph_before
, glyph_after
);
14709 stop
= max (glyph_before
, glyph_after
);
14713 start
= max (glyph_before
, glyph_after
);
14714 stop
= min (glyph_before
, glyph_after
);
14716 for (glyph
= start
+ incr
;
14717 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14720 /* Any glyphs that come from the buffer are here because
14721 of bidi reordering. Skip them, and only pay
14722 attention to glyphs that came from some string. */
14723 if (STRINGP (glyph
->object
))
14727 /* If the display property covers the newline, we
14728 need to search for it one position farther. */
14729 ptrdiff_t lim
= pos_after
14730 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14732 string_from_text_prop
= 0;
14733 str
= glyph
->object
;
14734 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14735 if (tem
== 0 /* from overlay */
14738 /* If the string from which this glyph came is
14739 found in the buffer at point, or at position
14740 that is closer to point than pos_after, then
14741 we've found the glyph we've been looking for.
14742 If it comes from an overlay (tem == 0), and
14743 it has the `cursor' property on one of its
14744 glyphs, record that glyph as a candidate for
14745 displaying the cursor. (As in the
14746 unidirectional version, we will display the
14747 cursor on the last candidate we find.) */
14750 || (tem
- pt_old
> 0 && tem
< pos_after
))
14752 /* The glyphs from this string could have
14753 been reordered. Find the one with the
14754 smallest string position. Or there could
14755 be a character in the string with the
14756 `cursor' property, which means display
14757 cursor on that character's glyph. */
14758 ptrdiff_t strpos
= glyph
->charpos
;
14763 string_from_text_prop
= 1;
14766 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14767 && EQ (glyph
->object
, str
);
14771 ptrdiff_t gpos
= glyph
->charpos
;
14773 cprop
= Fget_char_property (make_number (gpos
),
14781 if (tem
&& glyph
->charpos
< strpos
)
14783 strpos
= glyph
->charpos
;
14789 || (tem
- pt_old
> 0 && tem
< pos_after
))
14793 pos
= tem
+ 1; /* don't find previous instances */
14795 /* This string is not what we want; skip all of the
14796 glyphs that came from it. */
14797 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14798 && EQ (glyph
->object
, str
))
14805 /* If we reached the end of the line, and END was from a string,
14806 the cursor is not on this line. */
14808 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14809 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14810 && STRINGP (end
->object
)
14811 && row
->continued_p
)
14814 /* A truncated row may not include PT among its character positions.
14815 Setting the cursor inside the scroll margin will trigger
14816 recalculation of hscroll in hscroll_window_tree. But if a
14817 display string covers point, defer to the string-handling
14818 code below to figure this out. */
14819 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14821 cursor
= glyph_before
;
14824 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14825 /* Zero-width characters produce no glyphs. */
14827 && (row
->reversed_p
14828 ? glyph_after
> glyphs_end
14829 : glyph_after
< glyphs_end
)))
14831 cursor
= glyph_after
;
14837 if (cursor
!= NULL
)
14839 else if (glyph
== glyphs_end
14840 && pos_before
== pos_after
14841 && STRINGP ((row
->reversed_p
14842 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14843 : row
->glyphs
[TEXT_AREA
])->object
))
14845 /* If all the glyphs of this row came from strings, put the
14846 cursor on the first glyph of the row. This avoids having the
14847 cursor outside of the text area in this very rare and hard
14851 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14852 : row
->glyphs
[TEXT_AREA
];
14858 /* Need to compute x that corresponds to GLYPH. */
14859 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14861 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14863 x
+= g
->pixel_width
;
14867 /* ROW could be part of a continued line, which, under bidi
14868 reordering, might have other rows whose start and end charpos
14869 occlude point. Only set w->cursor if we found a better
14870 approximation to the cursor position than we have from previously
14871 examined candidate rows belonging to the same continued line. */
14872 if (/* We already have a candidate row. */
14873 w
->cursor
.vpos
>= 0
14874 /* That candidate is not the row we are processing. */
14875 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14876 /* Make sure cursor.vpos specifies a row whose start and end
14877 charpos occlude point, and it is valid candidate for being a
14878 cursor-row. This is because some callers of this function
14879 leave cursor.vpos at the row where the cursor was displayed
14880 during the last redisplay cycle. */
14881 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14882 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14883 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14886 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14888 /* Don't consider glyphs that are outside TEXT_AREA. */
14889 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14891 /* Keep the candidate whose buffer position is the closest to
14892 point or has the `cursor' property. */
14893 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14894 w
->cursor
.hpos
>= 0
14895 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14896 && ((BUFFERP (g1
->object
)
14897 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14898 || (BUFFERP (glyph
->object
)
14899 && eabs (g1
->charpos
- pt_old
)
14900 < eabs (glyph
->charpos
- pt_old
))))
14901 /* Previous candidate is a glyph from a string that has
14902 a non-nil `cursor' property. */
14903 || (STRINGP (g1
->object
)
14904 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14905 Qcursor
, g1
->object
))
14906 /* Previous candidate is from the same display
14907 string as this one, and the display string
14908 came from a text property. */
14909 || (EQ (g1
->object
, glyph
->object
)
14910 && string_from_text_prop
)
14911 /* this candidate is from newline and its
14912 position is not an exact match */
14913 || (INTEGERP (glyph
->object
)
14914 && glyph
->charpos
!= pt_old
)))))
14916 /* If this candidate gives an exact match, use that. */
14917 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14918 /* If this candidate is a glyph created for the
14919 terminating newline of a line, and point is on that
14920 newline, it wins because it's an exact match. */
14921 || (!row
->continued_p
14922 && INTEGERP (glyph
->object
)
14923 && glyph
->charpos
== 0
14924 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14925 /* Otherwise, keep the candidate that comes from a row
14926 spanning less buffer positions. This may win when one or
14927 both candidate positions are on glyphs that came from
14928 display strings, for which we cannot compare buffer
14930 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14931 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14932 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14935 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14937 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14938 w
->cursor
.y
= row
->y
+ dy
;
14940 if (w
== XWINDOW (selected_window
))
14942 if (!row
->continued_p
14943 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14946 this_line_buffer
= XBUFFER (w
->contents
);
14948 CHARPOS (this_line_start_pos
)
14949 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14950 BYTEPOS (this_line_start_pos
)
14951 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14953 CHARPOS (this_line_end_pos
)
14954 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14955 BYTEPOS (this_line_end_pos
)
14956 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14958 this_line_y
= w
->cursor
.y
;
14959 this_line_pixel_height
= row
->height
;
14960 this_line_vpos
= w
->cursor
.vpos
;
14961 this_line_start_x
= row
->x
;
14964 CHARPOS (this_line_start_pos
) = 0;
14971 /* Run window scroll functions, if any, for WINDOW with new window
14972 start STARTP. Sets the window start of WINDOW to that position.
14974 We assume that the window's buffer is really current. */
14976 static struct text_pos
14977 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14979 struct window
*w
= XWINDOW (window
);
14980 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14982 eassert (current_buffer
== XBUFFER (w
->contents
));
14984 if (!NILP (Vwindow_scroll_functions
))
14986 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14987 make_number (CHARPOS (startp
)));
14988 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14989 /* In case the hook functions switch buffers. */
14990 set_buffer_internal (XBUFFER (w
->contents
));
14997 /* Make sure the line containing the cursor is fully visible.
14998 A value of 1 means there is nothing to be done.
14999 (Either the line is fully visible, or it cannot be made so,
15000 or we cannot tell.)
15002 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15003 is higher than window.
15005 A value of 0 means the caller should do scrolling
15006 as if point had gone off the screen. */
15009 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15011 struct glyph_matrix
*matrix
;
15012 struct glyph_row
*row
;
15015 if (!make_cursor_line_fully_visible_p
)
15018 /* It's not always possible to find the cursor, e.g, when a window
15019 is full of overlay strings. Don't do anything in that case. */
15020 if (w
->cursor
.vpos
< 0)
15023 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15024 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15026 /* If the cursor row is not partially visible, there's nothing to do. */
15027 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15030 /* If the row the cursor is in is taller than the window's height,
15031 it's not clear what to do, so do nothing. */
15032 window_height
= window_box_height (w
);
15033 if (row
->height
>= window_height
)
15035 if (!force_p
|| MINI_WINDOW_P (w
)
15036 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15043 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15044 non-zero means only WINDOW is redisplayed in redisplay_internal.
15045 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15046 in redisplay_window to bring a partially visible line into view in
15047 the case that only the cursor has moved.
15049 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15050 last screen line's vertical height extends past the end of the screen.
15054 1 if scrolling succeeded
15056 0 if scrolling didn't find point.
15058 -1 if new fonts have been loaded so that we must interrupt
15059 redisplay, adjust glyph matrices, and try again. */
15065 SCROLLING_NEED_LARGER_MATRICES
15068 /* If scroll-conservatively is more than this, never recenter.
15070 If you change this, don't forget to update the doc string of
15071 `scroll-conservatively' and the Emacs manual. */
15072 #define SCROLL_LIMIT 100
15075 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15076 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15077 int temp_scroll_step
, int last_line_misfit
)
15079 struct window
*w
= XWINDOW (window
);
15080 struct frame
*f
= XFRAME (w
->frame
);
15081 struct text_pos pos
, startp
;
15083 int this_scroll_margin
, scroll_max
, rc
, height
;
15084 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15085 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15086 Lisp_Object aggressive
;
15087 /* We will never try scrolling more than this number of lines. */
15088 int scroll_limit
= SCROLL_LIMIT
;
15089 int frame_line_height
= default_line_pixel_height (w
);
15090 int window_total_lines
15091 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15094 debug_method_add (w
, "try_scrolling");
15097 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15099 /* Compute scroll margin height in pixels. We scroll when point is
15100 within this distance from the top or bottom of the window. */
15101 if (scroll_margin
> 0)
15102 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15103 * frame_line_height
;
15105 this_scroll_margin
= 0;
15107 /* Force arg_scroll_conservatively to have a reasonable value, to
15108 avoid scrolling too far away with slow move_it_* functions. Note
15109 that the user can supply scroll-conservatively equal to
15110 `most-positive-fixnum', which can be larger than INT_MAX. */
15111 if (arg_scroll_conservatively
> scroll_limit
)
15113 arg_scroll_conservatively
= scroll_limit
+ 1;
15114 scroll_max
= scroll_limit
* frame_line_height
;
15116 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15117 /* Compute how much we should try to scroll maximally to bring
15118 point into view. */
15119 scroll_max
= (max (scroll_step
,
15120 max (arg_scroll_conservatively
, temp_scroll_step
))
15121 * frame_line_height
);
15122 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15123 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15124 /* We're trying to scroll because of aggressive scrolling but no
15125 scroll_step is set. Choose an arbitrary one. */
15126 scroll_max
= 10 * frame_line_height
;
15132 /* Decide whether to scroll down. */
15133 if (PT
> CHARPOS (startp
))
15135 int scroll_margin_y
;
15137 /* Compute the pixel ypos of the scroll margin, then move IT to
15138 either that ypos or PT, whichever comes first. */
15139 start_display (&it
, w
, startp
);
15140 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15141 - frame_line_height
* extra_scroll_margin_lines
;
15142 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15143 (MOVE_TO_POS
| MOVE_TO_Y
));
15145 if (PT
> CHARPOS (it
.current
.pos
))
15147 int y0
= line_bottom_y (&it
);
15148 /* Compute how many pixels below window bottom to stop searching
15149 for PT. This avoids costly search for PT that is far away if
15150 the user limited scrolling by a small number of lines, but
15151 always finds PT if scroll_conservatively is set to a large
15152 number, such as most-positive-fixnum. */
15153 int slack
= max (scroll_max
, 10 * frame_line_height
);
15154 int y_to_move
= it
.last_visible_y
+ slack
;
15156 /* Compute the distance from the scroll margin to PT or to
15157 the scroll limit, whichever comes first. This should
15158 include the height of the cursor line, to make that line
15160 move_it_to (&it
, PT
, -1, y_to_move
,
15161 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15162 dy
= line_bottom_y (&it
) - y0
;
15164 if (dy
> scroll_max
)
15165 return SCROLLING_FAILED
;
15174 /* Point is in or below the bottom scroll margin, so move the
15175 window start down. If scrolling conservatively, move it just
15176 enough down to make point visible. If scroll_step is set,
15177 move it down by scroll_step. */
15178 if (arg_scroll_conservatively
)
15180 = min (max (dy
, frame_line_height
),
15181 frame_line_height
* arg_scroll_conservatively
);
15182 else if (scroll_step
|| temp_scroll_step
)
15183 amount_to_scroll
= scroll_max
;
15186 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15187 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15188 if (NUMBERP (aggressive
))
15190 double float_amount
= XFLOATINT (aggressive
) * height
;
15191 int aggressive_scroll
= float_amount
;
15192 if (aggressive_scroll
== 0 && float_amount
> 0)
15193 aggressive_scroll
= 1;
15194 /* Don't let point enter the scroll margin near top of
15195 the window. This could happen if the value of
15196 scroll_up_aggressively is too large and there are
15197 non-zero margins, because scroll_up_aggressively
15198 means put point that fraction of window height
15199 _from_the_bottom_margin_. */
15200 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15201 aggressive_scroll
= height
- 2*this_scroll_margin
;
15202 amount_to_scroll
= dy
+ aggressive_scroll
;
15206 if (amount_to_scroll
<= 0)
15207 return SCROLLING_FAILED
;
15209 start_display (&it
, w
, startp
);
15210 if (arg_scroll_conservatively
<= scroll_limit
)
15211 move_it_vertically (&it
, amount_to_scroll
);
15214 /* Extra precision for users who set scroll-conservatively
15215 to a large number: make sure the amount we scroll
15216 the window start is never less than amount_to_scroll,
15217 which was computed as distance from window bottom to
15218 point. This matters when lines at window top and lines
15219 below window bottom have different height. */
15221 void *it1data
= NULL
;
15222 /* We use a temporary it1 because line_bottom_y can modify
15223 its argument, if it moves one line down; see there. */
15226 SAVE_IT (it1
, it
, it1data
);
15227 start_y
= line_bottom_y (&it1
);
15229 RESTORE_IT (&it
, &it
, it1data
);
15230 move_it_by_lines (&it
, 1);
15231 SAVE_IT (it1
, it
, it1data
);
15232 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15235 /* If STARTP is unchanged, move it down another screen line. */
15236 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15237 move_it_by_lines (&it
, 1);
15238 startp
= it
.current
.pos
;
15242 struct text_pos scroll_margin_pos
= startp
;
15245 /* See if point is inside the scroll margin at the top of the
15247 if (this_scroll_margin
)
15251 start_display (&it
, w
, startp
);
15252 y_start
= it
.current_y
;
15253 move_it_vertically (&it
, this_scroll_margin
);
15254 scroll_margin_pos
= it
.current
.pos
;
15255 /* If we didn't move enough before hitting ZV, request
15256 additional amount of scroll, to move point out of the
15258 if (IT_CHARPOS (it
) == ZV
15259 && it
.current_y
- y_start
< this_scroll_margin
)
15260 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15263 if (PT
< CHARPOS (scroll_margin_pos
))
15265 /* Point is in the scroll margin at the top of the window or
15266 above what is displayed in the window. */
15269 /* Compute the vertical distance from PT to the scroll
15270 margin position. Move as far as scroll_max allows, or
15271 one screenful, or 10 screen lines, whichever is largest.
15272 Give up if distance is greater than scroll_max or if we
15273 didn't reach the scroll margin position. */
15274 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15275 start_display (&it
, w
, pos
);
15277 y_to_move
= max (it
.last_visible_y
,
15278 max (scroll_max
, 10 * frame_line_height
));
15279 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15281 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15282 dy
= it
.current_y
- y0
;
15283 if (dy
> scroll_max
15284 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15285 return SCROLLING_FAILED
;
15287 /* Additional scroll for when ZV was too close to point. */
15290 /* Compute new window start. */
15291 start_display (&it
, w
, startp
);
15293 if (arg_scroll_conservatively
)
15294 amount_to_scroll
= max (dy
, frame_line_height
*
15295 max (scroll_step
, temp_scroll_step
));
15296 else if (scroll_step
|| temp_scroll_step
)
15297 amount_to_scroll
= scroll_max
;
15300 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15301 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15302 if (NUMBERP (aggressive
))
15304 double float_amount
= XFLOATINT (aggressive
) * height
;
15305 int aggressive_scroll
= float_amount
;
15306 if (aggressive_scroll
== 0 && float_amount
> 0)
15307 aggressive_scroll
= 1;
15308 /* Don't let point enter the scroll margin near
15309 bottom of the window, if the value of
15310 scroll_down_aggressively happens to be too
15312 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15313 aggressive_scroll
= height
- 2*this_scroll_margin
;
15314 amount_to_scroll
= dy
+ aggressive_scroll
;
15318 if (amount_to_scroll
<= 0)
15319 return SCROLLING_FAILED
;
15321 move_it_vertically_backward (&it
, amount_to_scroll
);
15322 startp
= it
.current
.pos
;
15326 /* Run window scroll functions. */
15327 startp
= run_window_scroll_functions (window
, startp
);
15329 /* Display the window. Give up if new fonts are loaded, or if point
15331 if (!try_window (window
, startp
, 0))
15332 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15333 else if (w
->cursor
.vpos
< 0)
15335 clear_glyph_matrix (w
->desired_matrix
);
15336 rc
= SCROLLING_FAILED
;
15340 /* Maybe forget recorded base line for line number display. */
15341 if (!just_this_one_p
15342 || current_buffer
->clip_changed
15343 || BEG_UNCHANGED
< CHARPOS (startp
))
15344 w
->base_line_number
= 0;
15346 /* If cursor ends up on a partially visible line,
15347 treat that as being off the bottom of the screen. */
15348 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15349 /* It's possible that the cursor is on the first line of the
15350 buffer, which is partially obscured due to a vscroll
15351 (Bug#7537). In that case, avoid looping forever. */
15352 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15354 clear_glyph_matrix (w
->desired_matrix
);
15355 ++extra_scroll_margin_lines
;
15358 rc
= SCROLLING_SUCCESS
;
15365 /* Compute a suitable window start for window W if display of W starts
15366 on a continuation line. Value is non-zero if a new window start
15369 The new window start will be computed, based on W's width, starting
15370 from the start of the continued line. It is the start of the
15371 screen line with the minimum distance from the old start W->start. */
15374 compute_window_start_on_continuation_line (struct window
*w
)
15376 struct text_pos pos
, start_pos
;
15377 int window_start_changed_p
= 0;
15379 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15381 /* If window start is on a continuation line... Window start may be
15382 < BEGV in case there's invisible text at the start of the
15383 buffer (M-x rmail, for example). */
15384 if (CHARPOS (start_pos
) > BEGV
15385 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15388 struct glyph_row
*row
;
15390 /* Handle the case that the window start is out of range. */
15391 if (CHARPOS (start_pos
) < BEGV
)
15392 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15393 else if (CHARPOS (start_pos
) > ZV
)
15394 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15396 /* Find the start of the continued line. This should be fast
15397 because find_newline is fast (newline cache). */
15398 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15399 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15400 row
, DEFAULT_FACE_ID
);
15401 reseat_at_previous_visible_line_start (&it
);
15403 /* If the line start is "too far" away from the window start,
15404 say it takes too much time to compute a new window start. */
15405 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15406 /* PXW: Do we need upper bounds here? */
15407 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15409 int min_distance
, distance
;
15411 /* Move forward by display lines to find the new window
15412 start. If window width was enlarged, the new start can
15413 be expected to be > the old start. If window width was
15414 decreased, the new window start will be < the old start.
15415 So, we're looking for the display line start with the
15416 minimum distance from the old window start. */
15417 pos
= it
.current
.pos
;
15418 min_distance
= INFINITY
;
15419 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15420 distance
< min_distance
)
15422 min_distance
= distance
;
15423 pos
= it
.current
.pos
;
15424 if (it
.line_wrap
== WORD_WRAP
)
15426 /* Under WORD_WRAP, move_it_by_lines is likely to
15427 overshoot and stop not at the first, but the
15428 second character from the left margin. So in
15429 that case, we need a more tight control on the X
15430 coordinate of the iterator than move_it_by_lines
15431 promises in its contract. The method is to first
15432 go to the last (rightmost) visible character of a
15433 line, then move to the leftmost character on the
15434 next line in a separate call. */
15435 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15436 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15437 move_it_to (&it
, ZV
, 0,
15438 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15439 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15442 move_it_by_lines (&it
, 1);
15445 /* Set the window start there. */
15446 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15447 window_start_changed_p
= 1;
15451 return window_start_changed_p
;
15455 /* Try cursor movement in case text has not changed in window WINDOW,
15456 with window start STARTP. Value is
15458 CURSOR_MOVEMENT_SUCCESS if successful
15460 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15462 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15463 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15464 we want to scroll as if scroll-step were set to 1. See the code.
15466 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15467 which case we have to abort this redisplay, and adjust matrices
15472 CURSOR_MOVEMENT_SUCCESS
,
15473 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15474 CURSOR_MOVEMENT_MUST_SCROLL
,
15475 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15479 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15481 struct window
*w
= XWINDOW (window
);
15482 struct frame
*f
= XFRAME (w
->frame
);
15483 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15486 if (inhibit_try_cursor_movement
)
15490 /* Previously, there was a check for Lisp integer in the
15491 if-statement below. Now, this field is converted to
15492 ptrdiff_t, thus zero means invalid position in a buffer. */
15493 eassert (w
->last_point
> 0);
15494 /* Likewise there was a check whether window_end_vpos is nil or larger
15495 than the window. Now window_end_vpos is int and so never nil, but
15496 let's leave eassert to check whether it fits in the window. */
15497 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15499 /* Handle case where text has not changed, only point, and it has
15500 not moved off the frame. */
15501 if (/* Point may be in this window. */
15502 PT
>= CHARPOS (startp
)
15503 /* Selective display hasn't changed. */
15504 && !current_buffer
->clip_changed
15505 /* Function force-mode-line-update is used to force a thorough
15506 redisplay. It sets either windows_or_buffers_changed or
15507 update_mode_lines. So don't take a shortcut here for these
15509 && !update_mode_lines
15510 && !windows_or_buffers_changed
15511 && !f
->cursor_type_changed
15512 && NILP (Vshow_trailing_whitespace
)
15513 /* This code is not used for mini-buffer for the sake of the case
15514 of redisplaying to replace an echo area message; since in
15515 that case the mini-buffer contents per se are usually
15516 unchanged. This code is of no real use in the mini-buffer
15517 since the handling of this_line_start_pos, etc., in redisplay
15518 handles the same cases. */
15519 && !EQ (window
, minibuf_window
)
15520 && (FRAME_WINDOW_P (f
)
15521 || !overlay_arrow_in_current_buffer_p ()))
15523 int this_scroll_margin
, top_scroll_margin
;
15524 struct glyph_row
*row
= NULL
;
15525 int frame_line_height
= default_line_pixel_height (w
);
15526 int window_total_lines
15527 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15530 debug_method_add (w
, "cursor movement");
15533 /* Scroll if point within this distance from the top or bottom
15534 of the window. This is a pixel value. */
15535 if (scroll_margin
> 0)
15537 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15538 this_scroll_margin
*= frame_line_height
;
15541 this_scroll_margin
= 0;
15543 top_scroll_margin
= this_scroll_margin
;
15544 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15545 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15547 /* Start with the row the cursor was displayed during the last
15548 not paused redisplay. Give up if that row is not valid. */
15549 if (w
->last_cursor_vpos
< 0
15550 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15551 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15554 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15555 if (row
->mode_line_p
)
15557 if (!row
->enabled_p
)
15558 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15561 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15563 int scroll_p
= 0, must_scroll
= 0;
15564 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15566 if (PT
> w
->last_point
)
15568 /* Point has moved forward. */
15569 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15570 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15572 eassert (row
->enabled_p
);
15576 /* If the end position of a row equals the start
15577 position of the next row, and PT is at that position,
15578 we would rather display cursor in the next line. */
15579 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15580 && MATRIX_ROW_END_CHARPOS (row
) == PT
15581 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15582 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15583 && !cursor_row_p (row
))
15586 /* If within the scroll margin, scroll. Note that
15587 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15588 the next line would be drawn, and that
15589 this_scroll_margin can be zero. */
15590 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15591 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15592 /* Line is completely visible last line in window
15593 and PT is to be set in the next line. */
15594 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15595 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15596 && !row
->ends_at_zv_p
15597 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15600 else if (PT
< w
->last_point
)
15602 /* Cursor has to be moved backward. Note that PT >=
15603 CHARPOS (startp) because of the outer if-statement. */
15604 while (!row
->mode_line_p
15605 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15606 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15607 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15608 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15609 row
> w
->current_matrix
->rows
15610 && (row
-1)->ends_in_newline_from_string_p
))))
15611 && (row
->y
> top_scroll_margin
15612 || CHARPOS (startp
) == BEGV
))
15614 eassert (row
->enabled_p
);
15618 /* Consider the following case: Window starts at BEGV,
15619 there is invisible, intangible text at BEGV, so that
15620 display starts at some point START > BEGV. It can
15621 happen that we are called with PT somewhere between
15622 BEGV and START. Try to handle that case. */
15623 if (row
< w
->current_matrix
->rows
15624 || row
->mode_line_p
)
15626 row
= w
->current_matrix
->rows
;
15627 if (row
->mode_line_p
)
15631 /* Due to newlines in overlay strings, we may have to
15632 skip forward over overlay strings. */
15633 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15634 && MATRIX_ROW_END_CHARPOS (row
) == PT
15635 && !cursor_row_p (row
))
15638 /* If within the scroll margin, scroll. */
15639 if (row
->y
< top_scroll_margin
15640 && CHARPOS (startp
) != BEGV
)
15645 /* Cursor did not move. So don't scroll even if cursor line
15646 is partially visible, as it was so before. */
15647 rc
= CURSOR_MOVEMENT_SUCCESS
;
15650 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15651 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15653 /* if PT is not in the glyph row, give up. */
15654 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15657 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15658 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15660 struct glyph_row
*row1
;
15662 /* If rows are bidi-reordered and point moved, back up
15663 until we find a row that does not belong to a
15664 continuation line. This is because we must consider
15665 all rows of a continued line as candidates for the
15666 new cursor positioning, since row start and end
15667 positions change non-linearly with vertical position
15669 /* FIXME: Revisit this when glyph ``spilling'' in
15670 continuation lines' rows is implemented for
15671 bidi-reordered rows. */
15672 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15673 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15676 /* If we hit the beginning of the displayed portion
15677 without finding the first row of a continued
15681 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15684 eassert (row
->enabled_p
);
15689 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15690 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15691 /* Make sure this isn't a header line by any chance, since
15692 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15693 && !row
->mode_line_p
15694 && make_cursor_line_fully_visible_p
)
15696 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15697 && !row
->ends_at_zv_p
15698 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15699 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15700 else if (row
->height
> window_box_height (w
))
15702 /* If we end up in a partially visible line, let's
15703 make it fully visible, except when it's taller
15704 than the window, in which case we can't do much
15707 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15711 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15712 if (!cursor_row_fully_visible_p (w
, 0, 1))
15713 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15715 rc
= CURSOR_MOVEMENT_SUCCESS
;
15719 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15720 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15721 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15723 /* With bidi-reordered rows, there could be more than
15724 one candidate row whose start and end positions
15725 occlude point. We need to let set_cursor_from_row
15726 find the best candidate. */
15727 /* FIXME: Revisit this when glyph ``spilling'' in
15728 continuation lines' rows is implemented for
15729 bidi-reordered rows. */
15734 int at_zv_p
= 0, exact_match_p
= 0;
15736 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15737 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15738 && cursor_row_p (row
))
15739 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15741 /* As soon as we've found the exact match for point,
15742 or the first suitable row whose ends_at_zv_p flag
15743 is set, we are done. */
15746 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15747 w
->cursor
.vpos
)->ends_at_zv_p
;
15749 && w
->cursor
.hpos
>= 0
15750 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15753 struct glyph_row
*candidate
=
15754 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15756 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15757 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15760 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15761 || (INTEGERP (g
->object
)
15762 && (g
->charpos
== PT
15763 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15765 if (at_zv_p
|| exact_match_p
)
15767 rc
= CURSOR_MOVEMENT_SUCCESS
;
15771 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15775 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15776 || row
->continued_p
)
15777 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15778 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15779 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15780 /* If we didn't find any candidate rows, or exited the
15781 loop before all the candidates were examined, signal
15782 to the caller that this method failed. */
15783 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15785 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15786 && !row
->continued_p
))
15787 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15789 rc
= CURSOR_MOVEMENT_SUCCESS
;
15795 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15797 rc
= CURSOR_MOVEMENT_SUCCESS
;
15802 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15803 && MATRIX_ROW_START_CHARPOS (row
) == PT
15804 && cursor_row_p (row
));
15814 set_vertical_scroll_bar (struct window
*w
)
15816 ptrdiff_t start
, end
, whole
;
15818 /* Calculate the start and end positions for the current window.
15819 At some point, it would be nice to choose between scrollbars
15820 which reflect the whole buffer size, with special markers
15821 indicating narrowing, and scrollbars which reflect only the
15824 Note that mini-buffers sometimes aren't displaying any text. */
15825 if (!MINI_WINDOW_P (w
)
15826 || (w
== XWINDOW (minibuf_window
)
15827 && NILP (echo_area_buffer
[0])))
15829 struct buffer
*buf
= XBUFFER (w
->contents
);
15830 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15831 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15832 /* I don't think this is guaranteed to be right. For the
15833 moment, we'll pretend it is. */
15834 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15838 if (whole
< (end
- start
))
15839 whole
= end
- start
;
15842 start
= end
= whole
= 0;
15844 /* Indicate what this scroll bar ought to be displaying now. */
15845 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15846 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15847 (w
, end
- start
, whole
, start
);
15852 set_horizontal_scroll_bar (struct window
*w
)
15854 int start
, end
, whole
, portion
;
15856 if (!MINI_WINDOW_P (w
)
15857 || (w
== XWINDOW (minibuf_window
)
15858 && NILP (echo_area_buffer
[0])))
15860 struct buffer
*b
= XBUFFER (w
->contents
);
15861 struct buffer
*old_buffer
= NULL
;
15863 struct text_pos startp
;
15865 if (b
!= current_buffer
)
15867 old_buffer
= current_buffer
;
15868 set_buffer_internal (b
);
15871 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15872 start_display (&it
, w
, startp
);
15873 it
.last_visible_x
= INT_MAX
;
15874 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15875 MOVE_TO_X
| MOVE_TO_Y
);
15876 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15877 window_box_height (w), -1,
15878 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15880 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15881 end
= start
+ window_box_width (w
, TEXT_AREA
);
15882 portion
= end
- start
;
15883 /* After enlarging a horizontally scrolled window such that it
15884 gets at least as wide as the text it contains, make sure that
15885 the thumb doesn't fill the entire scroll bar so we can still
15886 drag it back to see the entire text. */
15887 whole
= max (whole
, end
);
15893 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15894 if (EQ (pdir
, Qright_to_left
))
15896 start
= whole
- end
;
15897 end
= start
+ portion
;
15902 set_buffer_internal (old_buffer
);
15905 start
= end
= whole
= portion
= 0;
15907 w
->hscroll_whole
= whole
;
15909 /* Indicate what this scroll bar ought to be displaying now. */
15910 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15911 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15912 (w
, portion
, whole
, start
);
15916 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15917 selected_window is redisplayed.
15919 We can return without actually redisplaying the window if fonts has been
15920 changed on window's frame. In that case, redisplay_internal will retry.
15922 As one of the important parts of redisplaying a window, we need to
15923 decide whether the previous window-start position (stored in the
15924 window's w->start marker position) is still valid, and if it isn't,
15925 recompute it. Some details about that:
15927 . The previous window-start could be in a continuation line, in
15928 which case we need to recompute it when the window width
15929 changes. See compute_window_start_on_continuation_line and its
15932 . The text that changed since last redisplay could include the
15933 previous window-start position. In that case, we try to salvage
15934 what we can from the current glyph matrix by calling
15935 try_scrolling, which see.
15937 . Some Emacs command could force us to use a specific window-start
15938 position by setting the window's force_start flag, or gently
15939 propose doing that by setting the window's optional_new_start
15940 flag. In these cases, we try using the specified start point if
15941 that succeeds (i.e. the window desired matrix is successfully
15942 recomputed, and point location is within the window). In case
15943 of optional_new_start, we first check if the specified start
15944 position is feasible, i.e. if it will allow point to be
15945 displayed in the window. If using the specified start point
15946 fails, e.g., if new fonts are needed to be loaded, we abort the
15947 redisplay cycle and leave it up to the next cycle to figure out
15950 . Note that the window's force_start flag is sometimes set by
15951 redisplay itself, when it decides that the previous window start
15952 point is fine and should be kept. Search for "goto force_start"
15953 below to see the details. Like the values of window-start
15954 specified outside of redisplay, these internally-deduced values
15955 are tested for feasibility, and ignored if found to be
15958 . Note that the function try_window, used to completely redisplay
15959 a window, accepts the window's start point as its argument.
15960 This is used several times in the redisplay code to control
15961 where the window start will be, according to user options such
15962 as scroll-conservatively, and also to ensure the screen line
15963 showing point will be fully (as opposed to partially) visible on
15967 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15969 struct window
*w
= XWINDOW (window
);
15970 struct frame
*f
= XFRAME (w
->frame
);
15971 struct buffer
*buffer
= XBUFFER (w
->contents
);
15972 struct buffer
*old
= current_buffer
;
15973 struct text_pos lpoint
, opoint
, startp
;
15974 int update_mode_line
;
15977 /* Record it now because it's overwritten. */
15978 bool current_matrix_up_to_date_p
= false;
15979 bool used_current_matrix_p
= false;
15980 /* This is less strict than current_matrix_up_to_date_p.
15981 It indicates that the buffer contents and narrowing are unchanged. */
15982 bool buffer_unchanged_p
= false;
15983 int temp_scroll_step
= 0;
15984 ptrdiff_t count
= SPECPDL_INDEX ();
15986 int centering_position
= -1;
15987 int last_line_misfit
= 0;
15988 ptrdiff_t beg_unchanged
, end_unchanged
;
15989 int frame_line_height
;
15991 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15995 *w
->desired_matrix
->method
= 0;
15998 if (!just_this_one_p
15999 && REDISPLAY_SOME_P ()
16002 && !buffer
->text
->redisplay
16003 && BUF_PT (buffer
) == w
->last_point
)
16006 /* Make sure that both W's markers are valid. */
16007 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16008 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16010 /* We come here again if we need to run window-text-change-functions
16013 reconsider_clip_changes (w
);
16014 frame_line_height
= default_line_pixel_height (w
);
16016 /* Has the mode line to be updated? */
16017 update_mode_line
= (w
->update_mode_line
16018 || update_mode_lines
16019 || buffer
->clip_changed
16020 || buffer
->prevent_redisplay_optimizations_p
);
16022 if (!just_this_one_p
)
16023 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16024 cleverly elsewhere. */
16025 w
->must_be_updated_p
= true;
16027 if (MINI_WINDOW_P (w
))
16029 if (w
== XWINDOW (echo_area_window
)
16030 && !NILP (echo_area_buffer
[0]))
16032 if (update_mode_line
)
16033 /* We may have to update a tty frame's menu bar or a
16034 tool-bar. Example `M-x C-h C-h C-g'. */
16035 goto finish_menu_bars
;
16037 /* We've already displayed the echo area glyphs in this window. */
16038 goto finish_scroll_bars
;
16040 else if ((w
!= XWINDOW (minibuf_window
)
16041 || minibuf_level
== 0)
16042 /* When buffer is nonempty, redisplay window normally. */
16043 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16044 /* Quail displays non-mini buffers in minibuffer window.
16045 In that case, redisplay the window normally. */
16046 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16048 /* W is a mini-buffer window, but it's not active, so clear
16050 int yb
= window_text_bottom_y (w
);
16051 struct glyph_row
*row
;
16054 for (y
= 0, row
= w
->desired_matrix
->rows
;
16056 y
+= row
->height
, ++row
)
16057 blank_row (w
, row
, y
);
16058 goto finish_scroll_bars
;
16061 clear_glyph_matrix (w
->desired_matrix
);
16064 /* Otherwise set up data on this window; select its buffer and point
16066 /* Really select the buffer, for the sake of buffer-local
16068 set_buffer_internal_1 (XBUFFER (w
->contents
));
16070 current_matrix_up_to_date_p
16071 = (w
->window_end_valid
16072 && !current_buffer
->clip_changed
16073 && !current_buffer
->prevent_redisplay_optimizations_p
16074 && !window_outdated (w
));
16076 /* Run the window-text-change-functions
16077 if it is possible that the text on the screen has changed
16078 (either due to modification of the text, or any other reason). */
16079 if (!current_matrix_up_to_date_p
16080 && !NILP (Vwindow_text_change_functions
))
16082 safe_run_hooks (Qwindow_text_change_functions
);
16086 beg_unchanged
= BEG_UNCHANGED
;
16087 end_unchanged
= END_UNCHANGED
;
16089 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16091 specbind (Qinhibit_point_motion_hooks
, Qt
);
16094 = (w
->window_end_valid
16095 && !current_buffer
->clip_changed
16096 && !window_outdated (w
));
16098 /* When windows_or_buffers_changed is non-zero, we can't rely
16099 on the window end being valid, so set it to zero there. */
16100 if (windows_or_buffers_changed
)
16102 /* If window starts on a continuation line, maybe adjust the
16103 window start in case the window's width changed. */
16104 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16105 compute_window_start_on_continuation_line (w
);
16107 w
->window_end_valid
= false;
16108 /* If so, we also can't rely on current matrix
16109 and should not fool try_cursor_movement below. */
16110 current_matrix_up_to_date_p
= false;
16113 /* Some sanity checks. */
16114 CHECK_WINDOW_END (w
);
16115 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16117 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16120 if (mode_line_update_needed (w
))
16121 update_mode_line
= 1;
16123 /* Point refers normally to the selected window. For any other
16124 window, set up appropriate value. */
16125 if (!EQ (window
, selected_window
))
16127 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16128 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16133 new_pt_byte
= BEGV_BYTE
;
16134 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16136 else if (new_pt
> (ZV
- 1))
16139 new_pt_byte
= ZV_BYTE
;
16140 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16143 /* We don't use SET_PT so that the point-motion hooks don't run. */
16144 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16147 /* If any of the character widths specified in the display table
16148 have changed, invalidate the width run cache. It's true that
16149 this may be a bit late to catch such changes, but the rest of
16150 redisplay goes (non-fatally) haywire when the display table is
16151 changed, so why should we worry about doing any better? */
16152 if (current_buffer
->width_run_cache
16153 || (current_buffer
->base_buffer
16154 && current_buffer
->base_buffer
->width_run_cache
))
16156 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16158 if (! disptab_matches_widthtab
16159 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16161 struct buffer
*buf
= current_buffer
;
16163 if (buf
->base_buffer
)
16164 buf
= buf
->base_buffer
;
16165 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16166 recompute_width_table (current_buffer
, disptab
);
16170 /* If window-start is screwed up, choose a new one. */
16171 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16174 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16176 /* If someone specified a new starting point but did not insist,
16177 check whether it can be used. */
16178 if (w
->optional_new_start
16179 && CHARPOS (startp
) >= BEGV
16180 && CHARPOS (startp
) <= ZV
)
16182 w
->optional_new_start
= 0;
16183 start_display (&it
, w
, startp
);
16184 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16185 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16186 if (IT_CHARPOS (it
) == PT
)
16187 w
->force_start
= 1;
16188 /* IT may overshoot PT if text at PT is invisible. */
16189 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
16190 w
->force_start
= 1;
16195 /* Handle case where place to start displaying has been specified,
16196 unless the specified location is outside the accessible range. */
16197 if (w
->force_start
|| window_frozen_p (w
))
16199 /* We set this later on if we have to adjust point. */
16202 w
->force_start
= 0;
16204 w
->window_end_valid
= 0;
16206 /* Forget any recorded base line for line number display. */
16207 if (!buffer_unchanged_p
)
16208 w
->base_line_number
= 0;
16210 /* Redisplay the mode line. Select the buffer properly for that.
16211 Also, run the hook window-scroll-functions
16212 because we have scrolled. */
16213 /* Note, we do this after clearing force_start because
16214 if there's an error, it is better to forget about force_start
16215 than to get into an infinite loop calling the hook functions
16216 and having them get more errors. */
16217 if (!update_mode_line
16218 || ! NILP (Vwindow_scroll_functions
))
16220 update_mode_line
= 1;
16221 w
->update_mode_line
= 1;
16222 startp
= run_window_scroll_functions (window
, startp
);
16225 if (CHARPOS (startp
) < BEGV
)
16226 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16227 else if (CHARPOS (startp
) > ZV
)
16228 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16230 /* Redisplay, then check if cursor has been set during the
16231 redisplay. Give up if new fonts were loaded. */
16232 /* We used to issue a CHECK_MARGINS argument to try_window here,
16233 but this causes scrolling to fail when point begins inside
16234 the scroll margin (bug#148) -- cyd */
16235 if (!try_window (window
, startp
, 0))
16237 w
->force_start
= 1;
16238 clear_glyph_matrix (w
->desired_matrix
);
16239 goto need_larger_matrices
;
16242 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16244 /* If point does not appear, try to move point so it does
16245 appear. The desired matrix has been built above, so we
16246 can use it here. */
16247 new_vpos
= window_box_height (w
) / 2;
16250 if (!cursor_row_fully_visible_p (w
, 0, 0))
16252 /* Point does appear, but on a line partly visible at end of window.
16253 Move it back to a fully-visible line. */
16254 new_vpos
= window_box_height (w
);
16255 /* But if window_box_height suggests a Y coordinate that is
16256 not less than we already have, that line will clearly not
16257 be fully visible, so give up and scroll the display.
16258 This can happen when the default face uses a font whose
16259 dimensions are different from the frame's default
16261 if (new_vpos
>= w
->cursor
.y
)
16263 w
->cursor
.vpos
= -1;
16264 clear_glyph_matrix (w
->desired_matrix
);
16265 goto try_to_scroll
;
16268 else if (w
->cursor
.vpos
>= 0)
16270 /* Some people insist on not letting point enter the scroll
16271 margin, even though this part handles windows that didn't
16273 int window_total_lines
16274 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16275 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16276 int pixel_margin
= margin
* frame_line_height
;
16277 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16279 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16280 below, which finds the row to move point to, advances by
16281 the Y coordinate of the _next_ row, see the definition of
16282 MATRIX_ROW_BOTTOM_Y. */
16283 if (w
->cursor
.vpos
< margin
+ header_line
)
16285 w
->cursor
.vpos
= -1;
16286 clear_glyph_matrix (w
->desired_matrix
);
16287 goto try_to_scroll
;
16291 int window_height
= window_box_height (w
);
16294 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16295 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16297 w
->cursor
.vpos
= -1;
16298 clear_glyph_matrix (w
->desired_matrix
);
16299 goto try_to_scroll
;
16304 /* If we need to move point for either of the above reasons,
16305 now actually do it. */
16308 struct glyph_row
*row
;
16310 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16311 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16314 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16315 MATRIX_ROW_START_BYTEPOS (row
));
16317 if (w
!= XWINDOW (selected_window
))
16318 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16319 else if (current_buffer
== old
)
16320 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16322 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16324 /* If we are highlighting the region, then we just changed
16325 the region, so redisplay to show it. */
16326 /* FIXME: We need to (re)run pre-redisplay-function! */
16327 /* if (markpos_of_region () >= 0)
16329 clear_glyph_matrix (w->desired_matrix);
16330 if (!try_window (window, startp, 0))
16331 goto need_larger_matrices;
16337 debug_method_add (w
, "forced window start");
16342 /* Handle case where text has not changed, only point, and it has
16343 not moved off the frame, and we are not retrying after hscroll.
16344 (current_matrix_up_to_date_p is nonzero when retrying.) */
16345 if (current_matrix_up_to_date_p
16346 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16347 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16351 case CURSOR_MOVEMENT_SUCCESS
:
16352 used_current_matrix_p
= 1;
16355 case CURSOR_MOVEMENT_MUST_SCROLL
:
16356 goto try_to_scroll
;
16362 /* If current starting point was originally the beginning of a line
16363 but no longer is, find a new starting point. */
16364 else if (w
->start_at_line_beg
16365 && !(CHARPOS (startp
) <= BEGV
16366 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16369 debug_method_add (w
, "recenter 1");
16374 /* Try scrolling with try_window_id. Value is > 0 if update has
16375 been done, it is -1 if we know that the same window start will
16376 not work. It is 0 if unsuccessful for some other reason. */
16377 else if ((tem
= try_window_id (w
)) != 0)
16380 debug_method_add (w
, "try_window_id %d", tem
);
16383 if (f
->fonts_changed
)
16384 goto need_larger_matrices
;
16388 /* Otherwise try_window_id has returned -1 which means that we
16389 don't want the alternative below this comment to execute. */
16391 else if (CHARPOS (startp
) >= BEGV
16392 && CHARPOS (startp
) <= ZV
16393 && PT
>= CHARPOS (startp
)
16394 && (CHARPOS (startp
) < ZV
16395 /* Avoid starting at end of buffer. */
16396 || CHARPOS (startp
) == BEGV
16397 || !window_outdated (w
)))
16399 int d1
, d2
, d3
, d4
, d5
, d6
;
16401 /* If first window line is a continuation line, and window start
16402 is inside the modified region, but the first change is before
16403 current window start, we must select a new window start.
16405 However, if this is the result of a down-mouse event (e.g. by
16406 extending the mouse-drag-overlay), we don't want to select a
16407 new window start, since that would change the position under
16408 the mouse, resulting in an unwanted mouse-movement rather
16409 than a simple mouse-click. */
16410 if (!w
->start_at_line_beg
16411 && NILP (do_mouse_tracking
)
16412 && CHARPOS (startp
) > BEGV
16413 && CHARPOS (startp
) > BEG
+ beg_unchanged
16414 && CHARPOS (startp
) <= Z
- end_unchanged
16415 /* Even if w->start_at_line_beg is nil, a new window may
16416 start at a line_beg, since that's how set_buffer_window
16417 sets it. So, we need to check the return value of
16418 compute_window_start_on_continuation_line. (See also
16420 && XMARKER (w
->start
)->buffer
== current_buffer
16421 && compute_window_start_on_continuation_line (w
)
16422 /* It doesn't make sense to force the window start like we
16423 do at label force_start if it is already known that point
16424 will not be visible in the resulting window, because
16425 doing so will move point from its correct position
16426 instead of scrolling the window to bring point into view.
16428 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16430 w
->force_start
= 1;
16431 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16436 debug_method_add (w
, "same window start");
16439 /* Try to redisplay starting at same place as before.
16440 If point has not moved off frame, accept the results. */
16441 if (!current_matrix_up_to_date_p
16442 /* Don't use try_window_reusing_current_matrix in this case
16443 because a window scroll function can have changed the
16445 || !NILP (Vwindow_scroll_functions
)
16446 || MINI_WINDOW_P (w
)
16447 || !(used_current_matrix_p
16448 = try_window_reusing_current_matrix (w
)))
16450 IF_DEBUG (debug_method_add (w
, "1"));
16451 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16452 /* -1 means we need to scroll.
16453 0 means we need new matrices, but fonts_changed
16454 is set in that case, so we will detect it below. */
16455 goto try_to_scroll
;
16458 if (f
->fonts_changed
)
16459 goto need_larger_matrices
;
16461 if (w
->cursor
.vpos
>= 0)
16463 if (!just_this_one_p
16464 || current_buffer
->clip_changed
16465 || BEG_UNCHANGED
< CHARPOS (startp
))
16466 /* Forget any recorded base line for line number display. */
16467 w
->base_line_number
= 0;
16469 if (!cursor_row_fully_visible_p (w
, 1, 0))
16471 clear_glyph_matrix (w
->desired_matrix
);
16472 last_line_misfit
= 1;
16474 /* Drop through and scroll. */
16479 clear_glyph_matrix (w
->desired_matrix
);
16484 /* Redisplay the mode line. Select the buffer properly for that. */
16485 if (!update_mode_line
)
16487 update_mode_line
= 1;
16488 w
->update_mode_line
= 1;
16491 /* Try to scroll by specified few lines. */
16492 if ((scroll_conservatively
16493 || emacs_scroll_step
16494 || temp_scroll_step
16495 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16496 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16497 && CHARPOS (startp
) >= BEGV
16498 && CHARPOS (startp
) <= ZV
)
16500 /* The function returns -1 if new fonts were loaded, 1 if
16501 successful, 0 if not successful. */
16502 int ss
= try_scrolling (window
, just_this_one_p
,
16503 scroll_conservatively
,
16505 temp_scroll_step
, last_line_misfit
);
16508 case SCROLLING_SUCCESS
:
16511 case SCROLLING_NEED_LARGER_MATRICES
:
16512 goto need_larger_matrices
;
16514 case SCROLLING_FAILED
:
16522 /* Finally, just choose a place to start which positions point
16523 according to user preferences. */
16528 debug_method_add (w
, "recenter");
16531 /* Forget any previously recorded base line for line number display. */
16532 if (!buffer_unchanged_p
)
16533 w
->base_line_number
= 0;
16535 /* Determine the window start relative to point. */
16536 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16537 it
.current_y
= it
.last_visible_y
;
16538 if (centering_position
< 0)
16540 int window_total_lines
16541 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16544 ? min (scroll_margin
, window_total_lines
/ 4)
16546 ptrdiff_t margin_pos
= CHARPOS (startp
);
16547 Lisp_Object aggressive
;
16550 /* If there is a scroll margin at the top of the window, find
16551 its character position. */
16553 /* Cannot call start_display if startp is not in the
16554 accessible region of the buffer. This can happen when we
16555 have just switched to a different buffer and/or changed
16556 its restriction. In that case, startp is initialized to
16557 the character position 1 (BEGV) because we did not yet
16558 have chance to display the buffer even once. */
16559 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16562 void *it1data
= NULL
;
16564 SAVE_IT (it1
, it
, it1data
);
16565 start_display (&it1
, w
, startp
);
16566 move_it_vertically (&it1
, margin
* frame_line_height
);
16567 margin_pos
= IT_CHARPOS (it1
);
16568 RESTORE_IT (&it
, &it
, it1data
);
16570 scrolling_up
= PT
> margin_pos
;
16573 ? BVAR (current_buffer
, scroll_up_aggressively
)
16574 : BVAR (current_buffer
, scroll_down_aggressively
);
16576 if (!MINI_WINDOW_P (w
)
16577 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16581 /* Setting scroll-conservatively overrides
16582 scroll-*-aggressively. */
16583 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16585 double float_amount
= XFLOATINT (aggressive
);
16587 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16588 if (pt_offset
== 0 && float_amount
> 0)
16590 if (pt_offset
&& margin
> 0)
16593 /* Compute how much to move the window start backward from
16594 point so that point will be displayed where the user
16598 centering_position
= it
.last_visible_y
;
16600 centering_position
-= pt_offset
;
16601 centering_position
-=
16602 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16603 + WINDOW_HEADER_LINE_HEIGHT (w
);
16604 /* Don't let point enter the scroll margin near top of
16606 if (centering_position
< margin
* frame_line_height
)
16607 centering_position
= margin
* frame_line_height
;
16610 centering_position
= margin
* frame_line_height
+ pt_offset
;
16613 /* Set the window start half the height of the window backward
16615 centering_position
= window_box_height (w
) / 2;
16617 move_it_vertically_backward (&it
, centering_position
);
16619 eassert (IT_CHARPOS (it
) >= BEGV
);
16621 /* The function move_it_vertically_backward may move over more
16622 than the specified y-distance. If it->w is small, e.g. a
16623 mini-buffer window, we may end up in front of the window's
16624 display area. Start displaying at the start of the line
16625 containing PT in this case. */
16626 if (it
.current_y
<= 0)
16628 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16629 move_it_vertically_backward (&it
, 0);
16633 it
.current_x
= it
.hpos
= 0;
16635 /* Set the window start position here explicitly, to avoid an
16636 infinite loop in case the functions in window-scroll-functions
16638 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16640 /* Run scroll hooks. */
16641 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16643 /* Redisplay the window. */
16644 if (!current_matrix_up_to_date_p
16645 || windows_or_buffers_changed
16646 || f
->cursor_type_changed
16647 /* Don't use try_window_reusing_current_matrix in this case
16648 because it can have changed the buffer. */
16649 || !NILP (Vwindow_scroll_functions
)
16650 || !just_this_one_p
16651 || MINI_WINDOW_P (w
)
16652 || !(used_current_matrix_p
16653 = try_window_reusing_current_matrix (w
)))
16654 try_window (window
, startp
, 0);
16656 /* If new fonts have been loaded (due to fontsets), give up. We
16657 have to start a new redisplay since we need to re-adjust glyph
16659 if (f
->fonts_changed
)
16660 goto need_larger_matrices
;
16662 /* If cursor did not appear assume that the middle of the window is
16663 in the first line of the window. Do it again with the next line.
16664 (Imagine a window of height 100, displaying two lines of height
16665 60. Moving back 50 from it->last_visible_y will end in the first
16667 if (w
->cursor
.vpos
< 0)
16669 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16671 clear_glyph_matrix (w
->desired_matrix
);
16672 move_it_by_lines (&it
, 1);
16673 try_window (window
, it
.current
.pos
, 0);
16675 else if (PT
< IT_CHARPOS (it
))
16677 clear_glyph_matrix (w
->desired_matrix
);
16678 move_it_by_lines (&it
, -1);
16679 try_window (window
, it
.current
.pos
, 0);
16683 /* Not much we can do about it. */
16687 /* Consider the following case: Window starts at BEGV, there is
16688 invisible, intangible text at BEGV, so that display starts at
16689 some point START > BEGV. It can happen that we are called with
16690 PT somewhere between BEGV and START. Try to handle that case,
16691 and similar ones. */
16692 if (w
->cursor
.vpos
< 0)
16694 /* First, try locating the proper glyph row for PT. */
16695 struct glyph_row
*row
=
16696 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16698 /* Sometimes point is at the beginning of invisible text that is
16699 before the 1st character displayed in the row. In that case,
16700 row_containing_pos fails to find the row, because no glyphs
16701 with appropriate buffer positions are present in the row.
16702 Therefore, we next try to find the row which shows the 1st
16703 position after the invisible text. */
16707 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16710 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16713 Lisp_Object invis_end
=
16714 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16717 if (NATNUMP (invis_end
))
16718 alt_pos
= XFASTINT (invis_end
);
16721 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16725 /* Finally, fall back on the first row of the window after the
16726 header line (if any). This is slightly better than not
16727 displaying the cursor at all. */
16730 row
= w
->current_matrix
->rows
;
16731 if (row
->mode_line_p
)
16734 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16737 if (!cursor_row_fully_visible_p (w
, 0, 0))
16739 /* If vscroll is enabled, disable it and try again. */
16743 clear_glyph_matrix (w
->desired_matrix
);
16747 /* Users who set scroll-conservatively to a large number want
16748 point just above/below the scroll margin. If we ended up
16749 with point's row partially visible, move the window start to
16750 make that row fully visible and out of the margin. */
16751 if (scroll_conservatively
> SCROLL_LIMIT
)
16753 int window_total_lines
16754 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16757 ? min (scroll_margin
, window_total_lines
/ 4)
16759 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16761 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16762 clear_glyph_matrix (w
->desired_matrix
);
16763 if (1 == try_window (window
, it
.current
.pos
,
16764 TRY_WINDOW_CHECK_MARGINS
))
16768 /* If centering point failed to make the whole line visible,
16769 put point at the top instead. That has to make the whole line
16770 visible, if it can be done. */
16771 if (centering_position
== 0)
16774 clear_glyph_matrix (w
->desired_matrix
);
16775 centering_position
= 0;
16781 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16782 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16783 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16785 /* Display the mode line, if we must. */
16786 if ((update_mode_line
16787 /* If window not full width, must redo its mode line
16788 if (a) the window to its side is being redone and
16789 (b) we do a frame-based redisplay. This is a consequence
16790 of how inverted lines are drawn in frame-based redisplay. */
16791 || (!just_this_one_p
16792 && !FRAME_WINDOW_P (f
)
16793 && !WINDOW_FULL_WIDTH_P (w
))
16794 /* Line number to display. */
16795 || w
->base_line_pos
> 0
16796 /* Column number is displayed and different from the one displayed. */
16797 || (w
->column_number_displayed
!= -1
16798 && (w
->column_number_displayed
!= current_column ())))
16799 /* This means that the window has a mode line. */
16800 && (WINDOW_WANTS_MODELINE_P (w
)
16801 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16804 display_mode_lines (w
);
16806 /* If mode line height has changed, arrange for a thorough
16807 immediate redisplay using the correct mode line height. */
16808 if (WINDOW_WANTS_MODELINE_P (w
)
16809 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16811 f
->fonts_changed
= 1;
16812 w
->mode_line_height
= -1;
16813 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16814 = DESIRED_MODE_LINE_HEIGHT (w
);
16817 /* If header line height has changed, arrange for a thorough
16818 immediate redisplay using the correct header line height. */
16819 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16820 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16822 f
->fonts_changed
= 1;
16823 w
->header_line_height
= -1;
16824 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16825 = DESIRED_HEADER_LINE_HEIGHT (w
);
16828 if (f
->fonts_changed
)
16829 goto need_larger_matrices
;
16832 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16834 w
->base_line_pos
= 0;
16835 w
->base_line_number
= 0;
16840 /* When we reach a frame's selected window, redo the frame's menu bar. */
16841 if (update_mode_line
16842 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16844 int redisplay_menu_p
= 0;
16846 if (FRAME_WINDOW_P (f
))
16848 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16849 || defined (HAVE_NS) || defined (USE_GTK)
16850 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16852 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16856 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16858 if (redisplay_menu_p
)
16859 display_menu_bar (w
);
16861 #ifdef HAVE_WINDOW_SYSTEM
16862 if (FRAME_WINDOW_P (f
))
16864 #if defined (USE_GTK) || defined (HAVE_NS)
16865 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16866 redisplay_tool_bar (f
);
16868 if (WINDOWP (f
->tool_bar_window
)
16869 && (FRAME_TOOL_BAR_LINES (f
) > 0
16870 || !NILP (Vauto_resize_tool_bars
))
16871 && redisplay_tool_bar (f
))
16872 ignore_mouse_drag_p
= 1;
16878 #ifdef HAVE_WINDOW_SYSTEM
16879 if (FRAME_WINDOW_P (f
)
16880 && update_window_fringes (w
, (just_this_one_p
16881 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16882 || w
->pseudo_window_p
)))
16886 if (draw_window_fringes (w
, 1))
16888 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16889 x_draw_right_divider (w
);
16891 x_draw_vertical_border (w
);
16897 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16898 x_draw_bottom_divider (w
);
16899 #endif /* HAVE_WINDOW_SYSTEM */
16901 /* We go to this label, with fonts_changed set, if it is
16902 necessary to try again using larger glyph matrices.
16903 We have to redeem the scroll bar even in this case,
16904 because the loop in redisplay_internal expects that. */
16905 need_larger_matrices
:
16907 finish_scroll_bars
:
16909 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16911 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16912 /* Set the thumb's position and size. */
16913 set_vertical_scroll_bar (w
);
16915 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16916 /* Set the thumb's position and size. */
16917 set_horizontal_scroll_bar (w
);
16919 /* Note that we actually used the scroll bar attached to this
16920 window, so it shouldn't be deleted at the end of redisplay. */
16921 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16922 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16925 /* Restore current_buffer and value of point in it. The window
16926 update may have changed the buffer, so first make sure `opoint'
16927 is still valid (Bug#6177). */
16928 if (CHARPOS (opoint
) < BEGV
)
16929 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16930 else if (CHARPOS (opoint
) > ZV
)
16931 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16933 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16935 set_buffer_internal_1 (old
);
16936 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16937 shorter. This can be caused by log truncation in *Messages*. */
16938 if (CHARPOS (lpoint
) <= ZV
)
16939 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16941 unbind_to (count
, Qnil
);
16945 /* Build the complete desired matrix of WINDOW with a window start
16946 buffer position POS.
16948 Value is 1 if successful. It is zero if fonts were loaded during
16949 redisplay which makes re-adjusting glyph matrices necessary, and -1
16950 if point would appear in the scroll margins.
16951 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16952 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16956 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16958 struct window
*w
= XWINDOW (window
);
16960 struct glyph_row
*last_text_row
= NULL
;
16961 struct frame
*f
= XFRAME (w
->frame
);
16962 int frame_line_height
= default_line_pixel_height (w
);
16964 /* Make POS the new window start. */
16965 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16967 /* Mark cursor position as unknown. No overlay arrow seen. */
16968 w
->cursor
.vpos
= -1;
16969 overlay_arrow_seen
= 0;
16971 /* Initialize iterator and info to start at POS. */
16972 start_display (&it
, w
, pos
);
16973 it
.glyph_row
->reversed_p
= false;
16975 /* Display all lines of W. */
16976 while (it
.current_y
< it
.last_visible_y
)
16978 if (display_line (&it
))
16979 last_text_row
= it
.glyph_row
- 1;
16980 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16984 /* Don't let the cursor end in the scroll margins. */
16985 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16986 && !MINI_WINDOW_P (w
))
16988 int this_scroll_margin
;
16989 int window_total_lines
16990 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16992 if (scroll_margin
> 0)
16994 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16995 this_scroll_margin
*= frame_line_height
;
16998 this_scroll_margin
= 0;
17000 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17001 && w
->cursor
.y
< this_scroll_margin
17002 && CHARPOS (pos
) > BEGV
17003 && IT_CHARPOS (it
) < ZV
)
17004 /* rms: considering make_cursor_line_fully_visible_p here
17005 seems to give wrong results. We don't want to recenter
17006 when the last line is partly visible, we want to allow
17007 that case to be handled in the usual way. */
17008 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17010 w
->cursor
.vpos
= -1;
17011 clear_glyph_matrix (w
->desired_matrix
);
17016 /* If bottom moved off end of frame, change mode line percentage. */
17017 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17018 w
->update_mode_line
= 1;
17020 /* Set window_end_pos to the offset of the last character displayed
17021 on the window from the end of current_buffer. Set
17022 window_end_vpos to its row number. */
17025 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17026 adjust_window_ends (w
, last_text_row
, 0);
17028 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17029 w
->window_end_vpos
)));
17033 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17034 w
->window_end_pos
= Z
- ZV
;
17035 w
->window_end_vpos
= 0;
17038 /* But that is not valid info until redisplay finishes. */
17039 w
->window_end_valid
= 0;
17045 /************************************************************************
17046 Window redisplay reusing current matrix when buffer has not changed
17047 ************************************************************************/
17049 /* Try redisplay of window W showing an unchanged buffer with a
17050 different window start than the last time it was displayed by
17051 reusing its current matrix. Value is non-zero if successful.
17052 W->start is the new window start. */
17055 try_window_reusing_current_matrix (struct window
*w
)
17057 struct frame
*f
= XFRAME (w
->frame
);
17058 struct glyph_row
*bottom_row
;
17061 struct text_pos start
, new_start
;
17062 int nrows_scrolled
, i
;
17063 struct glyph_row
*last_text_row
;
17064 struct glyph_row
*last_reused_text_row
;
17065 struct glyph_row
*start_row
;
17066 int start_vpos
, min_y
, max_y
;
17069 if (inhibit_try_window_reusing
)
17073 if (/* This function doesn't handle terminal frames. */
17074 !FRAME_WINDOW_P (f
)
17075 /* Don't try to reuse the display if windows have been split
17077 || windows_or_buffers_changed
17078 || f
->cursor_type_changed
)
17081 /* Can't do this if showing trailing whitespace. */
17082 if (!NILP (Vshow_trailing_whitespace
))
17085 /* If top-line visibility has changed, give up. */
17086 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17087 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17090 /* Give up if old or new display is scrolled vertically. We could
17091 make this function handle this, but right now it doesn't. */
17092 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17093 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17096 /* The variable new_start now holds the new window start. The old
17097 start `start' can be determined from the current matrix. */
17098 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17099 start
= start_row
->minpos
;
17100 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17102 /* Clear the desired matrix for the display below. */
17103 clear_glyph_matrix (w
->desired_matrix
);
17105 if (CHARPOS (new_start
) <= CHARPOS (start
))
17107 /* Don't use this method if the display starts with an ellipsis
17108 displayed for invisible text. It's not easy to handle that case
17109 below, and it's certainly not worth the effort since this is
17110 not a frequent case. */
17111 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17114 IF_DEBUG (debug_method_add (w
, "twu1"));
17116 /* Display up to a row that can be reused. The variable
17117 last_text_row is set to the last row displayed that displays
17118 text. Note that it.vpos == 0 if or if not there is a
17119 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17120 start_display (&it
, w
, new_start
);
17121 w
->cursor
.vpos
= -1;
17122 last_text_row
= last_reused_text_row
= NULL
;
17124 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17126 /* If we have reached into the characters in the START row,
17127 that means the line boundaries have changed. So we
17128 can't start copying with the row START. Maybe it will
17129 work to start copying with the following row. */
17130 while (IT_CHARPOS (it
) > CHARPOS (start
))
17132 /* Advance to the next row as the "start". */
17134 start
= start_row
->minpos
;
17135 /* If there are no more rows to try, or just one, give up. */
17136 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17137 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17138 || CHARPOS (start
) == ZV
)
17140 clear_glyph_matrix (w
->desired_matrix
);
17144 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17146 /* If we have reached alignment, we can copy the rest of the
17148 if (IT_CHARPOS (it
) == CHARPOS (start
)
17149 /* Don't accept "alignment" inside a display vector,
17150 since start_row could have started in the middle of
17151 that same display vector (thus their character
17152 positions match), and we have no way of telling if
17153 that is the case. */
17154 && it
.current
.dpvec_index
< 0)
17157 it
.glyph_row
->reversed_p
= false;
17158 if (display_line (&it
))
17159 last_text_row
= it
.glyph_row
- 1;
17163 /* A value of current_y < last_visible_y means that we stopped
17164 at the previous window start, which in turn means that we
17165 have at least one reusable row. */
17166 if (it
.current_y
< it
.last_visible_y
)
17168 struct glyph_row
*row
;
17170 /* IT.vpos always starts from 0; it counts text lines. */
17171 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17173 /* Find PT if not already found in the lines displayed. */
17174 if (w
->cursor
.vpos
< 0)
17176 int dy
= it
.current_y
- start_row
->y
;
17178 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17179 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17181 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17182 dy
, nrows_scrolled
);
17185 clear_glyph_matrix (w
->desired_matrix
);
17190 /* Scroll the display. Do it before the current matrix is
17191 changed. The problem here is that update has not yet
17192 run, i.e. part of the current matrix is not up to date.
17193 scroll_run_hook will clear the cursor, and use the
17194 current matrix to get the height of the row the cursor is
17196 run
.current_y
= start_row
->y
;
17197 run
.desired_y
= it
.current_y
;
17198 run
.height
= it
.last_visible_y
- it
.current_y
;
17200 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17203 FRAME_RIF (f
)->update_window_begin_hook (w
);
17204 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17205 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17206 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17210 /* Shift current matrix down by nrows_scrolled lines. */
17211 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17212 rotate_matrix (w
->current_matrix
,
17214 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17217 /* Disable lines that must be updated. */
17218 for (i
= 0; i
< nrows_scrolled
; ++i
)
17219 (start_row
+ i
)->enabled_p
= false;
17221 /* Re-compute Y positions. */
17222 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17223 max_y
= it
.last_visible_y
;
17224 for (row
= start_row
+ nrows_scrolled
;
17228 row
->y
= it
.current_y
;
17229 row
->visible_height
= row
->height
;
17231 if (row
->y
< min_y
)
17232 row
->visible_height
-= min_y
- row
->y
;
17233 if (row
->y
+ row
->height
> max_y
)
17234 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17235 if (row
->fringe_bitmap_periodic_p
)
17236 row
->redraw_fringe_bitmaps_p
= 1;
17238 it
.current_y
+= row
->height
;
17240 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17241 last_reused_text_row
= row
;
17242 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17246 /* Disable lines in the current matrix which are now
17247 below the window. */
17248 for (++row
; row
< bottom_row
; ++row
)
17249 row
->enabled_p
= row
->mode_line_p
= 0;
17252 /* Update window_end_pos etc.; last_reused_text_row is the last
17253 reused row from the current matrix containing text, if any.
17254 The value of last_text_row is the last displayed line
17255 containing text. */
17256 if (last_reused_text_row
)
17257 adjust_window_ends (w
, last_reused_text_row
, 1);
17258 else if (last_text_row
)
17259 adjust_window_ends (w
, last_text_row
, 0);
17262 /* This window must be completely empty. */
17263 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17264 w
->window_end_pos
= Z
- ZV
;
17265 w
->window_end_vpos
= 0;
17267 w
->window_end_valid
= 0;
17269 /* Update hint: don't try scrolling again in update_window. */
17270 w
->desired_matrix
->no_scrolling_p
= 1;
17273 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17277 else if (CHARPOS (new_start
) > CHARPOS (start
))
17279 struct glyph_row
*pt_row
, *row
;
17280 struct glyph_row
*first_reusable_row
;
17281 struct glyph_row
*first_row_to_display
;
17283 int yb
= window_text_bottom_y (w
);
17285 /* Find the row starting at new_start, if there is one. Don't
17286 reuse a partially visible line at the end. */
17287 first_reusable_row
= start_row
;
17288 while (first_reusable_row
->enabled_p
17289 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17290 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17291 < CHARPOS (new_start
)))
17292 ++first_reusable_row
;
17294 /* Give up if there is no row to reuse. */
17295 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17296 || !first_reusable_row
->enabled_p
17297 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17298 != CHARPOS (new_start
)))
17301 /* We can reuse fully visible rows beginning with
17302 first_reusable_row to the end of the window. Set
17303 first_row_to_display to the first row that cannot be reused.
17304 Set pt_row to the row containing point, if there is any. */
17306 for (first_row_to_display
= first_reusable_row
;
17307 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17308 ++first_row_to_display
)
17310 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17311 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17312 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17313 && first_row_to_display
->ends_at_zv_p
17314 && pt_row
== NULL
)))
17315 pt_row
= first_row_to_display
;
17318 /* Start displaying at the start of first_row_to_display. */
17319 eassert (first_row_to_display
->y
< yb
);
17320 init_to_row_start (&it
, w
, first_row_to_display
);
17322 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17324 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17326 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17327 + WINDOW_HEADER_LINE_HEIGHT (w
));
17329 /* Display lines beginning with first_row_to_display in the
17330 desired matrix. Set last_text_row to the last row displayed
17331 that displays text. */
17332 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17333 if (pt_row
== NULL
)
17334 w
->cursor
.vpos
= -1;
17335 last_text_row
= NULL
;
17336 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17337 if (display_line (&it
))
17338 last_text_row
= it
.glyph_row
- 1;
17340 /* If point is in a reused row, adjust y and vpos of the cursor
17344 w
->cursor
.vpos
-= nrows_scrolled
;
17345 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17348 /* Give up if point isn't in a row displayed or reused. (This
17349 also handles the case where w->cursor.vpos < nrows_scrolled
17350 after the calls to display_line, which can happen with scroll
17351 margins. See bug#1295.) */
17352 if (w
->cursor
.vpos
< 0)
17354 clear_glyph_matrix (w
->desired_matrix
);
17358 /* Scroll the display. */
17359 run
.current_y
= first_reusable_row
->y
;
17360 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17361 run
.height
= it
.last_visible_y
- run
.current_y
;
17362 dy
= run
.current_y
- run
.desired_y
;
17367 FRAME_RIF (f
)->update_window_begin_hook (w
);
17368 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17369 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17370 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17374 /* Adjust Y positions of reused rows. */
17375 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17376 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17377 max_y
= it
.last_visible_y
;
17378 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17381 row
->visible_height
= row
->height
;
17382 if (row
->y
< min_y
)
17383 row
->visible_height
-= min_y
- row
->y
;
17384 if (row
->y
+ row
->height
> max_y
)
17385 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17386 if (row
->fringe_bitmap_periodic_p
)
17387 row
->redraw_fringe_bitmaps_p
= 1;
17390 /* Scroll the current matrix. */
17391 eassert (nrows_scrolled
> 0);
17392 rotate_matrix (w
->current_matrix
,
17394 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17397 /* Disable rows not reused. */
17398 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17399 row
->enabled_p
= false;
17401 /* Point may have moved to a different line, so we cannot assume that
17402 the previous cursor position is valid; locate the correct row. */
17405 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17407 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17408 && !row
->ends_at_zv_p
;
17412 w
->cursor
.y
= row
->y
;
17414 if (row
< bottom_row
)
17416 /* Can't simply scan the row for point with
17417 bidi-reordered glyph rows. Let set_cursor_from_row
17418 figure out where to put the cursor, and if it fails,
17420 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17422 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17425 clear_glyph_matrix (w
->desired_matrix
);
17431 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17432 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17435 && (!BUFFERP (glyph
->object
)
17436 || glyph
->charpos
< PT
);
17440 w
->cursor
.x
+= glyph
->pixel_width
;
17446 /* Adjust window end. A null value of last_text_row means that
17447 the window end is in reused rows which in turn means that
17448 only its vpos can have changed. */
17450 adjust_window_ends (w
, last_text_row
, 0);
17452 w
->window_end_vpos
-= nrows_scrolled
;
17454 w
->window_end_valid
= 0;
17455 w
->desired_matrix
->no_scrolling_p
= 1;
17458 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17468 /************************************************************************
17469 Window redisplay reusing current matrix when buffer has changed
17470 ************************************************************************/
17472 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17473 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17474 ptrdiff_t *, ptrdiff_t *);
17475 static struct glyph_row
*
17476 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17477 struct glyph_row
*);
17480 /* Return the last row in MATRIX displaying text. If row START is
17481 non-null, start searching with that row. IT gives the dimensions
17482 of the display. Value is null if matrix is empty; otherwise it is
17483 a pointer to the row found. */
17485 static struct glyph_row
*
17486 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17487 struct glyph_row
*start
)
17489 struct glyph_row
*row
, *row_found
;
17491 /* Set row_found to the last row in IT->w's current matrix
17492 displaying text. The loop looks funny but think of partially
17495 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17496 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17498 eassert (row
->enabled_p
);
17500 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17509 /* Return the last row in the current matrix of W that is not affected
17510 by changes at the start of current_buffer that occurred since W's
17511 current matrix was built. Value is null if no such row exists.
17513 BEG_UNCHANGED us the number of characters unchanged at the start of
17514 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17515 first changed character in current_buffer. Characters at positions <
17516 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17517 when the current matrix was built. */
17519 static struct glyph_row
*
17520 find_last_unchanged_at_beg_row (struct window
*w
)
17522 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17523 struct glyph_row
*row
;
17524 struct glyph_row
*row_found
= NULL
;
17525 int yb
= window_text_bottom_y (w
);
17527 /* Find the last row displaying unchanged text. */
17528 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17529 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17530 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17533 if (/* If row ends before first_changed_pos, it is unchanged,
17534 except in some case. */
17535 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17536 /* When row ends in ZV and we write at ZV it is not
17538 && !row
->ends_at_zv_p
17539 /* When first_changed_pos is the end of a continued line,
17540 row is not unchanged because it may be no longer
17542 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17543 && (row
->continued_p
17544 || row
->exact_window_width_line_p
))
17545 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17546 needs to be recomputed, so don't consider this row as
17547 unchanged. This happens when the last line was
17548 bidi-reordered and was killed immediately before this
17549 redisplay cycle. In that case, ROW->end stores the
17550 buffer position of the first visual-order character of
17551 the killed text, which is now beyond ZV. */
17552 && CHARPOS (row
->end
.pos
) <= ZV
)
17555 /* Stop if last visible row. */
17556 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17564 /* Find the first glyph row in the current matrix of W that is not
17565 affected by changes at the end of current_buffer since the
17566 time W's current matrix was built.
17568 Return in *DELTA the number of chars by which buffer positions in
17569 unchanged text at the end of current_buffer must be adjusted.
17571 Return in *DELTA_BYTES the corresponding number of bytes.
17573 Value is null if no such row exists, i.e. all rows are affected by
17576 static struct glyph_row
*
17577 find_first_unchanged_at_end_row (struct window
*w
,
17578 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17580 struct glyph_row
*row
;
17581 struct glyph_row
*row_found
= NULL
;
17583 *delta
= *delta_bytes
= 0;
17585 /* Display must not have been paused, otherwise the current matrix
17586 is not up to date. */
17587 eassert (w
->window_end_valid
);
17589 /* A value of window_end_pos >= END_UNCHANGED means that the window
17590 end is in the range of changed text. If so, there is no
17591 unchanged row at the end of W's current matrix. */
17592 if (w
->window_end_pos
>= END_UNCHANGED
)
17595 /* Set row to the last row in W's current matrix displaying text. */
17596 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17598 /* If matrix is entirely empty, no unchanged row exists. */
17599 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17601 /* The value of row is the last glyph row in the matrix having a
17602 meaningful buffer position in it. The end position of row
17603 corresponds to window_end_pos. This allows us to translate
17604 buffer positions in the current matrix to current buffer
17605 positions for characters not in changed text. */
17607 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17608 ptrdiff_t Z_BYTE_old
=
17609 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17610 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17611 struct glyph_row
*first_text_row
17612 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17614 *delta
= Z
- Z_old
;
17615 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17617 /* Set last_unchanged_pos to the buffer position of the last
17618 character in the buffer that has not been changed. Z is the
17619 index + 1 of the last character in current_buffer, i.e. by
17620 subtracting END_UNCHANGED we get the index of the last
17621 unchanged character, and we have to add BEG to get its buffer
17623 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17624 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17626 /* Search backward from ROW for a row displaying a line that
17627 starts at a minimum position >= last_unchanged_pos_old. */
17628 for (; row
> first_text_row
; --row
)
17630 /* This used to abort, but it can happen.
17631 It is ok to just stop the search instead here. KFS. */
17632 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17635 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17640 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17646 /* Make sure that glyph rows in the current matrix of window W
17647 reference the same glyph memory as corresponding rows in the
17648 frame's frame matrix. This function is called after scrolling W's
17649 current matrix on a terminal frame in try_window_id and
17650 try_window_reusing_current_matrix. */
17653 sync_frame_with_window_matrix_rows (struct window
*w
)
17655 struct frame
*f
= XFRAME (w
->frame
);
17656 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17658 /* Preconditions: W must be a leaf window and full-width. Its frame
17659 must have a frame matrix. */
17660 eassert (BUFFERP (w
->contents
));
17661 eassert (WINDOW_FULL_WIDTH_P (w
));
17662 eassert (!FRAME_WINDOW_P (f
));
17664 /* If W is a full-width window, glyph pointers in W's current matrix
17665 have, by definition, to be the same as glyph pointers in the
17666 corresponding frame matrix. Note that frame matrices have no
17667 marginal areas (see build_frame_matrix). */
17668 window_row
= w
->current_matrix
->rows
;
17669 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17670 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17671 while (window_row
< window_row_end
)
17673 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17674 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17676 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17677 frame_row
->glyphs
[TEXT_AREA
] = start
;
17678 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17679 frame_row
->glyphs
[LAST_AREA
] = end
;
17681 /* Disable frame rows whose corresponding window rows have
17682 been disabled in try_window_id. */
17683 if (!window_row
->enabled_p
)
17684 frame_row
->enabled_p
= false;
17686 ++window_row
, ++frame_row
;
17691 /* Find the glyph row in window W containing CHARPOS. Consider all
17692 rows between START and END (not inclusive). END null means search
17693 all rows to the end of the display area of W. Value is the row
17694 containing CHARPOS or null. */
17697 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17698 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17700 struct glyph_row
*row
= start
;
17701 struct glyph_row
*best_row
= NULL
;
17702 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17705 /* If we happen to start on a header-line, skip that. */
17706 if (row
->mode_line_p
)
17709 if ((end
&& row
>= end
) || !row
->enabled_p
)
17712 last_y
= window_text_bottom_y (w
) - dy
;
17716 /* Give up if we have gone too far. */
17717 if (end
&& row
>= end
)
17719 /* This formerly returned if they were equal.
17720 I think that both quantities are of a "last plus one" type;
17721 if so, when they are equal, the row is within the screen. -- rms. */
17722 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17725 /* If it is in this row, return this row. */
17726 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17727 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17728 /* The end position of a row equals the start
17729 position of the next row. If CHARPOS is there, we
17730 would rather consider it displayed in the next
17731 line, except when this line ends in ZV. */
17732 && !row_for_charpos_p (row
, charpos
)))
17733 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17737 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17738 || (!best_row
&& !row
->continued_p
))
17740 /* In bidi-reordered rows, there could be several rows whose
17741 edges surround CHARPOS, all of these rows belonging to
17742 the same continued line. We need to find the row which
17743 fits CHARPOS the best. */
17744 for (g
= row
->glyphs
[TEXT_AREA
];
17745 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17748 if (!STRINGP (g
->object
))
17750 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17752 mindif
= eabs (g
->charpos
- charpos
);
17754 /* Exact match always wins. */
17761 else if (best_row
&& !row
->continued_p
)
17768 /* Try to redisplay window W by reusing its existing display. W's
17769 current matrix must be up to date when this function is called,
17770 i.e. window_end_valid must be nonzero.
17774 >= 1 if successful, i.e. display has been updated
17776 1 means the changes were in front of a newline that precedes
17777 the window start, and the whole current matrix was reused
17778 2 means the changes were after the last position displayed
17779 in the window, and the whole current matrix was reused
17780 3 means portions of the current matrix were reused, while
17781 some of the screen lines were redrawn
17782 -1 if redisplay with same window start is known not to succeed
17783 0 if otherwise unsuccessful
17785 The following steps are performed:
17787 1. Find the last row in the current matrix of W that is not
17788 affected by changes at the start of current_buffer. If no such row
17791 2. Find the first row in W's current matrix that is not affected by
17792 changes at the end of current_buffer. Maybe there is no such row.
17794 3. Display lines beginning with the row + 1 found in step 1 to the
17795 row found in step 2 or, if step 2 didn't find a row, to the end of
17798 4. If cursor is not known to appear on the window, give up.
17800 5. If display stopped at the row found in step 2, scroll the
17801 display and current matrix as needed.
17803 6. Maybe display some lines at the end of W, if we must. This can
17804 happen under various circumstances, like a partially visible line
17805 becoming fully visible, or because newly displayed lines are displayed
17806 in smaller font sizes.
17808 7. Update W's window end information. */
17811 try_window_id (struct window
*w
)
17813 struct frame
*f
= XFRAME (w
->frame
);
17814 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17815 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17816 struct glyph_row
*last_unchanged_at_beg_row
;
17817 struct glyph_row
*first_unchanged_at_end_row
;
17818 struct glyph_row
*row
;
17819 struct glyph_row
*bottom_row
;
17822 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17824 struct text_pos start_pos
;
17826 int first_unchanged_at_end_vpos
= 0;
17827 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17828 struct text_pos start
;
17829 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17832 if (inhibit_try_window_id
)
17836 /* This is handy for debugging. */
17838 #define GIVE_UP(X) \
17840 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17844 #define GIVE_UP(X) return 0
17847 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17849 /* Don't use this for mini-windows because these can show
17850 messages and mini-buffers, and we don't handle that here. */
17851 if (MINI_WINDOW_P (w
))
17854 /* This flag is used to prevent redisplay optimizations. */
17855 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17858 /* This function's optimizations cannot be used if overlays have
17859 changed in the buffer displayed by the window, so give up if they
17861 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17864 /* Verify that narrowing has not changed.
17865 Also verify that we were not told to prevent redisplay optimizations.
17866 It would be nice to further
17867 reduce the number of cases where this prevents try_window_id. */
17868 if (current_buffer
->clip_changed
17869 || current_buffer
->prevent_redisplay_optimizations_p
)
17872 /* Window must either use window-based redisplay or be full width. */
17873 if (!FRAME_WINDOW_P (f
)
17874 && (!FRAME_LINE_INS_DEL_OK (f
)
17875 || !WINDOW_FULL_WIDTH_P (w
)))
17878 /* Give up if point is known NOT to appear in W. */
17879 if (PT
< CHARPOS (start
))
17882 /* Another way to prevent redisplay optimizations. */
17883 if (w
->last_modified
== 0)
17886 /* Verify that window is not hscrolled. */
17887 if (w
->hscroll
!= 0)
17890 /* Verify that display wasn't paused. */
17891 if (!w
->window_end_valid
)
17894 /* Likewise if highlighting trailing whitespace. */
17895 if (!NILP (Vshow_trailing_whitespace
))
17898 /* Can't use this if overlay arrow position and/or string have
17900 if (overlay_arrows_changed_p ())
17903 /* When word-wrap is on, adding a space to the first word of a
17904 wrapped line can change the wrap position, altering the line
17905 above it. It might be worthwhile to handle this more
17906 intelligently, but for now just redisplay from scratch. */
17907 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17910 /* Under bidi reordering, adding or deleting a character in the
17911 beginning of a paragraph, before the first strong directional
17912 character, can change the base direction of the paragraph (unless
17913 the buffer specifies a fixed paragraph direction), which will
17914 require to redisplay the whole paragraph. It might be worthwhile
17915 to find the paragraph limits and widen the range of redisplayed
17916 lines to that, but for now just give up this optimization and
17917 redisplay from scratch. */
17918 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17919 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17922 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17923 only if buffer has really changed. The reason is that the gap is
17924 initially at Z for freshly visited files. The code below would
17925 set end_unchanged to 0 in that case. */
17926 if (MODIFF
> SAVE_MODIFF
17927 /* This seems to happen sometimes after saving a buffer. */
17928 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17930 if (GPT
- BEG
< BEG_UNCHANGED
)
17931 BEG_UNCHANGED
= GPT
- BEG
;
17932 if (Z
- GPT
< END_UNCHANGED
)
17933 END_UNCHANGED
= Z
- GPT
;
17936 /* The position of the first and last character that has been changed. */
17937 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17938 last_changed_charpos
= Z
- END_UNCHANGED
;
17940 /* If window starts after a line end, and the last change is in
17941 front of that newline, then changes don't affect the display.
17942 This case happens with stealth-fontification. Note that although
17943 the display is unchanged, glyph positions in the matrix have to
17944 be adjusted, of course. */
17945 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17946 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17947 && ((last_changed_charpos
< CHARPOS (start
)
17948 && CHARPOS (start
) == BEGV
)
17949 || (last_changed_charpos
< CHARPOS (start
) - 1
17950 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17952 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17953 struct glyph_row
*r0
;
17955 /* Compute how many chars/bytes have been added to or removed
17956 from the buffer. */
17957 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17958 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17959 Z_delta
= Z
- Z_old
;
17960 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17962 /* Give up if PT is not in the window. Note that it already has
17963 been checked at the start of try_window_id that PT is not in
17964 front of the window start. */
17965 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17968 /* If window start is unchanged, we can reuse the whole matrix
17969 as is, after adjusting glyph positions. No need to compute
17970 the window end again, since its offset from Z hasn't changed. */
17971 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17972 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17973 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17974 /* PT must not be in a partially visible line. */
17975 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17976 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17978 /* Adjust positions in the glyph matrix. */
17979 if (Z_delta
|| Z_delta_bytes
)
17981 struct glyph_row
*r1
17982 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17983 increment_matrix_positions (w
->current_matrix
,
17984 MATRIX_ROW_VPOS (r0
, current_matrix
),
17985 MATRIX_ROW_VPOS (r1
, current_matrix
),
17986 Z_delta
, Z_delta_bytes
);
17989 /* Set the cursor. */
17990 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17992 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17997 /* Handle the case that changes are all below what is displayed in
17998 the window, and that PT is in the window. This shortcut cannot
17999 be taken if ZV is visible in the window, and text has been added
18000 there that is visible in the window. */
18001 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18002 /* ZV is not visible in the window, or there are no
18003 changes at ZV, actually. */
18004 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18005 || first_changed_charpos
== last_changed_charpos
))
18007 struct glyph_row
*r0
;
18009 /* Give up if PT is not in the window. Note that it already has
18010 been checked at the start of try_window_id that PT is not in
18011 front of the window start. */
18012 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18015 /* If window start is unchanged, we can reuse the whole matrix
18016 as is, without changing glyph positions since no text has
18017 been added/removed in front of the window end. */
18018 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18019 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18020 /* PT must not be in a partially visible line. */
18021 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18022 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18024 /* We have to compute the window end anew since text
18025 could have been added/removed after it. */
18026 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18027 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18029 /* Set the cursor. */
18030 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18032 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18037 /* Give up if window start is in the changed area.
18039 The condition used to read
18041 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18043 but why that was tested escapes me at the moment. */
18044 if (CHARPOS (start
) >= first_changed_charpos
18045 && CHARPOS (start
) <= last_changed_charpos
)
18048 /* Check that window start agrees with the start of the first glyph
18049 row in its current matrix. Check this after we know the window
18050 start is not in changed text, otherwise positions would not be
18052 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18053 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18056 /* Give up if the window ends in strings. Overlay strings
18057 at the end are difficult to handle, so don't try. */
18058 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18059 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18062 /* Compute the position at which we have to start displaying new
18063 lines. Some of the lines at the top of the window might be
18064 reusable because they are not displaying changed text. Find the
18065 last row in W's current matrix not affected by changes at the
18066 start of current_buffer. Value is null if changes start in the
18067 first line of window. */
18068 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18069 if (last_unchanged_at_beg_row
)
18071 /* Avoid starting to display in the middle of a character, a TAB
18072 for instance. This is easier than to set up the iterator
18073 exactly, and it's not a frequent case, so the additional
18074 effort wouldn't really pay off. */
18075 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18076 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18077 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18078 --last_unchanged_at_beg_row
;
18080 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18083 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18085 start_pos
= it
.current
.pos
;
18087 /* Start displaying new lines in the desired matrix at the same
18088 vpos we would use in the current matrix, i.e. below
18089 last_unchanged_at_beg_row. */
18090 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18092 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18093 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18095 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18099 /* There are no reusable lines at the start of the window.
18100 Start displaying in the first text line. */
18101 start_display (&it
, w
, start
);
18102 it
.vpos
= it
.first_vpos
;
18103 start_pos
= it
.current
.pos
;
18106 /* Find the first row that is not affected by changes at the end of
18107 the buffer. Value will be null if there is no unchanged row, in
18108 which case we must redisplay to the end of the window. delta
18109 will be set to the value by which buffer positions beginning with
18110 first_unchanged_at_end_row have to be adjusted due to text
18112 first_unchanged_at_end_row
18113 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18114 IF_DEBUG (debug_delta
= delta
);
18115 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18117 /* Set stop_pos to the buffer position up to which we will have to
18118 display new lines. If first_unchanged_at_end_row != NULL, this
18119 is the buffer position of the start of the line displayed in that
18120 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18121 that we don't stop at a buffer position. */
18123 if (first_unchanged_at_end_row
)
18125 eassert (last_unchanged_at_beg_row
== NULL
18126 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18128 /* If this is a continuation line, move forward to the next one
18129 that isn't. Changes in lines above affect this line.
18130 Caution: this may move first_unchanged_at_end_row to a row
18131 not displaying text. */
18132 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18133 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18134 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18135 < it
.last_visible_y
))
18136 ++first_unchanged_at_end_row
;
18138 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18139 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18140 >= it
.last_visible_y
))
18141 first_unchanged_at_end_row
= NULL
;
18144 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18146 first_unchanged_at_end_vpos
18147 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18148 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18151 else if (last_unchanged_at_beg_row
== NULL
)
18157 /* Either there is no unchanged row at the end, or the one we have
18158 now displays text. This is a necessary condition for the window
18159 end pos calculation at the end of this function. */
18160 eassert (first_unchanged_at_end_row
== NULL
18161 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18163 debug_last_unchanged_at_beg_vpos
18164 = (last_unchanged_at_beg_row
18165 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18167 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18169 #endif /* GLYPH_DEBUG */
18172 /* Display new lines. Set last_text_row to the last new line
18173 displayed which has text on it, i.e. might end up as being the
18174 line where the window_end_vpos is. */
18175 w
->cursor
.vpos
= -1;
18176 last_text_row
= NULL
;
18177 overlay_arrow_seen
= 0;
18178 if (it
.current_y
< it
.last_visible_y
18179 && !f
->fonts_changed
18180 && (first_unchanged_at_end_row
== NULL
18181 || IT_CHARPOS (it
) < stop_pos
))
18182 it
.glyph_row
->reversed_p
= false;
18183 while (it
.current_y
< it
.last_visible_y
18184 && !f
->fonts_changed
18185 && (first_unchanged_at_end_row
== NULL
18186 || IT_CHARPOS (it
) < stop_pos
))
18188 if (display_line (&it
))
18189 last_text_row
= it
.glyph_row
- 1;
18192 if (f
->fonts_changed
)
18196 /* Compute differences in buffer positions, y-positions etc. for
18197 lines reused at the bottom of the window. Compute what we can
18199 if (first_unchanged_at_end_row
18200 /* No lines reused because we displayed everything up to the
18201 bottom of the window. */
18202 && it
.current_y
< it
.last_visible_y
)
18205 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18207 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18208 run
.current_y
= first_unchanged_at_end_row
->y
;
18209 run
.desired_y
= run
.current_y
+ dy
;
18210 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18214 delta
= delta_bytes
= dvpos
= dy
18215 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18216 first_unchanged_at_end_row
= NULL
;
18218 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18221 /* Find the cursor if not already found. We have to decide whether
18222 PT will appear on this window (it sometimes doesn't, but this is
18223 not a very frequent case.) This decision has to be made before
18224 the current matrix is altered. A value of cursor.vpos < 0 means
18225 that PT is either in one of the lines beginning at
18226 first_unchanged_at_end_row or below the window. Don't care for
18227 lines that might be displayed later at the window end; as
18228 mentioned, this is not a frequent case. */
18229 if (w
->cursor
.vpos
< 0)
18231 /* Cursor in unchanged rows at the top? */
18232 if (PT
< CHARPOS (start_pos
)
18233 && last_unchanged_at_beg_row
)
18235 row
= row_containing_pos (w
, PT
,
18236 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18237 last_unchanged_at_beg_row
+ 1, 0);
18239 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18242 /* Start from first_unchanged_at_end_row looking for PT. */
18243 else if (first_unchanged_at_end_row
)
18245 row
= row_containing_pos (w
, PT
- delta
,
18246 first_unchanged_at_end_row
, NULL
, 0);
18248 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18249 delta_bytes
, dy
, dvpos
);
18252 /* Give up if cursor was not found. */
18253 if (w
->cursor
.vpos
< 0)
18255 clear_glyph_matrix (w
->desired_matrix
);
18260 /* Don't let the cursor end in the scroll margins. */
18262 int this_scroll_margin
, cursor_height
;
18263 int frame_line_height
= default_line_pixel_height (w
);
18264 int window_total_lines
18265 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18267 this_scroll_margin
=
18268 max (0, min (scroll_margin
, window_total_lines
/ 4));
18269 this_scroll_margin
*= frame_line_height
;
18270 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18272 if ((w
->cursor
.y
< this_scroll_margin
18273 && CHARPOS (start
) > BEGV
)
18274 /* Old redisplay didn't take scroll margin into account at the bottom,
18275 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18276 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18277 ? cursor_height
+ this_scroll_margin
18278 : 1)) > it
.last_visible_y
)
18280 w
->cursor
.vpos
= -1;
18281 clear_glyph_matrix (w
->desired_matrix
);
18286 /* Scroll the display. Do it before changing the current matrix so
18287 that xterm.c doesn't get confused about where the cursor glyph is
18289 if (dy
&& run
.height
)
18293 if (FRAME_WINDOW_P (f
))
18295 FRAME_RIF (f
)->update_window_begin_hook (w
);
18296 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18297 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18298 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18302 /* Terminal frame. In this case, dvpos gives the number of
18303 lines to scroll by; dvpos < 0 means scroll up. */
18305 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18306 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18307 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18308 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18309 + window_internal_height (w
));
18311 #if defined (HAVE_GPM) || defined (MSDOS)
18312 x_clear_window_mouse_face (w
);
18314 /* Perform the operation on the screen. */
18317 /* Scroll last_unchanged_at_beg_row to the end of the
18318 window down dvpos lines. */
18319 set_terminal_window (f
, end
);
18321 /* On dumb terminals delete dvpos lines at the end
18322 before inserting dvpos empty lines. */
18323 if (!FRAME_SCROLL_REGION_OK (f
))
18324 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18326 /* Insert dvpos empty lines in front of
18327 last_unchanged_at_beg_row. */
18328 ins_del_lines (f
, from
, dvpos
);
18330 else if (dvpos
< 0)
18332 /* Scroll up last_unchanged_at_beg_vpos to the end of
18333 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18334 set_terminal_window (f
, end
);
18336 /* Delete dvpos lines in front of
18337 last_unchanged_at_beg_vpos. ins_del_lines will set
18338 the cursor to the given vpos and emit |dvpos| delete
18340 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18342 /* On a dumb terminal insert dvpos empty lines at the
18344 if (!FRAME_SCROLL_REGION_OK (f
))
18345 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18348 set_terminal_window (f
, 0);
18354 /* Shift reused rows of the current matrix to the right position.
18355 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18357 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18358 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18361 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18362 bottom_vpos
, dvpos
);
18363 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18366 else if (dvpos
> 0)
18368 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18369 bottom_vpos
, dvpos
);
18370 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18371 first_unchanged_at_end_vpos
+ dvpos
);
18374 /* For frame-based redisplay, make sure that current frame and window
18375 matrix are in sync with respect to glyph memory. */
18376 if (!FRAME_WINDOW_P (f
))
18377 sync_frame_with_window_matrix_rows (w
);
18379 /* Adjust buffer positions in reused rows. */
18380 if (delta
|| delta_bytes
)
18381 increment_matrix_positions (current_matrix
,
18382 first_unchanged_at_end_vpos
+ dvpos
,
18383 bottom_vpos
, delta
, delta_bytes
);
18385 /* Adjust Y positions. */
18387 shift_glyph_matrix (w
, current_matrix
,
18388 first_unchanged_at_end_vpos
+ dvpos
,
18391 if (first_unchanged_at_end_row
)
18393 first_unchanged_at_end_row
+= dvpos
;
18394 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18395 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18396 first_unchanged_at_end_row
= NULL
;
18399 /* If scrolling up, there may be some lines to display at the end of
18401 last_text_row_at_end
= NULL
;
18404 /* Scrolling up can leave for example a partially visible line
18405 at the end of the window to be redisplayed. */
18406 /* Set last_row to the glyph row in the current matrix where the
18407 window end line is found. It has been moved up or down in
18408 the matrix by dvpos. */
18409 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18410 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18412 /* If last_row is the window end line, it should display text. */
18413 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18415 /* If window end line was partially visible before, begin
18416 displaying at that line. Otherwise begin displaying with the
18417 line following it. */
18418 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18420 init_to_row_start (&it
, w
, last_row
);
18421 it
.vpos
= last_vpos
;
18422 it
.current_y
= last_row
->y
;
18426 init_to_row_end (&it
, w
, last_row
);
18427 it
.vpos
= 1 + last_vpos
;
18428 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18432 /* We may start in a continuation line. If so, we have to
18433 get the right continuation_lines_width and current_x. */
18434 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18435 it
.hpos
= it
.current_x
= 0;
18437 /* Display the rest of the lines at the window end. */
18438 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18439 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18441 /* Is it always sure that the display agrees with lines in
18442 the current matrix? I don't think so, so we mark rows
18443 displayed invalid in the current matrix by setting their
18444 enabled_p flag to zero. */
18445 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18446 if (display_line (&it
))
18447 last_text_row_at_end
= it
.glyph_row
- 1;
18451 /* Update window_end_pos and window_end_vpos. */
18452 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18454 /* Window end line if one of the preserved rows from the current
18455 matrix. Set row to the last row displaying text in current
18456 matrix starting at first_unchanged_at_end_row, after
18458 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18459 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18460 first_unchanged_at_end_row
);
18461 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18462 adjust_window_ends (w
, row
, 1);
18463 eassert (w
->window_end_bytepos
>= 0);
18464 IF_DEBUG (debug_method_add (w
, "A"));
18466 else if (last_text_row_at_end
)
18468 adjust_window_ends (w
, last_text_row_at_end
, 0);
18469 eassert (w
->window_end_bytepos
>= 0);
18470 IF_DEBUG (debug_method_add (w
, "B"));
18472 else if (last_text_row
)
18474 /* We have displayed either to the end of the window or at the
18475 end of the window, i.e. the last row with text is to be found
18476 in the desired matrix. */
18477 adjust_window_ends (w
, last_text_row
, 0);
18478 eassert (w
->window_end_bytepos
>= 0);
18480 else if (first_unchanged_at_end_row
== NULL
18481 && last_text_row
== NULL
18482 && last_text_row_at_end
== NULL
)
18484 /* Displayed to end of window, but no line containing text was
18485 displayed. Lines were deleted at the end of the window. */
18486 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18487 int vpos
= w
->window_end_vpos
;
18488 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18489 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18492 row
== NULL
&& vpos
>= first_vpos
;
18493 --vpos
, --current_row
, --desired_row
)
18495 if (desired_row
->enabled_p
)
18497 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18500 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18504 eassert (row
!= NULL
);
18505 w
->window_end_vpos
= vpos
+ 1;
18506 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18507 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18508 eassert (w
->window_end_bytepos
>= 0);
18509 IF_DEBUG (debug_method_add (w
, "C"));
18514 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18515 debug_end_vpos
= w
->window_end_vpos
));
18517 /* Record that display has not been completed. */
18518 w
->window_end_valid
= 0;
18519 w
->desired_matrix
->no_scrolling_p
= 1;
18527 /***********************************************************************
18528 More debugging support
18529 ***********************************************************************/
18533 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18534 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18535 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18538 /* Dump the contents of glyph matrix MATRIX on stderr.
18540 GLYPHS 0 means don't show glyph contents.
18541 GLYPHS 1 means show glyphs in short form
18542 GLYPHS > 1 means show glyphs in long form. */
18545 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18548 for (i
= 0; i
< matrix
->nrows
; ++i
)
18549 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18553 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18554 the glyph row and area where the glyph comes from. */
18557 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18559 if (glyph
->type
== CHAR_GLYPH
18560 || glyph
->type
== GLYPHLESS_GLYPH
)
18563 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18564 glyph
- row
->glyphs
[TEXT_AREA
],
18565 (glyph
->type
== CHAR_GLYPH
18569 (BUFFERP (glyph
->object
)
18571 : (STRINGP (glyph
->object
)
18573 : (INTEGERP (glyph
->object
)
18576 glyph
->pixel_width
,
18578 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18582 glyph
->left_box_line_p
,
18583 glyph
->right_box_line_p
);
18585 else if (glyph
->type
== STRETCH_GLYPH
)
18588 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18589 glyph
- row
->glyphs
[TEXT_AREA
],
18592 (BUFFERP (glyph
->object
)
18594 : (STRINGP (glyph
->object
)
18596 : (INTEGERP (glyph
->object
)
18599 glyph
->pixel_width
,
18603 glyph
->left_box_line_p
,
18604 glyph
->right_box_line_p
);
18606 else if (glyph
->type
== IMAGE_GLYPH
)
18609 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18610 glyph
- row
->glyphs
[TEXT_AREA
],
18613 (BUFFERP (glyph
->object
)
18615 : (STRINGP (glyph
->object
)
18617 : (INTEGERP (glyph
->object
)
18620 glyph
->pixel_width
,
18624 glyph
->left_box_line_p
,
18625 glyph
->right_box_line_p
);
18627 else if (glyph
->type
== COMPOSITE_GLYPH
)
18630 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18631 glyph
- row
->glyphs
[TEXT_AREA
],
18634 (BUFFERP (glyph
->object
)
18636 : (STRINGP (glyph
->object
)
18638 : (INTEGERP (glyph
->object
)
18641 glyph
->pixel_width
,
18643 if (glyph
->u
.cmp
.automatic
)
18646 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18647 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18649 glyph
->left_box_line_p
,
18650 glyph
->right_box_line_p
);
18655 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18656 GLYPHS 0 means don't show glyph contents.
18657 GLYPHS 1 means show glyphs in short form
18658 GLYPHS > 1 means show glyphs in long form. */
18661 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18665 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18666 fprintf (stderr
, "==============================================================================\n");
18668 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18669 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18671 MATRIX_ROW_START_CHARPOS (row
),
18672 MATRIX_ROW_END_CHARPOS (row
),
18673 row
->used
[TEXT_AREA
],
18674 row
->contains_overlapping_glyphs_p
,
18676 row
->truncated_on_left_p
,
18677 row
->truncated_on_right_p
,
18679 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18680 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18683 row
->ends_in_middle_of_char_p
,
18684 row
->starts_in_middle_of_char_p
,
18690 row
->visible_height
,
18693 /* The next 3 lines should align to "Start" in the header. */
18694 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18695 row
->end
.overlay_string_index
,
18696 row
->continuation_lines_width
);
18697 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18698 CHARPOS (row
->start
.string_pos
),
18699 CHARPOS (row
->end
.string_pos
));
18700 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18701 row
->end
.dpvec_index
);
18708 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18710 struct glyph
*glyph
= row
->glyphs
[area
];
18711 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18713 /* Glyph for a line end in text. */
18714 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18717 if (glyph
< glyph_end
)
18718 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18720 for (; glyph
< glyph_end
; ++glyph
)
18721 dump_glyph (row
, glyph
, area
);
18724 else if (glyphs
== 1)
18727 char s
[SHRT_MAX
+ 4];
18729 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18733 for (i
= 0; i
< row
->used
[area
]; ++i
)
18735 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18736 if (i
== row
->used
[area
] - 1
18737 && area
== TEXT_AREA
18738 && INTEGERP (glyph
->object
)
18739 && glyph
->type
== CHAR_GLYPH
18740 && glyph
->u
.ch
== ' ')
18742 strcpy (&s
[i
], "[\\n]");
18745 else if (glyph
->type
== CHAR_GLYPH
18746 && glyph
->u
.ch
< 0x80
18747 && glyph
->u
.ch
>= ' ')
18748 s
[i
] = glyph
->u
.ch
;
18754 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18760 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18761 Sdump_glyph_matrix
, 0, 1, "p",
18762 doc
: /* Dump the current matrix of the selected window to stderr.
18763 Shows contents of glyph row structures. With non-nil
18764 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18765 glyphs in short form, otherwise show glyphs in long form. */)
18766 (Lisp_Object glyphs
)
18768 struct window
*w
= XWINDOW (selected_window
);
18769 struct buffer
*buffer
= XBUFFER (w
->contents
);
18771 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18772 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18773 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18774 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18775 fprintf (stderr
, "=============================================\n");
18776 dump_glyph_matrix (w
->current_matrix
,
18777 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18782 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18783 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18786 struct frame
*f
= XFRAME (selected_frame
);
18787 dump_glyph_matrix (f
->current_matrix
, 1);
18792 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18793 doc
: /* Dump glyph row ROW to stderr.
18794 GLYPH 0 means don't dump glyphs.
18795 GLYPH 1 means dump glyphs in short form.
18796 GLYPH > 1 or omitted means dump glyphs in long form. */)
18797 (Lisp_Object row
, Lisp_Object glyphs
)
18799 struct glyph_matrix
*matrix
;
18802 CHECK_NUMBER (row
);
18803 matrix
= XWINDOW (selected_window
)->current_matrix
;
18805 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18806 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18808 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18813 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18814 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18815 GLYPH 0 means don't dump glyphs.
18816 GLYPH 1 means dump glyphs in short form.
18817 GLYPH > 1 or omitted means dump glyphs in long form.
18819 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18821 (Lisp_Object row
, Lisp_Object glyphs
)
18823 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18824 struct frame
*sf
= SELECTED_FRAME ();
18825 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18828 CHECK_NUMBER (row
);
18830 if (vpos
>= 0 && vpos
< m
->nrows
)
18831 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18832 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18838 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18839 doc
: /* Toggle tracing of redisplay.
18840 With ARG, turn tracing on if and only if ARG is positive. */)
18844 trace_redisplay_p
= !trace_redisplay_p
;
18847 arg
= Fprefix_numeric_value (arg
);
18848 trace_redisplay_p
= XINT (arg
) > 0;
18855 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18856 doc
: /* Like `format', but print result to stderr.
18857 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18858 (ptrdiff_t nargs
, Lisp_Object
*args
)
18860 Lisp_Object s
= Fformat (nargs
, args
);
18861 fprintf (stderr
, "%s", SDATA (s
));
18865 #endif /* GLYPH_DEBUG */
18869 /***********************************************************************
18870 Building Desired Matrix Rows
18871 ***********************************************************************/
18873 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18874 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18876 static struct glyph_row
*
18877 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18879 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18880 struct buffer
*buffer
= XBUFFER (w
->contents
);
18881 struct buffer
*old
= current_buffer
;
18882 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18883 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18884 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18885 const unsigned char *p
;
18888 int n_glyphs_before
;
18890 set_buffer_temp (buffer
);
18891 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18892 scratch_glyph_row
.reversed_p
= false;
18893 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18894 SET_TEXT_POS (it
.position
, 0, 0);
18896 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18898 while (p
< arrow_end
)
18900 Lisp_Object face
, ilisp
;
18902 /* Get the next character. */
18904 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18907 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18908 if (! ASCII_CHAR_P (it
.c
))
18909 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18913 /* Get its face. */
18914 ilisp
= make_number (p
- arrow_string
);
18915 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18916 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18918 /* Compute its width, get its glyphs. */
18919 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18920 SET_TEXT_POS (it
.position
, -1, -1);
18921 PRODUCE_GLYPHS (&it
);
18923 /* If this character doesn't fit any more in the line, we have
18924 to remove some glyphs. */
18925 if (it
.current_x
> it
.last_visible_x
)
18927 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18932 set_buffer_temp (old
);
18933 return it
.glyph_row
;
18937 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18938 glyphs to insert is determined by produce_special_glyphs. */
18941 insert_left_trunc_glyphs (struct it
*it
)
18943 struct it truncate_it
;
18944 struct glyph
*from
, *end
, *to
, *toend
;
18946 eassert (!FRAME_WINDOW_P (it
->f
)
18947 || (!it
->glyph_row
->reversed_p
18948 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18949 || (it
->glyph_row
->reversed_p
18950 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18952 /* Get the truncation glyphs. */
18954 truncate_it
.current_x
= 0;
18955 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18956 truncate_it
.glyph_row
= &scratch_glyph_row
;
18957 truncate_it
.area
= TEXT_AREA
;
18958 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18959 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18960 truncate_it
.object
= make_number (0);
18961 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18963 /* Overwrite glyphs from IT with truncation glyphs. */
18964 if (!it
->glyph_row
->reversed_p
)
18966 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18968 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18969 end
= from
+ tused
;
18970 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18971 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18972 if (FRAME_WINDOW_P (it
->f
))
18974 /* On GUI frames, when variable-size fonts are displayed,
18975 the truncation glyphs may need more pixels than the row's
18976 glyphs they overwrite. We overwrite more glyphs to free
18977 enough screen real estate, and enlarge the stretch glyph
18978 on the right (see display_line), if there is one, to
18979 preserve the screen position of the truncation glyphs on
18982 struct glyph
*g
= to
;
18985 /* The first glyph could be partially visible, in which case
18986 it->glyph_row->x will be negative. But we want the left
18987 truncation glyphs to be aligned at the left margin of the
18988 window, so we override the x coordinate at which the row
18990 it
->glyph_row
->x
= 0;
18991 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18993 w
+= g
->pixel_width
;
18996 if (g
- to
- tused
> 0)
18998 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18999 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19001 used
= it
->glyph_row
->used
[TEXT_AREA
];
19002 if (it
->glyph_row
->truncated_on_right_p
19003 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19004 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19007 int extra
= w
- it
->truncation_pixel_width
;
19009 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19016 /* There may be padding glyphs left over. Overwrite them too. */
19017 if (!FRAME_WINDOW_P (it
->f
))
19019 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19021 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19028 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19032 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19034 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19035 that back to front. */
19036 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19037 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19038 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19039 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19040 if (FRAME_WINDOW_P (it
->f
))
19043 struct glyph
*g
= to
;
19045 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19047 w
+= g
->pixel_width
;
19050 if (to
- g
- tused
> 0)
19052 if (it
->glyph_row
->truncated_on_right_p
19053 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19054 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19056 int extra
= w
- it
->truncation_pixel_width
;
19058 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19062 while (from
>= end
&& to
>= toend
)
19064 if (!FRAME_WINDOW_P (it
->f
))
19066 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19069 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19070 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19071 while (from
>= end
&& to
>= toend
)
19077 /* Need to free some room before prepending additional
19079 int move_by
= from
- end
+ 1;
19080 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19081 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19083 for ( ; g
>= g0
; g
--)
19085 while (from
>= end
)
19087 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19092 /* Compute the hash code for ROW. */
19094 row_hash (struct glyph_row
*row
)
19097 unsigned hashval
= 0;
19099 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19100 for (k
= 0; k
< row
->used
[area
]; ++k
)
19101 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19102 + row
->glyphs
[area
][k
].u
.val
19103 + row
->glyphs
[area
][k
].face_id
19104 + row
->glyphs
[area
][k
].padding_p
19105 + (row
->glyphs
[area
][k
].type
<< 2));
19110 /* Compute the pixel height and width of IT->glyph_row.
19112 Most of the time, ascent and height of a display line will be equal
19113 to the max_ascent and max_height values of the display iterator
19114 structure. This is not the case if
19116 1. We hit ZV without displaying anything. In this case, max_ascent
19117 and max_height will be zero.
19119 2. We have some glyphs that don't contribute to the line height.
19120 (The glyph row flag contributes_to_line_height_p is for future
19121 pixmap extensions).
19123 The first case is easily covered by using default values because in
19124 these cases, the line height does not really matter, except that it
19125 must not be zero. */
19128 compute_line_metrics (struct it
*it
)
19130 struct glyph_row
*row
= it
->glyph_row
;
19132 if (FRAME_WINDOW_P (it
->f
))
19134 int i
, min_y
, max_y
;
19136 /* The line may consist of one space only, that was added to
19137 place the cursor on it. If so, the row's height hasn't been
19139 if (row
->height
== 0)
19141 if (it
->max_ascent
+ it
->max_descent
== 0)
19142 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19143 row
->ascent
= it
->max_ascent
;
19144 row
->height
= it
->max_ascent
+ it
->max_descent
;
19145 row
->phys_ascent
= it
->max_phys_ascent
;
19146 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19147 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19150 /* Compute the width of this line. */
19151 row
->pixel_width
= row
->x
;
19152 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19153 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19155 eassert (row
->pixel_width
>= 0);
19156 eassert (row
->ascent
>= 0 && row
->height
> 0);
19158 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19159 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19161 /* If first line's physical ascent is larger than its logical
19162 ascent, use the physical ascent, and make the row taller.
19163 This makes accented characters fully visible. */
19164 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19165 && row
->phys_ascent
> row
->ascent
)
19167 row
->height
+= row
->phys_ascent
- row
->ascent
;
19168 row
->ascent
= row
->phys_ascent
;
19171 /* Compute how much of the line is visible. */
19172 row
->visible_height
= row
->height
;
19174 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19175 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19177 if (row
->y
< min_y
)
19178 row
->visible_height
-= min_y
- row
->y
;
19179 if (row
->y
+ row
->height
> max_y
)
19180 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19184 row
->pixel_width
= row
->used
[TEXT_AREA
];
19185 if (row
->continued_p
)
19186 row
->pixel_width
-= it
->continuation_pixel_width
;
19187 else if (row
->truncated_on_right_p
)
19188 row
->pixel_width
-= it
->truncation_pixel_width
;
19189 row
->ascent
= row
->phys_ascent
= 0;
19190 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19191 row
->extra_line_spacing
= 0;
19194 /* Compute a hash code for this row. */
19195 row
->hash
= row_hash (row
);
19197 it
->max_ascent
= it
->max_descent
= 0;
19198 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19202 /* Append one space to the glyph row of iterator IT if doing a
19203 window-based redisplay. The space has the same face as
19204 IT->face_id. Value is non-zero if a space was added.
19206 This function is called to make sure that there is always one glyph
19207 at the end of a glyph row that the cursor can be set on under
19208 window-systems. (If there weren't such a glyph we would not know
19209 how wide and tall a box cursor should be displayed).
19211 At the same time this space let's a nicely handle clearing to the
19212 end of the line if the row ends in italic text. */
19215 append_space_for_newline (struct it
*it
, int default_face_p
)
19217 if (FRAME_WINDOW_P (it
->f
))
19219 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19221 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19222 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19224 /* Save some values that must not be changed.
19225 Must save IT->c and IT->len because otherwise
19226 ITERATOR_AT_END_P wouldn't work anymore after
19227 append_space_for_newline has been called. */
19228 enum display_element_type saved_what
= it
->what
;
19229 int saved_c
= it
->c
, saved_len
= it
->len
;
19230 int saved_char_to_display
= it
->char_to_display
;
19231 int saved_x
= it
->current_x
;
19232 int saved_face_id
= it
->face_id
;
19233 int saved_box_end
= it
->end_of_box_run_p
;
19234 struct text_pos saved_pos
;
19235 Lisp_Object saved_object
;
19238 saved_object
= it
->object
;
19239 saved_pos
= it
->position
;
19241 it
->what
= IT_CHARACTER
;
19242 memset (&it
->position
, 0, sizeof it
->position
);
19243 it
->object
= make_number (0);
19244 it
->c
= it
->char_to_display
= ' ';
19247 /* If the default face was remapped, be sure to use the
19248 remapped face for the appended newline. */
19249 if (default_face_p
)
19250 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19251 else if (it
->face_before_selective_p
)
19252 it
->face_id
= it
->saved_face_id
;
19253 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19254 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19255 /* In R2L rows, we will prepend a stretch glyph that will
19256 have the end_of_box_run_p flag set for it, so there's no
19257 need for the appended newline glyph to have that flag
19259 if (it
->glyph_row
->reversed_p
19260 /* But if the appended newline glyph goes all the way to
19261 the end of the row, there will be no stretch glyph,
19262 so leave the box flag set. */
19263 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19264 it
->end_of_box_run_p
= 0;
19266 PRODUCE_GLYPHS (it
);
19268 it
->override_ascent
= -1;
19269 it
->constrain_row_ascent_descent_p
= 0;
19270 it
->current_x
= saved_x
;
19271 it
->object
= saved_object
;
19272 it
->position
= saved_pos
;
19273 it
->what
= saved_what
;
19274 it
->face_id
= saved_face_id
;
19275 it
->len
= saved_len
;
19277 it
->char_to_display
= saved_char_to_display
;
19278 it
->end_of_box_run_p
= saved_box_end
;
19287 /* Extend the face of the last glyph in the text area of IT->glyph_row
19288 to the end of the display line. Called from display_line. If the
19289 glyph row is empty, add a space glyph to it so that we know the
19290 face to draw. Set the glyph row flag fill_line_p. If the glyph
19291 row is R2L, prepend a stretch glyph to cover the empty space to the
19292 left of the leftmost glyph. */
19295 extend_face_to_end_of_line (struct it
*it
)
19297 struct face
*face
, *default_face
;
19298 struct frame
*f
= it
->f
;
19300 /* If line is already filled, do nothing. Non window-system frames
19301 get a grace of one more ``pixel'' because their characters are
19302 1-``pixel'' wide, so they hit the equality too early. This grace
19303 is needed only for R2L rows that are not continued, to produce
19304 one extra blank where we could display the cursor. */
19305 if ((it
->current_x
>= it
->last_visible_x
19306 + (!FRAME_WINDOW_P (f
)
19307 && it
->glyph_row
->reversed_p
19308 && !it
->glyph_row
->continued_p
))
19309 /* If the window has display margins, we will need to extend
19310 their face even if the text area is filled. */
19311 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19312 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19315 /* The default face, possibly remapped. */
19316 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19318 /* Face extension extends the background and box of IT->face_id
19319 to the end of the line. If the background equals the background
19320 of the frame, we don't have to do anything. */
19321 if (it
->face_before_selective_p
)
19322 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19324 face
= FACE_FROM_ID (f
, it
->face_id
);
19326 if (FRAME_WINDOW_P (f
)
19327 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19328 && face
->box
== FACE_NO_BOX
19329 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19330 #ifdef HAVE_WINDOW_SYSTEM
19333 && !it
->glyph_row
->reversed_p
)
19336 /* Set the glyph row flag indicating that the face of the last glyph
19337 in the text area has to be drawn to the end of the text area. */
19338 it
->glyph_row
->fill_line_p
= 1;
19340 /* If current character of IT is not ASCII, make sure we have the
19341 ASCII face. This will be automatically undone the next time
19342 get_next_display_element returns a multibyte character. Note
19343 that the character will always be single byte in unibyte
19345 if (!ASCII_CHAR_P (it
->c
))
19347 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19350 if (FRAME_WINDOW_P (f
))
19352 /* If the row is empty, add a space with the current face of IT,
19353 so that we know which face to draw. */
19354 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19356 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19357 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19358 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19360 /* Mode line and the header line don't have margins, and
19361 likewise the frame's tool-bar window, if there is any. */
19362 if (!(it
->glyph_row
->mode_line_p
19363 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19364 || (WINDOWP (f
->tool_bar_window
)
19365 && it
->w
== XWINDOW (f
->tool_bar_window
))
19369 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19370 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19372 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19373 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19375 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19377 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19378 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19380 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19381 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19383 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19386 #ifdef HAVE_WINDOW_SYSTEM
19387 if (it
->glyph_row
->reversed_p
)
19389 /* Prepend a stretch glyph to the row, such that the
19390 rightmost glyph will be drawn flushed all the way to the
19391 right margin of the window. The stretch glyph that will
19392 occupy the empty space, if any, to the left of the
19394 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19395 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19396 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19398 int row_width
, stretch_ascent
, stretch_width
;
19399 struct text_pos saved_pos
;
19400 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19402 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19403 row_width
+= g
->pixel_width
;
19405 /* FIXME: There are various minor display glitches in R2L
19406 rows when only one of the fringes is missing. The
19407 strange condition below produces the least bad effect. */
19408 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19409 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19410 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19411 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19413 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19414 stretch_width
-= row_width
;
19416 if (stretch_width
> 0)
19419 (((it
->ascent
+ it
->descent
)
19420 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19421 saved_pos
= it
->position
;
19422 memset (&it
->position
, 0, sizeof it
->position
);
19423 saved_avoid_cursor
= it
->avoid_cursor_p
;
19424 it
->avoid_cursor_p
= 1;
19425 saved_face_id
= it
->face_id
;
19426 saved_box_start
= it
->start_of_box_run_p
;
19427 /* The last row's stretch glyph should get the default
19428 face, to avoid painting the rest of the window with
19429 the region face, if the region ends at ZV. */
19430 if (it
->glyph_row
->ends_at_zv_p
)
19431 it
->face_id
= default_face
->id
;
19433 it
->face_id
= face
->id
;
19434 it
->start_of_box_run_p
= 0;
19435 append_stretch_glyph (it
, make_number (0), stretch_width
,
19436 it
->ascent
+ it
->descent
, stretch_ascent
);
19437 it
->position
= saved_pos
;
19438 it
->avoid_cursor_p
= saved_avoid_cursor
;
19439 it
->face_id
= saved_face_id
;
19440 it
->start_of_box_run_p
= saved_box_start
;
19442 /* If stretch_width comes out negative, it means that the
19443 last glyph is only partially visible. In R2L rows, we
19444 want the leftmost glyph to be partially visible, so we
19445 need to give the row the corresponding left offset. */
19446 if (stretch_width
< 0)
19447 it
->glyph_row
->x
= stretch_width
;
19449 #endif /* HAVE_WINDOW_SYSTEM */
19453 /* Save some values that must not be changed. */
19454 int saved_x
= it
->current_x
;
19455 struct text_pos saved_pos
;
19456 Lisp_Object saved_object
;
19457 enum display_element_type saved_what
= it
->what
;
19458 int saved_face_id
= it
->face_id
;
19460 saved_object
= it
->object
;
19461 saved_pos
= it
->position
;
19463 it
->what
= IT_CHARACTER
;
19464 memset (&it
->position
, 0, sizeof it
->position
);
19465 it
->object
= make_number (0);
19466 it
->c
= it
->char_to_display
= ' ';
19469 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19470 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19471 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19472 && !it
->glyph_row
->mode_line_p
19473 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19475 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19476 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19478 for (it
->current_x
= 0; g
< e
; g
++)
19479 it
->current_x
+= g
->pixel_width
;
19481 it
->area
= LEFT_MARGIN_AREA
;
19482 it
->face_id
= default_face
->id
;
19483 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19484 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19486 PRODUCE_GLYPHS (it
);
19487 /* term.c:produce_glyphs advances it->current_x only for
19489 it
->current_x
+= it
->pixel_width
;
19492 it
->current_x
= saved_x
;
19493 it
->area
= TEXT_AREA
;
19496 /* The last row's blank glyphs should get the default face, to
19497 avoid painting the rest of the window with the region face,
19498 if the region ends at ZV. */
19499 if (it
->glyph_row
->ends_at_zv_p
)
19500 it
->face_id
= default_face
->id
;
19502 it
->face_id
= face
->id
;
19503 PRODUCE_GLYPHS (it
);
19505 while (it
->current_x
<= it
->last_visible_x
)
19506 PRODUCE_GLYPHS (it
);
19508 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19509 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19510 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19511 && !it
->glyph_row
->mode_line_p
19512 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19514 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19515 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19517 for ( ; g
< e
; g
++)
19518 it
->current_x
+= g
->pixel_width
;
19520 it
->area
= RIGHT_MARGIN_AREA
;
19521 it
->face_id
= default_face
->id
;
19522 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19523 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19525 PRODUCE_GLYPHS (it
);
19526 it
->current_x
+= it
->pixel_width
;
19529 it
->area
= TEXT_AREA
;
19532 /* Don't count these blanks really. It would let us insert a left
19533 truncation glyph below and make us set the cursor on them, maybe. */
19534 it
->current_x
= saved_x
;
19535 it
->object
= saved_object
;
19536 it
->position
= saved_pos
;
19537 it
->what
= saved_what
;
19538 it
->face_id
= saved_face_id
;
19543 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19544 trailing whitespace. */
19547 trailing_whitespace_p (ptrdiff_t charpos
)
19549 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19552 while (bytepos
< ZV_BYTE
19553 && (c
= FETCH_CHAR (bytepos
),
19554 c
== ' ' || c
== '\t'))
19557 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19559 if (bytepos
!= PT_BYTE
)
19566 /* Highlight trailing whitespace, if any, in ROW. */
19569 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19571 int used
= row
->used
[TEXT_AREA
];
19575 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19576 struct glyph
*glyph
= start
+ used
- 1;
19578 if (row
->reversed_p
)
19580 /* Right-to-left rows need to be processed in the opposite
19581 direction, so swap the edge pointers. */
19583 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19586 /* Skip over glyphs inserted to display the cursor at the
19587 end of a line, for extending the face of the last glyph
19588 to the end of the line on terminals, and for truncation
19589 and continuation glyphs. */
19590 if (!row
->reversed_p
)
19592 while (glyph
>= start
19593 && glyph
->type
== CHAR_GLYPH
19594 && INTEGERP (glyph
->object
))
19599 while (glyph
<= start
19600 && glyph
->type
== CHAR_GLYPH
19601 && INTEGERP (glyph
->object
))
19605 /* If last glyph is a space or stretch, and it's trailing
19606 whitespace, set the face of all trailing whitespace glyphs in
19607 IT->glyph_row to `trailing-whitespace'. */
19608 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19609 && BUFFERP (glyph
->object
)
19610 && (glyph
->type
== STRETCH_GLYPH
19611 || (glyph
->type
== CHAR_GLYPH
19612 && glyph
->u
.ch
== ' '))
19613 && trailing_whitespace_p (glyph
->charpos
))
19615 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19619 if (!row
->reversed_p
)
19621 while (glyph
>= start
19622 && BUFFERP (glyph
->object
)
19623 && (glyph
->type
== STRETCH_GLYPH
19624 || (glyph
->type
== CHAR_GLYPH
19625 && glyph
->u
.ch
== ' ')))
19626 (glyph
--)->face_id
= face_id
;
19630 while (glyph
<= start
19631 && BUFFERP (glyph
->object
)
19632 && (glyph
->type
== STRETCH_GLYPH
19633 || (glyph
->type
== CHAR_GLYPH
19634 && glyph
->u
.ch
== ' ')))
19635 (glyph
++)->face_id
= face_id
;
19642 /* Value is non-zero if glyph row ROW should be
19643 considered to hold the buffer position CHARPOS. */
19646 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19650 if (charpos
== CHARPOS (row
->end
.pos
)
19651 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19653 /* Suppose the row ends on a string.
19654 Unless the row is continued, that means it ends on a newline
19655 in the string. If it's anything other than a display string
19656 (e.g., a before-string from an overlay), we don't want the
19657 cursor there. (This heuristic seems to give the optimal
19658 behavior for the various types of multi-line strings.)
19659 One exception: if the string has `cursor' property on one of
19660 its characters, we _do_ want the cursor there. */
19661 if (CHARPOS (row
->end
.string_pos
) >= 0)
19663 if (row
->continued_p
)
19667 /* Check for `display' property. */
19668 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19669 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19670 struct glyph
*glyph
;
19673 for (glyph
= end
; glyph
>= beg
; --glyph
)
19674 if (STRINGP (glyph
->object
))
19677 = Fget_char_property (make_number (charpos
),
19681 && display_prop_string_p (prop
, glyph
->object
));
19682 /* If there's a `cursor' property on one of the
19683 string's characters, this row is a cursor row,
19684 even though this is not a display string. */
19687 Lisp_Object s
= glyph
->object
;
19689 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19691 ptrdiff_t gpos
= glyph
->charpos
;
19693 if (!NILP (Fget_char_property (make_number (gpos
),
19705 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19707 /* If the row ends in middle of a real character,
19708 and the line is continued, we want the cursor here.
19709 That's because CHARPOS (ROW->end.pos) would equal
19710 PT if PT is before the character. */
19711 if (!row
->ends_in_ellipsis_p
)
19712 result
= row
->continued_p
;
19714 /* If the row ends in an ellipsis, then
19715 CHARPOS (ROW->end.pos) will equal point after the
19716 invisible text. We want that position to be displayed
19717 after the ellipsis. */
19720 /* If the row ends at ZV, display the cursor at the end of that
19721 row instead of at the start of the row below. */
19722 else if (row
->ends_at_zv_p
)
19731 /* Value is non-zero if glyph row ROW should be
19732 used to hold the cursor. */
19735 cursor_row_p (struct glyph_row
*row
)
19737 return row_for_charpos_p (row
, PT
);
19742 /* Push the property PROP so that it will be rendered at the current
19743 position in IT. Return 1 if PROP was successfully pushed, 0
19744 otherwise. Called from handle_line_prefix to handle the
19745 `line-prefix' and `wrap-prefix' properties. */
19748 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19750 struct text_pos pos
=
19751 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19753 eassert (it
->method
== GET_FROM_BUFFER
19754 || it
->method
== GET_FROM_DISPLAY_VECTOR
19755 || it
->method
== GET_FROM_STRING
);
19757 /* We need to save the current buffer/string position, so it will be
19758 restored by pop_it, because iterate_out_of_display_property
19759 depends on that being set correctly, but some situations leave
19760 it->position not yet set when this function is called. */
19761 push_it (it
, &pos
);
19763 if (STRINGP (prop
))
19765 if (SCHARS (prop
) == 0)
19772 it
->string_from_prefix_prop_p
= 1;
19773 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19774 it
->current
.overlay_string_index
= -1;
19775 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19776 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19777 it
->method
= GET_FROM_STRING
;
19778 it
->stop_charpos
= 0;
19780 it
->base_level_stop
= 0;
19782 /* Force paragraph direction to be that of the parent
19784 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19785 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19787 it
->paragraph_embedding
= L2R
;
19789 /* Set up the bidi iterator for this display string. */
19792 it
->bidi_it
.string
.lstring
= it
->string
;
19793 it
->bidi_it
.string
.s
= NULL
;
19794 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19795 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19796 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19797 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19798 it
->bidi_it
.w
= it
->w
;
19799 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19802 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19804 it
->method
= GET_FROM_STRETCH
;
19807 #ifdef HAVE_WINDOW_SYSTEM
19808 else if (IMAGEP (prop
))
19810 it
->what
= IT_IMAGE
;
19811 it
->image_id
= lookup_image (it
->f
, prop
);
19812 it
->method
= GET_FROM_IMAGE
;
19814 #endif /* HAVE_WINDOW_SYSTEM */
19817 pop_it (it
); /* bogus display property, give up */
19824 /* Return the character-property PROP at the current position in IT. */
19827 get_it_property (struct it
*it
, Lisp_Object prop
)
19829 Lisp_Object position
, object
= it
->object
;
19831 if (STRINGP (object
))
19832 position
= make_number (IT_STRING_CHARPOS (*it
));
19833 else if (BUFFERP (object
))
19835 position
= make_number (IT_CHARPOS (*it
));
19836 object
= it
->window
;
19841 return Fget_char_property (position
, prop
, object
);
19844 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19847 handle_line_prefix (struct it
*it
)
19849 Lisp_Object prefix
;
19851 if (it
->continuation_lines_width
> 0)
19853 prefix
= get_it_property (it
, Qwrap_prefix
);
19855 prefix
= Vwrap_prefix
;
19859 prefix
= get_it_property (it
, Qline_prefix
);
19861 prefix
= Vline_prefix
;
19863 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19865 /* If the prefix is wider than the window, and we try to wrap
19866 it, it would acquire its own wrap prefix, and so on till the
19867 iterator stack overflows. So, don't wrap the prefix. */
19868 it
->line_wrap
= TRUNCATE
;
19869 it
->avoid_cursor_p
= 1;
19875 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19876 only for R2L lines from display_line and display_string, when they
19877 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19878 the line/string needs to be continued on the next glyph row. */
19880 unproduce_glyphs (struct it
*it
, int n
)
19882 struct glyph
*glyph
, *end
;
19884 eassert (it
->glyph_row
);
19885 eassert (it
->glyph_row
->reversed_p
);
19886 eassert (it
->area
== TEXT_AREA
);
19887 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19889 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19890 n
= it
->glyph_row
->used
[TEXT_AREA
];
19891 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19892 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19893 for ( ; glyph
< end
; glyph
++)
19894 glyph
[-n
] = *glyph
;
19897 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19898 and ROW->maxpos. */
19900 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19901 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19902 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19904 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19905 lines' rows is implemented for bidi-reordered rows. */
19907 /* ROW->minpos is the value of min_pos, the minimal buffer position
19908 we have in ROW, or ROW->start.pos if that is smaller. */
19909 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19910 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19912 /* We didn't find buffer positions smaller than ROW->start, or
19913 didn't find _any_ valid buffer positions in any of the glyphs,
19914 so we must trust the iterator's computed positions. */
19915 row
->minpos
= row
->start
.pos
;
19918 max_pos
= CHARPOS (it
->current
.pos
);
19919 max_bpos
= BYTEPOS (it
->current
.pos
);
19922 /* Here are the various use-cases for ending the row, and the
19923 corresponding values for ROW->maxpos:
19925 Line ends in a newline from buffer eol_pos + 1
19926 Line is continued from buffer max_pos + 1
19927 Line is truncated on right it->current.pos
19928 Line ends in a newline from string max_pos + 1(*)
19929 (*) + 1 only when line ends in a forward scan
19930 Line is continued from string max_pos
19931 Line is continued from display vector max_pos
19932 Line is entirely from a string min_pos == max_pos
19933 Line is entirely from a display vector min_pos == max_pos
19934 Line that ends at ZV ZV
19936 If you discover other use-cases, please add them here as
19938 if (row
->ends_at_zv_p
)
19939 row
->maxpos
= it
->current
.pos
;
19940 else if (row
->used
[TEXT_AREA
])
19942 int seen_this_string
= 0;
19943 struct glyph_row
*r1
= row
- 1;
19945 /* Did we see the same display string on the previous row? */
19946 if (STRINGP (it
->object
)
19947 /* this is not the first row */
19948 && row
> it
->w
->desired_matrix
->rows
19949 /* previous row is not the header line */
19950 && !r1
->mode_line_p
19951 /* previous row also ends in a newline from a string */
19952 && r1
->ends_in_newline_from_string_p
)
19954 struct glyph
*start
, *end
;
19956 /* Search for the last glyph of the previous row that came
19957 from buffer or string. Depending on whether the row is
19958 L2R or R2L, we need to process it front to back or the
19959 other way round. */
19960 if (!r1
->reversed_p
)
19962 start
= r1
->glyphs
[TEXT_AREA
];
19963 end
= start
+ r1
->used
[TEXT_AREA
];
19964 /* Glyphs inserted by redisplay have an integer (zero)
19965 as their object. */
19967 && INTEGERP ((end
- 1)->object
)
19968 && (end
- 1)->charpos
<= 0)
19972 if (EQ ((end
- 1)->object
, it
->object
))
19973 seen_this_string
= 1;
19976 /* If all the glyphs of the previous row were inserted
19977 by redisplay, it means the previous row was
19978 produced from a single newline, which is only
19979 possible if that newline came from the same string
19980 as the one which produced this ROW. */
19981 seen_this_string
= 1;
19985 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19986 start
= end
+ r1
->used
[TEXT_AREA
];
19988 && INTEGERP ((end
+ 1)->object
)
19989 && (end
+ 1)->charpos
<= 0)
19993 if (EQ ((end
+ 1)->object
, it
->object
))
19994 seen_this_string
= 1;
19997 seen_this_string
= 1;
20000 /* Take note of each display string that covers a newline only
20001 once, the first time we see it. This is for when a display
20002 string includes more than one newline in it. */
20003 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20005 /* If we were scanning the buffer forward when we displayed
20006 the string, we want to account for at least one buffer
20007 position that belongs to this row (position covered by
20008 the display string), so that cursor positioning will
20009 consider this row as a candidate when point is at the end
20010 of the visual line represented by this row. This is not
20011 required when scanning back, because max_pos will already
20012 have a much larger value. */
20013 if (CHARPOS (row
->end
.pos
) > max_pos
)
20014 INC_BOTH (max_pos
, max_bpos
);
20015 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20017 else if (CHARPOS (it
->eol_pos
) > 0)
20018 SET_TEXT_POS (row
->maxpos
,
20019 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20020 else if (row
->continued_p
)
20022 /* If max_pos is different from IT's current position, it
20023 means IT->method does not belong to the display element
20024 at max_pos. However, it also means that the display
20025 element at max_pos was displayed in its entirety on this
20026 line, which is equivalent to saying that the next line
20027 starts at the next buffer position. */
20028 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20029 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20032 INC_BOTH (max_pos
, max_bpos
);
20033 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20036 else if (row
->truncated_on_right_p
)
20037 /* display_line already called reseat_at_next_visible_line_start,
20038 which puts the iterator at the beginning of the next line, in
20039 the logical order. */
20040 row
->maxpos
= it
->current
.pos
;
20041 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20042 /* A line that is entirely from a string/image/stretch... */
20043 row
->maxpos
= row
->minpos
;
20048 row
->maxpos
= it
->current
.pos
;
20051 /* Construct the glyph row IT->glyph_row in the desired matrix of
20052 IT->w from text at the current position of IT. See dispextern.h
20053 for an overview of struct it. Value is non-zero if
20054 IT->glyph_row displays text, as opposed to a line displaying ZV
20058 display_line (struct it
*it
)
20060 struct glyph_row
*row
= it
->glyph_row
;
20061 Lisp_Object overlay_arrow_string
;
20063 void *wrap_data
= NULL
;
20064 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20065 int wrap_row_used
= -1;
20066 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20067 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20068 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20069 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20070 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20072 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20073 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20074 bool pending_handle_line_prefix
= false;
20076 /* We always start displaying at hpos zero even if hscrolled. */
20077 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20079 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20080 >= it
->w
->desired_matrix
->nrows
)
20082 it
->w
->nrows_scale_factor
++;
20083 it
->f
->fonts_changed
= 1;
20087 /* Clear the result glyph row and enable it. */
20088 prepare_desired_row (it
->w
, row
, false);
20090 row
->y
= it
->current_y
;
20091 row
->start
= it
->start
;
20092 row
->continuation_lines_width
= it
->continuation_lines_width
;
20093 row
->displays_text_p
= 1;
20094 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20095 it
->starts_in_middle_of_char_p
= 0;
20097 /* Arrange the overlays nicely for our purposes. Usually, we call
20098 display_line on only one line at a time, in which case this
20099 can't really hurt too much, or we call it on lines which appear
20100 one after another in the buffer, in which case all calls to
20101 recenter_overlay_lists but the first will be pretty cheap. */
20102 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20104 /* Move over display elements that are not visible because we are
20105 hscrolled. This may stop at an x-position < IT->first_visible_x
20106 if the first glyph is partially visible or if we hit a line end. */
20107 if (it
->current_x
< it
->first_visible_x
)
20109 enum move_it_result move_result
;
20111 this_line_min_pos
= row
->start
.pos
;
20112 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20113 MOVE_TO_POS
| MOVE_TO_X
);
20114 /* If we are under a large hscroll, move_it_in_display_line_to
20115 could hit the end of the line without reaching
20116 it->first_visible_x. Pretend that we did reach it. This is
20117 especially important on a TTY, where we will call
20118 extend_face_to_end_of_line, which needs to know how many
20119 blank glyphs to produce. */
20120 if (it
->current_x
< it
->first_visible_x
20121 && (move_result
== MOVE_NEWLINE_OR_CR
20122 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20123 it
->current_x
= it
->first_visible_x
;
20125 /* Record the smallest positions seen while we moved over
20126 display elements that are not visible. This is needed by
20127 redisplay_internal for optimizing the case where the cursor
20128 stays inside the same line. The rest of this function only
20129 considers positions that are actually displayed, so
20130 RECORD_MAX_MIN_POS will not otherwise record positions that
20131 are hscrolled to the left of the left edge of the window. */
20132 min_pos
= CHARPOS (this_line_min_pos
);
20133 min_bpos
= BYTEPOS (this_line_min_pos
);
20135 else if (it
->area
== TEXT_AREA
)
20137 /* We only do this when not calling move_it_in_display_line_to
20138 above, because that function calls itself handle_line_prefix. */
20139 handle_line_prefix (it
);
20143 /* Line-prefix and wrap-prefix are always displayed in the text
20144 area. But if this is the first call to display_line after
20145 init_iterator, the iterator might have been set up to write
20146 into a marginal area, e.g. if the line begins with some
20147 display property that writes to the margins. So we need to
20148 wait with the call to handle_line_prefix until whatever
20149 writes to the margin has done its job. */
20150 pending_handle_line_prefix
= true;
20153 /* Get the initial row height. This is either the height of the
20154 text hscrolled, if there is any, or zero. */
20155 row
->ascent
= it
->max_ascent
;
20156 row
->height
= it
->max_ascent
+ it
->max_descent
;
20157 row
->phys_ascent
= it
->max_phys_ascent
;
20158 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20159 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20161 /* Utility macro to record max and min buffer positions seen until now. */
20162 #define RECORD_MAX_MIN_POS(IT) \
20165 int composition_p = !STRINGP ((IT)->string) \
20166 && ((IT)->what == IT_COMPOSITION); \
20167 ptrdiff_t current_pos = \
20168 composition_p ? (IT)->cmp_it.charpos \
20169 : IT_CHARPOS (*(IT)); \
20170 ptrdiff_t current_bpos = \
20171 composition_p ? CHAR_TO_BYTE (current_pos) \
20172 : IT_BYTEPOS (*(IT)); \
20173 if (current_pos < min_pos) \
20175 min_pos = current_pos; \
20176 min_bpos = current_bpos; \
20178 if (IT_CHARPOS (*it) > max_pos) \
20180 max_pos = IT_CHARPOS (*it); \
20181 max_bpos = IT_BYTEPOS (*it); \
20186 /* Loop generating characters. The loop is left with IT on the next
20187 character to display. */
20190 int n_glyphs_before
, hpos_before
, x_before
;
20192 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20194 /* Retrieve the next thing to display. Value is zero if end of
20196 if (!get_next_display_element (it
))
20198 /* Maybe add a space at the end of this line that is used to
20199 display the cursor there under X. Set the charpos of the
20200 first glyph of blank lines not corresponding to any text
20202 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20203 row
->exact_window_width_line_p
= 1;
20204 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20205 || row
->used
[TEXT_AREA
] == 0)
20207 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20208 row
->displays_text_p
= 0;
20210 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20211 && (!MINI_WINDOW_P (it
->w
)
20212 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20213 row
->indicate_empty_line_p
= 1;
20216 it
->continuation_lines_width
= 0;
20217 row
->ends_at_zv_p
= 1;
20218 /* A row that displays right-to-left text must always have
20219 its last face extended all the way to the end of line,
20220 even if this row ends in ZV, because we still write to
20221 the screen left to right. We also need to extend the
20222 last face if the default face is remapped to some
20223 different face, otherwise the functions that clear
20224 portions of the screen will clear with the default face's
20225 background color. */
20226 if (row
->reversed_p
20227 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20228 extend_face_to_end_of_line (it
);
20232 /* Now, get the metrics of what we want to display. This also
20233 generates glyphs in `row' (which is IT->glyph_row). */
20234 n_glyphs_before
= row
->used
[TEXT_AREA
];
20237 /* Remember the line height so far in case the next element doesn't
20238 fit on the line. */
20239 if (it
->line_wrap
!= TRUNCATE
)
20241 ascent
= it
->max_ascent
;
20242 descent
= it
->max_descent
;
20243 phys_ascent
= it
->max_phys_ascent
;
20244 phys_descent
= it
->max_phys_descent
;
20246 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20248 if (IT_DISPLAYING_WHITESPACE (it
))
20252 SAVE_IT (wrap_it
, *it
, wrap_data
);
20254 wrap_row_used
= row
->used
[TEXT_AREA
];
20255 wrap_row_ascent
= row
->ascent
;
20256 wrap_row_height
= row
->height
;
20257 wrap_row_phys_ascent
= row
->phys_ascent
;
20258 wrap_row_phys_height
= row
->phys_height
;
20259 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20260 wrap_row_min_pos
= min_pos
;
20261 wrap_row_min_bpos
= min_bpos
;
20262 wrap_row_max_pos
= max_pos
;
20263 wrap_row_max_bpos
= max_bpos
;
20269 PRODUCE_GLYPHS (it
);
20271 /* If this display element was in marginal areas, continue with
20273 if (it
->area
!= TEXT_AREA
)
20275 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20276 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20277 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20278 row
->phys_height
= max (row
->phys_height
,
20279 it
->max_phys_ascent
+ it
->max_phys_descent
);
20280 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20281 it
->max_extra_line_spacing
);
20282 set_iterator_to_next (it
, 1);
20283 /* If we didn't handle the line/wrap prefix above, and the
20284 call to set_iterator_to_next just switched to TEXT_AREA,
20285 process the prefix now. */
20286 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20288 pending_handle_line_prefix
= false;
20289 handle_line_prefix (it
);
20294 /* Does the display element fit on the line? If we truncate
20295 lines, we should draw past the right edge of the window. If
20296 we don't truncate, we want to stop so that we can display the
20297 continuation glyph before the right margin. If lines are
20298 continued, there are two possible strategies for characters
20299 resulting in more than 1 glyph (e.g. tabs): Display as many
20300 glyphs as possible in this line and leave the rest for the
20301 continuation line, or display the whole element in the next
20302 line. Original redisplay did the former, so we do it also. */
20303 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20304 hpos_before
= it
->hpos
;
20307 if (/* Not a newline. */
20309 /* Glyphs produced fit entirely in the line. */
20310 && it
->current_x
< it
->last_visible_x
)
20312 it
->hpos
+= nglyphs
;
20313 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20314 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20315 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20316 row
->phys_height
= max (row
->phys_height
,
20317 it
->max_phys_ascent
+ it
->max_phys_descent
);
20318 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20319 it
->max_extra_line_spacing
);
20320 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20321 /* In R2L rows, we arrange in extend_face_to_end_of_line
20322 to add a right offset to the line, by a suitable
20323 change to the stretch glyph that is the leftmost
20324 glyph of the line. */
20325 && !row
->reversed_p
)
20326 row
->x
= x
- it
->first_visible_x
;
20327 /* Record the maximum and minimum buffer positions seen so
20328 far in glyphs that will be displayed by this row. */
20330 RECORD_MAX_MIN_POS (it
);
20335 struct glyph
*glyph
;
20337 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20339 /* Identify the glyphs added by the last call to
20340 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20341 the previous glyphs. */
20342 if (!row
->reversed_p
)
20343 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20345 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20346 new_x
= x
+ glyph
->pixel_width
;
20348 if (/* Lines are continued. */
20349 it
->line_wrap
!= TRUNCATE
20350 && (/* Glyph doesn't fit on the line. */
20351 new_x
> it
->last_visible_x
20352 /* Or it fits exactly on a window system frame. */
20353 || (new_x
== it
->last_visible_x
20354 && FRAME_WINDOW_P (it
->f
)
20355 && (row
->reversed_p
20356 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20357 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20359 /* End of a continued line. */
20362 || (new_x
== it
->last_visible_x
20363 && FRAME_WINDOW_P (it
->f
)
20364 && (row
->reversed_p
20365 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20366 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20368 /* Current glyph is the only one on the line or
20369 fits exactly on the line. We must continue
20370 the line because we can't draw the cursor
20371 after the glyph. */
20372 row
->continued_p
= 1;
20373 it
->current_x
= new_x
;
20374 it
->continuation_lines_width
+= new_x
;
20376 if (i
== nglyphs
- 1)
20378 /* If line-wrap is on, check if a previous
20379 wrap point was found. */
20380 if (wrap_row_used
> 0
20381 /* Even if there is a previous wrap
20382 point, continue the line here as
20383 usual, if (i) the previous character
20384 was a space or tab AND (ii) the
20385 current character is not. */
20387 || IT_DISPLAYING_WHITESPACE (it
)))
20390 /* Record the maximum and minimum buffer
20391 positions seen so far in glyphs that will be
20392 displayed by this row. */
20394 RECORD_MAX_MIN_POS (it
);
20395 set_iterator_to_next (it
, 1);
20396 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20398 if (!get_next_display_element (it
))
20400 row
->exact_window_width_line_p
= 1;
20401 it
->continuation_lines_width
= 0;
20402 row
->continued_p
= 0;
20403 row
->ends_at_zv_p
= 1;
20405 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20407 row
->continued_p
= 0;
20408 row
->exact_window_width_line_p
= 1;
20412 else if (it
->bidi_p
)
20413 RECORD_MAX_MIN_POS (it
);
20414 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20415 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20416 extend_face_to_end_of_line (it
);
20418 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20419 && !FRAME_WINDOW_P (it
->f
))
20421 /* A padding glyph that doesn't fit on this line.
20422 This means the whole character doesn't fit
20424 if (row
->reversed_p
)
20425 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20426 - n_glyphs_before
);
20427 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20429 /* Fill the rest of the row with continuation
20430 glyphs like in 20.x. */
20431 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20432 < row
->glyphs
[1 + TEXT_AREA
])
20433 produce_special_glyphs (it
, IT_CONTINUATION
);
20435 row
->continued_p
= 1;
20436 it
->current_x
= x_before
;
20437 it
->continuation_lines_width
+= x_before
;
20439 /* Restore the height to what it was before the
20440 element not fitting on the line. */
20441 it
->max_ascent
= ascent
;
20442 it
->max_descent
= descent
;
20443 it
->max_phys_ascent
= phys_ascent
;
20444 it
->max_phys_descent
= phys_descent
;
20445 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20446 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20447 extend_face_to_end_of_line (it
);
20449 else if (wrap_row_used
> 0)
20452 if (row
->reversed_p
)
20453 unproduce_glyphs (it
,
20454 row
->used
[TEXT_AREA
] - wrap_row_used
);
20455 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20456 it
->continuation_lines_width
+= wrap_x
;
20457 row
->used
[TEXT_AREA
] = wrap_row_used
;
20458 row
->ascent
= wrap_row_ascent
;
20459 row
->height
= wrap_row_height
;
20460 row
->phys_ascent
= wrap_row_phys_ascent
;
20461 row
->phys_height
= wrap_row_phys_height
;
20462 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20463 min_pos
= wrap_row_min_pos
;
20464 min_bpos
= wrap_row_min_bpos
;
20465 max_pos
= wrap_row_max_pos
;
20466 max_bpos
= wrap_row_max_bpos
;
20467 row
->continued_p
= 1;
20468 row
->ends_at_zv_p
= 0;
20469 row
->exact_window_width_line_p
= 0;
20470 it
->continuation_lines_width
+= x
;
20472 /* Make sure that a non-default face is extended
20473 up to the right margin of the window. */
20474 extend_face_to_end_of_line (it
);
20476 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20478 /* A TAB that extends past the right edge of the
20479 window. This produces a single glyph on
20480 window system frames. We leave the glyph in
20481 this row and let it fill the row, but don't
20482 consume the TAB. */
20483 if ((row
->reversed_p
20484 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20485 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20486 produce_special_glyphs (it
, IT_CONTINUATION
);
20487 it
->continuation_lines_width
+= it
->last_visible_x
;
20488 row
->ends_in_middle_of_char_p
= 1;
20489 row
->continued_p
= 1;
20490 glyph
->pixel_width
= it
->last_visible_x
- x
;
20491 it
->starts_in_middle_of_char_p
= 1;
20492 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20493 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20494 extend_face_to_end_of_line (it
);
20498 /* Something other than a TAB that draws past
20499 the right edge of the window. Restore
20500 positions to values before the element. */
20501 if (row
->reversed_p
)
20502 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20503 - (n_glyphs_before
+ i
));
20504 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20506 /* Display continuation glyphs. */
20507 it
->current_x
= x_before
;
20508 it
->continuation_lines_width
+= x
;
20509 if (!FRAME_WINDOW_P (it
->f
)
20510 || (row
->reversed_p
20511 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20512 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20513 produce_special_glyphs (it
, IT_CONTINUATION
);
20514 row
->continued_p
= 1;
20516 extend_face_to_end_of_line (it
);
20518 if (nglyphs
> 1 && i
> 0)
20520 row
->ends_in_middle_of_char_p
= 1;
20521 it
->starts_in_middle_of_char_p
= 1;
20524 /* Restore the height to what it was before the
20525 element not fitting on the line. */
20526 it
->max_ascent
= ascent
;
20527 it
->max_descent
= descent
;
20528 it
->max_phys_ascent
= phys_ascent
;
20529 it
->max_phys_descent
= phys_descent
;
20534 else if (new_x
> it
->first_visible_x
)
20536 /* Increment number of glyphs actually displayed. */
20539 /* Record the maximum and minimum buffer positions
20540 seen so far in glyphs that will be displayed by
20543 RECORD_MAX_MIN_POS (it
);
20545 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20546 /* Glyph is partially visible, i.e. row starts at
20547 negative X position. Don't do that in R2L
20548 rows, where we arrange to add a right offset to
20549 the line in extend_face_to_end_of_line, by a
20550 suitable change to the stretch glyph that is
20551 the leftmost glyph of the line. */
20552 row
->x
= x
- it
->first_visible_x
;
20553 /* When the last glyph of an R2L row only fits
20554 partially on the line, we need to set row->x to a
20555 negative offset, so that the leftmost glyph is
20556 the one that is partially visible. But if we are
20557 going to produce the truncation glyph, this will
20558 be taken care of in produce_special_glyphs. */
20559 if (row
->reversed_p
20560 && new_x
> it
->last_visible_x
20561 && !(it
->line_wrap
== TRUNCATE
20562 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20564 eassert (FRAME_WINDOW_P (it
->f
));
20565 row
->x
= it
->last_visible_x
- new_x
;
20570 /* Glyph is completely off the left margin of the
20571 window. This should not happen because of the
20572 move_it_in_display_line at the start of this
20573 function, unless the text display area of the
20574 window is empty. */
20575 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20578 /* Even if this display element produced no glyphs at all,
20579 we want to record its position. */
20580 if (it
->bidi_p
&& nglyphs
== 0)
20581 RECORD_MAX_MIN_POS (it
);
20583 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20584 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20585 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20586 row
->phys_height
= max (row
->phys_height
,
20587 it
->max_phys_ascent
+ it
->max_phys_descent
);
20588 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20589 it
->max_extra_line_spacing
);
20591 /* End of this display line if row is continued. */
20592 if (row
->continued_p
|| row
->ends_at_zv_p
)
20597 /* Is this a line end? If yes, we're also done, after making
20598 sure that a non-default face is extended up to the right
20599 margin of the window. */
20600 if (ITERATOR_AT_END_OF_LINE_P (it
))
20602 int used_before
= row
->used
[TEXT_AREA
];
20604 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20606 /* Add a space at the end of the line that is used to
20607 display the cursor there. */
20608 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20609 append_space_for_newline (it
, 0);
20611 /* Extend the face to the end of the line. */
20612 extend_face_to_end_of_line (it
);
20614 /* Make sure we have the position. */
20615 if (used_before
== 0)
20616 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20618 /* Record the position of the newline, for use in
20620 it
->eol_pos
= it
->current
.pos
;
20622 /* Consume the line end. This skips over invisible lines. */
20623 set_iterator_to_next (it
, 1);
20624 it
->continuation_lines_width
= 0;
20628 /* Proceed with next display element. Note that this skips
20629 over lines invisible because of selective display. */
20630 set_iterator_to_next (it
, 1);
20632 /* If we truncate lines, we are done when the last displayed
20633 glyphs reach past the right margin of the window. */
20634 if (it
->line_wrap
== TRUNCATE
20635 && ((FRAME_WINDOW_P (it
->f
)
20636 /* Images are preprocessed in produce_image_glyph such
20637 that they are cropped at the right edge of the
20638 window, so an image glyph will always end exactly at
20639 last_visible_x, even if there's no right fringe. */
20640 && ((row
->reversed_p
20641 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20642 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20643 || it
->what
== IT_IMAGE
))
20644 ? (it
->current_x
>= it
->last_visible_x
)
20645 : (it
->current_x
> it
->last_visible_x
)))
20647 /* Maybe add truncation glyphs. */
20648 if (!FRAME_WINDOW_P (it
->f
)
20649 || (row
->reversed_p
20650 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20651 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20655 if (!row
->reversed_p
)
20657 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20658 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20663 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20664 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20666 /* Remove any padding glyphs at the front of ROW, to
20667 make room for the truncation glyphs we will be
20668 adding below. The loop below always inserts at
20669 least one truncation glyph, so also remove the
20670 last glyph added to ROW. */
20671 unproduce_glyphs (it
, i
+ 1);
20672 /* Adjust i for the loop below. */
20673 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20676 /* produce_special_glyphs overwrites the last glyph, so
20677 we don't want that if we want to keep that last
20678 glyph, which means it's an image. */
20679 if (it
->current_x
> it
->last_visible_x
)
20681 it
->current_x
= x_before
;
20682 if (!FRAME_WINDOW_P (it
->f
))
20684 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20686 row
->used
[TEXT_AREA
] = i
;
20687 produce_special_glyphs (it
, IT_TRUNCATION
);
20692 row
->used
[TEXT_AREA
] = i
;
20693 produce_special_glyphs (it
, IT_TRUNCATION
);
20695 it
->hpos
= hpos_before
;
20698 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20700 /* Don't truncate if we can overflow newline into fringe. */
20701 if (!get_next_display_element (it
))
20703 it
->continuation_lines_width
= 0;
20704 row
->ends_at_zv_p
= 1;
20705 row
->exact_window_width_line_p
= 1;
20708 if (ITERATOR_AT_END_OF_LINE_P (it
))
20710 row
->exact_window_width_line_p
= 1;
20711 goto at_end_of_line
;
20713 it
->current_x
= x_before
;
20714 it
->hpos
= hpos_before
;
20717 row
->truncated_on_right_p
= 1;
20718 it
->continuation_lines_width
= 0;
20719 reseat_at_next_visible_line_start (it
, 0);
20720 /* We insist below that IT's position be at ZV because in
20721 bidi-reordered lines the character at visible line start
20722 might not be the character that follows the newline in
20723 the logical order. */
20724 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20725 row
->ends_at_zv_p
=
20726 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20728 row
->ends_at_zv_p
= false;
20734 bidi_unshelve_cache (wrap_data
, 1);
20736 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20737 at the left window margin. */
20738 if (it
->first_visible_x
20739 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20741 if (!FRAME_WINDOW_P (it
->f
)
20742 || (((row
->reversed_p
20743 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20744 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20745 /* Don't let insert_left_trunc_glyphs overwrite the
20746 first glyph of the row if it is an image. */
20747 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20748 insert_left_trunc_glyphs (it
);
20749 row
->truncated_on_left_p
= 1;
20752 /* Remember the position at which this line ends.
20754 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20755 cannot be before the call to find_row_edges below, since that is
20756 where these positions are determined. */
20757 row
->end
= it
->current
;
20760 row
->minpos
= row
->start
.pos
;
20761 row
->maxpos
= row
->end
.pos
;
20765 /* ROW->minpos and ROW->maxpos must be the smallest and
20766 `1 + the largest' buffer positions in ROW. But if ROW was
20767 bidi-reordered, these two positions can be anywhere in the
20768 row, so we must determine them now. */
20769 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20772 /* If the start of this line is the overlay arrow-position, then
20773 mark this glyph row as the one containing the overlay arrow.
20774 This is clearly a mess with variable size fonts. It would be
20775 better to let it be displayed like cursors under X. */
20776 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20777 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20778 !NILP (overlay_arrow_string
)))
20780 /* Overlay arrow in window redisplay is a fringe bitmap. */
20781 if (STRINGP (overlay_arrow_string
))
20783 struct glyph_row
*arrow_row
20784 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20785 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20786 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20787 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20788 struct glyph
*p2
, *end
;
20790 /* Copy the arrow glyphs. */
20791 while (glyph
< arrow_end
)
20794 /* Throw away padding glyphs. */
20796 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20797 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20803 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20808 eassert (INTEGERP (overlay_arrow_string
));
20809 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20811 overlay_arrow_seen
= 1;
20814 /* Highlight trailing whitespace. */
20815 if (!NILP (Vshow_trailing_whitespace
))
20816 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20818 /* Compute pixel dimensions of this line. */
20819 compute_line_metrics (it
);
20821 /* Implementation note: No changes in the glyphs of ROW or in their
20822 faces can be done past this point, because compute_line_metrics
20823 computes ROW's hash value and stores it within the glyph_row
20826 /* Record whether this row ends inside an ellipsis. */
20827 row
->ends_in_ellipsis_p
20828 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20829 && it
->ellipsis_p
);
20831 /* Save fringe bitmaps in this row. */
20832 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20833 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20834 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20835 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20837 it
->left_user_fringe_bitmap
= 0;
20838 it
->left_user_fringe_face_id
= 0;
20839 it
->right_user_fringe_bitmap
= 0;
20840 it
->right_user_fringe_face_id
= 0;
20842 /* Maybe set the cursor. */
20843 cvpos
= it
->w
->cursor
.vpos
;
20845 /* In bidi-reordered rows, keep checking for proper cursor
20846 position even if one has been found already, because buffer
20847 positions in such rows change non-linearly with ROW->VPOS,
20848 when a line is continued. One exception: when we are at ZV,
20849 display cursor on the first suitable glyph row, since all
20850 the empty rows after that also have their position set to ZV. */
20851 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20852 lines' rows is implemented for bidi-reordered rows. */
20854 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20855 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20856 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20857 && cursor_row_p (row
))
20858 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20860 /* Prepare for the next line. This line starts horizontally at (X
20861 HPOS) = (0 0). Vertical positions are incremented. As a
20862 convenience for the caller, IT->glyph_row is set to the next
20864 it
->current_x
= it
->hpos
= 0;
20865 it
->current_y
+= row
->height
;
20866 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20869 /* The next row should by default use the same value of the
20870 reversed_p flag as this one. set_iterator_to_next decides when
20871 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20872 the flag accordingly. */
20873 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20874 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20875 it
->start
= row
->end
;
20876 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20878 #undef RECORD_MAX_MIN_POS
20881 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20882 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20883 doc
: /* Return paragraph direction at point in BUFFER.
20884 Value is either `left-to-right' or `right-to-left'.
20885 If BUFFER is omitted or nil, it defaults to the current buffer.
20887 Paragraph direction determines how the text in the paragraph is displayed.
20888 In left-to-right paragraphs, text begins at the left margin of the window
20889 and the reading direction is generally left to right. In right-to-left
20890 paragraphs, text begins at the right margin and is read from right to left.
20892 See also `bidi-paragraph-direction'. */)
20893 (Lisp_Object buffer
)
20895 struct buffer
*buf
= current_buffer
;
20896 struct buffer
*old
= buf
;
20898 if (! NILP (buffer
))
20900 CHECK_BUFFER (buffer
);
20901 buf
= XBUFFER (buffer
);
20904 if (NILP (BVAR (buf
, bidi_display_reordering
))
20905 || NILP (BVAR (buf
, enable_multibyte_characters
))
20906 /* When we are loading loadup.el, the character property tables
20907 needed for bidi iteration are not yet available. */
20908 || !NILP (Vpurify_flag
))
20909 return Qleft_to_right
;
20910 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20911 return BVAR (buf
, bidi_paragraph_direction
);
20914 /* Determine the direction from buffer text. We could try to
20915 use current_matrix if it is up to date, but this seems fast
20916 enough as it is. */
20917 struct bidi_it itb
;
20918 ptrdiff_t pos
= BUF_PT (buf
);
20919 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20921 void *itb_data
= bidi_shelve_cache ();
20923 set_buffer_temp (buf
);
20924 /* bidi_paragraph_init finds the base direction of the paragraph
20925 by searching forward from paragraph start. We need the base
20926 direction of the current or _previous_ paragraph, so we need
20927 to make sure we are within that paragraph. To that end, find
20928 the previous non-empty line. */
20929 if (pos
>= ZV
&& pos
> BEGV
)
20930 DEC_BOTH (pos
, bytepos
);
20931 if (fast_looking_at (build_local_string ("[\f\t ]*\n"),
20932 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20934 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20935 || c
== ' ' || c
== '\t' || c
== '\f')
20937 if (bytepos
<= BEGV_BYTE
)
20942 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20945 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20946 itb
.paragraph_dir
= NEUTRAL_DIR
;
20947 itb
.string
.s
= NULL
;
20948 itb
.string
.lstring
= Qnil
;
20949 itb
.string
.bufpos
= 0;
20950 itb
.string
.from_disp_str
= 0;
20951 itb
.string
.unibyte
= 0;
20952 /* We have no window to use here for ignoring window-specific
20953 overlays. Using NULL for window pointer will cause
20954 compute_display_string_pos to use the current buffer. */
20956 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20957 bidi_unshelve_cache (itb_data
, 0);
20958 set_buffer_temp (old
);
20959 switch (itb
.paragraph_dir
)
20962 return Qleft_to_right
;
20965 return Qright_to_left
;
20973 DEFUN ("move-point-visually", Fmove_point_visually
,
20974 Smove_point_visually
, 1, 1, 0,
20975 doc
: /* Move point in the visual order in the specified DIRECTION.
20976 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20979 Value is the new character position of point. */)
20980 (Lisp_Object direction
)
20982 struct window
*w
= XWINDOW (selected_window
);
20983 struct buffer
*b
= XBUFFER (w
->contents
);
20984 struct glyph_row
*row
;
20986 Lisp_Object paragraph_dir
;
20988 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20989 (!(ROW)->continued_p \
20990 && INTEGERP ((GLYPH)->object) \
20991 && (GLYPH)->type == CHAR_GLYPH \
20992 && (GLYPH)->u.ch == ' ' \
20993 && (GLYPH)->charpos >= 0 \
20994 && !(GLYPH)->avoid_cursor_p)
20996 CHECK_NUMBER (direction
);
20997 dir
= XINT (direction
);
21003 /* If current matrix is up-to-date, we can use the information
21004 recorded in the glyphs, at least as long as the goal is on the
21006 if (w
->window_end_valid
21007 && !windows_or_buffers_changed
21009 && !b
->clip_changed
21010 && !b
->prevent_redisplay_optimizations_p
21011 && !window_outdated (w
)
21012 /* We rely below on the cursor coordinates to be up to date, but
21013 we cannot trust them if some command moved point since the
21014 last complete redisplay. */
21015 && w
->last_point
== BUF_PT (b
)
21016 && w
->cursor
.vpos
>= 0
21017 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21018 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21020 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21021 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21022 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21024 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21026 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21028 SET_PT (g
->charpos
);
21029 w
->cursor
.vpos
= -1;
21030 return make_number (PT
);
21032 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21036 if (BUFFERP (gpt
->object
))
21039 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21040 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21042 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21044 else if (BUFFERP (g
->object
))
21045 new_pos
= g
->charpos
;
21049 w
->cursor
.vpos
= -1;
21050 return make_number (PT
);
21052 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21054 /* Glyphs inserted at the end of a non-empty line for
21055 positioning the cursor have zero charpos, so we must
21056 deduce the value of point by other means. */
21057 if (g
->charpos
> 0)
21058 SET_PT (g
->charpos
);
21059 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21061 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21062 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21065 w
->cursor
.vpos
= -1;
21066 return make_number (PT
);
21069 if (g
== e
|| INTEGERP (g
->object
))
21071 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21072 goto simulate_display
;
21073 if (!row
->reversed_p
)
21077 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21078 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21079 goto simulate_display
;
21083 if (row
->reversed_p
&& !row
->continued_p
)
21085 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21086 w
->cursor
.vpos
= -1;
21087 return make_number (PT
);
21089 g
= row
->glyphs
[TEXT_AREA
];
21090 e
= g
+ row
->used
[TEXT_AREA
];
21091 for ( ; g
< e
; g
++)
21093 if (BUFFERP (g
->object
)
21094 /* Empty lines have only one glyph, which stands
21095 for the newline, and whose charpos is the
21096 buffer position of the newline. */
21097 || ROW_GLYPH_NEWLINE_P (row
, g
)
21098 /* When the buffer ends in a newline, the line at
21099 EOB also has one glyph, but its charpos is -1. */
21100 || (row
->ends_at_zv_p
21101 && !row
->reversed_p
21102 && INTEGERP (g
->object
)
21103 && g
->type
== CHAR_GLYPH
21104 && g
->u
.ch
== ' '))
21106 if (g
->charpos
> 0)
21107 SET_PT (g
->charpos
);
21108 else if (!row
->reversed_p
21109 && row
->ends_at_zv_p
21114 w
->cursor
.vpos
= -1;
21115 return make_number (PT
);
21121 if (!row
->reversed_p
&& !row
->continued_p
)
21123 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21124 w
->cursor
.vpos
= -1;
21125 return make_number (PT
);
21127 e
= row
->glyphs
[TEXT_AREA
];
21128 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21129 for ( ; g
>= e
; g
--)
21131 if (BUFFERP (g
->object
)
21132 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21134 /* Empty R2L lines on GUI frames have the buffer
21135 position of the newline stored in the stretch
21137 || g
->type
== STRETCH_GLYPH
21138 || (row
->ends_at_zv_p
21140 && INTEGERP (g
->object
)
21141 && g
->type
== CHAR_GLYPH
21142 && g
->u
.ch
== ' '))
21144 if (g
->charpos
> 0)
21145 SET_PT (g
->charpos
);
21146 else if (row
->reversed_p
21147 && row
->ends_at_zv_p
21152 w
->cursor
.vpos
= -1;
21153 return make_number (PT
);
21162 /* If we wind up here, we failed to move by using the glyphs, so we
21163 need to simulate display instead. */
21166 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21168 paragraph_dir
= Qleft_to_right
;
21169 if (EQ (paragraph_dir
, Qright_to_left
))
21171 if (PT
<= BEGV
&& dir
< 0)
21172 xsignal0 (Qbeginning_of_buffer
);
21173 else if (PT
>= ZV
&& dir
> 0)
21174 xsignal0 (Qend_of_buffer
);
21177 struct text_pos pt
;
21179 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21181 bool overshoot_expected
= false;
21182 bool target_is_eol_p
= false;
21184 /* Setup the arena. */
21185 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21186 start_display (&it
, w
, pt
);
21188 if (it
.cmp_it
.id
< 0
21189 && it
.method
== GET_FROM_STRING
21190 && it
.area
== TEXT_AREA
21191 && it
.string_from_display_prop_p
21192 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21193 overshoot_expected
= true;
21195 /* Find the X coordinate of point. We start from the beginning
21196 of this or previous line to make sure we are before point in
21197 the logical order (since the move_it_* functions can only
21200 reseat_at_previous_visible_line_start (&it
);
21201 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21202 if (IT_CHARPOS (it
) != PT
)
21204 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21205 -1, -1, -1, MOVE_TO_POS
);
21206 /* If we missed point because the character there is
21207 displayed out of a display vector that has more than one
21208 glyph, retry expecting overshoot. */
21209 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21210 && it
.current
.dpvec_index
> 0
21211 && !overshoot_expected
)
21213 overshoot_expected
= true;
21216 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21217 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21219 pt_x
= it
.current_x
;
21221 if (dir
> 0 || overshoot_expected
)
21223 struct glyph_row
*row
= it
.glyph_row
;
21225 /* When point is at beginning of line, we don't have
21226 information about the glyph there loaded into struct
21227 it. Calling get_next_display_element fixes that. */
21229 get_next_display_element (&it
);
21230 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21231 it
.glyph_row
= NULL
;
21232 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21233 it
.glyph_row
= row
;
21234 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21235 it, lest it will become out of sync with it's buffer
21237 it
.current_x
= pt_x
;
21240 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21241 pixel_width
= it
.pixel_width
;
21242 if (overshoot_expected
&& at_eol_p
)
21244 else if (pixel_width
<= 0)
21247 /* If there's a display string (or something similar) at point,
21248 we are actually at the glyph to the left of point, so we need
21249 to correct the X coordinate. */
21250 if (overshoot_expected
)
21253 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21255 pt_x
+= pixel_width
;
21258 /* Compute target X coordinate, either to the left or to the
21259 right of point. On TTY frames, all characters have the same
21260 pixel width of 1, so we can use that. On GUI frames we don't
21261 have an easy way of getting at the pixel width of the
21262 character to the left of point, so we use a different method
21263 of getting to that place. */
21265 target_x
= pt_x
+ pixel_width
;
21267 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21269 /* Target X coordinate could be one line above or below the line
21270 of point, in which case we need to adjust the target X
21271 coordinate. Also, if moving to the left, we need to begin at
21272 the left edge of the point's screen line. */
21277 start_display (&it
, w
, pt
);
21278 reseat_at_previous_visible_line_start (&it
);
21279 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21281 move_it_by_lines (&it
, pt_vpos
);
21285 move_it_by_lines (&it
, -1);
21286 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21287 target_is_eol_p
= true;
21288 /* Under word-wrap, we don't know the x coordinate of
21289 the last character displayed on the previous line,
21290 which immediately precedes the wrap point. To find
21291 out its x coordinate, we try moving to the right
21292 margin of the window, which will stop at the wrap
21293 point, and then reset target_x to point at the
21294 character that precedes the wrap point. This is not
21295 needed on GUI frames, because (see below) there we
21296 move from the left margin one grapheme cluster at a
21297 time, and stop when we hit the wrap point. */
21298 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21300 void *it_data
= NULL
;
21303 SAVE_IT (it2
, it
, it_data
);
21304 move_it_in_display_line_to (&it
, ZV
, target_x
,
21305 MOVE_TO_POS
| MOVE_TO_X
);
21306 /* If we arrived at target_x, that _is_ the last
21307 character on the previous line. */
21308 if (it
.current_x
!= target_x
)
21309 target_x
= it
.current_x
- 1;
21310 RESTORE_IT (&it
, &it2
, it_data
);
21317 || (target_x
>= it
.last_visible_x
21318 && it
.line_wrap
!= TRUNCATE
))
21321 move_it_by_lines (&it
, 0);
21322 move_it_by_lines (&it
, 1);
21327 /* Move to the target X coordinate. */
21328 #ifdef HAVE_WINDOW_SYSTEM
21329 /* On GUI frames, as we don't know the X coordinate of the
21330 character to the left of point, moving point to the left
21331 requires walking, one grapheme cluster at a time, until we
21332 find ourself at a place immediately to the left of the
21333 character at point. */
21334 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21336 struct text_pos new_pos
;
21337 enum move_it_result rc
= MOVE_X_REACHED
;
21339 if (it
.current_x
== 0)
21340 get_next_display_element (&it
);
21341 if (it
.what
== IT_COMPOSITION
)
21343 new_pos
.charpos
= it
.cmp_it
.charpos
;
21344 new_pos
.bytepos
= -1;
21347 new_pos
= it
.current
.pos
;
21349 while (it
.current_x
+ it
.pixel_width
<= target_x
21350 && (rc
== MOVE_X_REACHED
21351 /* Under word-wrap, move_it_in_display_line_to
21352 stops at correct coordinates, but sometimes
21353 returns MOVE_POS_MATCH_OR_ZV. */
21354 || (it
.line_wrap
== WORD_WRAP
21355 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21357 int new_x
= it
.current_x
+ it
.pixel_width
;
21359 /* For composed characters, we want the position of the
21360 first character in the grapheme cluster (usually, the
21361 composition's base character), whereas it.current
21362 might give us the position of the _last_ one, e.g. if
21363 the composition is rendered in reverse due to bidi
21365 if (it
.what
== IT_COMPOSITION
)
21367 new_pos
.charpos
= it
.cmp_it
.charpos
;
21368 new_pos
.bytepos
= -1;
21371 new_pos
= it
.current
.pos
;
21372 if (new_x
== it
.current_x
)
21374 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21375 MOVE_TO_POS
| MOVE_TO_X
);
21376 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21379 /* The previous position we saw in the loop is the one we
21381 if (new_pos
.bytepos
== -1)
21382 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21383 it
.current
.pos
= new_pos
;
21387 if (it
.current_x
!= target_x
)
21388 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21390 /* When lines are truncated, the above loop will stop at the
21391 window edge. But we want to get to the end of line, even if
21392 it is beyond the window edge; automatic hscroll will then
21393 scroll the window to show point as appropriate. */
21394 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21395 && get_next_display_element (&it
))
21397 struct text_pos new_pos
= it
.current
.pos
;
21399 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21401 set_iterator_to_next (&it
, 0);
21402 if (it
.method
== GET_FROM_BUFFER
)
21403 new_pos
= it
.current
.pos
;
21404 if (!get_next_display_element (&it
))
21408 it
.current
.pos
= new_pos
;
21411 /* If we ended up in a display string that covers point, move to
21412 buffer position to the right in the visual order. */
21415 while (IT_CHARPOS (it
) == PT
)
21417 set_iterator_to_next (&it
, 0);
21418 if (!get_next_display_element (&it
))
21423 /* Move point to that position. */
21424 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21427 return make_number (PT
);
21429 #undef ROW_GLYPH_NEWLINE_P
21433 /***********************************************************************
21435 ***********************************************************************/
21437 /* Redisplay the menu bar in the frame for window W.
21439 The menu bar of X frames that don't have X toolkit support is
21440 displayed in a special window W->frame->menu_bar_window.
21442 The menu bar of terminal frames is treated specially as far as
21443 glyph matrices are concerned. Menu bar lines are not part of
21444 windows, so the update is done directly on the frame matrix rows
21445 for the menu bar. */
21448 display_menu_bar (struct window
*w
)
21450 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21455 /* Don't do all this for graphical frames. */
21457 if (FRAME_W32_P (f
))
21460 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21466 if (FRAME_NS_P (f
))
21468 #endif /* HAVE_NS */
21470 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21471 eassert (!FRAME_WINDOW_P (f
));
21472 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21473 it
.first_visible_x
= 0;
21474 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21475 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21476 if (FRAME_WINDOW_P (f
))
21478 /* Menu bar lines are displayed in the desired matrix of the
21479 dummy window menu_bar_window. */
21480 struct window
*menu_w
;
21481 menu_w
= XWINDOW (f
->menu_bar_window
);
21482 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21484 it
.first_visible_x
= 0;
21485 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21488 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21490 /* This is a TTY frame, i.e. character hpos/vpos are used as
21492 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21494 it
.first_visible_x
= 0;
21495 it
.last_visible_x
= FRAME_COLS (f
);
21498 /* FIXME: This should be controlled by a user option. See the
21499 comments in redisplay_tool_bar and display_mode_line about
21501 it
.paragraph_embedding
= L2R
;
21503 /* Clear all rows of the menu bar. */
21504 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21506 struct glyph_row
*row
= it
.glyph_row
+ i
;
21507 clear_glyph_row (row
);
21508 row
->enabled_p
= true;
21509 row
->full_width_p
= 1;
21510 row
->reversed_p
= false;
21513 /* Display all items of the menu bar. */
21514 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21515 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21517 Lisp_Object string
;
21519 /* Stop at nil string. */
21520 string
= AREF (items
, i
+ 1);
21524 /* Remember where item was displayed. */
21525 ASET (items
, i
+ 3, make_number (it
.hpos
));
21527 /* Display the item, pad with one space. */
21528 if (it
.current_x
< it
.last_visible_x
)
21529 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21530 SCHARS (string
) + 1, 0, 0, -1);
21533 /* Fill out the line with spaces. */
21534 if (it
.current_x
< it
.last_visible_x
)
21535 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21537 /* Compute the total height of the lines. */
21538 compute_line_metrics (&it
);
21541 /* Deep copy of a glyph row, including the glyphs. */
21543 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21545 struct glyph
*pointers
[1 + LAST_AREA
];
21546 int to_used
= to
->used
[TEXT_AREA
];
21548 /* Save glyph pointers of TO. */
21549 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21551 /* Do a structure assignment. */
21554 /* Restore original glyph pointers of TO. */
21555 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21557 /* Copy the glyphs. */
21558 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21559 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21561 /* If we filled only part of the TO row, fill the rest with
21562 space_glyph (which will display as empty space). */
21563 if (to_used
> from
->used
[TEXT_AREA
])
21564 fill_up_frame_row_with_spaces (to
, to_used
);
21567 /* Display one menu item on a TTY, by overwriting the glyphs in the
21568 frame F's desired glyph matrix with glyphs produced from the menu
21569 item text. Called from term.c to display TTY drop-down menus one
21572 ITEM_TEXT is the menu item text as a C string.
21574 FACE_ID is the face ID to be used for this menu item. FACE_ID
21575 could specify one of 3 faces: a face for an enabled item, a face
21576 for a disabled item, or a face for a selected item.
21578 X and Y are coordinates of the first glyph in the frame's desired
21579 matrix to be overwritten by the menu item. Since this is a TTY, Y
21580 is the zero-based number of the glyph row and X is the zero-based
21581 glyph number in the row, starting from left, where to start
21582 displaying the item.
21584 SUBMENU non-zero means this menu item drops down a submenu, which
21585 should be indicated by displaying a proper visual cue after the
21589 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21590 int x
, int y
, int submenu
)
21593 struct frame
*f
= SELECTED_FRAME ();
21594 struct window
*w
= XWINDOW (f
->selected_window
);
21595 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21596 struct glyph_row
*row
;
21597 size_t item_len
= strlen (item_text
);
21599 eassert (FRAME_TERMCAP_P (f
));
21601 /* Don't write beyond the matrix's last row. This can happen for
21602 TTY screens that are not high enough to show the entire menu.
21603 (This is actually a bit of defensive programming, as
21604 tty_menu_display already limits the number of menu items to one
21605 less than the number of screen lines.) */
21606 if (y
>= f
->desired_matrix
->nrows
)
21609 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21610 it
.first_visible_x
= 0;
21611 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21612 row
= it
.glyph_row
;
21613 /* Start with the row contents from the current matrix. */
21614 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21615 saved_width
= row
->full_width_p
;
21616 row
->full_width_p
= 1;
21617 saved_reversed
= row
->reversed_p
;
21618 row
->reversed_p
= 0;
21619 row
->enabled_p
= true;
21621 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21623 eassert (x
< f
->desired_matrix
->matrix_w
);
21624 it
.current_x
= it
.hpos
= x
;
21625 it
.current_y
= it
.vpos
= y
;
21626 saved_used
= row
->used
[TEXT_AREA
];
21627 saved_truncated
= row
->truncated_on_right_p
;
21628 row
->used
[TEXT_AREA
] = x
;
21629 it
.face_id
= face_id
;
21630 it
.line_wrap
= TRUNCATE
;
21632 /* FIXME: This should be controlled by a user option. See the
21633 comments in redisplay_tool_bar and display_mode_line about this.
21634 Also, if paragraph_embedding could ever be R2L, changes will be
21635 needed to avoid shifting to the right the row characters in
21636 term.c:append_glyph. */
21637 it
.paragraph_embedding
= L2R
;
21639 /* Pad with a space on the left. */
21640 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21642 /* Display the menu item, pad with spaces to WIDTH. */
21645 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21646 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21648 /* Indicate with " >" that there's a submenu. */
21649 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21650 FRAME_COLS (f
) - 1, -1);
21653 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21654 width
, 0, FRAME_COLS (f
) - 1, -1);
21656 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21657 row
->truncated_on_right_p
= saved_truncated
;
21658 row
->hash
= row_hash (row
);
21659 row
->full_width_p
= saved_width
;
21660 row
->reversed_p
= saved_reversed
;
21663 /***********************************************************************
21665 ***********************************************************************/
21667 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21668 FORCE is non-zero, redisplay mode lines unconditionally.
21669 Otherwise, redisplay only mode lines that are garbaged. Value is
21670 the number of windows whose mode lines were redisplayed. */
21673 redisplay_mode_lines (Lisp_Object window
, bool force
)
21677 while (!NILP (window
))
21679 struct window
*w
= XWINDOW (window
);
21681 if (WINDOWP (w
->contents
))
21682 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21684 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21685 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21687 struct text_pos lpoint
;
21688 struct buffer
*old
= current_buffer
;
21690 /* Set the window's buffer for the mode line display. */
21691 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21692 set_buffer_internal_1 (XBUFFER (w
->contents
));
21694 /* Point refers normally to the selected window. For any
21695 other window, set up appropriate value. */
21696 if (!EQ (window
, selected_window
))
21698 struct text_pos pt
;
21700 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21701 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21704 /* Display mode lines. */
21705 clear_glyph_matrix (w
->desired_matrix
);
21706 if (display_mode_lines (w
))
21709 /* Restore old settings. */
21710 set_buffer_internal_1 (old
);
21711 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21721 /* Display the mode and/or header line of window W. Value is the
21722 sum number of mode lines and header lines displayed. */
21725 display_mode_lines (struct window
*w
)
21727 Lisp_Object old_selected_window
= selected_window
;
21728 Lisp_Object old_selected_frame
= selected_frame
;
21729 Lisp_Object new_frame
= w
->frame
;
21730 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21733 selected_frame
= new_frame
;
21734 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21735 or window's point, then we'd need select_window_1 here as well. */
21736 XSETWINDOW (selected_window
, w
);
21737 XFRAME (new_frame
)->selected_window
= selected_window
;
21739 /* These will be set while the mode line specs are processed. */
21740 line_number_displayed
= 0;
21741 w
->column_number_displayed
= -1;
21743 if (WINDOW_WANTS_MODELINE_P (w
))
21745 struct window
*sel_w
= XWINDOW (old_selected_window
);
21747 /* Select mode line face based on the real selected window. */
21748 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21749 BVAR (current_buffer
, mode_line_format
));
21753 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21755 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21756 BVAR (current_buffer
, header_line_format
));
21760 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21761 selected_frame
= old_selected_frame
;
21762 selected_window
= old_selected_window
;
21764 w
->must_be_updated_p
= true;
21769 /* Display mode or header line of window W. FACE_ID specifies which
21770 line to display; it is either MODE_LINE_FACE_ID or
21771 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21772 display. Value is the pixel height of the mode/header line
21776 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21780 ptrdiff_t count
= SPECPDL_INDEX ();
21782 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21783 /* Don't extend on a previously drawn mode-line.
21784 This may happen if called from pos_visible_p. */
21785 it
.glyph_row
->enabled_p
= false;
21786 prepare_desired_row (w
, it
.glyph_row
, true);
21788 it
.glyph_row
->mode_line_p
= 1;
21790 /* FIXME: This should be controlled by a user option. But
21791 supporting such an option is not trivial, since the mode line is
21792 made up of many separate strings. */
21793 it
.paragraph_embedding
= L2R
;
21795 record_unwind_protect (unwind_format_mode_line
,
21796 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21798 mode_line_target
= MODE_LINE_DISPLAY
;
21800 /* Temporarily make frame's keyboard the current kboard so that
21801 kboard-local variables in the mode_line_format will get the right
21803 push_kboard (FRAME_KBOARD (it
.f
));
21804 record_unwind_save_match_data ();
21805 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21808 unbind_to (count
, Qnil
);
21810 /* Fill up with spaces. */
21811 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21813 compute_line_metrics (&it
);
21814 it
.glyph_row
->full_width_p
= 1;
21815 it
.glyph_row
->continued_p
= 0;
21816 it
.glyph_row
->truncated_on_left_p
= 0;
21817 it
.glyph_row
->truncated_on_right_p
= 0;
21819 /* Make a 3D mode-line have a shadow at its right end. */
21820 face
= FACE_FROM_ID (it
.f
, face_id
);
21821 extend_face_to_end_of_line (&it
);
21822 if (face
->box
!= FACE_NO_BOX
)
21824 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21825 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21826 last
->right_box_line_p
= 1;
21829 return it
.glyph_row
->height
;
21832 /* Move element ELT in LIST to the front of LIST.
21833 Return the updated list. */
21836 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21838 register Lisp_Object tail
, prev
;
21839 register Lisp_Object tem
;
21843 while (CONSP (tail
))
21849 /* Splice out the link TAIL. */
21851 list
= XCDR (tail
);
21853 Fsetcdr (prev
, XCDR (tail
));
21855 /* Now make it the first. */
21856 Fsetcdr (tail
, list
);
21861 tail
= XCDR (tail
);
21865 /* Not found--return unchanged LIST. */
21869 /* Contribute ELT to the mode line for window IT->w. How it
21870 translates into text depends on its data type.
21872 IT describes the display environment in which we display, as usual.
21874 DEPTH is the depth in recursion. It is used to prevent
21875 infinite recursion here.
21877 FIELD_WIDTH is the number of characters the display of ELT should
21878 occupy in the mode line, and PRECISION is the maximum number of
21879 characters to display from ELT's representation. See
21880 display_string for details.
21882 Returns the hpos of the end of the text generated by ELT.
21884 PROPS is a property list to add to any string we encounter.
21886 If RISKY is nonzero, remove (disregard) any properties in any string
21887 we encounter, and ignore :eval and :propertize.
21889 The global variable `mode_line_target' determines whether the
21890 output is passed to `store_mode_line_noprop',
21891 `store_mode_line_string', or `display_string'. */
21894 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21895 Lisp_Object elt
, Lisp_Object props
, int risky
)
21897 int n
= 0, field
, prec
;
21902 elt
= build_string ("*too-deep*");
21906 switch (XTYPE (elt
))
21910 /* A string: output it and check for %-constructs within it. */
21912 ptrdiff_t offset
= 0;
21914 if (SCHARS (elt
) > 0
21915 && (!NILP (props
) || risky
))
21917 Lisp_Object oprops
, aelt
;
21918 oprops
= Ftext_properties_at (make_number (0), elt
);
21920 /* If the starting string's properties are not what
21921 we want, translate the string. Also, if the string
21922 is risky, do that anyway. */
21924 if (NILP (Fequal (props
, oprops
)) || risky
)
21926 /* If the starting string has properties,
21927 merge the specified ones onto the existing ones. */
21928 if (! NILP (oprops
) && !risky
)
21932 oprops
= Fcopy_sequence (oprops
);
21934 while (CONSP (tem
))
21936 oprops
= Fplist_put (oprops
, XCAR (tem
),
21937 XCAR (XCDR (tem
)));
21938 tem
= XCDR (XCDR (tem
));
21943 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21944 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21946 /* AELT is what we want. Move it to the front
21947 without consing. */
21949 mode_line_proptrans_alist
21950 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21956 /* If AELT has the wrong props, it is useless.
21957 so get rid of it. */
21959 mode_line_proptrans_alist
21960 = Fdelq (aelt
, mode_line_proptrans_alist
);
21962 elt
= Fcopy_sequence (elt
);
21963 Fset_text_properties (make_number (0), Flength (elt
),
21965 /* Add this item to mode_line_proptrans_alist. */
21966 mode_line_proptrans_alist
21967 = Fcons (Fcons (elt
, props
),
21968 mode_line_proptrans_alist
);
21969 /* Truncate mode_line_proptrans_alist
21970 to at most 50 elements. */
21971 tem
= Fnthcdr (make_number (50),
21972 mode_line_proptrans_alist
);
21974 XSETCDR (tem
, Qnil
);
21983 prec
= precision
- n
;
21984 switch (mode_line_target
)
21986 case MODE_LINE_NOPROP
:
21987 case MODE_LINE_TITLE
:
21988 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21990 case MODE_LINE_STRING
:
21991 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21993 case MODE_LINE_DISPLAY
:
21994 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21995 0, prec
, 0, STRING_MULTIBYTE (elt
));
22002 /* Handle the non-literal case. */
22004 while ((precision
<= 0 || n
< precision
)
22005 && SREF (elt
, offset
) != 0
22006 && (mode_line_target
!= MODE_LINE_DISPLAY
22007 || it
->current_x
< it
->last_visible_x
))
22009 ptrdiff_t last_offset
= offset
;
22011 /* Advance to end of string or next format specifier. */
22012 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22015 if (offset
- 1 != last_offset
)
22017 ptrdiff_t nchars
, nbytes
;
22019 /* Output to end of string or up to '%'. Field width
22020 is length of string. Don't output more than
22021 PRECISION allows us. */
22024 prec
= c_string_width (SDATA (elt
) + last_offset
,
22025 offset
- last_offset
, precision
- n
,
22028 switch (mode_line_target
)
22030 case MODE_LINE_NOPROP
:
22031 case MODE_LINE_TITLE
:
22032 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22034 case MODE_LINE_STRING
:
22036 ptrdiff_t bytepos
= last_offset
;
22037 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22038 ptrdiff_t endpos
= (precision
<= 0
22039 ? string_byte_to_char (elt
, offset
)
22040 : charpos
+ nchars
);
22042 n
+= store_mode_line_string (NULL
,
22043 Fsubstring (elt
, make_number (charpos
),
22044 make_number (endpos
)),
22048 case MODE_LINE_DISPLAY
:
22050 ptrdiff_t bytepos
= last_offset
;
22051 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22053 if (precision
<= 0)
22054 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22055 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22057 STRING_MULTIBYTE (elt
));
22062 else /* c == '%' */
22064 ptrdiff_t percent_position
= offset
;
22066 /* Get the specified minimum width. Zero means
22069 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22070 field
= field
* 10 + c
- '0';
22072 /* Don't pad beyond the total padding allowed. */
22073 if (field_width
- n
> 0 && field
> field_width
- n
)
22074 field
= field_width
- n
;
22076 /* Note that either PRECISION <= 0 or N < PRECISION. */
22077 prec
= precision
- n
;
22080 n
+= display_mode_element (it
, depth
, field
, prec
,
22081 Vglobal_mode_string
, props
,
22086 ptrdiff_t bytepos
, charpos
;
22088 Lisp_Object string
;
22090 bytepos
= percent_position
;
22091 charpos
= (STRING_MULTIBYTE (elt
)
22092 ? string_byte_to_char (elt
, bytepos
)
22094 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22095 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22097 switch (mode_line_target
)
22099 case MODE_LINE_NOPROP
:
22100 case MODE_LINE_TITLE
:
22101 n
+= store_mode_line_noprop (spec
, field
, prec
);
22103 case MODE_LINE_STRING
:
22105 Lisp_Object tem
= build_string (spec
);
22106 props
= Ftext_properties_at (make_number (charpos
), elt
);
22107 /* Should only keep face property in props */
22108 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22111 case MODE_LINE_DISPLAY
:
22113 int nglyphs_before
, nwritten
;
22115 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22116 nwritten
= display_string (spec
, string
, elt
,
22121 /* Assign to the glyphs written above the
22122 string where the `%x' came from, position
22126 struct glyph
*glyph
22127 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22131 for (i
= 0; i
< nwritten
; ++i
)
22133 glyph
[i
].object
= elt
;
22134 glyph
[i
].charpos
= charpos
;
22151 /* A symbol: process the value of the symbol recursively
22152 as if it appeared here directly. Avoid error if symbol void.
22153 Special case: if value of symbol is a string, output the string
22156 register Lisp_Object tem
;
22158 /* If the variable is not marked as risky to set
22159 then its contents are risky to use. */
22160 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22163 tem
= Fboundp (elt
);
22166 tem
= Fsymbol_value (elt
);
22167 /* If value is a string, output that string literally:
22168 don't check for % within it. */
22172 if (!EQ (tem
, elt
))
22174 /* Give up right away for nil or t. */
22184 register Lisp_Object car
, tem
;
22186 /* A cons cell: five distinct cases.
22187 If first element is :eval or :propertize, do something special.
22188 If first element is a string or a cons, process all the elements
22189 and effectively concatenate them.
22190 If first element is a negative number, truncate displaying cdr to
22191 at most that many characters. If positive, pad (with spaces)
22192 to at least that many characters.
22193 If first element is a symbol, process the cadr or caddr recursively
22194 according to whether the symbol's value is non-nil or nil. */
22196 if (EQ (car
, QCeval
))
22198 /* An element of the form (:eval FORM) means evaluate FORM
22199 and use the result as mode line elements. */
22204 if (CONSP (XCDR (elt
)))
22207 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22208 n
+= display_mode_element (it
, depth
, field_width
- n
,
22209 precision
- n
, spec
, props
,
22213 else if (EQ (car
, QCpropertize
))
22215 /* An element of the form (:propertize ELT PROPS...)
22216 means display ELT but applying properties PROPS. */
22221 if (CONSP (XCDR (elt
)))
22222 n
+= display_mode_element (it
, depth
, field_width
- n
,
22223 precision
- n
, XCAR (XCDR (elt
)),
22224 XCDR (XCDR (elt
)), risky
);
22226 else if (SYMBOLP (car
))
22228 tem
= Fboundp (car
);
22232 /* elt is now the cdr, and we know it is a cons cell.
22233 Use its car if CAR has a non-nil value. */
22236 tem
= Fsymbol_value (car
);
22243 /* Symbol's value is nil (or symbol is unbound)
22244 Get the cddr of the original list
22245 and if possible find the caddr and use that. */
22249 else if (!CONSP (elt
))
22254 else if (INTEGERP (car
))
22256 register int lim
= XINT (car
);
22260 /* Negative int means reduce maximum width. */
22261 if (precision
<= 0)
22264 precision
= min (precision
, -lim
);
22268 /* Padding specified. Don't let it be more than
22269 current maximum. */
22271 lim
= min (precision
, lim
);
22273 /* If that's more padding than already wanted, queue it.
22274 But don't reduce padding already specified even if
22275 that is beyond the current truncation point. */
22276 field_width
= max (lim
, field_width
);
22280 else if (STRINGP (car
) || CONSP (car
))
22282 Lisp_Object halftail
= elt
;
22286 && (precision
<= 0 || n
< precision
))
22288 n
+= display_mode_element (it
, depth
,
22289 /* Do padding only after the last
22290 element in the list. */
22291 (! CONSP (XCDR (elt
))
22294 precision
- n
, XCAR (elt
),
22298 if ((len
& 1) == 0)
22299 halftail
= XCDR (halftail
);
22300 /* Check for cycle. */
22301 if (EQ (halftail
, elt
))
22310 elt
= build_string ("*invalid*");
22314 /* Pad to FIELD_WIDTH. */
22315 if (field_width
> 0 && n
< field_width
)
22317 switch (mode_line_target
)
22319 case MODE_LINE_NOPROP
:
22320 case MODE_LINE_TITLE
:
22321 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22323 case MODE_LINE_STRING
:
22324 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22326 case MODE_LINE_DISPLAY
:
22327 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22336 /* Store a mode-line string element in mode_line_string_list.
22338 If STRING is non-null, display that C string. Otherwise, the Lisp
22339 string LISP_STRING is displayed.
22341 FIELD_WIDTH is the minimum number of output glyphs to produce.
22342 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22343 with spaces. FIELD_WIDTH <= 0 means don't pad.
22345 PRECISION is the maximum number of characters to output from
22346 STRING. PRECISION <= 0 means don't truncate the string.
22348 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22349 properties to the string.
22351 PROPS are the properties to add to the string.
22352 The mode_line_string_face face property is always added to the string.
22356 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22357 int field_width
, int precision
, Lisp_Object props
)
22362 if (string
!= NULL
)
22364 len
= strlen (string
);
22365 if (precision
> 0 && len
> precision
)
22367 lisp_string
= make_string (string
, len
);
22369 props
= mode_line_string_face_prop
;
22370 else if (!NILP (mode_line_string_face
))
22372 Lisp_Object face
= Fplist_get (props
, Qface
);
22373 props
= Fcopy_sequence (props
);
22375 face
= mode_line_string_face
;
22377 face
= list2 (face
, mode_line_string_face
);
22378 props
= Fplist_put (props
, Qface
, face
);
22380 Fadd_text_properties (make_number (0), make_number (len
),
22381 props
, lisp_string
);
22385 len
= XFASTINT (Flength (lisp_string
));
22386 if (precision
> 0 && len
> precision
)
22389 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22392 if (!NILP (mode_line_string_face
))
22396 props
= Ftext_properties_at (make_number (0), lisp_string
);
22397 face
= Fplist_get (props
, Qface
);
22399 face
= mode_line_string_face
;
22401 face
= list2 (face
, mode_line_string_face
);
22402 props
= list2 (Qface
, face
);
22404 lisp_string
= Fcopy_sequence (lisp_string
);
22407 Fadd_text_properties (make_number (0), make_number (len
),
22408 props
, lisp_string
);
22413 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22417 if (field_width
> len
)
22419 field_width
-= len
;
22420 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22422 Fadd_text_properties (make_number (0), make_number (field_width
),
22423 props
, lisp_string
);
22424 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22432 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22434 doc
: /* Format a string out of a mode line format specification.
22435 First arg FORMAT specifies the mode line format (see `mode-line-format'
22436 for details) to use.
22438 By default, the format is evaluated for the currently selected window.
22440 Optional second arg FACE specifies the face property to put on all
22441 characters for which no face is specified. The value nil means the
22442 default face. The value t means whatever face the window's mode line
22443 currently uses (either `mode-line' or `mode-line-inactive',
22444 depending on whether the window is the selected window or not).
22445 An integer value means the value string has no text
22448 Optional third and fourth args WINDOW and BUFFER specify the window
22449 and buffer to use as the context for the formatting (defaults
22450 are the selected window and the WINDOW's buffer). */)
22451 (Lisp_Object format
, Lisp_Object face
,
22452 Lisp_Object window
, Lisp_Object buffer
)
22457 struct buffer
*old_buffer
= NULL
;
22459 int no_props
= INTEGERP (face
);
22460 ptrdiff_t count
= SPECPDL_INDEX ();
22462 int string_start
= 0;
22464 w
= decode_any_window (window
);
22465 XSETWINDOW (window
, w
);
22468 buffer
= w
->contents
;
22469 CHECK_BUFFER (buffer
);
22471 /* Make formatting the modeline a non-op when noninteractive, otherwise
22472 there will be problems later caused by a partially initialized frame. */
22473 if (NILP (format
) || noninteractive
)
22474 return empty_unibyte_string
;
22479 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22480 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22481 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22482 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22483 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22484 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22485 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22488 old_buffer
= current_buffer
;
22490 /* Save things including mode_line_proptrans_alist,
22491 and set that to nil so that we don't alter the outer value. */
22492 record_unwind_protect (unwind_format_mode_line
,
22493 format_mode_line_unwind_data
22494 (XFRAME (WINDOW_FRAME (w
)),
22495 old_buffer
, selected_window
, 1));
22496 mode_line_proptrans_alist
= Qnil
;
22498 Fselect_window (window
, Qt
);
22499 set_buffer_internal_1 (XBUFFER (buffer
));
22501 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22505 mode_line_target
= MODE_LINE_NOPROP
;
22506 mode_line_string_face_prop
= Qnil
;
22507 mode_line_string_list
= Qnil
;
22508 string_start
= MODE_LINE_NOPROP_LEN (0);
22512 mode_line_target
= MODE_LINE_STRING
;
22513 mode_line_string_list
= Qnil
;
22514 mode_line_string_face
= face
;
22515 mode_line_string_face_prop
22516 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22519 push_kboard (FRAME_KBOARD (it
.f
));
22520 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22525 len
= MODE_LINE_NOPROP_LEN (string_start
);
22526 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22530 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22531 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22532 empty_unibyte_string
);
22535 unbind_to (count
, Qnil
);
22539 /* Write a null-terminated, right justified decimal representation of
22540 the positive integer D to BUF using a minimal field width WIDTH. */
22543 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22545 register char *p
= buf
;
22553 *p
++ = d
% 10 + '0';
22558 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22569 /* Write a null-terminated, right justified decimal and "human
22570 readable" representation of the nonnegative integer D to BUF using
22571 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22573 static const char power_letter
[] =
22587 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22589 /* We aim to represent the nonnegative integer D as
22590 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22591 ptrdiff_t quotient
= d
;
22593 /* -1 means: do not use TENTHS. */
22597 /* Length of QUOTIENT.TENTHS as a string. */
22603 if (quotient
>= 1000)
22605 /* Scale to the appropriate EXPONENT. */
22608 remainder
= quotient
% 1000;
22612 while (quotient
>= 1000);
22614 /* Round to nearest and decide whether to use TENTHS or not. */
22617 tenths
= remainder
/ 100;
22618 if (remainder
% 100 >= 50)
22625 if (quotient
== 10)
22633 if (remainder
>= 500)
22635 if (quotient
< 999)
22646 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22647 if (tenths
== -1 && quotient
<= 99)
22654 p
= psuffix
= buf
+ max (width
, length
);
22656 /* Print EXPONENT. */
22657 *psuffix
++ = power_letter
[exponent
];
22660 /* Print TENTHS. */
22663 *--p
= '0' + tenths
;
22667 /* Print QUOTIENT. */
22670 int digit
= quotient
% 10;
22671 *--p
= '0' + digit
;
22673 while ((quotient
/= 10) != 0);
22675 /* Print leading spaces. */
22680 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22681 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22682 type of CODING_SYSTEM. Return updated pointer into BUF. */
22684 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22687 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22690 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22691 const unsigned char *eol_str
;
22693 /* The EOL conversion we are using. */
22694 Lisp_Object eoltype
;
22696 val
= CODING_SYSTEM_SPEC (coding_system
);
22699 if (!VECTORP (val
)) /* Not yet decided. */
22701 *buf
++ = multibyte
? '-' : ' ';
22703 eoltype
= eol_mnemonic_undecided
;
22704 /* Don't mention EOL conversion if it isn't decided. */
22709 Lisp_Object eolvalue
;
22711 attrs
= AREF (val
, 0);
22712 eolvalue
= AREF (val
, 2);
22715 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22720 /* The EOL conversion that is normal on this system. */
22722 if (NILP (eolvalue
)) /* Not yet decided. */
22723 eoltype
= eol_mnemonic_undecided
;
22724 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22725 eoltype
= eol_mnemonic_undecided
;
22726 else /* eolvalue is Qunix, Qdos, or Qmac. */
22727 eoltype
= (EQ (eolvalue
, Qunix
)
22728 ? eol_mnemonic_unix
22729 : (EQ (eolvalue
, Qdos
) == 1
22730 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22736 /* Mention the EOL conversion if it is not the usual one. */
22737 if (STRINGP (eoltype
))
22739 eol_str
= SDATA (eoltype
);
22740 eol_str_len
= SBYTES (eoltype
);
22742 else if (CHARACTERP (eoltype
))
22744 int c
= XFASTINT (eoltype
);
22745 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
22749 eol_str
= invalid_eol_type
;
22750 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22752 memcpy (buf
, eol_str
, eol_str_len
);
22753 buf
+= eol_str_len
;
22759 /* Return a string for the output of a mode line %-spec for window W,
22760 generated by character C. FIELD_WIDTH > 0 means pad the string
22761 returned with spaces to that value. Return a Lisp string in
22762 *STRING if the resulting string is taken from that Lisp string.
22764 Note we operate on the current buffer for most purposes. */
22766 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22768 static const char *
22769 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22770 Lisp_Object
*string
)
22773 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22774 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22775 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22776 produce strings from numerical values, so limit preposterously
22777 large values of FIELD_WIDTH to avoid overrunning the buffer's
22778 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22779 bytes plus the terminating null. */
22780 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22781 struct buffer
*b
= current_buffer
;
22789 if (!NILP (BVAR (b
, read_only
)))
22791 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22796 /* This differs from %* only for a modified read-only buffer. */
22797 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22799 if (!NILP (BVAR (b
, read_only
)))
22804 /* This differs from %* in ignoring read-only-ness. */
22805 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22817 if (command_loop_level
> 5)
22819 p
= decode_mode_spec_buf
;
22820 for (i
= 0; i
< command_loop_level
; i
++)
22823 return decode_mode_spec_buf
;
22831 if (command_loop_level
> 5)
22833 p
= decode_mode_spec_buf
;
22834 for (i
= 0; i
< command_loop_level
; i
++)
22837 return decode_mode_spec_buf
;
22844 /* Let lots_of_dashes be a string of infinite length. */
22845 if (mode_line_target
== MODE_LINE_NOPROP
22846 || mode_line_target
== MODE_LINE_STRING
)
22848 if (field_width
<= 0
22849 || field_width
> sizeof (lots_of_dashes
))
22851 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22852 decode_mode_spec_buf
[i
] = '-';
22853 decode_mode_spec_buf
[i
] = '\0';
22854 return decode_mode_spec_buf
;
22857 return lots_of_dashes
;
22861 obj
= BVAR (b
, name
);
22865 /* %c and %l are ignored in `frame-title-format'.
22866 (In redisplay_internal, the frame title is drawn _before_ the
22867 windows are updated, so the stuff which depends on actual
22868 window contents (such as %l) may fail to render properly, or
22869 even crash emacs.) */
22870 if (mode_line_target
== MODE_LINE_TITLE
)
22874 ptrdiff_t col
= current_column ();
22875 w
->column_number_displayed
= col
;
22876 pint2str (decode_mode_spec_buf
, width
, col
);
22877 return decode_mode_spec_buf
;
22881 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
22883 if (NILP (Vmemory_full
))
22886 return "!MEM FULL! ";
22893 /* %F displays the frame name. */
22894 if (!NILP (f
->title
))
22895 return SSDATA (f
->title
);
22896 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22897 return SSDATA (f
->name
);
22901 obj
= BVAR (b
, filename
);
22906 ptrdiff_t size
= ZV
- BEGV
;
22907 pint2str (decode_mode_spec_buf
, width
, size
);
22908 return decode_mode_spec_buf
;
22913 ptrdiff_t size
= ZV
- BEGV
;
22914 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22915 return decode_mode_spec_buf
;
22920 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22921 ptrdiff_t topline
, nlines
, height
;
22924 /* %c and %l are ignored in `frame-title-format'. */
22925 if (mode_line_target
== MODE_LINE_TITLE
)
22928 startpos
= marker_position (w
->start
);
22929 startpos_byte
= marker_byte_position (w
->start
);
22930 height
= WINDOW_TOTAL_LINES (w
);
22932 /* If we decided that this buffer isn't suitable for line numbers,
22933 don't forget that too fast. */
22934 if (w
->base_line_pos
== -1)
22937 /* If the buffer is very big, don't waste time. */
22938 if (INTEGERP (Vline_number_display_limit
)
22939 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22941 w
->base_line_pos
= 0;
22942 w
->base_line_number
= 0;
22946 if (w
->base_line_number
> 0
22947 && w
->base_line_pos
> 0
22948 && w
->base_line_pos
<= startpos
)
22950 line
= w
->base_line_number
;
22951 linepos
= w
->base_line_pos
;
22952 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22957 linepos
= BUF_BEGV (b
);
22958 linepos_byte
= BUF_BEGV_BYTE (b
);
22961 /* Count lines from base line to window start position. */
22962 nlines
= display_count_lines (linepos_byte
,
22966 topline
= nlines
+ line
;
22968 /* Determine a new base line, if the old one is too close
22969 or too far away, or if we did not have one.
22970 "Too close" means it's plausible a scroll-down would
22971 go back past it. */
22972 if (startpos
== BUF_BEGV (b
))
22974 w
->base_line_number
= topline
;
22975 w
->base_line_pos
= BUF_BEGV (b
);
22977 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22978 || linepos
== BUF_BEGV (b
))
22980 ptrdiff_t limit
= BUF_BEGV (b
);
22981 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22982 ptrdiff_t position
;
22983 ptrdiff_t distance
=
22984 (height
* 2 + 30) * line_number_display_limit_width
;
22986 if (startpos
- distance
> limit
)
22988 limit
= startpos
- distance
;
22989 limit_byte
= CHAR_TO_BYTE (limit
);
22992 nlines
= display_count_lines (startpos_byte
,
22994 - (height
* 2 + 30),
22996 /* If we couldn't find the lines we wanted within
22997 line_number_display_limit_width chars per line,
22998 give up on line numbers for this window. */
22999 if (position
== limit_byte
&& limit
== startpos
- distance
)
23001 w
->base_line_pos
= -1;
23002 w
->base_line_number
= 0;
23006 w
->base_line_number
= topline
- nlines
;
23007 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23010 /* Now count lines from the start pos to point. */
23011 nlines
= display_count_lines (startpos_byte
,
23012 PT_BYTE
, PT
, &junk
);
23014 /* Record that we did display the line number. */
23015 line_number_displayed
= 1;
23017 /* Make the string to show. */
23018 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23019 return decode_mode_spec_buf
;
23022 char *p
= decode_mode_spec_buf
;
23023 int pad
= width
- 2;
23029 return decode_mode_spec_buf
;
23035 obj
= BVAR (b
, mode_name
);
23039 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23045 ptrdiff_t pos
= marker_position (w
->start
);
23046 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23048 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23050 if (pos
<= BUF_BEGV (b
))
23055 else if (pos
<= BUF_BEGV (b
))
23059 if (total
> 1000000)
23060 /* Do it differently for a large value, to avoid overflow. */
23061 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23063 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23064 /* We can't normally display a 3-digit number,
23065 so get us a 2-digit number that is close. */
23068 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23069 return decode_mode_spec_buf
;
23073 /* Display percentage of size above the bottom of the screen. */
23076 ptrdiff_t toppos
= marker_position (w
->start
);
23077 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23078 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23080 if (botpos
>= BUF_ZV (b
))
23082 if (toppos
<= BUF_BEGV (b
))
23089 if (total
> 1000000)
23090 /* Do it differently for a large value, to avoid overflow. */
23091 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23093 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23094 /* We can't normally display a 3-digit number,
23095 so get us a 2-digit number that is close. */
23098 if (toppos
<= BUF_BEGV (b
))
23099 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23101 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23102 return decode_mode_spec_buf
;
23107 /* status of process */
23108 obj
= Fget_buffer_process (Fcurrent_buffer ());
23110 return "no process";
23112 obj
= Fsymbol_name (Fprocess_status (obj
));
23118 ptrdiff_t count
= inhibit_garbage_collection ();
23119 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23120 Lisp_Object val
= Qnil
;
23122 if (STRINGP (curdir
))
23123 val
= call1 (intern ("file-remote-p"), curdir
);
23125 unbind_to (count
, Qnil
);
23134 /* coding-system (not including end-of-line format) */
23136 /* coding-system (including end-of-line type) */
23138 int eol_flag
= (c
== 'Z');
23139 char *p
= decode_mode_spec_buf
;
23141 if (! FRAME_WINDOW_P (f
))
23143 /* No need to mention EOL here--the terminal never needs
23144 to do EOL conversion. */
23145 p
= decode_mode_spec_coding (CODING_ID_NAME
23146 (FRAME_KEYBOARD_CODING (f
)->id
),
23148 p
= decode_mode_spec_coding (CODING_ID_NAME
23149 (FRAME_TERMINAL_CODING (f
)->id
),
23152 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23155 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23156 #ifdef subprocesses
23157 obj
= Fget_buffer_process (Fcurrent_buffer ());
23158 if (PROCESSP (obj
))
23160 p
= decode_mode_spec_coding
23161 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23162 p
= decode_mode_spec_coding
23163 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23165 #endif /* subprocesses */
23168 return decode_mode_spec_buf
;
23175 return SSDATA (obj
);
23182 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23183 means count lines back from START_BYTE. But don't go beyond
23184 LIMIT_BYTE. Return the number of lines thus found (always
23187 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23188 either the position COUNT lines after/before START_BYTE, if we
23189 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23193 display_count_lines (ptrdiff_t start_byte
,
23194 ptrdiff_t limit_byte
, ptrdiff_t count
,
23195 ptrdiff_t *byte_pos_ptr
)
23197 register unsigned char *cursor
;
23198 unsigned char *base
;
23200 register ptrdiff_t ceiling
;
23201 register unsigned char *ceiling_addr
;
23202 ptrdiff_t orig_count
= count
;
23204 /* If we are not in selective display mode,
23205 check only for newlines. */
23206 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23207 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23211 while (start_byte
< limit_byte
)
23213 ceiling
= BUFFER_CEILING_OF (start_byte
);
23214 ceiling
= min (limit_byte
- 1, ceiling
);
23215 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23216 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23220 if (selective_display
)
23222 while (*cursor
!= '\n' && *cursor
!= 015
23223 && ++cursor
!= ceiling_addr
)
23225 if (cursor
== ceiling_addr
)
23230 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23239 start_byte
+= cursor
- base
;
23240 *byte_pos_ptr
= start_byte
;
23244 while (cursor
< ceiling_addr
);
23246 start_byte
+= ceiling_addr
- base
;
23251 while (start_byte
> limit_byte
)
23253 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23254 ceiling
= max (limit_byte
, ceiling
);
23255 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23256 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23259 if (selective_display
)
23261 while (--cursor
>= ceiling_addr
23262 && *cursor
!= '\n' && *cursor
!= 015)
23264 if (cursor
< ceiling_addr
)
23269 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23276 start_byte
+= cursor
- base
+ 1;
23277 *byte_pos_ptr
= start_byte
;
23278 /* When scanning backwards, we should
23279 not count the newline posterior to which we stop. */
23280 return - orig_count
- 1;
23283 start_byte
+= ceiling_addr
- base
;
23287 *byte_pos_ptr
= limit_byte
;
23290 return - orig_count
+ count
;
23291 return orig_count
- count
;
23297 /***********************************************************************
23299 ***********************************************************************/
23301 /* Display a NUL-terminated string, starting with index START.
23303 If STRING is non-null, display that C string. Otherwise, the Lisp
23304 string LISP_STRING is displayed. There's a case that STRING is
23305 non-null and LISP_STRING is not nil. It means STRING is a string
23306 data of LISP_STRING. In that case, we display LISP_STRING while
23307 ignoring its text properties.
23309 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23310 FACE_STRING. Display STRING or LISP_STRING with the face at
23311 FACE_STRING_POS in FACE_STRING:
23313 Display the string in the environment given by IT, but use the
23314 standard display table, temporarily.
23316 FIELD_WIDTH is the minimum number of output glyphs to produce.
23317 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23318 with spaces. If STRING has more characters, more than FIELD_WIDTH
23319 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23321 PRECISION is the maximum number of characters to output from
23322 STRING. PRECISION < 0 means don't truncate the string.
23324 This is roughly equivalent to printf format specifiers:
23326 FIELD_WIDTH PRECISION PRINTF
23327 ----------------------------------------
23333 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23334 display them, and < 0 means obey the current buffer's value of
23335 enable_multibyte_characters.
23337 Value is the number of columns displayed. */
23340 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23341 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23342 int field_width
, int precision
, int max_x
, int multibyte
)
23344 int hpos_at_start
= it
->hpos
;
23345 int saved_face_id
= it
->face_id
;
23346 struct glyph_row
*row
= it
->glyph_row
;
23347 ptrdiff_t it_charpos
;
23349 /* Initialize the iterator IT for iteration over STRING beginning
23350 with index START. */
23351 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23352 precision
, field_width
, multibyte
);
23353 if (string
&& STRINGP (lisp_string
))
23354 /* LISP_STRING is the one returned by decode_mode_spec. We should
23355 ignore its text properties. */
23356 it
->stop_charpos
= it
->end_charpos
;
23358 /* If displaying STRING, set up the face of the iterator from
23359 FACE_STRING, if that's given. */
23360 if (STRINGP (face_string
))
23366 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23367 0, &endptr
, it
->base_face_id
, 0);
23368 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23369 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23372 /* Set max_x to the maximum allowed X position. Don't let it go
23373 beyond the right edge of the window. */
23375 max_x
= it
->last_visible_x
;
23377 max_x
= min (max_x
, it
->last_visible_x
);
23379 /* Skip over display elements that are not visible. because IT->w is
23381 if (it
->current_x
< it
->first_visible_x
)
23382 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23383 MOVE_TO_POS
| MOVE_TO_X
);
23385 row
->ascent
= it
->max_ascent
;
23386 row
->height
= it
->max_ascent
+ it
->max_descent
;
23387 row
->phys_ascent
= it
->max_phys_ascent
;
23388 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23389 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23391 if (STRINGP (it
->string
))
23392 it_charpos
= IT_STRING_CHARPOS (*it
);
23394 it_charpos
= IT_CHARPOS (*it
);
23396 /* This condition is for the case that we are called with current_x
23397 past last_visible_x. */
23398 while (it
->current_x
< max_x
)
23400 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23402 /* Get the next display element. */
23403 if (!get_next_display_element (it
))
23406 /* Produce glyphs. */
23407 x_before
= it
->current_x
;
23408 n_glyphs_before
= row
->used
[TEXT_AREA
];
23409 PRODUCE_GLYPHS (it
);
23411 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23414 while (i
< nglyphs
)
23416 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23418 if (it
->line_wrap
!= TRUNCATE
23419 && x
+ glyph
->pixel_width
> max_x
)
23421 /* End of continued line or max_x reached. */
23422 if (CHAR_GLYPH_PADDING_P (*glyph
))
23424 /* A wide character is unbreakable. */
23425 if (row
->reversed_p
)
23426 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23427 - n_glyphs_before
);
23428 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23429 it
->current_x
= x_before
;
23433 if (row
->reversed_p
)
23434 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23435 - (n_glyphs_before
+ i
));
23436 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23441 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23443 /* Glyph is at least partially visible. */
23445 if (x
< it
->first_visible_x
)
23446 row
->x
= x
- it
->first_visible_x
;
23450 /* Glyph is off the left margin of the display area.
23451 Should not happen. */
23455 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23456 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23457 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23458 row
->phys_height
= max (row
->phys_height
,
23459 it
->max_phys_ascent
+ it
->max_phys_descent
);
23460 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23461 it
->max_extra_line_spacing
);
23462 x
+= glyph
->pixel_width
;
23466 /* Stop if max_x reached. */
23470 /* Stop at line ends. */
23471 if (ITERATOR_AT_END_OF_LINE_P (it
))
23473 it
->continuation_lines_width
= 0;
23477 set_iterator_to_next (it
, 1);
23478 if (STRINGP (it
->string
))
23479 it_charpos
= IT_STRING_CHARPOS (*it
);
23481 it_charpos
= IT_CHARPOS (*it
);
23483 /* Stop if truncating at the right edge. */
23484 if (it
->line_wrap
== TRUNCATE
23485 && it
->current_x
>= it
->last_visible_x
)
23487 /* Add truncation mark, but don't do it if the line is
23488 truncated at a padding space. */
23489 if (it_charpos
< it
->string_nchars
)
23491 if (!FRAME_WINDOW_P (it
->f
))
23495 if (it
->current_x
> it
->last_visible_x
)
23497 if (!row
->reversed_p
)
23499 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23500 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23505 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23506 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23508 unproduce_glyphs (it
, ii
+ 1);
23509 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23511 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23513 row
->used
[TEXT_AREA
] = ii
;
23514 produce_special_glyphs (it
, IT_TRUNCATION
);
23517 produce_special_glyphs (it
, IT_TRUNCATION
);
23519 row
->truncated_on_right_p
= 1;
23525 /* Maybe insert a truncation at the left. */
23526 if (it
->first_visible_x
23529 if (!FRAME_WINDOW_P (it
->f
)
23530 || (row
->reversed_p
23531 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23532 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23533 insert_left_trunc_glyphs (it
);
23534 row
->truncated_on_left_p
= 1;
23537 it
->face_id
= saved_face_id
;
23539 /* Value is number of columns displayed. */
23540 return it
->hpos
- hpos_at_start
;
23545 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23546 appears as an element of LIST or as the car of an element of LIST.
23547 If PROPVAL is a list, compare each element against LIST in that
23548 way, and return 1/2 if any element of PROPVAL is found in LIST.
23549 Otherwise return 0. This function cannot quit.
23550 The return value is 2 if the text is invisible but with an ellipsis
23551 and 1 if it's invisible and without an ellipsis. */
23554 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23556 register Lisp_Object tail
, proptail
;
23558 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23560 register Lisp_Object tem
;
23562 if (EQ (propval
, tem
))
23564 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23565 return NILP (XCDR (tem
)) ? 1 : 2;
23568 if (CONSP (propval
))
23570 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23572 Lisp_Object propelt
;
23573 propelt
= XCAR (proptail
);
23574 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23576 register Lisp_Object tem
;
23578 if (EQ (propelt
, tem
))
23580 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23581 return NILP (XCDR (tem
)) ? 1 : 2;
23589 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23590 doc
: /* Non-nil if the property makes the text invisible.
23591 POS-OR-PROP can be a marker or number, in which case it is taken to be
23592 a position in the current buffer and the value of the `invisible' property
23593 is checked; or it can be some other value, which is then presumed to be the
23594 value of the `invisible' property of the text of interest.
23595 The non-nil value returned can be t for truly invisible text or something
23596 else if the text is replaced by an ellipsis. */)
23597 (Lisp_Object pos_or_prop
)
23600 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23601 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23603 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23604 return (invis
== 0 ? Qnil
23606 : make_number (invis
));
23609 /* Calculate a width or height in pixels from a specification using
23610 the following elements:
23613 NUM - a (fractional) multiple of the default font width/height
23614 (NUM) - specifies exactly NUM pixels
23615 UNIT - a fixed number of pixels, see below.
23616 ELEMENT - size of a display element in pixels, see below.
23617 (NUM . SPEC) - equals NUM * SPEC
23618 (+ SPEC SPEC ...) - add pixel values
23619 (- SPEC SPEC ...) - subtract pixel values
23620 (- SPEC) - negate pixel value
23623 INT or FLOAT - a number constant
23624 SYMBOL - use symbol's (buffer local) variable binding.
23627 in - pixels per inch *)
23628 mm - pixels per 1/1000 meter *)
23629 cm - pixels per 1/100 meter *)
23630 width - width of current font in pixels.
23631 height - height of current font in pixels.
23633 *) using the ratio(s) defined in display-pixels-per-inch.
23637 left-fringe - left fringe width in pixels
23638 right-fringe - right fringe width in pixels
23640 left-margin - left margin width in pixels
23641 right-margin - right margin width in pixels
23643 scroll-bar - scroll-bar area width in pixels
23647 Pixels corresponding to 5 inches:
23650 Total width of non-text areas on left side of window (if scroll-bar is on left):
23651 '(space :width (+ left-fringe left-margin scroll-bar))
23653 Align to first text column (in header line):
23654 '(space :align-to 0)
23656 Align to middle of text area minus half the width of variable `my-image'
23657 containing a loaded image:
23658 '(space :align-to (0.5 . (- text my-image)))
23660 Width of left margin minus width of 1 character in the default font:
23661 '(space :width (- left-margin 1))
23663 Width of left margin minus width of 2 characters in the current font:
23664 '(space :width (- left-margin (2 . width)))
23666 Center 1 character over left-margin (in header line):
23667 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23669 Different ways to express width of left fringe plus left margin minus one pixel:
23670 '(space :width (- (+ left-fringe left-margin) (1)))
23671 '(space :width (+ left-fringe left-margin (- (1))))
23672 '(space :width (+ left-fringe left-margin (-1)))
23677 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23678 struct font
*font
, int width_p
, int *align_to
)
23682 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23683 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23686 return OK_PIXELS (0);
23688 eassert (FRAME_LIVE_P (it
->f
));
23690 if (SYMBOLP (prop
))
23692 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23694 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23696 if (unit
[0] == 'i' && unit
[1] == 'n')
23698 else if (unit
[0] == 'm' && unit
[1] == 'm')
23700 else if (unit
[0] == 'c' && unit
[1] == 'm')
23706 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23707 : FRAME_RES_Y (it
->f
));
23710 return OK_PIXELS (ppi
/ pixels
);
23715 #ifdef HAVE_WINDOW_SYSTEM
23716 if (EQ (prop
, Qheight
))
23717 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23718 if (EQ (prop
, Qwidth
))
23719 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23721 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23722 return OK_PIXELS (1);
23725 if (EQ (prop
, Qtext
))
23726 return OK_PIXELS (width_p
23727 ? window_box_width (it
->w
, TEXT_AREA
)
23728 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23730 if (align_to
&& *align_to
< 0)
23733 if (EQ (prop
, Qleft
))
23734 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23735 if (EQ (prop
, Qright
))
23736 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23737 if (EQ (prop
, Qcenter
))
23738 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23739 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23740 if (EQ (prop
, Qleft_fringe
))
23741 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23742 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23743 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23744 if (EQ (prop
, Qright_fringe
))
23745 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23746 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23747 : window_box_right_offset (it
->w
, TEXT_AREA
));
23748 if (EQ (prop
, Qleft_margin
))
23749 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23750 if (EQ (prop
, Qright_margin
))
23751 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23752 if (EQ (prop
, Qscroll_bar
))
23753 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23755 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23756 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23757 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23762 if (EQ (prop
, Qleft_fringe
))
23763 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23764 if (EQ (prop
, Qright_fringe
))
23765 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23766 if (EQ (prop
, Qleft_margin
))
23767 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23768 if (EQ (prop
, Qright_margin
))
23769 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23770 if (EQ (prop
, Qscroll_bar
))
23771 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23774 prop
= buffer_local_value (prop
, it
->w
->contents
);
23775 if (EQ (prop
, Qunbound
))
23779 if (INTEGERP (prop
) || FLOATP (prop
))
23781 int base_unit
= (width_p
23782 ? FRAME_COLUMN_WIDTH (it
->f
)
23783 : FRAME_LINE_HEIGHT (it
->f
));
23784 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23789 Lisp_Object car
= XCAR (prop
);
23790 Lisp_Object cdr
= XCDR (prop
);
23794 #ifdef HAVE_WINDOW_SYSTEM
23795 if (FRAME_WINDOW_P (it
->f
)
23796 && valid_image_p (prop
))
23798 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23799 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23801 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23804 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23810 while (CONSP (cdr
))
23812 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23813 font
, width_p
, align_to
))
23816 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23821 if (EQ (car
, Qminus
))
23823 return OK_PIXELS (pixels
);
23826 car
= buffer_local_value (car
, it
->w
->contents
);
23827 if (EQ (car
, Qunbound
))
23831 if (INTEGERP (car
) || FLOATP (car
))
23834 pixels
= XFLOATINT (car
);
23836 return OK_PIXELS (pixels
);
23837 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23838 font
, width_p
, align_to
))
23839 return OK_PIXELS (pixels
* fact
);
23850 /***********************************************************************
23852 ***********************************************************************/
23854 #ifdef HAVE_WINDOW_SYSTEM
23859 dump_glyph_string (struct glyph_string
*s
)
23861 fprintf (stderr
, "glyph string\n");
23862 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23863 s
->x
, s
->y
, s
->width
, s
->height
);
23864 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23865 fprintf (stderr
, " hl = %d\n", s
->hl
);
23866 fprintf (stderr
, " left overhang = %d, right = %d\n",
23867 s
->left_overhang
, s
->right_overhang
);
23868 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23869 fprintf (stderr
, " extends to end of line = %d\n",
23870 s
->extends_to_end_of_line_p
);
23871 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23872 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23875 #endif /* GLYPH_DEBUG */
23877 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23878 of XChar2b structures for S; it can't be allocated in
23879 init_glyph_string because it must be allocated via `alloca'. W
23880 is the window on which S is drawn. ROW and AREA are the glyph row
23881 and area within the row from which S is constructed. START is the
23882 index of the first glyph structure covered by S. HL is a
23883 face-override for drawing S. */
23886 #define OPTIONAL_HDC(hdc) HDC hdc,
23887 #define DECLARE_HDC(hdc) HDC hdc;
23888 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23889 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23892 #ifndef OPTIONAL_HDC
23893 #define OPTIONAL_HDC(hdc)
23894 #define DECLARE_HDC(hdc)
23895 #define ALLOCATE_HDC(hdc, f)
23896 #define RELEASE_HDC(hdc, f)
23900 init_glyph_string (struct glyph_string
*s
,
23902 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23903 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23905 memset (s
, 0, sizeof *s
);
23907 s
->f
= XFRAME (w
->frame
);
23911 s
->display
= FRAME_X_DISPLAY (s
->f
);
23912 s
->window
= FRAME_X_WINDOW (s
->f
);
23913 s
->char2b
= char2b
;
23917 s
->first_glyph
= row
->glyphs
[area
] + start
;
23918 s
->height
= row
->height
;
23919 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23920 s
->ybase
= s
->y
+ row
->ascent
;
23924 /* Append the list of glyph strings with head H and tail T to the list
23925 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23928 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23929 struct glyph_string
*h
, struct glyph_string
*t
)
23943 /* Prepend the list of glyph strings with head H and tail T to the
23944 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23948 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23949 struct glyph_string
*h
, struct glyph_string
*t
)
23963 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23964 Set *HEAD and *TAIL to the resulting list. */
23967 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23968 struct glyph_string
*s
)
23970 s
->next
= s
->prev
= NULL
;
23971 append_glyph_string_lists (head
, tail
, s
, s
);
23975 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23976 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23977 make sure that X resources for the face returned are allocated.
23978 Value is a pointer to a realized face that is ready for display if
23979 DISPLAY_P is non-zero. */
23981 static struct face
*
23982 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23983 XChar2b
*char2b
, int display_p
)
23985 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23990 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23992 if (code
== FONT_INVALID_CODE
)
23995 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23997 /* Make sure X resources of the face are allocated. */
23998 #ifdef HAVE_X_WINDOWS
24002 eassert (face
!= NULL
);
24003 prepare_face_for_display (f
, face
);
24010 /* Get face and two-byte form of character glyph GLYPH on frame F.
24011 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24012 a pointer to a realized face that is ready for display. */
24014 static struct face
*
24015 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24016 XChar2b
*char2b
, int *two_byte_p
)
24021 eassert (glyph
->type
== CHAR_GLYPH
);
24022 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24024 /* Make sure X resources of the face are allocated. */
24025 eassert (face
!= NULL
);
24026 prepare_face_for_display (f
, face
);
24033 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24034 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24036 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24038 if (code
== FONT_INVALID_CODE
)
24042 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24047 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24048 Return 1 if FONT has a glyph for C, otherwise return 0. */
24051 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24055 if (CHAR_BYTE8_P (c
))
24056 code
= CHAR_TO_BYTE8 (c
);
24058 code
= font
->driver
->encode_char (font
, c
);
24060 if (code
== FONT_INVALID_CODE
)
24062 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24067 /* Fill glyph string S with composition components specified by S->cmp.
24069 BASE_FACE is the base face of the composition.
24070 S->cmp_from is the index of the first component for S.
24072 OVERLAPS non-zero means S should draw the foreground only, and use
24073 its physical height for clipping. See also draw_glyphs.
24075 Value is the index of a component not in S. */
24078 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24082 /* For all glyphs of this composition, starting at the offset
24083 S->cmp_from, until we reach the end of the definition or encounter a
24084 glyph that requires the different face, add it to S. */
24089 s
->for_overlaps
= overlaps
;
24092 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24094 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24096 /* TAB in a composition means display glyphs with padding space
24097 on the left or right. */
24100 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24103 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24110 s
->font
= s
->face
->font
;
24112 else if (s
->face
!= face
)
24120 if (s
->face
== NULL
)
24122 s
->face
= base_face
->ascii_face
;
24123 s
->font
= s
->face
->font
;
24126 /* All glyph strings for the same composition has the same width,
24127 i.e. the width set for the first component of the composition. */
24128 s
->width
= s
->first_glyph
->pixel_width
;
24130 /* If the specified font could not be loaded, use the frame's
24131 default font, but record the fact that we couldn't load it in
24132 the glyph string so that we can draw rectangles for the
24133 characters of the glyph string. */
24134 if (s
->font
== NULL
)
24136 s
->font_not_found_p
= 1;
24137 s
->font
= FRAME_FONT (s
->f
);
24140 /* Adjust base line for subscript/superscript text. */
24141 s
->ybase
+= s
->first_glyph
->voffset
;
24143 /* This glyph string must always be drawn with 16-bit functions. */
24150 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24151 int start
, int end
, int overlaps
)
24153 struct glyph
*glyph
, *last
;
24154 Lisp_Object lgstring
;
24157 s
->for_overlaps
= overlaps
;
24158 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24159 last
= s
->row
->glyphs
[s
->area
] + end
;
24160 s
->cmp_id
= glyph
->u
.cmp
.id
;
24161 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24162 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24163 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24164 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24165 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24167 while (glyph
< last
24168 && glyph
->u
.cmp
.automatic
24169 && glyph
->u
.cmp
.id
== s
->cmp_id
24170 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24171 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24173 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24175 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24176 unsigned code
= LGLYPH_CODE (lglyph
);
24178 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24180 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24181 return glyph
- s
->row
->glyphs
[s
->area
];
24185 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24186 See the comment of fill_glyph_string for arguments.
24187 Value is the index of the first glyph not in S. */
24191 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24192 int start
, int end
, int overlaps
)
24194 struct glyph
*glyph
, *last
;
24197 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24198 s
->for_overlaps
= overlaps
;
24199 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24200 last
= s
->row
->glyphs
[s
->area
] + end
;
24201 voffset
= glyph
->voffset
;
24202 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24203 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24205 s
->width
= glyph
->pixel_width
;
24207 while (glyph
< last
24208 && glyph
->type
== GLYPHLESS_GLYPH
24209 && glyph
->voffset
== voffset
24210 && glyph
->face_id
== face_id
)
24213 s
->width
+= glyph
->pixel_width
;
24216 s
->ybase
+= voffset
;
24217 return glyph
- s
->row
->glyphs
[s
->area
];
24221 /* Fill glyph string S from a sequence of character glyphs.
24223 FACE_ID is the face id of the string. START is the index of the
24224 first glyph to consider, END is the index of the last + 1.
24225 OVERLAPS non-zero means S should draw the foreground only, and use
24226 its physical height for clipping. See also draw_glyphs.
24228 Value is the index of the first glyph not in S. */
24231 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24232 int start
, int end
, int overlaps
)
24234 struct glyph
*glyph
, *last
;
24236 int glyph_not_available_p
;
24238 eassert (s
->f
== XFRAME (s
->w
->frame
));
24239 eassert (s
->nchars
== 0);
24240 eassert (start
>= 0 && end
> start
);
24242 s
->for_overlaps
= overlaps
;
24243 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24244 last
= s
->row
->glyphs
[s
->area
] + end
;
24245 voffset
= glyph
->voffset
;
24246 s
->padding_p
= glyph
->padding_p
;
24247 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24249 while (glyph
< last
24250 && glyph
->type
== CHAR_GLYPH
24251 && glyph
->voffset
== voffset
24252 /* Same face id implies same font, nowadays. */
24253 && glyph
->face_id
== face_id
24254 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24258 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24259 s
->char2b
+ s
->nchars
,
24261 s
->two_byte_p
= two_byte_p
;
24263 eassert (s
->nchars
<= end
- start
);
24264 s
->width
+= glyph
->pixel_width
;
24265 if (glyph
++->padding_p
!= s
->padding_p
)
24269 s
->font
= s
->face
->font
;
24271 /* If the specified font could not be loaded, use the frame's font,
24272 but record the fact that we couldn't load it in
24273 S->font_not_found_p so that we can draw rectangles for the
24274 characters of the glyph string. */
24275 if (s
->font
== NULL
|| glyph_not_available_p
)
24277 s
->font_not_found_p
= 1;
24278 s
->font
= FRAME_FONT (s
->f
);
24281 /* Adjust base line for subscript/superscript text. */
24282 s
->ybase
+= voffset
;
24284 eassert (s
->face
&& s
->face
->gc
);
24285 return glyph
- s
->row
->glyphs
[s
->area
];
24289 /* Fill glyph string S from image glyph S->first_glyph. */
24292 fill_image_glyph_string (struct glyph_string
*s
)
24294 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24295 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24297 s
->slice
= s
->first_glyph
->slice
.img
;
24298 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24299 s
->font
= s
->face
->font
;
24300 s
->width
= s
->first_glyph
->pixel_width
;
24302 /* Adjust base line for subscript/superscript text. */
24303 s
->ybase
+= s
->first_glyph
->voffset
;
24307 /* Fill glyph string S from a sequence of stretch glyphs.
24309 START is the index of the first glyph to consider,
24310 END is the index of the last + 1.
24312 Value is the index of the first glyph not in S. */
24315 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24317 struct glyph
*glyph
, *last
;
24318 int voffset
, face_id
;
24320 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24322 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24323 last
= s
->row
->glyphs
[s
->area
] + end
;
24324 face_id
= glyph
->face_id
;
24325 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24326 s
->font
= s
->face
->font
;
24327 s
->width
= glyph
->pixel_width
;
24329 voffset
= glyph
->voffset
;
24333 && glyph
->type
== STRETCH_GLYPH
24334 && glyph
->voffset
== voffset
24335 && glyph
->face_id
== face_id
);
24337 s
->width
+= glyph
->pixel_width
;
24339 /* Adjust base line for subscript/superscript text. */
24340 s
->ybase
+= voffset
;
24342 /* The case that face->gc == 0 is handled when drawing the glyph
24343 string by calling prepare_face_for_display. */
24345 return glyph
- s
->row
->glyphs
[s
->area
];
24348 static struct font_metrics
*
24349 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24351 static struct font_metrics metrics
;
24356 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24357 if (code
== FONT_INVALID_CODE
)
24359 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24364 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24365 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24366 assumed to be zero. */
24369 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24371 *left
= *right
= 0;
24373 if (glyph
->type
== CHAR_GLYPH
)
24377 struct font_metrics
*pcm
;
24379 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24380 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24382 if (pcm
->rbearing
> pcm
->width
)
24383 *right
= pcm
->rbearing
- pcm
->width
;
24384 if (pcm
->lbearing
< 0)
24385 *left
= -pcm
->lbearing
;
24388 else if (glyph
->type
== COMPOSITE_GLYPH
)
24390 if (! glyph
->u
.cmp
.automatic
)
24392 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24394 if (cmp
->rbearing
> cmp
->pixel_width
)
24395 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24396 if (cmp
->lbearing
< 0)
24397 *left
= - cmp
->lbearing
;
24401 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24402 struct font_metrics metrics
;
24404 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24405 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24406 if (metrics
.rbearing
> metrics
.width
)
24407 *right
= metrics
.rbearing
- metrics
.width
;
24408 if (metrics
.lbearing
< 0)
24409 *left
= - metrics
.lbearing
;
24415 /* Return the index of the first glyph preceding glyph string S that
24416 is overwritten by S because of S's left overhang. Value is -1
24417 if no glyphs are overwritten. */
24420 left_overwritten (struct glyph_string
*s
)
24424 if (s
->left_overhang
)
24427 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24428 int first
= s
->first_glyph
- glyphs
;
24430 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24431 x
-= glyphs
[i
].pixel_width
;
24442 /* Return the index of the first glyph preceding glyph string S that
24443 is overwriting S because of its right overhang. Value is -1 if no
24444 glyph in front of S overwrites S. */
24447 left_overwriting (struct glyph_string
*s
)
24450 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24451 int first
= s
->first_glyph
- glyphs
;
24455 for (i
= first
- 1; i
>= 0; --i
)
24458 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24461 x
-= glyphs
[i
].pixel_width
;
24468 /* Return the index of the last glyph following glyph string S that is
24469 overwritten by S because of S's right overhang. Value is -1 if
24470 no such glyph is found. */
24473 right_overwritten (struct glyph_string
*s
)
24477 if (s
->right_overhang
)
24480 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24481 int first
= (s
->first_glyph
- glyphs
24482 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24483 int end
= s
->row
->used
[s
->area
];
24485 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24486 x
+= glyphs
[i
].pixel_width
;
24495 /* Return the index of the last glyph following glyph string S that
24496 overwrites S because of its left overhang. Value is negative
24497 if no such glyph is found. */
24500 right_overwriting (struct glyph_string
*s
)
24503 int end
= s
->row
->used
[s
->area
];
24504 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24505 int first
= (s
->first_glyph
- glyphs
24506 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24510 for (i
= first
; i
< end
; ++i
)
24513 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24516 x
+= glyphs
[i
].pixel_width
;
24523 /* Set background width of glyph string S. START is the index of the
24524 first glyph following S. LAST_X is the right-most x-position + 1
24525 in the drawing area. */
24528 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24530 /* If the face of this glyph string has to be drawn to the end of
24531 the drawing area, set S->extends_to_end_of_line_p. */
24533 if (start
== s
->row
->used
[s
->area
]
24534 && ((s
->row
->fill_line_p
24535 && (s
->hl
== DRAW_NORMAL_TEXT
24536 || s
->hl
== DRAW_IMAGE_RAISED
24537 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24538 || s
->hl
== DRAW_MOUSE_FACE
))
24539 s
->extends_to_end_of_line_p
= 1;
24541 /* If S extends its face to the end of the line, set its
24542 background_width to the distance to the right edge of the drawing
24544 if (s
->extends_to_end_of_line_p
)
24545 s
->background_width
= last_x
- s
->x
+ 1;
24547 s
->background_width
= s
->width
;
24551 /* Compute overhangs and x-positions for glyph string S and its
24552 predecessors, or successors. X is the starting x-position for S.
24553 BACKWARD_P non-zero means process predecessors. */
24556 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24562 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24563 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24573 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24574 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24584 /* The following macros are only called from draw_glyphs below.
24585 They reference the following parameters of that function directly:
24586 `w', `row', `area', and `overlap_p'
24587 as well as the following local variables:
24588 `s', `f', and `hdc' (in W32) */
24591 /* On W32, silently add local `hdc' variable to argument list of
24592 init_glyph_string. */
24593 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24594 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24596 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24597 init_glyph_string (s, char2b, w, row, area, start, hl)
24600 /* Add a glyph string for a stretch glyph to the list of strings
24601 between HEAD and TAIL. START is the index of the stretch glyph in
24602 row area AREA of glyph row ROW. END is the index of the last glyph
24603 in that glyph row area. X is the current output position assigned
24604 to the new glyph string constructed. HL overrides that face of the
24605 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24606 is the right-most x-position of the drawing area. */
24608 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24609 and below -- keep them on one line. */
24610 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24613 s = alloca (sizeof *s); \
24614 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24615 START = fill_stretch_glyph_string (s, START, END); \
24616 append_glyph_string (&HEAD, &TAIL, s); \
24622 /* Add a glyph string for an image glyph to the list of strings
24623 between HEAD and TAIL. START is the index of the image glyph in
24624 row area AREA of glyph row ROW. END is the index of the last glyph
24625 in that glyph row area. X is the current output position assigned
24626 to the new glyph string constructed. HL overrides that face of the
24627 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24628 is the right-most x-position of the drawing area. */
24630 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24633 s = alloca (sizeof *s); \
24634 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24635 fill_image_glyph_string (s); \
24636 append_glyph_string (&HEAD, &TAIL, s); \
24643 /* Add a glyph string for a sequence of character glyphs to the list
24644 of strings between HEAD and TAIL. START is the index of the first
24645 glyph in row area AREA of glyph row ROW that is part of the new
24646 glyph string. END is the index of the last glyph in that glyph row
24647 area. X is the current output position assigned to the new glyph
24648 string constructed. HL overrides that face of the glyph; e.g. it
24649 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24650 right-most x-position of the drawing area. */
24652 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24658 face_id = (row)->glyphs[area][START].face_id; \
24660 s = alloca (sizeof *s); \
24661 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24662 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24663 append_glyph_string (&HEAD, &TAIL, s); \
24665 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24670 /* Add a glyph string for a composite sequence to the list of strings
24671 between HEAD and TAIL. START is the index of the first glyph in
24672 row area AREA of glyph row ROW that is part of the new glyph
24673 string. END is the index of the last glyph in that glyph row area.
24674 X is the current output position assigned to the new glyph string
24675 constructed. HL overrides that face of the glyph; e.g. it is
24676 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24677 x-position of the drawing area. */
24679 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24681 int face_id = (row)->glyphs[area][START].face_id; \
24682 struct face *base_face = FACE_FROM_ID (f, face_id); \
24683 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24684 struct composition *cmp = composition_table[cmp_id]; \
24686 struct glyph_string *first_s = NULL; \
24689 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
24691 /* Make glyph_strings for each glyph sequence that is drawable by \
24692 the same face, and append them to HEAD/TAIL. */ \
24693 for (n = 0; n < cmp->glyph_len;) \
24695 s = alloca (sizeof *s); \
24696 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24697 append_glyph_string (&(HEAD), &(TAIL), s); \
24703 n = fill_composite_glyph_string (s, base_face, overlaps); \
24711 /* Add a glyph string for a glyph-string sequence to the list of strings
24712 between HEAD and TAIL. */
24714 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24718 Lisp_Object gstring; \
24720 face_id = (row)->glyphs[area][START].face_id; \
24721 gstring = (composition_gstring_from_id \
24722 ((row)->glyphs[area][START].u.cmp.id)); \
24723 s = alloca (sizeof *s); \
24724 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
24725 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24726 append_glyph_string (&(HEAD), &(TAIL), s); \
24728 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24732 /* Add a glyph string for a sequence of glyphless character's glyphs
24733 to the list of strings between HEAD and TAIL. The meanings of
24734 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24736 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24741 face_id = (row)->glyphs[area][START].face_id; \
24743 s = alloca (sizeof *s); \
24744 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24745 append_glyph_string (&HEAD, &TAIL, s); \
24747 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24753 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24754 of AREA of glyph row ROW on window W between indices START and END.
24755 HL overrides the face for drawing glyph strings, e.g. it is
24756 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24757 x-positions of the drawing area.
24759 This is an ugly monster macro construct because we must use alloca
24760 to allocate glyph strings (because draw_glyphs can be called
24761 asynchronously). */
24763 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24766 HEAD = TAIL = NULL; \
24767 while (START < END) \
24769 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24770 switch (first_glyph->type) \
24773 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24777 case COMPOSITE_GLYPH: \
24778 if (first_glyph->u.cmp.automatic) \
24779 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24782 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24786 case STRETCH_GLYPH: \
24787 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24791 case IMAGE_GLYPH: \
24792 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24796 case GLYPHLESS_GLYPH: \
24797 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24807 set_glyph_string_background_width (s, START, LAST_X); \
24814 /* Draw glyphs between START and END in AREA of ROW on window W,
24815 starting at x-position X. X is relative to AREA in W. HL is a
24816 face-override with the following meaning:
24818 DRAW_NORMAL_TEXT draw normally
24819 DRAW_CURSOR draw in cursor face
24820 DRAW_MOUSE_FACE draw in mouse face.
24821 DRAW_INVERSE_VIDEO draw in mode line face
24822 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24823 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24825 If OVERLAPS is non-zero, draw only the foreground of characters and
24826 clip to the physical height of ROW. Non-zero value also defines
24827 the overlapping part to be drawn:
24829 OVERLAPS_PRED overlap with preceding rows
24830 OVERLAPS_SUCC overlap with succeeding rows
24831 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24832 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24834 Value is the x-position reached, relative to AREA of W. */
24837 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24838 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24839 enum draw_glyphs_face hl
, int overlaps
)
24841 struct glyph_string
*head
, *tail
;
24842 struct glyph_string
*s
;
24843 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24844 int i
, j
, x_reached
, last_x
, area_left
= 0;
24845 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24848 ALLOCATE_HDC (hdc
, f
);
24850 /* Let's rather be paranoid than getting a SEGV. */
24851 end
= min (end
, row
->used
[area
]);
24852 start
= clip_to_bounds (0, start
, end
);
24854 /* Translate X to frame coordinates. Set last_x to the right
24855 end of the drawing area. */
24856 if (row
->full_width_p
)
24858 /* X is relative to the left edge of W, without scroll bars
24860 area_left
= WINDOW_LEFT_EDGE_X (w
);
24861 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24862 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24866 area_left
= window_box_left (w
, area
);
24867 last_x
= area_left
+ window_box_width (w
, area
);
24871 /* Build a doubly-linked list of glyph_string structures between
24872 head and tail from what we have to draw. Note that the macro
24873 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24874 the reason we use a separate variable `i'. */
24877 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24879 x_reached
= tail
->x
+ tail
->background_width
;
24883 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24884 the row, redraw some glyphs in front or following the glyph
24885 strings built above. */
24886 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24888 struct glyph_string
*h
, *t
;
24889 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24890 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24891 int check_mouse_face
= 0;
24894 /* If mouse highlighting is on, we may need to draw adjacent
24895 glyphs using mouse-face highlighting. */
24896 if (area
== TEXT_AREA
&& row
->mouse_face_p
24897 && hlinfo
->mouse_face_beg_row
>= 0
24898 && hlinfo
->mouse_face_end_row
>= 0)
24900 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24902 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24903 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24905 check_mouse_face
= 1;
24906 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24907 ? hlinfo
->mouse_face_beg_col
: 0;
24908 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24909 ? hlinfo
->mouse_face_end_col
24910 : row
->used
[TEXT_AREA
];
24914 /* Compute overhangs for all glyph strings. */
24915 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24916 for (s
= head
; s
; s
= s
->next
)
24917 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24919 /* Prepend glyph strings for glyphs in front of the first glyph
24920 string that are overwritten because of the first glyph
24921 string's left overhang. The background of all strings
24922 prepended must be drawn because the first glyph string
24924 i
= left_overwritten (head
);
24927 enum draw_glyphs_face overlap_hl
;
24929 /* If this row contains mouse highlighting, attempt to draw
24930 the overlapped glyphs with the correct highlight. This
24931 code fails if the overlap encompasses more than one glyph
24932 and mouse-highlight spans only some of these glyphs.
24933 However, making it work perfectly involves a lot more
24934 code, and I don't know if the pathological case occurs in
24935 practice, so we'll stick to this for now. --- cyd */
24936 if (check_mouse_face
24937 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24938 overlap_hl
= DRAW_MOUSE_FACE
;
24940 overlap_hl
= DRAW_NORMAL_TEXT
;
24942 if (hl
!= overlap_hl
)
24945 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24946 overlap_hl
, dummy_x
, last_x
);
24948 compute_overhangs_and_x (t
, head
->x
, 1);
24949 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24950 if (clip_head
== NULL
)
24954 /* Prepend glyph strings for glyphs in front of the first glyph
24955 string that overwrite that glyph string because of their
24956 right overhang. For these strings, only the foreground must
24957 be drawn, because it draws over the glyph string at `head'.
24958 The background must not be drawn because this would overwrite
24959 right overhangs of preceding glyphs for which no glyph
24961 i
= left_overwriting (head
);
24964 enum draw_glyphs_face overlap_hl
;
24966 if (check_mouse_face
24967 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24968 overlap_hl
= DRAW_MOUSE_FACE
;
24970 overlap_hl
= DRAW_NORMAL_TEXT
;
24972 if (hl
== overlap_hl
|| clip_head
== NULL
)
24974 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24975 overlap_hl
, dummy_x
, last_x
);
24976 for (s
= h
; s
; s
= s
->next
)
24977 s
->background_filled_p
= 1;
24978 compute_overhangs_and_x (t
, head
->x
, 1);
24979 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24982 /* Append glyphs strings for glyphs following the last glyph
24983 string tail that are overwritten by tail. The background of
24984 these strings has to be drawn because tail's foreground draws
24986 i
= right_overwritten (tail
);
24989 enum draw_glyphs_face overlap_hl
;
24991 if (check_mouse_face
24992 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24993 overlap_hl
= DRAW_MOUSE_FACE
;
24995 overlap_hl
= DRAW_NORMAL_TEXT
;
24997 if (hl
!= overlap_hl
)
24999 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25000 overlap_hl
, x
, last_x
);
25001 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25002 we don't have `end = i;' here. */
25003 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25004 append_glyph_string_lists (&head
, &tail
, h
, t
);
25005 if (clip_tail
== NULL
)
25009 /* Append glyph strings for glyphs following the last glyph
25010 string tail that overwrite tail. The foreground of such
25011 glyphs has to be drawn because it writes into the background
25012 of tail. The background must not be drawn because it could
25013 paint over the foreground of following glyphs. */
25014 i
= right_overwriting (tail
);
25017 enum draw_glyphs_face overlap_hl
;
25018 if (check_mouse_face
25019 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25020 overlap_hl
= DRAW_MOUSE_FACE
;
25022 overlap_hl
= DRAW_NORMAL_TEXT
;
25024 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25026 i
++; /* We must include the Ith glyph. */
25027 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25028 overlap_hl
, x
, last_x
);
25029 for (s
= h
; s
; s
= s
->next
)
25030 s
->background_filled_p
= 1;
25031 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25032 append_glyph_string_lists (&head
, &tail
, h
, t
);
25034 if (clip_head
|| clip_tail
)
25035 for (s
= head
; s
; s
= s
->next
)
25037 s
->clip_head
= clip_head
;
25038 s
->clip_tail
= clip_tail
;
25042 /* Draw all strings. */
25043 for (s
= head
; s
; s
= s
->next
)
25044 FRAME_RIF (f
)->draw_glyph_string (s
);
25047 /* When focus a sole frame and move horizontally, this sets on_p to 0
25048 causing a failure to erase prev cursor position. */
25049 if (area
== TEXT_AREA
25050 && !row
->full_width_p
25051 /* When drawing overlapping rows, only the glyph strings'
25052 foreground is drawn, which doesn't erase a cursor
25056 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25057 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25058 : (tail
? tail
->x
+ tail
->background_width
: x
));
25062 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25063 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25067 /* Value is the x-position up to which drawn, relative to AREA of W.
25068 This doesn't include parts drawn because of overhangs. */
25069 if (row
->full_width_p
)
25070 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25072 x_reached
-= area_left
;
25074 RELEASE_HDC (hdc
, f
);
25080 /* Expand row matrix if too narrow. Don't expand if area
25083 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25085 if (!it->f->fonts_changed \
25086 && (it->glyph_row->glyphs[area] \
25087 < it->glyph_row->glyphs[area + 1])) \
25089 it->w->ncols_scale_factor++; \
25090 it->f->fonts_changed = 1; \
25094 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25095 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25098 append_glyph (struct it
*it
)
25100 struct glyph
*glyph
;
25101 enum glyph_row_area area
= it
->area
;
25103 eassert (it
->glyph_row
);
25104 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25106 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25107 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25109 /* If the glyph row is reversed, we need to prepend the glyph
25110 rather than append it. */
25111 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25115 /* Make room for the additional glyph. */
25116 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25118 glyph
= it
->glyph_row
->glyphs
[area
];
25120 glyph
->charpos
= CHARPOS (it
->position
);
25121 glyph
->object
= it
->object
;
25122 if (it
->pixel_width
> 0)
25124 glyph
->pixel_width
= it
->pixel_width
;
25125 glyph
->padding_p
= 0;
25129 /* Assure at least 1-pixel width. Otherwise, cursor can't
25130 be displayed correctly. */
25131 glyph
->pixel_width
= 1;
25132 glyph
->padding_p
= 1;
25134 glyph
->ascent
= it
->ascent
;
25135 glyph
->descent
= it
->descent
;
25136 glyph
->voffset
= it
->voffset
;
25137 glyph
->type
= CHAR_GLYPH
;
25138 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25139 glyph
->multibyte_p
= it
->multibyte_p
;
25140 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25142 /* In R2L rows, the left and the right box edges need to be
25143 drawn in reverse direction. */
25144 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25145 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25149 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25150 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25152 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25153 || it
->phys_descent
> it
->descent
);
25154 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25155 glyph
->face_id
= it
->face_id
;
25156 glyph
->u
.ch
= it
->char_to_display
;
25157 glyph
->slice
.img
= null_glyph_slice
;
25158 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25161 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25162 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25164 glyph
->bidi_type
= it
->bidi_it
.type
;
25168 glyph
->resolved_level
= 0;
25169 glyph
->bidi_type
= UNKNOWN_BT
;
25171 ++it
->glyph_row
->used
[area
];
25174 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25177 /* Store one glyph for the composition IT->cmp_it.id in
25178 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25182 append_composite_glyph (struct it
*it
)
25184 struct glyph
*glyph
;
25185 enum glyph_row_area area
= it
->area
;
25187 eassert (it
->glyph_row
);
25189 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25190 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25192 /* If the glyph row is reversed, we need to prepend the glyph
25193 rather than append it. */
25194 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25198 /* Make room for the new glyph. */
25199 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25201 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25203 glyph
->charpos
= it
->cmp_it
.charpos
;
25204 glyph
->object
= it
->object
;
25205 glyph
->pixel_width
= it
->pixel_width
;
25206 glyph
->ascent
= it
->ascent
;
25207 glyph
->descent
= it
->descent
;
25208 glyph
->voffset
= it
->voffset
;
25209 glyph
->type
= COMPOSITE_GLYPH
;
25210 if (it
->cmp_it
.ch
< 0)
25212 glyph
->u
.cmp
.automatic
= 0;
25213 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25214 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25218 glyph
->u
.cmp
.automatic
= 1;
25219 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25220 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25221 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25223 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25224 glyph
->multibyte_p
= it
->multibyte_p
;
25225 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25227 /* In R2L rows, the left and the right box edges need to be
25228 drawn in reverse direction. */
25229 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25230 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25234 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25235 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25237 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25238 || it
->phys_descent
> it
->descent
);
25239 glyph
->padding_p
= 0;
25240 glyph
->glyph_not_available_p
= 0;
25241 glyph
->face_id
= it
->face_id
;
25242 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25245 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25246 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25248 glyph
->bidi_type
= it
->bidi_it
.type
;
25250 ++it
->glyph_row
->used
[area
];
25253 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25257 /* Change IT->ascent and IT->height according to the setting of
25261 take_vertical_position_into_account (struct it
*it
)
25265 if (it
->voffset
< 0)
25266 /* Increase the ascent so that we can display the text higher
25268 it
->ascent
-= it
->voffset
;
25270 /* Increase the descent so that we can display the text lower
25272 it
->descent
+= it
->voffset
;
25277 /* Produce glyphs/get display metrics for the image IT is loaded with.
25278 See the description of struct display_iterator in dispextern.h for
25279 an overview of struct display_iterator. */
25282 produce_image_glyph (struct it
*it
)
25286 int glyph_ascent
, crop
;
25287 struct glyph_slice slice
;
25289 eassert (it
->what
== IT_IMAGE
);
25291 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25293 /* Make sure X resources of the face is loaded. */
25294 prepare_face_for_display (it
->f
, face
);
25296 if (it
->image_id
< 0)
25298 /* Fringe bitmap. */
25299 it
->ascent
= it
->phys_ascent
= 0;
25300 it
->descent
= it
->phys_descent
= 0;
25301 it
->pixel_width
= 0;
25306 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25308 /* Make sure X resources of the image is loaded. */
25309 prepare_image_for_display (it
->f
, img
);
25311 slice
.x
= slice
.y
= 0;
25312 slice
.width
= img
->width
;
25313 slice
.height
= img
->height
;
25315 if (INTEGERP (it
->slice
.x
))
25316 slice
.x
= XINT (it
->slice
.x
);
25317 else if (FLOATP (it
->slice
.x
))
25318 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25320 if (INTEGERP (it
->slice
.y
))
25321 slice
.y
= XINT (it
->slice
.y
);
25322 else if (FLOATP (it
->slice
.y
))
25323 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25325 if (INTEGERP (it
->slice
.width
))
25326 slice
.width
= XINT (it
->slice
.width
);
25327 else if (FLOATP (it
->slice
.width
))
25328 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25330 if (INTEGERP (it
->slice
.height
))
25331 slice
.height
= XINT (it
->slice
.height
);
25332 else if (FLOATP (it
->slice
.height
))
25333 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25335 if (slice
.x
>= img
->width
)
25336 slice
.x
= img
->width
;
25337 if (slice
.y
>= img
->height
)
25338 slice
.y
= img
->height
;
25339 if (slice
.x
+ slice
.width
>= img
->width
)
25340 slice
.width
= img
->width
- slice
.x
;
25341 if (slice
.y
+ slice
.height
> img
->height
)
25342 slice
.height
= img
->height
- slice
.y
;
25344 if (slice
.width
== 0 || slice
.height
== 0)
25347 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25349 it
->descent
= slice
.height
- glyph_ascent
;
25351 it
->descent
+= img
->vmargin
;
25352 if (slice
.y
+ slice
.height
== img
->height
)
25353 it
->descent
+= img
->vmargin
;
25354 it
->phys_descent
= it
->descent
;
25356 it
->pixel_width
= slice
.width
;
25358 it
->pixel_width
+= img
->hmargin
;
25359 if (slice
.x
+ slice
.width
== img
->width
)
25360 it
->pixel_width
+= img
->hmargin
;
25362 /* It's quite possible for images to have an ascent greater than
25363 their height, so don't get confused in that case. */
25364 if (it
->descent
< 0)
25369 if (face
->box
!= FACE_NO_BOX
)
25371 if (face
->box_line_width
> 0)
25374 it
->ascent
+= face
->box_line_width
;
25375 if (slice
.y
+ slice
.height
== img
->height
)
25376 it
->descent
+= face
->box_line_width
;
25379 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25380 it
->pixel_width
+= eabs (face
->box_line_width
);
25381 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25382 it
->pixel_width
+= eabs (face
->box_line_width
);
25385 take_vertical_position_into_account (it
);
25387 /* Automatically crop wide image glyphs at right edge so we can
25388 draw the cursor on same display row. */
25389 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25390 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25392 it
->pixel_width
-= crop
;
25393 slice
.width
-= crop
;
25398 struct glyph
*glyph
;
25399 enum glyph_row_area area
= it
->area
;
25401 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25402 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25404 glyph
->charpos
= CHARPOS (it
->position
);
25405 glyph
->object
= it
->object
;
25406 glyph
->pixel_width
= it
->pixel_width
;
25407 glyph
->ascent
= glyph_ascent
;
25408 glyph
->descent
= it
->descent
;
25409 glyph
->voffset
= it
->voffset
;
25410 glyph
->type
= IMAGE_GLYPH
;
25411 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25412 glyph
->multibyte_p
= it
->multibyte_p
;
25413 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25415 /* In R2L rows, the left and the right box edges need to be
25416 drawn in reverse direction. */
25417 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25418 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25422 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25423 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25425 glyph
->overlaps_vertically_p
= 0;
25426 glyph
->padding_p
= 0;
25427 glyph
->glyph_not_available_p
= 0;
25428 glyph
->face_id
= it
->face_id
;
25429 glyph
->u
.img_id
= img
->id
;
25430 glyph
->slice
.img
= slice
;
25431 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25434 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25435 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25437 glyph
->bidi_type
= it
->bidi_it
.type
;
25439 ++it
->glyph_row
->used
[area
];
25442 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25447 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25448 of the glyph, WIDTH and HEIGHT are the width and height of the
25449 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25452 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25453 int width
, int height
, int ascent
)
25455 struct glyph
*glyph
;
25456 enum glyph_row_area area
= it
->area
;
25458 eassert (ascent
>= 0 && ascent
<= height
);
25460 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25461 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25463 /* If the glyph row is reversed, we need to prepend the glyph
25464 rather than append it. */
25465 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25469 /* Make room for the additional glyph. */
25470 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25472 glyph
= it
->glyph_row
->glyphs
[area
];
25474 /* Decrease the width of the first glyph of the row that
25475 begins before first_visible_x (e.g., due to hscroll).
25476 This is so the overall width of the row becomes smaller
25477 by the scroll amount, and the stretch glyph appended by
25478 extend_face_to_end_of_line will be wider, to shift the
25479 row glyphs to the right. (In L2R rows, the corresponding
25480 left-shift effect is accomplished by setting row->x to a
25481 negative value, which won't work with R2L rows.)
25483 This must leave us with a positive value of WIDTH, since
25484 otherwise the call to move_it_in_display_line_to at the
25485 beginning of display_line would have got past the entire
25486 first glyph, and then it->current_x would have been
25487 greater or equal to it->first_visible_x. */
25488 if (it
->current_x
< it
->first_visible_x
)
25489 width
-= it
->first_visible_x
- it
->current_x
;
25490 eassert (width
> 0);
25492 glyph
->charpos
= CHARPOS (it
->position
);
25493 glyph
->object
= object
;
25494 glyph
->pixel_width
= width
;
25495 glyph
->ascent
= ascent
;
25496 glyph
->descent
= height
- ascent
;
25497 glyph
->voffset
= it
->voffset
;
25498 glyph
->type
= STRETCH_GLYPH
;
25499 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25500 glyph
->multibyte_p
= it
->multibyte_p
;
25501 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25503 /* In R2L rows, the left and the right box edges need to be
25504 drawn in reverse direction. */
25505 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25506 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25510 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25511 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25513 glyph
->overlaps_vertically_p
= 0;
25514 glyph
->padding_p
= 0;
25515 glyph
->glyph_not_available_p
= 0;
25516 glyph
->face_id
= it
->face_id
;
25517 glyph
->u
.stretch
.ascent
= ascent
;
25518 glyph
->u
.stretch
.height
= height
;
25519 glyph
->slice
.img
= null_glyph_slice
;
25520 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25523 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25524 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25526 glyph
->bidi_type
= it
->bidi_it
.type
;
25530 glyph
->resolved_level
= 0;
25531 glyph
->bidi_type
= UNKNOWN_BT
;
25533 ++it
->glyph_row
->used
[area
];
25536 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25539 #endif /* HAVE_WINDOW_SYSTEM */
25541 /* Produce a stretch glyph for iterator IT. IT->object is the value
25542 of the glyph property displayed. The value must be a list
25543 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25546 1. `:width WIDTH' specifies that the space should be WIDTH *
25547 canonical char width wide. WIDTH may be an integer or floating
25550 2. `:relative-width FACTOR' specifies that the width of the stretch
25551 should be computed from the width of the first character having the
25552 `glyph' property, and should be FACTOR times that width.
25554 3. `:align-to HPOS' specifies that the space should be wide enough
25555 to reach HPOS, a value in canonical character units.
25557 Exactly one of the above pairs must be present.
25559 4. `:height HEIGHT' specifies that the height of the stretch produced
25560 should be HEIGHT, measured in canonical character units.
25562 5. `:relative-height FACTOR' specifies that the height of the
25563 stretch should be FACTOR times the height of the characters having
25564 the glyph property.
25566 Either none or exactly one of 4 or 5 must be present.
25568 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25569 of the stretch should be used for the ascent of the stretch.
25570 ASCENT must be in the range 0 <= ASCENT <= 100. */
25573 produce_stretch_glyph (struct it
*it
)
25575 /* (space :width WIDTH :height HEIGHT ...) */
25576 Lisp_Object prop
, plist
;
25577 int width
= 0, height
= 0, align_to
= -1;
25578 int zero_width_ok_p
= 0;
25580 struct font
*font
= NULL
;
25582 #ifdef HAVE_WINDOW_SYSTEM
25584 int zero_height_ok_p
= 0;
25586 if (FRAME_WINDOW_P (it
->f
))
25588 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25589 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25590 prepare_face_for_display (it
->f
, face
);
25594 /* List should start with `space'. */
25595 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25596 plist
= XCDR (it
->object
);
25598 /* Compute the width of the stretch. */
25599 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25600 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25602 /* Absolute width `:width WIDTH' specified and valid. */
25603 zero_width_ok_p
= 1;
25606 #ifdef HAVE_WINDOW_SYSTEM
25607 else if (FRAME_WINDOW_P (it
->f
)
25608 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25610 /* Relative width `:relative-width FACTOR' specified and valid.
25611 Compute the width of the characters having the `glyph'
25614 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25617 if (it
->multibyte_p
)
25618 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25621 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25622 if (! ASCII_CHAR_P (it2
.c
))
25623 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25626 it2
.glyph_row
= NULL
;
25627 it2
.what
= IT_CHARACTER
;
25628 x_produce_glyphs (&it2
);
25629 width
= NUMVAL (prop
) * it2
.pixel_width
;
25631 #endif /* HAVE_WINDOW_SYSTEM */
25632 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25633 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25635 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25636 align_to
= (align_to
< 0
25638 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25639 else if (align_to
< 0)
25640 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25641 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25642 zero_width_ok_p
= 1;
25645 /* Nothing specified -> width defaults to canonical char width. */
25646 width
= FRAME_COLUMN_WIDTH (it
->f
);
25648 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25651 #ifdef HAVE_WINDOW_SYSTEM
25652 /* Compute height. */
25653 if (FRAME_WINDOW_P (it
->f
))
25655 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25656 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25659 zero_height_ok_p
= 1;
25661 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25663 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25665 height
= FONT_HEIGHT (font
);
25667 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25670 /* Compute percentage of height used for ascent. If
25671 `:ascent ASCENT' is present and valid, use that. Otherwise,
25672 derive the ascent from the font in use. */
25673 if (prop
= Fplist_get (plist
, QCascent
),
25674 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25675 ascent
= height
* NUMVAL (prop
) / 100.0;
25676 else if (!NILP (prop
)
25677 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25678 ascent
= min (max (0, (int)tem
), height
);
25680 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25683 #endif /* HAVE_WINDOW_SYSTEM */
25686 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25687 && it
->current_x
+ width
> it
->last_visible_x
)
25689 width
= it
->last_visible_x
- it
->current_x
;
25690 #ifdef HAVE_WINDOW_SYSTEM
25691 /* Subtract one more pixel from the stretch width, but only on
25692 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25693 width
-= FRAME_WINDOW_P (it
->f
);
25697 if (width
> 0 && height
> 0 && it
->glyph_row
)
25699 Lisp_Object o_object
= it
->object
;
25700 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25703 if (!STRINGP (object
))
25704 object
= it
->w
->contents
;
25705 #ifdef HAVE_WINDOW_SYSTEM
25706 if (FRAME_WINDOW_P (it
->f
))
25707 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25711 it
->object
= object
;
25712 it
->char_to_display
= ' ';
25713 it
->pixel_width
= it
->len
= 1;
25715 tty_append_glyph (it
);
25716 it
->object
= o_object
;
25720 it
->pixel_width
= width
;
25721 #ifdef HAVE_WINDOW_SYSTEM
25722 if (FRAME_WINDOW_P (it
->f
))
25724 it
->ascent
= it
->phys_ascent
= ascent
;
25725 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25726 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25727 take_vertical_position_into_account (it
);
25731 it
->nglyphs
= width
;
25734 /* Get information about special display element WHAT in an
25735 environment described by IT. WHAT is one of IT_TRUNCATION or
25736 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25737 non-null glyph_row member. This function ensures that fields like
25738 face_id, c, len of IT are left untouched. */
25741 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25748 temp_it
.object
= make_number (0);
25749 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25751 if (what
== IT_CONTINUATION
)
25753 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25754 if (it
->bidi_it
.paragraph_dir
== R2L
)
25755 SET_GLYPH_FROM_CHAR (glyph
, '/');
25757 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25759 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25761 /* FIXME: Should we mirror GC for R2L lines? */
25762 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25763 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25766 else if (what
== IT_TRUNCATION
)
25768 /* Truncation glyph. */
25769 SET_GLYPH_FROM_CHAR (glyph
, '$');
25771 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25773 /* FIXME: Should we mirror GC for R2L lines? */
25774 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25775 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25781 #ifdef HAVE_WINDOW_SYSTEM
25782 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25783 is turned off, we precede the truncation/continuation glyphs by a
25784 stretch glyph whose width is computed such that these special
25785 glyphs are aligned at the window margin, even when very different
25786 fonts are used in different glyph rows. */
25787 if (FRAME_WINDOW_P (temp_it
.f
)
25788 /* init_iterator calls this with it->glyph_row == NULL, and it
25789 wants only the pixel width of the truncation/continuation
25791 && temp_it
.glyph_row
25792 /* insert_left_trunc_glyphs calls us at the beginning of the
25793 row, and it has its own calculation of the stretch glyph
25795 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25796 && (temp_it
.glyph_row
->reversed_p
25797 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25798 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25800 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25802 if (stretch_width
> 0)
25804 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25805 struct font
*font
=
25806 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25807 int stretch_ascent
=
25808 (((temp_it
.ascent
+ temp_it
.descent
)
25809 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25811 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25812 temp_it
.ascent
+ temp_it
.descent
,
25819 temp_it
.what
= IT_CHARACTER
;
25820 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25821 temp_it
.face_id
= GLYPH_FACE (glyph
);
25822 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25824 PRODUCE_GLYPHS (&temp_it
);
25825 it
->pixel_width
= temp_it
.pixel_width
;
25826 it
->nglyphs
= temp_it
.nglyphs
;
25829 #ifdef HAVE_WINDOW_SYSTEM
25831 /* Calculate line-height and line-spacing properties.
25832 An integer value specifies explicit pixel value.
25833 A float value specifies relative value to current face height.
25834 A cons (float . face-name) specifies relative value to
25835 height of specified face font.
25837 Returns height in pixels, or nil. */
25841 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25842 int boff
, int override
)
25844 Lisp_Object face_name
= Qnil
;
25845 int ascent
, descent
, height
;
25847 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25852 face_name
= XCAR (val
);
25854 if (!NUMBERP (val
))
25855 val
= make_number (1);
25856 if (NILP (face_name
))
25858 height
= it
->ascent
+ it
->descent
;
25863 if (NILP (face_name
))
25865 font
= FRAME_FONT (it
->f
);
25866 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25868 else if (EQ (face_name
, Qt
))
25877 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25879 return make_number (-1);
25881 face
= FACE_FROM_ID (it
->f
, face_id
);
25884 return make_number (-1);
25885 boff
= font
->baseline_offset
;
25886 if (font
->vertical_centering
)
25887 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25890 ascent
= FONT_BASE (font
) + boff
;
25891 descent
= FONT_DESCENT (font
) - boff
;
25895 it
->override_ascent
= ascent
;
25896 it
->override_descent
= descent
;
25897 it
->override_boff
= boff
;
25900 height
= ascent
+ descent
;
25904 height
= (int)(XFLOAT_DATA (val
) * height
);
25905 else if (INTEGERP (val
))
25906 height
*= XINT (val
);
25908 return make_number (height
);
25912 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25913 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25914 and only if this is for a character for which no font was found.
25916 If the display method (it->glyphless_method) is
25917 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25918 length of the acronym or the hexadecimal string, UPPER_XOFF and
25919 UPPER_YOFF are pixel offsets for the upper part of the string,
25920 LOWER_XOFF and LOWER_YOFF are for the lower part.
25922 For the other display methods, LEN through LOWER_YOFF are zero. */
25925 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25926 short upper_xoff
, short upper_yoff
,
25927 short lower_xoff
, short lower_yoff
)
25929 struct glyph
*glyph
;
25930 enum glyph_row_area area
= it
->area
;
25932 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25933 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25935 /* If the glyph row is reversed, we need to prepend the glyph
25936 rather than append it. */
25937 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25941 /* Make room for the additional glyph. */
25942 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25944 glyph
= it
->glyph_row
->glyphs
[area
];
25946 glyph
->charpos
= CHARPOS (it
->position
);
25947 glyph
->object
= it
->object
;
25948 glyph
->pixel_width
= it
->pixel_width
;
25949 glyph
->ascent
= it
->ascent
;
25950 glyph
->descent
= it
->descent
;
25951 glyph
->voffset
= it
->voffset
;
25952 glyph
->type
= GLYPHLESS_GLYPH
;
25953 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25954 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25955 glyph
->u
.glyphless
.len
= len
;
25956 glyph
->u
.glyphless
.ch
= it
->c
;
25957 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25958 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25959 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25960 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25961 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25962 glyph
->multibyte_p
= it
->multibyte_p
;
25963 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25965 /* In R2L rows, the left and the right box edges need to be
25966 drawn in reverse direction. */
25967 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25968 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25972 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25973 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25975 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25976 || it
->phys_descent
> it
->descent
);
25977 glyph
->padding_p
= 0;
25978 glyph
->glyph_not_available_p
= 0;
25979 glyph
->face_id
= face_id
;
25980 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25983 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25984 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25986 glyph
->bidi_type
= it
->bidi_it
.type
;
25988 ++it
->glyph_row
->used
[area
];
25991 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25995 /* Produce a glyph for a glyphless character for iterator IT.
25996 IT->glyphless_method specifies which method to use for displaying
25997 the character. See the description of enum
25998 glyphless_display_method in dispextern.h for the detail.
26000 FOR_NO_FONT is nonzero if and only if this is for a character for
26001 which no font was found. ACRONYM, if non-nil, is an acronym string
26002 for the character. */
26005 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26010 int base_width
, base_height
, width
, height
;
26011 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26014 /* Get the metrics of the base font. We always refer to the current
26016 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26017 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26018 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26019 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26020 base_height
= it
->ascent
+ it
->descent
;
26021 base_width
= font
->average_width
;
26023 face_id
= merge_glyphless_glyph_face (it
);
26025 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26027 it
->pixel_width
= THIN_SPACE_WIDTH
;
26029 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26031 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26033 width
= CHAR_WIDTH (it
->c
);
26036 else if (width
> 4)
26038 it
->pixel_width
= base_width
* width
;
26040 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26046 unsigned int code
[6];
26048 int ascent
, descent
;
26049 struct font_metrics metrics_upper
, metrics_lower
;
26051 face
= FACE_FROM_ID (it
->f
, face_id
);
26052 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26053 prepare_face_for_display (it
->f
, face
);
26055 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26057 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26058 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26059 if (CONSP (acronym
))
26060 acronym
= XCAR (acronym
);
26061 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26065 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26066 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26069 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26070 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26071 upper_len
= (len
+ 1) / 2;
26072 font
->driver
->text_extents (font
, code
, upper_len
,
26074 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26079 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26080 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26081 upper_xoff
= upper_yoff
= 2; /* the typical case */
26082 if (base_width
>= width
)
26084 /* Align the upper to the left, the lower to the right. */
26085 it
->pixel_width
= base_width
;
26086 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26090 /* Center the shorter one. */
26091 it
->pixel_width
= width
;
26092 if (metrics_upper
.width
>= metrics_lower
.width
)
26093 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26096 /* FIXME: This code doesn't look right. It formerly was
26097 missing the "lower_xoff = 0;", which couldn't have
26098 been right since it left lower_xoff uninitialized. */
26100 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26104 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26105 top, bottom, and between upper and lower strings. */
26106 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26107 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26108 /* Center vertically.
26109 H:base_height, D:base_descent
26110 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26112 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26113 descent = D - H/2 + h/2;
26114 lower_yoff = descent - 2 - ld;
26115 upper_yoff = lower_yoff - la - 1 - ud; */
26116 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26117 descent
= it
->descent
- (base_height
- height
) / 2;
26118 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26119 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26120 - metrics_upper
.descent
);
26121 /* Don't make the height shorter than the base height. */
26122 if (height
> base_height
)
26124 it
->ascent
= ascent
;
26125 it
->descent
= descent
;
26129 it
->phys_ascent
= it
->ascent
;
26130 it
->phys_descent
= it
->descent
;
26132 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26133 upper_xoff
, upper_yoff
,
26134 lower_xoff
, lower_yoff
);
26136 take_vertical_position_into_account (it
);
26141 Produce glyphs/get display metrics for the display element IT is
26142 loaded with. See the description of struct it in dispextern.h
26143 for an overview of struct it. */
26146 x_produce_glyphs (struct it
*it
)
26148 int extra_line_spacing
= it
->extra_line_spacing
;
26150 it
->glyph_not_available_p
= 0;
26152 if (it
->what
== IT_CHARACTER
)
26155 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26156 struct font
*font
= face
->font
;
26157 struct font_metrics
*pcm
= NULL
;
26158 int boff
; /* Baseline offset. */
26162 /* When no suitable font is found, display this character by
26163 the method specified in the first extra slot of
26164 Vglyphless_char_display. */
26165 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26167 eassert (it
->what
== IT_GLYPHLESS
);
26168 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26172 boff
= font
->baseline_offset
;
26173 if (font
->vertical_centering
)
26174 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26176 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26182 if (it
->override_ascent
>= 0)
26184 it
->ascent
= it
->override_ascent
;
26185 it
->descent
= it
->override_descent
;
26186 boff
= it
->override_boff
;
26190 it
->ascent
= FONT_BASE (font
) + boff
;
26191 it
->descent
= FONT_DESCENT (font
) - boff
;
26194 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26196 pcm
= get_per_char_metric (font
, &char2b
);
26197 if (pcm
->width
== 0
26198 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26204 it
->phys_ascent
= pcm
->ascent
+ boff
;
26205 it
->phys_descent
= pcm
->descent
- boff
;
26206 it
->pixel_width
= pcm
->width
;
26210 it
->glyph_not_available_p
= 1;
26211 it
->phys_ascent
= it
->ascent
;
26212 it
->phys_descent
= it
->descent
;
26213 it
->pixel_width
= font
->space_width
;
26216 if (it
->constrain_row_ascent_descent_p
)
26218 if (it
->descent
> it
->max_descent
)
26220 it
->ascent
+= it
->descent
- it
->max_descent
;
26221 it
->descent
= it
->max_descent
;
26223 if (it
->ascent
> it
->max_ascent
)
26225 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26226 it
->ascent
= it
->max_ascent
;
26228 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26229 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26230 extra_line_spacing
= 0;
26233 /* If this is a space inside a region of text with
26234 `space-width' property, change its width. */
26235 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26237 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26239 /* If face has a box, add the box thickness to the character
26240 height. If character has a box line to the left and/or
26241 right, add the box line width to the character's width. */
26242 if (face
->box
!= FACE_NO_BOX
)
26244 int thick
= face
->box_line_width
;
26248 it
->ascent
+= thick
;
26249 it
->descent
+= thick
;
26254 if (it
->start_of_box_run_p
)
26255 it
->pixel_width
+= thick
;
26256 if (it
->end_of_box_run_p
)
26257 it
->pixel_width
+= thick
;
26260 /* If face has an overline, add the height of the overline
26261 (1 pixel) and a 1 pixel margin to the character height. */
26262 if (face
->overline_p
)
26263 it
->ascent
+= overline_margin
;
26265 if (it
->constrain_row_ascent_descent_p
)
26267 if (it
->ascent
> it
->max_ascent
)
26268 it
->ascent
= it
->max_ascent
;
26269 if (it
->descent
> it
->max_descent
)
26270 it
->descent
= it
->max_descent
;
26273 take_vertical_position_into_account (it
);
26275 /* If we have to actually produce glyphs, do it. */
26280 /* Translate a space with a `space-width' property
26281 into a stretch glyph. */
26282 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26283 / FONT_HEIGHT (font
));
26284 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26285 it
->ascent
+ it
->descent
, ascent
);
26290 /* If characters with lbearing or rbearing are displayed
26291 in this line, record that fact in a flag of the
26292 glyph row. This is used to optimize X output code. */
26293 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26294 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26296 if (! stretched_p
&& it
->pixel_width
== 0)
26297 /* We assure that all visible glyphs have at least 1-pixel
26299 it
->pixel_width
= 1;
26301 else if (it
->char_to_display
== '\n')
26303 /* A newline has no width, but we need the height of the
26304 line. But if previous part of the line sets a height,
26305 don't increase that height. */
26307 Lisp_Object height
;
26308 Lisp_Object total_height
= Qnil
;
26310 it
->override_ascent
= -1;
26311 it
->pixel_width
= 0;
26314 height
= get_it_property (it
, Qline_height
);
26315 /* Split (line-height total-height) list. */
26317 && CONSP (XCDR (height
))
26318 && NILP (XCDR (XCDR (height
))))
26320 total_height
= XCAR (XCDR (height
));
26321 height
= XCAR (height
);
26323 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26325 if (it
->override_ascent
>= 0)
26327 it
->ascent
= it
->override_ascent
;
26328 it
->descent
= it
->override_descent
;
26329 boff
= it
->override_boff
;
26333 it
->ascent
= FONT_BASE (font
) + boff
;
26334 it
->descent
= FONT_DESCENT (font
) - boff
;
26337 if (EQ (height
, Qt
))
26339 if (it
->descent
> it
->max_descent
)
26341 it
->ascent
+= it
->descent
- it
->max_descent
;
26342 it
->descent
= it
->max_descent
;
26344 if (it
->ascent
> it
->max_ascent
)
26346 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26347 it
->ascent
= it
->max_ascent
;
26349 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26350 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26351 it
->constrain_row_ascent_descent_p
= 1;
26352 extra_line_spacing
= 0;
26356 Lisp_Object spacing
;
26358 it
->phys_ascent
= it
->ascent
;
26359 it
->phys_descent
= it
->descent
;
26361 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26362 && face
->box
!= FACE_NO_BOX
26363 && face
->box_line_width
> 0)
26365 it
->ascent
+= face
->box_line_width
;
26366 it
->descent
+= face
->box_line_width
;
26369 && XINT (height
) > it
->ascent
+ it
->descent
)
26370 it
->ascent
= XINT (height
) - it
->descent
;
26372 if (!NILP (total_height
))
26373 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26376 spacing
= get_it_property (it
, Qline_spacing
);
26377 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26379 if (INTEGERP (spacing
))
26381 extra_line_spacing
= XINT (spacing
);
26382 if (!NILP (total_height
))
26383 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26387 else /* i.e. (it->char_to_display == '\t') */
26389 if (font
->space_width
> 0)
26391 int tab_width
= it
->tab_width
* font
->space_width
;
26392 int x
= it
->current_x
+ it
->continuation_lines_width
;
26393 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26395 /* If the distance from the current position to the next tab
26396 stop is less than a space character width, use the
26397 tab stop after that. */
26398 if (next_tab_x
- x
< font
->space_width
)
26399 next_tab_x
+= tab_width
;
26401 it
->pixel_width
= next_tab_x
- x
;
26403 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26404 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26408 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26409 it
->ascent
+ it
->descent
, it
->ascent
);
26414 it
->pixel_width
= 0;
26419 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26421 /* A static composition.
26423 Note: A composition is represented as one glyph in the
26424 glyph matrix. There are no padding glyphs.
26426 Important note: pixel_width, ascent, and descent are the
26427 values of what is drawn by draw_glyphs (i.e. the values of
26428 the overall glyphs composed). */
26429 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26430 int boff
; /* baseline offset */
26431 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26432 int glyph_len
= cmp
->glyph_len
;
26433 struct font
*font
= face
->font
;
26437 /* If we have not yet calculated pixel size data of glyphs of
26438 the composition for the current face font, calculate them
26439 now. Theoretically, we have to check all fonts for the
26440 glyphs, but that requires much time and memory space. So,
26441 here we check only the font of the first glyph. This may
26442 lead to incorrect display, but it's very rare, and C-l
26443 (recenter-top-bottom) can correct the display anyway. */
26444 if (! cmp
->font
|| cmp
->font
!= font
)
26446 /* Ascent and descent of the font of the first character
26447 of this composition (adjusted by baseline offset).
26448 Ascent and descent of overall glyphs should not be less
26449 than these, respectively. */
26450 int font_ascent
, font_descent
, font_height
;
26451 /* Bounding box of the overall glyphs. */
26452 int leftmost
, rightmost
, lowest
, highest
;
26453 int lbearing
, rbearing
;
26454 int i
, width
, ascent
, descent
;
26455 int left_padded
= 0, right_padded
= 0;
26456 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26458 struct font_metrics
*pcm
;
26459 int font_not_found_p
;
26462 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26463 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26465 if (glyph_len
< cmp
->glyph_len
)
26467 for (i
= 0; i
< glyph_len
; i
++)
26469 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26471 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26476 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26477 : IT_CHARPOS (*it
));
26478 /* If no suitable font is found, use the default font. */
26479 font_not_found_p
= font
== NULL
;
26480 if (font_not_found_p
)
26482 face
= face
->ascii_face
;
26485 boff
= font
->baseline_offset
;
26486 if (font
->vertical_centering
)
26487 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26488 font_ascent
= FONT_BASE (font
) + boff
;
26489 font_descent
= FONT_DESCENT (font
) - boff
;
26490 font_height
= FONT_HEIGHT (font
);
26495 if (! font_not_found_p
)
26497 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26499 pcm
= get_per_char_metric (font
, &char2b
);
26502 /* Initialize the bounding box. */
26505 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26506 ascent
= pcm
->ascent
;
26507 descent
= pcm
->descent
;
26508 lbearing
= pcm
->lbearing
;
26509 rbearing
= pcm
->rbearing
;
26513 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26514 ascent
= FONT_BASE (font
);
26515 descent
= FONT_DESCENT (font
);
26522 lowest
= - descent
+ boff
;
26523 highest
= ascent
+ boff
;
26525 if (! font_not_found_p
26526 && font
->default_ascent
26527 && CHAR_TABLE_P (Vuse_default_ascent
)
26528 && !NILP (Faref (Vuse_default_ascent
,
26529 make_number (it
->char_to_display
))))
26530 highest
= font
->default_ascent
+ boff
;
26532 /* Draw the first glyph at the normal position. It may be
26533 shifted to right later if some other glyphs are drawn
26535 cmp
->offsets
[i
* 2] = 0;
26536 cmp
->offsets
[i
* 2 + 1] = boff
;
26537 cmp
->lbearing
= lbearing
;
26538 cmp
->rbearing
= rbearing
;
26540 /* Set cmp->offsets for the remaining glyphs. */
26541 for (i
++; i
< glyph_len
; i
++)
26543 int left
, right
, btm
, top
;
26544 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26546 struct face
*this_face
;
26550 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26551 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26552 font
= this_face
->font
;
26558 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26560 pcm
= get_per_char_metric (font
, &char2b
);
26563 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26566 width
= pcm
->width
;
26567 ascent
= pcm
->ascent
;
26568 descent
= pcm
->descent
;
26569 lbearing
= pcm
->lbearing
;
26570 rbearing
= pcm
->rbearing
;
26571 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26573 /* Relative composition with or without
26574 alternate chars. */
26575 left
= (leftmost
+ rightmost
- width
) / 2;
26576 btm
= - descent
+ boff
;
26577 if (font
->relative_compose
26578 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26579 || NILP (Faref (Vignore_relative_composition
,
26580 make_number (ch
)))))
26583 if (- descent
>= font
->relative_compose
)
26584 /* One extra pixel between two glyphs. */
26586 else if (ascent
<= 0)
26587 /* One extra pixel between two glyphs. */
26588 btm
= lowest
- 1 - ascent
- descent
;
26593 /* A composition rule is specified by an integer
26594 value that encodes global and new reference
26595 points (GREF and NREF). GREF and NREF are
26596 specified by numbers as below:
26598 0---1---2 -- ascent
26602 9--10--11 -- center
26604 ---3---4---5--- baseline
26606 6---7---8 -- descent
26608 int rule
= COMPOSITION_RULE (cmp
, i
);
26609 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26611 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26612 grefx
= gref
% 3, nrefx
= nref
% 3;
26613 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26615 xoff
= font_height
* (xoff
- 128) / 256;
26617 yoff
= font_height
* (yoff
- 128) / 256;
26620 + grefx
* (rightmost
- leftmost
) / 2
26621 - nrefx
* width
/ 2
26624 btm
= ((grefy
== 0 ? highest
26626 : grefy
== 2 ? lowest
26627 : (highest
+ lowest
) / 2)
26628 - (nrefy
== 0 ? ascent
+ descent
26629 : nrefy
== 1 ? descent
- boff
26631 : (ascent
+ descent
) / 2)
26635 cmp
->offsets
[i
* 2] = left
;
26636 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26638 /* Update the bounding box of the overall glyphs. */
26641 right
= left
+ width
;
26642 if (left
< leftmost
)
26644 if (right
> rightmost
)
26647 top
= btm
+ descent
+ ascent
;
26653 if (cmp
->lbearing
> left
+ lbearing
)
26654 cmp
->lbearing
= left
+ lbearing
;
26655 if (cmp
->rbearing
< left
+ rbearing
)
26656 cmp
->rbearing
= left
+ rbearing
;
26660 /* If there are glyphs whose x-offsets are negative,
26661 shift all glyphs to the right and make all x-offsets
26665 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26666 cmp
->offsets
[i
* 2] -= leftmost
;
26667 rightmost
-= leftmost
;
26668 cmp
->lbearing
-= leftmost
;
26669 cmp
->rbearing
-= leftmost
;
26672 if (left_padded
&& cmp
->lbearing
< 0)
26674 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26675 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26676 rightmost
-= cmp
->lbearing
;
26677 cmp
->rbearing
-= cmp
->lbearing
;
26680 if (right_padded
&& rightmost
< cmp
->rbearing
)
26682 rightmost
= cmp
->rbearing
;
26685 cmp
->pixel_width
= rightmost
;
26686 cmp
->ascent
= highest
;
26687 cmp
->descent
= - lowest
;
26688 if (cmp
->ascent
< font_ascent
)
26689 cmp
->ascent
= font_ascent
;
26690 if (cmp
->descent
< font_descent
)
26691 cmp
->descent
= font_descent
;
26695 && (cmp
->lbearing
< 0
26696 || cmp
->rbearing
> cmp
->pixel_width
))
26697 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26699 it
->pixel_width
= cmp
->pixel_width
;
26700 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26701 it
->descent
= it
->phys_descent
= cmp
->descent
;
26702 if (face
->box
!= FACE_NO_BOX
)
26704 int thick
= face
->box_line_width
;
26708 it
->ascent
+= thick
;
26709 it
->descent
+= thick
;
26714 if (it
->start_of_box_run_p
)
26715 it
->pixel_width
+= thick
;
26716 if (it
->end_of_box_run_p
)
26717 it
->pixel_width
+= thick
;
26720 /* If face has an overline, add the height of the overline
26721 (1 pixel) and a 1 pixel margin to the character height. */
26722 if (face
->overline_p
)
26723 it
->ascent
+= overline_margin
;
26725 take_vertical_position_into_account (it
);
26726 if (it
->ascent
< 0)
26728 if (it
->descent
< 0)
26731 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26732 append_composite_glyph (it
);
26734 else if (it
->what
== IT_COMPOSITION
)
26736 /* A dynamic (automatic) composition. */
26737 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26738 Lisp_Object gstring
;
26739 struct font_metrics metrics
;
26743 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26745 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26748 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26749 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26750 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26751 it
->descent
= it
->phys_descent
= metrics
.descent
;
26752 if (face
->box
!= FACE_NO_BOX
)
26754 int thick
= face
->box_line_width
;
26758 it
->ascent
+= thick
;
26759 it
->descent
+= thick
;
26764 if (it
->start_of_box_run_p
)
26765 it
->pixel_width
+= thick
;
26766 if (it
->end_of_box_run_p
)
26767 it
->pixel_width
+= thick
;
26769 /* If face has an overline, add the height of the overline
26770 (1 pixel) and a 1 pixel margin to the character height. */
26771 if (face
->overline_p
)
26772 it
->ascent
+= overline_margin
;
26773 take_vertical_position_into_account (it
);
26774 if (it
->ascent
< 0)
26776 if (it
->descent
< 0)
26780 append_composite_glyph (it
);
26782 else if (it
->what
== IT_GLYPHLESS
)
26783 produce_glyphless_glyph (it
, 0, Qnil
);
26784 else if (it
->what
== IT_IMAGE
)
26785 produce_image_glyph (it
);
26786 else if (it
->what
== IT_STRETCH
)
26787 produce_stretch_glyph (it
);
26790 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26791 because this isn't true for images with `:ascent 100'. */
26792 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26793 if (it
->area
== TEXT_AREA
)
26794 it
->current_x
+= it
->pixel_width
;
26796 if (extra_line_spacing
> 0)
26798 it
->descent
+= extra_line_spacing
;
26799 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26800 it
->max_extra_line_spacing
= extra_line_spacing
;
26803 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26804 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26805 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26806 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26810 Output LEN glyphs starting at START at the nominal cursor position.
26811 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26812 being updated, and UPDATED_AREA is the area of that row being updated. */
26815 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26816 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26818 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26820 eassert (updated_row
);
26821 /* When the window is hscrolled, cursor hpos can legitimately be out
26822 of bounds, but we draw the cursor at the corresponding window
26823 margin in that case. */
26824 if (!updated_row
->reversed_p
&& chpos
< 0)
26826 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26827 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26831 /* Write glyphs. */
26833 hpos
= start
- updated_row
->glyphs
[updated_area
];
26834 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26835 updated_row
, updated_area
,
26837 DRAW_NORMAL_TEXT
, 0);
26839 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26840 if (updated_area
== TEXT_AREA
26841 && w
->phys_cursor_on_p
26842 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26844 && chpos
< hpos
+ len
)
26845 w
->phys_cursor_on_p
= 0;
26849 /* Advance the output cursor. */
26850 w
->output_cursor
.hpos
+= len
;
26851 w
->output_cursor
.x
= x
;
26856 Insert LEN glyphs from START at the nominal cursor position. */
26859 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26860 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26863 int line_height
, shift_by_width
, shifted_region_width
;
26864 struct glyph_row
*row
;
26865 struct glyph
*glyph
;
26866 int frame_x
, frame_y
;
26869 eassert (updated_row
);
26871 f
= XFRAME (WINDOW_FRAME (w
));
26873 /* Get the height of the line we are in. */
26875 line_height
= row
->height
;
26877 /* Get the width of the glyphs to insert. */
26878 shift_by_width
= 0;
26879 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26880 shift_by_width
+= glyph
->pixel_width
;
26882 /* Get the width of the region to shift right. */
26883 shifted_region_width
= (window_box_width (w
, updated_area
)
26884 - w
->output_cursor
.x
26888 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26889 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26891 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26892 line_height
, shift_by_width
);
26894 /* Write the glyphs. */
26895 hpos
= start
- row
->glyphs
[updated_area
];
26896 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26898 DRAW_NORMAL_TEXT
, 0);
26900 /* Advance the output cursor. */
26901 w
->output_cursor
.hpos
+= len
;
26902 w
->output_cursor
.x
+= shift_by_width
;
26908 Erase the current text line from the nominal cursor position
26909 (inclusive) to pixel column TO_X (exclusive). The idea is that
26910 everything from TO_X onward is already erased.
26912 TO_X is a pixel position relative to UPDATED_AREA of currently
26913 updated window W. TO_X == -1 means clear to the end of this area. */
26916 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26917 enum glyph_row_area updated_area
, int to_x
)
26920 int max_x
, min_y
, max_y
;
26921 int from_x
, from_y
, to_y
;
26923 eassert (updated_row
);
26924 f
= XFRAME (w
->frame
);
26926 if (updated_row
->full_width_p
)
26927 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26928 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26930 max_x
= window_box_width (w
, updated_area
);
26931 max_y
= window_text_bottom_y (w
);
26933 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26934 of window. For TO_X > 0, truncate to end of drawing area. */
26940 to_x
= min (to_x
, max_x
);
26942 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26944 /* Notice if the cursor will be cleared by this operation. */
26945 if (!updated_row
->full_width_p
)
26946 notice_overwritten_cursor (w
, updated_area
,
26947 w
->output_cursor
.x
, -1,
26949 MATRIX_ROW_BOTTOM_Y (updated_row
));
26951 from_x
= w
->output_cursor
.x
;
26953 /* Translate to frame coordinates. */
26954 if (updated_row
->full_width_p
)
26956 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26957 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26961 int area_left
= window_box_left (w
, updated_area
);
26962 from_x
+= area_left
;
26966 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26967 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26968 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26970 /* Prevent inadvertently clearing to end of the X window. */
26971 if (to_x
> from_x
&& to_y
> from_y
)
26974 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26975 to_x
- from_x
, to_y
- from_y
);
26980 #endif /* HAVE_WINDOW_SYSTEM */
26984 /***********************************************************************
26986 ***********************************************************************/
26988 /* Value is the internal representation of the specified cursor type
26989 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26990 of the bar cursor. */
26992 static enum text_cursor_kinds
26993 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26995 enum text_cursor_kinds type
;
27000 if (EQ (arg
, Qbox
))
27001 return FILLED_BOX_CURSOR
;
27003 if (EQ (arg
, Qhollow
))
27004 return HOLLOW_BOX_CURSOR
;
27006 if (EQ (arg
, Qbar
))
27013 && EQ (XCAR (arg
), Qbar
)
27014 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27016 *width
= XINT (XCDR (arg
));
27020 if (EQ (arg
, Qhbar
))
27023 return HBAR_CURSOR
;
27027 && EQ (XCAR (arg
), Qhbar
)
27028 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27030 *width
= XINT (XCDR (arg
));
27031 return HBAR_CURSOR
;
27034 /* Treat anything unknown as "hollow box cursor".
27035 It was bad to signal an error; people have trouble fixing
27036 .Xdefaults with Emacs, when it has something bad in it. */
27037 type
= HOLLOW_BOX_CURSOR
;
27042 /* Set the default cursor types for specified frame. */
27044 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27049 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27050 FRAME_CURSOR_WIDTH (f
) = width
;
27052 /* By default, set up the blink-off state depending on the on-state. */
27054 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27057 FRAME_BLINK_OFF_CURSOR (f
)
27058 = get_specified_cursor_type (XCDR (tem
), &width
);
27059 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27062 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27064 /* Make sure the cursor gets redrawn. */
27065 f
->cursor_type_changed
= 1;
27069 #ifdef HAVE_WINDOW_SYSTEM
27071 /* Return the cursor we want to be displayed in window W. Return
27072 width of bar/hbar cursor through WIDTH arg. Return with
27073 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27074 (i.e. if the `system caret' should track this cursor).
27076 In a mini-buffer window, we want the cursor only to appear if we
27077 are reading input from this window. For the selected window, we
27078 want the cursor type given by the frame parameter or buffer local
27079 setting of cursor-type. If explicitly marked off, draw no cursor.
27080 In all other cases, we want a hollow box cursor. */
27082 static enum text_cursor_kinds
27083 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27084 int *active_cursor
)
27086 struct frame
*f
= XFRAME (w
->frame
);
27087 struct buffer
*b
= XBUFFER (w
->contents
);
27088 int cursor_type
= DEFAULT_CURSOR
;
27089 Lisp_Object alt_cursor
;
27090 int non_selected
= 0;
27092 *active_cursor
= 1;
27095 if (cursor_in_echo_area
27096 && FRAME_HAS_MINIBUF_P (f
)
27097 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27099 if (w
== XWINDOW (echo_area_window
))
27101 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27103 *width
= FRAME_CURSOR_WIDTH (f
);
27104 return FRAME_DESIRED_CURSOR (f
);
27107 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27110 *active_cursor
= 0;
27114 /* Detect a nonselected window or nonselected frame. */
27115 else if (w
!= XWINDOW (f
->selected_window
)
27116 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27118 *active_cursor
= 0;
27120 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27126 /* Never display a cursor in a window in which cursor-type is nil. */
27127 if (NILP (BVAR (b
, cursor_type
)))
27130 /* Get the normal cursor type for this window. */
27131 if (EQ (BVAR (b
, cursor_type
), Qt
))
27133 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27134 *width
= FRAME_CURSOR_WIDTH (f
);
27137 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27139 /* Use cursor-in-non-selected-windows instead
27140 for non-selected window or frame. */
27143 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27144 if (!EQ (Qt
, alt_cursor
))
27145 return get_specified_cursor_type (alt_cursor
, width
);
27146 /* t means modify the normal cursor type. */
27147 if (cursor_type
== FILLED_BOX_CURSOR
)
27148 cursor_type
= HOLLOW_BOX_CURSOR
;
27149 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27151 return cursor_type
;
27154 /* Use normal cursor if not blinked off. */
27155 if (!w
->cursor_off_p
)
27157 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27159 if (cursor_type
== FILLED_BOX_CURSOR
)
27161 /* Using a block cursor on large images can be very annoying.
27162 So use a hollow cursor for "large" images.
27163 If image is not transparent (no mask), also use hollow cursor. */
27164 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27165 if (img
!= NULL
&& IMAGEP (img
->spec
))
27167 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27168 where N = size of default frame font size.
27169 This should cover most of the "tiny" icons people may use. */
27171 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27172 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27173 cursor_type
= HOLLOW_BOX_CURSOR
;
27176 else if (cursor_type
!= NO_CURSOR
)
27178 /* Display current only supports BOX and HOLLOW cursors for images.
27179 So for now, unconditionally use a HOLLOW cursor when cursor is
27180 not a solid box cursor. */
27181 cursor_type
= HOLLOW_BOX_CURSOR
;
27184 return cursor_type
;
27187 /* Cursor is blinked off, so determine how to "toggle" it. */
27189 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27190 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27191 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27193 /* Then see if frame has specified a specific blink off cursor type. */
27194 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27196 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27197 return FRAME_BLINK_OFF_CURSOR (f
);
27201 /* Some people liked having a permanently visible blinking cursor,
27202 while others had very strong opinions against it. So it was
27203 decided to remove it. KFS 2003-09-03 */
27205 /* Finally perform built-in cursor blinking:
27206 filled box <-> hollow box
27207 wide [h]bar <-> narrow [h]bar
27208 narrow [h]bar <-> no cursor
27209 other type <-> no cursor */
27211 if (cursor_type
== FILLED_BOX_CURSOR
)
27212 return HOLLOW_BOX_CURSOR
;
27214 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27217 return cursor_type
;
27225 /* Notice when the text cursor of window W has been completely
27226 overwritten by a drawing operation that outputs glyphs in AREA
27227 starting at X0 and ending at X1 in the line starting at Y0 and
27228 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27229 the rest of the line after X0 has been written. Y coordinates
27230 are window-relative. */
27233 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27234 int x0
, int x1
, int y0
, int y1
)
27236 int cx0
, cx1
, cy0
, cy1
;
27237 struct glyph_row
*row
;
27239 if (!w
->phys_cursor_on_p
)
27241 if (area
!= TEXT_AREA
)
27244 if (w
->phys_cursor
.vpos
< 0
27245 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27246 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27247 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27250 if (row
->cursor_in_fringe_p
)
27252 row
->cursor_in_fringe_p
= 0;
27253 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27254 w
->phys_cursor_on_p
= 0;
27258 cx0
= w
->phys_cursor
.x
;
27259 cx1
= cx0
+ w
->phys_cursor_width
;
27260 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27263 /* The cursor image will be completely removed from the
27264 screen if the output area intersects the cursor area in
27265 y-direction. When we draw in [y0 y1[, and some part of
27266 the cursor is at y < y0, that part must have been drawn
27267 before. When scrolling, the cursor is erased before
27268 actually scrolling, so we don't come here. When not
27269 scrolling, the rows above the old cursor row must have
27270 changed, and in this case these rows must have written
27271 over the cursor image.
27273 Likewise if part of the cursor is below y1, with the
27274 exception of the cursor being in the first blank row at
27275 the buffer and window end because update_text_area
27276 doesn't draw that row. (Except when it does, but
27277 that's handled in update_text_area.) */
27279 cy0
= w
->phys_cursor
.y
;
27280 cy1
= cy0
+ w
->phys_cursor_height
;
27281 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27284 w
->phys_cursor_on_p
= 0;
27287 #endif /* HAVE_WINDOW_SYSTEM */
27290 /************************************************************************
27292 ************************************************************************/
27294 #ifdef HAVE_WINDOW_SYSTEM
27297 Fix the display of area AREA of overlapping row ROW in window W
27298 with respect to the overlapping part OVERLAPS. */
27301 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27302 enum glyph_row_area area
, int overlaps
)
27309 for (i
= 0; i
< row
->used
[area
];)
27311 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27313 int start
= i
, start_x
= x
;
27317 x
+= row
->glyphs
[area
][i
].pixel_width
;
27320 while (i
< row
->used
[area
]
27321 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27323 draw_glyphs (w
, start_x
, row
, area
,
27325 DRAW_NORMAL_TEXT
, overlaps
);
27329 x
+= row
->glyphs
[area
][i
].pixel_width
;
27339 Draw the cursor glyph of window W in glyph row ROW. See the
27340 comment of draw_glyphs for the meaning of HL. */
27343 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27344 enum draw_glyphs_face hl
)
27346 /* If cursor hpos is out of bounds, don't draw garbage. This can
27347 happen in mini-buffer windows when switching between echo area
27348 glyphs and mini-buffer. */
27349 if ((row
->reversed_p
27350 ? (w
->phys_cursor
.hpos
>= 0)
27351 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27353 int on_p
= w
->phys_cursor_on_p
;
27355 int hpos
= w
->phys_cursor
.hpos
;
27357 /* When the window is hscrolled, cursor hpos can legitimately be
27358 out of bounds, but we draw the cursor at the corresponding
27359 window margin in that case. */
27360 if (!row
->reversed_p
&& hpos
< 0)
27362 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27363 hpos
= row
->used
[TEXT_AREA
] - 1;
27365 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27367 w
->phys_cursor_on_p
= on_p
;
27369 if (hl
== DRAW_CURSOR
)
27370 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27371 /* When we erase the cursor, and ROW is overlapped by other
27372 rows, make sure that these overlapping parts of other rows
27374 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27376 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27378 if (row
> w
->current_matrix
->rows
27379 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27380 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27381 OVERLAPS_ERASED_CURSOR
);
27383 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27384 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27385 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27386 OVERLAPS_ERASED_CURSOR
);
27392 /* Erase the image of a cursor of window W from the screen. */
27395 erase_phys_cursor (struct window
*w
)
27397 struct frame
*f
= XFRAME (w
->frame
);
27398 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27399 int hpos
= w
->phys_cursor
.hpos
;
27400 int vpos
= w
->phys_cursor
.vpos
;
27401 int mouse_face_here_p
= 0;
27402 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27403 struct glyph_row
*cursor_row
;
27404 struct glyph
*cursor_glyph
;
27405 enum draw_glyphs_face hl
;
27407 /* No cursor displayed or row invalidated => nothing to do on the
27409 if (w
->phys_cursor_type
== NO_CURSOR
)
27410 goto mark_cursor_off
;
27412 /* VPOS >= active_glyphs->nrows means that window has been resized.
27413 Don't bother to erase the cursor. */
27414 if (vpos
>= active_glyphs
->nrows
)
27415 goto mark_cursor_off
;
27417 /* If row containing cursor is marked invalid, there is nothing we
27419 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27420 if (!cursor_row
->enabled_p
)
27421 goto mark_cursor_off
;
27423 /* If line spacing is > 0, old cursor may only be partially visible in
27424 window after split-window. So adjust visible height. */
27425 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27426 window_text_bottom_y (w
) - cursor_row
->y
);
27428 /* If row is completely invisible, don't attempt to delete a cursor which
27429 isn't there. This can happen if cursor is at top of a window, and
27430 we switch to a buffer with a header line in that window. */
27431 if (cursor_row
->visible_height
<= 0)
27432 goto mark_cursor_off
;
27434 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27435 if (cursor_row
->cursor_in_fringe_p
)
27437 cursor_row
->cursor_in_fringe_p
= 0;
27438 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27439 goto mark_cursor_off
;
27442 /* This can happen when the new row is shorter than the old one.
27443 In this case, either draw_glyphs or clear_end_of_line
27444 should have cleared the cursor. Note that we wouldn't be
27445 able to erase the cursor in this case because we don't have a
27446 cursor glyph at hand. */
27447 if ((cursor_row
->reversed_p
27448 ? (w
->phys_cursor
.hpos
< 0)
27449 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27450 goto mark_cursor_off
;
27452 /* When the window is hscrolled, cursor hpos can legitimately be out
27453 of bounds, but we draw the cursor at the corresponding window
27454 margin in that case. */
27455 if (!cursor_row
->reversed_p
&& hpos
< 0)
27457 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27458 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27460 /* If the cursor is in the mouse face area, redisplay that when
27461 we clear the cursor. */
27462 if (! NILP (hlinfo
->mouse_face_window
)
27463 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27464 /* Don't redraw the cursor's spot in mouse face if it is at the
27465 end of a line (on a newline). The cursor appears there, but
27466 mouse highlighting does not. */
27467 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27468 mouse_face_here_p
= 1;
27470 /* Maybe clear the display under the cursor. */
27471 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27474 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27477 cursor_glyph
= get_phys_cursor_glyph (w
);
27478 if (cursor_glyph
== NULL
)
27479 goto mark_cursor_off
;
27481 width
= cursor_glyph
->pixel_width
;
27482 x
= w
->phys_cursor
.x
;
27488 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27489 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27490 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27493 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27496 /* Erase the cursor by redrawing the character underneath it. */
27497 if (mouse_face_here_p
)
27498 hl
= DRAW_MOUSE_FACE
;
27500 hl
= DRAW_NORMAL_TEXT
;
27501 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27504 w
->phys_cursor_on_p
= 0;
27505 w
->phys_cursor_type
= NO_CURSOR
;
27510 Display or clear cursor of window W. If ON is zero, clear the
27511 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27512 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27515 display_and_set_cursor (struct window
*w
, bool on
,
27516 int hpos
, int vpos
, int x
, int y
)
27518 struct frame
*f
= XFRAME (w
->frame
);
27519 int new_cursor_type
;
27520 int new_cursor_width
;
27522 struct glyph_row
*glyph_row
;
27523 struct glyph
*glyph
;
27525 /* This is pointless on invisible frames, and dangerous on garbaged
27526 windows and frames; in the latter case, the frame or window may
27527 be in the midst of changing its size, and x and y may be off the
27529 if (! FRAME_VISIBLE_P (f
)
27530 || FRAME_GARBAGED_P (f
)
27531 || vpos
>= w
->current_matrix
->nrows
27532 || hpos
>= w
->current_matrix
->matrix_w
)
27535 /* If cursor is off and we want it off, return quickly. */
27536 if (!on
&& !w
->phys_cursor_on_p
)
27539 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27540 /* If cursor row is not enabled, we don't really know where to
27541 display the cursor. */
27542 if (!glyph_row
->enabled_p
)
27544 w
->phys_cursor_on_p
= 0;
27549 if (!glyph_row
->exact_window_width_line_p
27550 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27551 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27553 eassert (input_blocked_p ());
27555 /* Set new_cursor_type to the cursor we want to be displayed. */
27556 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27557 &new_cursor_width
, &active_cursor
);
27559 /* If cursor is currently being shown and we don't want it to be or
27560 it is in the wrong place, or the cursor type is not what we want,
27562 if (w
->phys_cursor_on_p
27564 || w
->phys_cursor
.x
!= x
27565 || w
->phys_cursor
.y
!= y
27566 /* HPOS can be negative in R2L rows whose
27567 exact_window_width_line_p flag is set (i.e. their newline
27568 would "overflow into the fringe"). */
27570 || new_cursor_type
!= w
->phys_cursor_type
27571 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27572 && new_cursor_width
!= w
->phys_cursor_width
)))
27573 erase_phys_cursor (w
);
27575 /* Don't check phys_cursor_on_p here because that flag is only set
27576 to zero in some cases where we know that the cursor has been
27577 completely erased, to avoid the extra work of erasing the cursor
27578 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27579 still not be visible, or it has only been partly erased. */
27582 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27583 w
->phys_cursor_height
= glyph_row
->height
;
27585 /* Set phys_cursor_.* before x_draw_.* is called because some
27586 of them may need the information. */
27587 w
->phys_cursor
.x
= x
;
27588 w
->phys_cursor
.y
= glyph_row
->y
;
27589 w
->phys_cursor
.hpos
= hpos
;
27590 w
->phys_cursor
.vpos
= vpos
;
27593 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27594 new_cursor_type
, new_cursor_width
,
27595 on
, active_cursor
);
27599 /* Switch the display of W's cursor on or off, according to the value
27603 update_window_cursor (struct window
*w
, bool on
)
27605 /* Don't update cursor in windows whose frame is in the process
27606 of being deleted. */
27607 if (w
->current_matrix
)
27609 int hpos
= w
->phys_cursor
.hpos
;
27610 int vpos
= w
->phys_cursor
.vpos
;
27611 struct glyph_row
*row
;
27613 if (vpos
>= w
->current_matrix
->nrows
27614 || hpos
>= w
->current_matrix
->matrix_w
)
27617 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27619 /* When the window is hscrolled, cursor hpos can legitimately be
27620 out of bounds, but we draw the cursor at the corresponding
27621 window margin in that case. */
27622 if (!row
->reversed_p
&& hpos
< 0)
27624 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27625 hpos
= row
->used
[TEXT_AREA
] - 1;
27628 display_and_set_cursor (w
, on
, hpos
, vpos
,
27629 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27635 /* Call update_window_cursor with parameter ON_P on all leaf windows
27636 in the window tree rooted at W. */
27639 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27643 if (WINDOWP (w
->contents
))
27644 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27646 update_window_cursor (w
, on_p
);
27648 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27654 Display the cursor on window W, or clear it, according to ON_P.
27655 Don't change the cursor's position. */
27658 x_update_cursor (struct frame
*f
, bool on_p
)
27660 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27665 Clear the cursor of window W to background color, and mark the
27666 cursor as not shown. This is used when the text where the cursor
27667 is about to be rewritten. */
27670 x_clear_cursor (struct window
*w
)
27672 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27673 update_window_cursor (w
, 0);
27676 #endif /* HAVE_WINDOW_SYSTEM */
27678 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27681 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27682 int start_hpos
, int end_hpos
,
27683 enum draw_glyphs_face draw
)
27685 #ifdef HAVE_WINDOW_SYSTEM
27686 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27688 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27692 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27693 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27697 /* Display the active region described by mouse_face_* according to DRAW. */
27700 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27702 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27703 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27705 if (/* If window is in the process of being destroyed, don't bother
27707 w
->current_matrix
!= NULL
27708 /* Don't update mouse highlight if hidden. */
27709 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27710 /* Recognize when we are called to operate on rows that don't exist
27711 anymore. This can happen when a window is split. */
27712 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27714 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27715 struct glyph_row
*row
, *first
, *last
;
27717 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27718 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27720 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27722 int start_hpos
, end_hpos
, start_x
;
27724 /* For all but the first row, the highlight starts at column 0. */
27727 /* R2L rows have BEG and END in reversed order, but the
27728 screen drawing geometry is always left to right. So
27729 we need to mirror the beginning and end of the
27730 highlighted area in R2L rows. */
27731 if (!row
->reversed_p
)
27733 start_hpos
= hlinfo
->mouse_face_beg_col
;
27734 start_x
= hlinfo
->mouse_face_beg_x
;
27736 else if (row
== last
)
27738 start_hpos
= hlinfo
->mouse_face_end_col
;
27739 start_x
= hlinfo
->mouse_face_end_x
;
27747 else if (row
->reversed_p
&& row
== last
)
27749 start_hpos
= hlinfo
->mouse_face_end_col
;
27750 start_x
= hlinfo
->mouse_face_end_x
;
27760 if (!row
->reversed_p
)
27761 end_hpos
= hlinfo
->mouse_face_end_col
;
27762 else if (row
== first
)
27763 end_hpos
= hlinfo
->mouse_face_beg_col
;
27766 end_hpos
= row
->used
[TEXT_AREA
];
27767 if (draw
== DRAW_NORMAL_TEXT
)
27768 row
->fill_line_p
= 1; /* Clear to end of line */
27771 else if (row
->reversed_p
&& row
== first
)
27772 end_hpos
= hlinfo
->mouse_face_beg_col
;
27775 end_hpos
= row
->used
[TEXT_AREA
];
27776 if (draw
== DRAW_NORMAL_TEXT
)
27777 row
->fill_line_p
= 1; /* Clear to end of line */
27780 if (end_hpos
> start_hpos
)
27782 draw_row_with_mouse_face (w
, start_x
, row
,
27783 start_hpos
, end_hpos
, draw
);
27786 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27790 #ifdef HAVE_WINDOW_SYSTEM
27791 /* When we've written over the cursor, arrange for it to
27792 be displayed again. */
27793 if (FRAME_WINDOW_P (f
)
27794 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27796 int hpos
= w
->phys_cursor
.hpos
;
27798 /* When the window is hscrolled, cursor hpos can legitimately be
27799 out of bounds, but we draw the cursor at the corresponding
27800 window margin in that case. */
27801 if (!row
->reversed_p
&& hpos
< 0)
27803 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27804 hpos
= row
->used
[TEXT_AREA
] - 1;
27807 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27808 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27811 #endif /* HAVE_WINDOW_SYSTEM */
27814 #ifdef HAVE_WINDOW_SYSTEM
27815 /* Change the mouse cursor. */
27816 if (FRAME_WINDOW_P (f
))
27818 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27819 if (draw
== DRAW_NORMAL_TEXT
27820 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27821 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27824 if (draw
== DRAW_MOUSE_FACE
)
27825 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27827 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27829 #endif /* HAVE_WINDOW_SYSTEM */
27833 Clear out the mouse-highlighted active region.
27834 Redraw it un-highlighted first. Value is non-zero if mouse
27835 face was actually drawn unhighlighted. */
27838 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27842 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27844 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27848 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27849 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27850 hlinfo
->mouse_face_window
= Qnil
;
27851 hlinfo
->mouse_face_overlay
= Qnil
;
27855 /* Return true if the coordinates HPOS and VPOS on windows W are
27856 within the mouse face on that window. */
27858 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27860 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27862 /* Quickly resolve the easy cases. */
27863 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27864 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27866 if (vpos
< hlinfo
->mouse_face_beg_row
27867 || vpos
> hlinfo
->mouse_face_end_row
)
27869 if (vpos
> hlinfo
->mouse_face_beg_row
27870 && vpos
< hlinfo
->mouse_face_end_row
)
27873 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27875 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27877 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27880 else if ((vpos
== hlinfo
->mouse_face_beg_row
27881 && hpos
>= hlinfo
->mouse_face_beg_col
)
27882 || (vpos
== hlinfo
->mouse_face_end_row
27883 && hpos
< hlinfo
->mouse_face_end_col
))
27888 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27890 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27893 else if ((vpos
== hlinfo
->mouse_face_beg_row
27894 && hpos
<= hlinfo
->mouse_face_beg_col
)
27895 || (vpos
== hlinfo
->mouse_face_end_row
27896 && hpos
> hlinfo
->mouse_face_end_col
))
27904 True if physical cursor of window W is within mouse face. */
27907 cursor_in_mouse_face_p (struct window
*w
)
27909 int hpos
= w
->phys_cursor
.hpos
;
27910 int vpos
= w
->phys_cursor
.vpos
;
27911 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27913 /* When the window is hscrolled, cursor hpos can legitimately be out
27914 of bounds, but we draw the cursor at the corresponding window
27915 margin in that case. */
27916 if (!row
->reversed_p
&& hpos
< 0)
27918 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27919 hpos
= row
->used
[TEXT_AREA
] - 1;
27921 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27926 /* Find the glyph rows START_ROW and END_ROW of window W that display
27927 characters between buffer positions START_CHARPOS and END_CHARPOS
27928 (excluding END_CHARPOS). DISP_STRING is a display string that
27929 covers these buffer positions. This is similar to
27930 row_containing_pos, but is more accurate when bidi reordering makes
27931 buffer positions change non-linearly with glyph rows. */
27933 rows_from_pos_range (struct window
*w
,
27934 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27935 Lisp_Object disp_string
,
27936 struct glyph_row
**start
, struct glyph_row
**end
)
27938 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27939 int last_y
= window_text_bottom_y (w
);
27940 struct glyph_row
*row
;
27945 while (!first
->enabled_p
27946 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27949 /* Find the START row. */
27951 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27954 /* A row can potentially be the START row if the range of the
27955 characters it displays intersects the range
27956 [START_CHARPOS..END_CHARPOS). */
27957 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27958 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27959 /* See the commentary in row_containing_pos, for the
27960 explanation of the complicated way to check whether
27961 some position is beyond the end of the characters
27962 displayed by a row. */
27963 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27964 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27965 && !row
->ends_at_zv_p
27966 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27967 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27968 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27969 && !row
->ends_at_zv_p
27970 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27972 /* Found a candidate row. Now make sure at least one of the
27973 glyphs it displays has a charpos from the range
27974 [START_CHARPOS..END_CHARPOS).
27976 This is not obvious because bidi reordering could make
27977 buffer positions of a row be 1,2,3,102,101,100, and if we
27978 want to highlight characters in [50..60), we don't want
27979 this row, even though [50..60) does intersect [1..103),
27980 the range of character positions given by the row's start
27981 and end positions. */
27982 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27983 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27987 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27988 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27989 /* A glyph that comes from DISP_STRING is by
27990 definition to be highlighted. */
27991 || EQ (g
->object
, disp_string
))
28000 /* Find the END row. */
28002 /* If the last row is partially visible, start looking for END
28003 from that row, instead of starting from FIRST. */
28004 && !(row
->enabled_p
28005 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28007 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28009 struct glyph_row
*next
= row
+ 1;
28010 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28012 if (!next
->enabled_p
28013 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28014 /* The first row >= START whose range of displayed characters
28015 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28016 is the row END + 1. */
28017 || (start_charpos
< next_start
28018 && end_charpos
< next_start
)
28019 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28020 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28021 && !next
->ends_at_zv_p
28022 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28023 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28024 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28025 && !next
->ends_at_zv_p
28026 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28033 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28034 but none of the characters it displays are in the range, it is
28036 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28037 struct glyph
*s
= g
;
28038 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28042 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28043 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28044 /* If the buffer position of the first glyph in
28045 the row is equal to END_CHARPOS, it means
28046 the last character to be highlighted is the
28047 newline of ROW, and we must consider NEXT as
28049 || (((!next
->reversed_p
&& g
== s
)
28050 || (next
->reversed_p
&& g
== e
- 1))
28051 && (g
->charpos
== end_charpos
28052 /* Special case for when NEXT is an
28053 empty line at ZV. */
28054 || (g
->charpos
== -1
28055 && !row
->ends_at_zv_p
28056 && next_start
== end_charpos
)))))
28057 /* A glyph that comes from DISP_STRING is by
28058 definition to be highlighted. */
28059 || EQ (g
->object
, disp_string
))
28068 /* The first row that ends at ZV must be the last to be
28070 else if (next
->ends_at_zv_p
)
28079 /* This function sets the mouse_face_* elements of HLINFO, assuming
28080 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28081 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28082 for the overlay or run of text properties specifying the mouse
28083 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28084 before-string and after-string that must also be highlighted.
28085 DISP_STRING, if non-nil, is a display string that may cover some
28086 or all of the highlighted text. */
28089 mouse_face_from_buffer_pos (Lisp_Object window
,
28090 Mouse_HLInfo
*hlinfo
,
28091 ptrdiff_t mouse_charpos
,
28092 ptrdiff_t start_charpos
,
28093 ptrdiff_t end_charpos
,
28094 Lisp_Object before_string
,
28095 Lisp_Object after_string
,
28096 Lisp_Object disp_string
)
28098 struct window
*w
= XWINDOW (window
);
28099 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28100 struct glyph_row
*r1
, *r2
;
28101 struct glyph
*glyph
, *end
;
28102 ptrdiff_t ignore
, pos
;
28105 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28106 eassert (NILP (before_string
) || STRINGP (before_string
));
28107 eassert (NILP (after_string
) || STRINGP (after_string
));
28109 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28110 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28112 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28113 /* If the before-string or display-string contains newlines,
28114 rows_from_pos_range skips to its last row. Move back. */
28115 if (!NILP (before_string
) || !NILP (disp_string
))
28117 struct glyph_row
*prev
;
28118 while ((prev
= r1
- 1, prev
>= first
)
28119 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28120 && prev
->used
[TEXT_AREA
] > 0)
28122 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28123 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28124 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28126 || !(EQ (glyph
->object
, before_string
)
28127 || EQ (glyph
->object
, disp_string
)))
28134 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28135 hlinfo
->mouse_face_past_end
= 1;
28137 else if (!NILP (after_string
))
28139 /* If the after-string has newlines, advance to its last row. */
28140 struct glyph_row
*next
;
28141 struct glyph_row
*last
28142 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28144 for (next
= r2
+ 1;
28146 && next
->used
[TEXT_AREA
] > 0
28147 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28151 /* The rest of the display engine assumes that mouse_face_beg_row is
28152 either above mouse_face_end_row or identical to it. But with
28153 bidi-reordered continued lines, the row for START_CHARPOS could
28154 be below the row for END_CHARPOS. If so, swap the rows and store
28155 them in correct order. */
28158 struct glyph_row
*tem
= r2
;
28164 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28165 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28167 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28168 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28169 could be anywhere in the row and in any order. The strategy
28170 below is to find the leftmost and the rightmost glyph that
28171 belongs to either of these 3 strings, or whose position is
28172 between START_CHARPOS and END_CHARPOS, and highlight all the
28173 glyphs between those two. This may cover more than just the text
28174 between START_CHARPOS and END_CHARPOS if the range of characters
28175 strides the bidi level boundary, e.g. if the beginning is in R2L
28176 text while the end is in L2R text or vice versa. */
28177 if (!r1
->reversed_p
)
28179 /* This row is in a left to right paragraph. Scan it left to
28181 glyph
= r1
->glyphs
[TEXT_AREA
];
28182 end
= glyph
+ r1
->used
[TEXT_AREA
];
28185 /* Skip truncation glyphs at the start of the glyph row. */
28186 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28188 && INTEGERP (glyph
->object
)
28189 && glyph
->charpos
< 0;
28191 x
+= glyph
->pixel_width
;
28193 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28194 or DISP_STRING, and the first glyph from buffer whose
28195 position is between START_CHARPOS and END_CHARPOS. */
28197 && !INTEGERP (glyph
->object
)
28198 && !EQ (glyph
->object
, disp_string
)
28199 && !(BUFFERP (glyph
->object
)
28200 && (glyph
->charpos
>= start_charpos
28201 && glyph
->charpos
< end_charpos
));
28204 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28205 are present at buffer positions between START_CHARPOS and
28206 END_CHARPOS, or if they come from an overlay. */
28207 if (EQ (glyph
->object
, before_string
))
28209 pos
= string_buffer_position (before_string
,
28211 /* If pos == 0, it means before_string came from an
28212 overlay, not from a buffer position. */
28213 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28216 else if (EQ (glyph
->object
, after_string
))
28218 pos
= string_buffer_position (after_string
, end_charpos
);
28219 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28222 x
+= glyph
->pixel_width
;
28224 hlinfo
->mouse_face_beg_x
= x
;
28225 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28229 /* This row is in a right to left paragraph. Scan it right to
28233 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28234 glyph
= end
+ r1
->used
[TEXT_AREA
];
28236 /* Skip truncation glyphs at the start of the glyph row. */
28237 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28239 && INTEGERP (glyph
->object
)
28240 && glyph
->charpos
< 0;
28244 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28245 or DISP_STRING, and the first glyph from buffer whose
28246 position is between START_CHARPOS and END_CHARPOS. */
28248 && !INTEGERP (glyph
->object
)
28249 && !EQ (glyph
->object
, disp_string
)
28250 && !(BUFFERP (glyph
->object
)
28251 && (glyph
->charpos
>= start_charpos
28252 && glyph
->charpos
< end_charpos
));
28255 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28256 are present at buffer positions between START_CHARPOS and
28257 END_CHARPOS, or if they come from an overlay. */
28258 if (EQ (glyph
->object
, before_string
))
28260 pos
= string_buffer_position (before_string
, start_charpos
);
28261 /* If pos == 0, it means before_string came from an
28262 overlay, not from a buffer position. */
28263 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28266 else if (EQ (glyph
->object
, after_string
))
28268 pos
= string_buffer_position (after_string
, end_charpos
);
28269 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28274 glyph
++; /* first glyph to the right of the highlighted area */
28275 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28276 x
+= g
->pixel_width
;
28277 hlinfo
->mouse_face_beg_x
= x
;
28278 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28281 /* If the highlight ends in a different row, compute GLYPH and END
28282 for the end row. Otherwise, reuse the values computed above for
28283 the row where the highlight begins. */
28286 if (!r2
->reversed_p
)
28288 glyph
= r2
->glyphs
[TEXT_AREA
];
28289 end
= glyph
+ r2
->used
[TEXT_AREA
];
28294 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28295 glyph
= end
+ r2
->used
[TEXT_AREA
];
28299 if (!r2
->reversed_p
)
28301 /* Skip truncation and continuation glyphs near the end of the
28302 row, and also blanks and stretch glyphs inserted by
28303 extend_face_to_end_of_line. */
28305 && INTEGERP ((end
- 1)->object
))
28307 /* Scan the rest of the glyph row from the end, looking for the
28308 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28309 DISP_STRING, or whose position is between START_CHARPOS
28313 && !INTEGERP (end
->object
)
28314 && !EQ (end
->object
, disp_string
)
28315 && !(BUFFERP (end
->object
)
28316 && (end
->charpos
>= start_charpos
28317 && end
->charpos
< end_charpos
));
28320 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28321 are present at buffer positions between START_CHARPOS and
28322 END_CHARPOS, or if they come from an overlay. */
28323 if (EQ (end
->object
, before_string
))
28325 pos
= string_buffer_position (before_string
, start_charpos
);
28326 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28329 else if (EQ (end
->object
, after_string
))
28331 pos
= string_buffer_position (after_string
, end_charpos
);
28332 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28336 /* Find the X coordinate of the last glyph to be highlighted. */
28337 for (; glyph
<= end
; ++glyph
)
28338 x
+= glyph
->pixel_width
;
28340 hlinfo
->mouse_face_end_x
= x
;
28341 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28345 /* Skip truncation and continuation glyphs near the end of the
28346 row, and also blanks and stretch glyphs inserted by
28347 extend_face_to_end_of_line. */
28351 && INTEGERP (end
->object
))
28353 x
+= end
->pixel_width
;
28356 /* Scan the rest of the glyph row from the end, looking for the
28357 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28358 DISP_STRING, or whose position is between START_CHARPOS
28362 && !INTEGERP (end
->object
)
28363 && !EQ (end
->object
, disp_string
)
28364 && !(BUFFERP (end
->object
)
28365 && (end
->charpos
>= start_charpos
28366 && end
->charpos
< end_charpos
));
28369 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28370 are present at buffer positions between START_CHARPOS and
28371 END_CHARPOS, or if they come from an overlay. */
28372 if (EQ (end
->object
, before_string
))
28374 pos
= string_buffer_position (before_string
, start_charpos
);
28375 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28378 else if (EQ (end
->object
, after_string
))
28380 pos
= string_buffer_position (after_string
, end_charpos
);
28381 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28384 x
+= end
->pixel_width
;
28386 /* If we exited the above loop because we arrived at the last
28387 glyph of the row, and its buffer position is still not in
28388 range, it means the last character in range is the preceding
28389 newline. Bump the end column and x values to get past the
28392 && BUFFERP (end
->object
)
28393 && (end
->charpos
< start_charpos
28394 || end
->charpos
>= end_charpos
))
28396 x
+= end
->pixel_width
;
28399 hlinfo
->mouse_face_end_x
= x
;
28400 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28403 hlinfo
->mouse_face_window
= window
;
28404 hlinfo
->mouse_face_face_id
28405 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28407 !hlinfo
->mouse_face_hidden
, -1);
28408 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28411 /* The following function is not used anymore (replaced with
28412 mouse_face_from_string_pos), but I leave it here for the time
28413 being, in case someone would. */
28415 #if 0 /* not used */
28417 /* Find the position of the glyph for position POS in OBJECT in
28418 window W's current matrix, and return in *X, *Y the pixel
28419 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28421 RIGHT_P non-zero means return the position of the right edge of the
28422 glyph, RIGHT_P zero means return the left edge position.
28424 If no glyph for POS exists in the matrix, return the position of
28425 the glyph with the next smaller position that is in the matrix, if
28426 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28427 exists in the matrix, return the position of the glyph with the
28428 next larger position in OBJECT.
28430 Value is non-zero if a glyph was found. */
28433 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28434 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28436 int yb
= window_text_bottom_y (w
);
28437 struct glyph_row
*r
;
28438 struct glyph
*best_glyph
= NULL
;
28439 struct glyph_row
*best_row
= NULL
;
28442 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28443 r
->enabled_p
&& r
->y
< yb
;
28446 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28447 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28450 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28451 if (EQ (g
->object
, object
))
28453 if (g
->charpos
== pos
)
28460 else if (best_glyph
== NULL
28461 || ((eabs (g
->charpos
- pos
)
28462 < eabs (best_glyph
->charpos
- pos
))
28465 : g
->charpos
> pos
)))
28479 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28483 *x
+= best_glyph
->pixel_width
;
28488 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28491 return best_glyph
!= NULL
;
28493 #endif /* not used */
28495 /* Find the positions of the first and the last glyphs in window W's
28496 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28497 (assumed to be a string), and return in HLINFO's mouse_face_*
28498 members the pixel and column/row coordinates of those glyphs. */
28501 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28502 Lisp_Object object
,
28503 ptrdiff_t startpos
, ptrdiff_t endpos
)
28505 int yb
= window_text_bottom_y (w
);
28506 struct glyph_row
*r
;
28507 struct glyph
*g
, *e
;
28511 /* Find the glyph row with at least one position in the range
28512 [STARTPOS..ENDPOS), and the first glyph in that row whose
28513 position belongs to that range. */
28514 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28515 r
->enabled_p
&& r
->y
< yb
;
28518 if (!r
->reversed_p
)
28520 g
= r
->glyphs
[TEXT_AREA
];
28521 e
= g
+ r
->used
[TEXT_AREA
];
28522 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28523 if (EQ (g
->object
, object
)
28524 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28526 hlinfo
->mouse_face_beg_row
28527 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28528 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28529 hlinfo
->mouse_face_beg_x
= gx
;
28538 e
= r
->glyphs
[TEXT_AREA
];
28539 g
= e
+ r
->used
[TEXT_AREA
];
28540 for ( ; g
> e
; --g
)
28541 if (EQ ((g
-1)->object
, object
)
28542 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28544 hlinfo
->mouse_face_beg_row
28545 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28546 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28547 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28548 gx
+= g1
->pixel_width
;
28549 hlinfo
->mouse_face_beg_x
= gx
;
28561 /* Starting with the next row, look for the first row which does NOT
28562 include any glyphs whose positions are in the range. */
28563 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28565 g
= r
->glyphs
[TEXT_AREA
];
28566 e
= g
+ r
->used
[TEXT_AREA
];
28568 for ( ; g
< e
; ++g
)
28569 if (EQ (g
->object
, object
)
28570 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28579 /* The highlighted region ends on the previous row. */
28582 /* Set the end row. */
28583 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28585 /* Compute and set the end column and the end column's horizontal
28586 pixel coordinate. */
28587 if (!r
->reversed_p
)
28589 g
= r
->glyphs
[TEXT_AREA
];
28590 e
= g
+ r
->used
[TEXT_AREA
];
28591 for ( ; e
> g
; --e
)
28592 if (EQ ((e
-1)->object
, object
)
28593 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28595 hlinfo
->mouse_face_end_col
= e
- g
;
28597 for (gx
= r
->x
; g
< e
; ++g
)
28598 gx
+= g
->pixel_width
;
28599 hlinfo
->mouse_face_end_x
= gx
;
28603 e
= r
->glyphs
[TEXT_AREA
];
28604 g
= e
+ r
->used
[TEXT_AREA
];
28605 for (gx
= r
->x
; e
< g
; ++e
)
28607 if (EQ (e
->object
, object
)
28608 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28610 gx
+= e
->pixel_width
;
28612 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28613 hlinfo
->mouse_face_end_x
= gx
;
28617 #ifdef HAVE_WINDOW_SYSTEM
28619 /* See if position X, Y is within a hot-spot of an image. */
28622 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28624 if (!CONSP (hot_spot
))
28627 if (EQ (XCAR (hot_spot
), Qrect
))
28629 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28630 Lisp_Object rect
= XCDR (hot_spot
);
28634 if (!CONSP (XCAR (rect
)))
28636 if (!CONSP (XCDR (rect
)))
28638 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28640 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28642 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28644 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28648 else if (EQ (XCAR (hot_spot
), Qcircle
))
28650 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28651 Lisp_Object circ
= XCDR (hot_spot
);
28652 Lisp_Object lr
, lx0
, ly0
;
28654 && CONSP (XCAR (circ
))
28655 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28656 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28657 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28659 double r
= XFLOATINT (lr
);
28660 double dx
= XINT (lx0
) - x
;
28661 double dy
= XINT (ly0
) - y
;
28662 return (dx
* dx
+ dy
* dy
<= r
* r
);
28665 else if (EQ (XCAR (hot_spot
), Qpoly
))
28667 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28668 if (VECTORP (XCDR (hot_spot
)))
28670 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28671 Lisp_Object
*poly
= v
->contents
;
28672 ptrdiff_t n
= v
->header
.size
;
28675 Lisp_Object lx
, ly
;
28678 /* Need an even number of coordinates, and at least 3 edges. */
28679 if (n
< 6 || n
& 1)
28682 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28683 If count is odd, we are inside polygon. Pixels on edges
28684 may or may not be included depending on actual geometry of the
28686 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28687 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28689 x0
= XINT (lx
), y0
= XINT (ly
);
28690 for (i
= 0; i
< n
; i
+= 2)
28692 int x1
= x0
, y1
= y0
;
28693 if ((lx
= poly
[i
], !INTEGERP (lx
))
28694 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28696 x0
= XINT (lx
), y0
= XINT (ly
);
28698 /* Does this segment cross the X line? */
28706 if (y
> y0
&& y
> y1
)
28708 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28718 find_hot_spot (Lisp_Object map
, int x
, int y
)
28720 while (CONSP (map
))
28722 if (CONSP (XCAR (map
))
28723 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28731 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28733 doc
: /* Lookup in image map MAP coordinates X and Y.
28734 An image map is an alist where each element has the format (AREA ID PLIST).
28735 An AREA is specified as either a rectangle, a circle, or a polygon:
28736 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28737 pixel coordinates of the upper left and bottom right corners.
28738 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28739 and the radius of the circle; r may be a float or integer.
28740 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28741 vector describes one corner in the polygon.
28742 Returns the alist element for the first matching AREA in MAP. */)
28743 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28751 return find_hot_spot (map
,
28752 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28753 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28757 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28759 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28761 /* Do not change cursor shape while dragging mouse. */
28762 if (!NILP (do_mouse_tracking
))
28765 if (!NILP (pointer
))
28767 if (EQ (pointer
, Qarrow
))
28768 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28769 else if (EQ (pointer
, Qhand
))
28770 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28771 else if (EQ (pointer
, Qtext
))
28772 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28773 else if (EQ (pointer
, intern ("hdrag")))
28774 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28775 else if (EQ (pointer
, intern ("nhdrag")))
28776 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28777 #ifdef HAVE_X_WINDOWS
28778 else if (EQ (pointer
, intern ("vdrag")))
28779 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28781 else if (EQ (pointer
, intern ("hourglass")))
28782 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28783 else if (EQ (pointer
, Qmodeline
))
28784 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28786 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28789 if (cursor
!= No_Cursor
)
28790 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28793 #endif /* HAVE_WINDOW_SYSTEM */
28795 /* Take proper action when mouse has moved to the mode or header line
28796 or marginal area AREA of window W, x-position X and y-position Y.
28797 X is relative to the start of the text display area of W, so the
28798 width of bitmap areas and scroll bars must be subtracted to get a
28799 position relative to the start of the mode line. */
28802 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28803 enum window_part area
)
28805 struct window
*w
= XWINDOW (window
);
28806 struct frame
*f
= XFRAME (w
->frame
);
28807 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28808 #ifdef HAVE_WINDOW_SYSTEM
28809 Display_Info
*dpyinfo
;
28811 Cursor cursor
= No_Cursor
;
28812 Lisp_Object pointer
= Qnil
;
28813 int dx
, dy
, width
, height
;
28815 Lisp_Object string
, object
= Qnil
;
28816 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28818 Lisp_Object mouse_face
;
28819 int original_x_pixel
= x
;
28820 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28821 struct glyph_row
*row
IF_LINT (= 0);
28823 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28828 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28829 returns them in row/column units! */
28830 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28831 &object
, &dx
, &dy
, &width
, &height
);
28833 row
= (area
== ON_MODE_LINE
28834 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28835 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28837 /* Find the glyph under the mouse pointer. */
28838 if (row
->mode_line_p
&& row
->enabled_p
)
28840 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28841 end
= glyph
+ row
->used
[TEXT_AREA
];
28843 for (x0
= original_x_pixel
;
28844 glyph
< end
&& x0
>= glyph
->pixel_width
;
28846 x0
-= glyph
->pixel_width
;
28854 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28855 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28856 returns them in row/column units! */
28857 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28858 &object
, &dx
, &dy
, &width
, &height
);
28863 #ifdef HAVE_WINDOW_SYSTEM
28864 if (IMAGEP (object
))
28866 Lisp_Object image_map
, hotspot
;
28867 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28869 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28871 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28875 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28876 If so, we could look for mouse-enter, mouse-leave
28877 properties in PLIST (and do something...). */
28878 hotspot
= XCDR (hotspot
);
28879 if (CONSP (hotspot
)
28880 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28882 pointer
= Fplist_get (plist
, Qpointer
);
28883 if (NILP (pointer
))
28885 help
= Fplist_get (plist
, Qhelp_echo
);
28888 help_echo_string
= help
;
28889 XSETWINDOW (help_echo_window
, w
);
28890 help_echo_object
= w
->contents
;
28891 help_echo_pos
= charpos
;
28895 if (NILP (pointer
))
28896 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28898 #endif /* HAVE_WINDOW_SYSTEM */
28900 if (STRINGP (string
))
28901 pos
= make_number (charpos
);
28903 /* Set the help text and mouse pointer. If the mouse is on a part
28904 of the mode line without any text (e.g. past the right edge of
28905 the mode line text), use the default help text and pointer. */
28906 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28908 /* Arrange to display the help by setting the global variables
28909 help_echo_string, help_echo_object, and help_echo_pos. */
28912 if (STRINGP (string
))
28913 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28917 help_echo_string
= help
;
28918 XSETWINDOW (help_echo_window
, w
);
28919 help_echo_object
= string
;
28920 help_echo_pos
= charpos
;
28922 else if (area
== ON_MODE_LINE
)
28924 Lisp_Object default_help
28925 = buffer_local_value (Qmode_line_default_help_echo
,
28928 if (STRINGP (default_help
))
28930 help_echo_string
= default_help
;
28931 XSETWINDOW (help_echo_window
, w
);
28932 help_echo_object
= Qnil
;
28933 help_echo_pos
= -1;
28938 #ifdef HAVE_WINDOW_SYSTEM
28939 /* Change the mouse pointer according to what is under it. */
28940 if (FRAME_WINDOW_P (f
))
28942 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28944 || NILP (Vresize_mini_windows
));
28946 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28947 if (STRINGP (string
))
28949 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28951 if (NILP (pointer
))
28952 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28954 /* Change the mouse pointer according to what is under X/Y. */
28956 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28959 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28960 if (!KEYMAPP (map
))
28961 map
= Fget_text_property (pos
, Qkeymap
, string
);
28962 if (!KEYMAPP (map
) && draggable
)
28963 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28966 else if (draggable
)
28967 /* Default mode-line pointer. */
28968 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28973 /* Change the mouse face according to what is under X/Y. */
28974 if (STRINGP (string
))
28976 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28977 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28978 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28983 struct glyph
* tmp_glyph
;
28987 int total_pixel_width
;
28988 ptrdiff_t begpos
, endpos
, ignore
;
28992 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28993 Qmouse_face
, string
, Qnil
);
28999 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29001 endpos
= SCHARS (string
);
29005 /* Calculate the glyph position GPOS of GLYPH in the
29006 displayed string, relative to the beginning of the
29007 highlighted part of the string.
29009 Note: GPOS is different from CHARPOS. CHARPOS is the
29010 position of GLYPH in the internal string object. A mode
29011 line string format has structures which are converted to
29012 a flattened string by the Emacs Lisp interpreter. The
29013 internal string is an element of those structures. The
29014 displayed string is the flattened string. */
29015 tmp_glyph
= row_start_glyph
;
29016 while (tmp_glyph
< glyph
29017 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29018 && begpos
<= tmp_glyph
->charpos
29019 && tmp_glyph
->charpos
< endpos
)))
29021 gpos
= glyph
- tmp_glyph
;
29023 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29024 the highlighted part of the displayed string to which
29025 GLYPH belongs. Note: GSEQ_LENGTH is different from
29026 SCHARS (STRING), because the latter returns the length of
29027 the internal string. */
29028 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29030 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29031 && begpos
<= tmp_glyph
->charpos
29032 && tmp_glyph
->charpos
< endpos
));
29035 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29037 /* Calculate the total pixel width of all the glyphs between
29038 the beginning of the highlighted area and GLYPH. */
29039 total_pixel_width
= 0;
29040 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29041 total_pixel_width
+= tmp_glyph
->pixel_width
;
29043 /* Pre calculation of re-rendering position. Note: X is in
29044 column units here, after the call to mode_line_string or
29045 marginal_area_string. */
29047 vpos
= (area
== ON_MODE_LINE
29048 ? (w
->current_matrix
)->nrows
- 1
29051 /* If GLYPH's position is included in the region that is
29052 already drawn in mouse face, we have nothing to do. */
29053 if ( EQ (window
, hlinfo
->mouse_face_window
)
29054 && (!row
->reversed_p
29055 ? (hlinfo
->mouse_face_beg_col
<= hpos
29056 && hpos
< hlinfo
->mouse_face_end_col
)
29057 /* In R2L rows we swap BEG and END, see below. */
29058 : (hlinfo
->mouse_face_end_col
<= hpos
29059 && hpos
< hlinfo
->mouse_face_beg_col
))
29060 && hlinfo
->mouse_face_beg_row
== vpos
)
29063 if (clear_mouse_face (hlinfo
))
29064 cursor
= No_Cursor
;
29066 if (!row
->reversed_p
)
29068 hlinfo
->mouse_face_beg_col
= hpos
;
29069 hlinfo
->mouse_face_beg_x
= original_x_pixel
29070 - (total_pixel_width
+ dx
);
29071 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29072 hlinfo
->mouse_face_end_x
= 0;
29076 /* In R2L rows, show_mouse_face expects BEG and END
29077 coordinates to be swapped. */
29078 hlinfo
->mouse_face_end_col
= hpos
;
29079 hlinfo
->mouse_face_end_x
= original_x_pixel
29080 - (total_pixel_width
+ dx
);
29081 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29082 hlinfo
->mouse_face_beg_x
= 0;
29085 hlinfo
->mouse_face_beg_row
= vpos
;
29086 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29087 hlinfo
->mouse_face_past_end
= 0;
29088 hlinfo
->mouse_face_window
= window
;
29090 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29095 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29097 if (NILP (pointer
))
29100 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29101 clear_mouse_face (hlinfo
);
29103 #ifdef HAVE_WINDOW_SYSTEM
29104 if (FRAME_WINDOW_P (f
))
29105 define_frame_cursor1 (f
, cursor
, pointer
);
29111 Take proper action when the mouse has moved to position X, Y on
29112 frame F with regards to highlighting portions of display that have
29113 mouse-face properties. Also de-highlight portions of display where
29114 the mouse was before, set the mouse pointer shape as appropriate
29115 for the mouse coordinates, and activate help echo (tooltips).
29116 X and Y can be negative or out of range. */
29119 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29121 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29122 enum window_part part
= ON_NOTHING
;
29123 Lisp_Object window
;
29125 Cursor cursor
= No_Cursor
;
29126 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29129 /* When a menu is active, don't highlight because this looks odd. */
29130 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29131 if (popup_activated ())
29135 if (!f
->glyphs_initialized_p
29136 || f
->pointer_invisible
)
29139 hlinfo
->mouse_face_mouse_x
= x
;
29140 hlinfo
->mouse_face_mouse_y
= y
;
29141 hlinfo
->mouse_face_mouse_frame
= f
;
29143 if (hlinfo
->mouse_face_defer
)
29146 /* Which window is that in? */
29147 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29149 /* If displaying active text in another window, clear that. */
29150 if (! EQ (window
, hlinfo
->mouse_face_window
)
29151 /* Also clear if we move out of text area in same window. */
29152 || (!NILP (hlinfo
->mouse_face_window
)
29155 && part
!= ON_MODE_LINE
29156 && part
!= ON_HEADER_LINE
))
29157 clear_mouse_face (hlinfo
);
29159 /* Not on a window -> return. */
29160 if (!WINDOWP (window
))
29163 /* Reset help_echo_string. It will get recomputed below. */
29164 help_echo_string
= Qnil
;
29166 /* Convert to window-relative pixel coordinates. */
29167 w
= XWINDOW (window
);
29168 frame_to_window_pixel_xy (w
, &x
, &y
);
29170 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29171 /* Handle tool-bar window differently since it doesn't display a
29173 if (EQ (window
, f
->tool_bar_window
))
29175 note_tool_bar_highlight (f
, x
, y
);
29180 /* Mouse is on the mode, header line or margin? */
29181 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29182 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29184 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29186 #ifdef HAVE_WINDOW_SYSTEM
29187 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29189 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29190 /* Show non-text cursor (Bug#16647). */
29198 #ifdef HAVE_WINDOW_SYSTEM
29199 if (part
== ON_VERTICAL_BORDER
)
29201 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29202 help_echo_string
= build_string ("drag-mouse-1: resize");
29204 else if (part
== ON_RIGHT_DIVIDER
)
29206 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29207 help_echo_string
= build_string ("drag-mouse-1: resize");
29209 else if (part
== ON_BOTTOM_DIVIDER
)
29210 if (! WINDOW_BOTTOMMOST_P (w
)
29212 || NILP (Vresize_mini_windows
))
29214 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29215 help_echo_string
= build_string ("drag-mouse-1: resize");
29218 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29219 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29220 || part
== ON_VERTICAL_SCROLL_BAR
29221 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29222 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29224 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29227 /* Are we in a window whose display is up to date?
29228 And verify the buffer's text has not changed. */
29229 b
= XBUFFER (w
->contents
);
29230 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29232 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29234 struct glyph
*glyph
;
29235 Lisp_Object object
;
29236 Lisp_Object mouse_face
= Qnil
, position
;
29237 Lisp_Object
*overlay_vec
= NULL
;
29238 ptrdiff_t i
, noverlays
;
29239 struct buffer
*obuf
;
29240 ptrdiff_t obegv
, ozv
;
29243 /* Find the glyph under X/Y. */
29244 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29246 #ifdef HAVE_WINDOW_SYSTEM
29247 /* Look for :pointer property on image. */
29248 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29250 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29251 if (img
!= NULL
&& IMAGEP (img
->spec
))
29253 Lisp_Object image_map
, hotspot
;
29254 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29256 && (hotspot
= find_hot_spot (image_map
,
29257 glyph
->slice
.img
.x
+ dx
,
29258 glyph
->slice
.img
.y
+ dy
),
29260 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29264 /* Could check XCAR (hotspot) to see if we enter/leave
29266 If so, we could look for mouse-enter, mouse-leave
29267 properties in PLIST (and do something...). */
29268 hotspot
= XCDR (hotspot
);
29269 if (CONSP (hotspot
)
29270 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29272 pointer
= Fplist_get (plist
, Qpointer
);
29273 if (NILP (pointer
))
29275 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29276 if (!NILP (help_echo_string
))
29278 help_echo_window
= window
;
29279 help_echo_object
= glyph
->object
;
29280 help_echo_pos
= glyph
->charpos
;
29284 if (NILP (pointer
))
29285 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29288 #endif /* HAVE_WINDOW_SYSTEM */
29290 /* Clear mouse face if X/Y not over text. */
29292 || area
!= TEXT_AREA
29293 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29294 /* Glyph's OBJECT is an integer for glyphs inserted by the
29295 display engine for its internal purposes, like truncation
29296 and continuation glyphs and blanks beyond the end of
29297 line's text on text terminals. If we are over such a
29298 glyph, we are not over any text. */
29299 || INTEGERP (glyph
->object
)
29300 /* R2L rows have a stretch glyph at their front, which
29301 stands for no text, whereas L2R rows have no glyphs at
29302 all beyond the end of text. Treat such stretch glyphs
29303 like we do with NULL glyphs in L2R rows. */
29304 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29305 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29306 && glyph
->type
== STRETCH_GLYPH
29307 && glyph
->avoid_cursor_p
))
29309 if (clear_mouse_face (hlinfo
))
29310 cursor
= No_Cursor
;
29311 #ifdef HAVE_WINDOW_SYSTEM
29312 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29314 if (area
!= TEXT_AREA
)
29315 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29317 pointer
= Vvoid_text_area_pointer
;
29323 pos
= glyph
->charpos
;
29324 object
= glyph
->object
;
29325 if (!STRINGP (object
) && !BUFFERP (object
))
29328 /* If we get an out-of-range value, return now; avoid an error. */
29329 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29332 /* Make the window's buffer temporarily current for
29333 overlays_at and compute_char_face. */
29334 obuf
= current_buffer
;
29335 current_buffer
= b
;
29341 /* Is this char mouse-active or does it have help-echo? */
29342 position
= make_number (pos
);
29346 if (BUFFERP (object
))
29348 /* Put all the overlays we want in a vector in overlay_vec. */
29349 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29350 /* Sort overlays into increasing priority order. */
29351 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29356 if (NILP (Vmouse_highlight
))
29358 clear_mouse_face (hlinfo
);
29359 goto check_help_echo
;
29362 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29365 cursor
= No_Cursor
;
29367 /* Check mouse-face highlighting. */
29369 /* If there exists an overlay with mouse-face overlapping
29370 the one we are currently highlighting, we have to
29371 check if we enter the overlapping overlay, and then
29372 highlight only that. */
29373 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29374 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29376 /* Find the highest priority overlay with a mouse-face. */
29377 Lisp_Object overlay
= Qnil
;
29378 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29380 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29381 if (!NILP (mouse_face
))
29382 overlay
= overlay_vec
[i
];
29385 /* If we're highlighting the same overlay as before, there's
29386 no need to do that again. */
29387 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29388 goto check_help_echo
;
29389 hlinfo
->mouse_face_overlay
= overlay
;
29391 /* Clear the display of the old active region, if any. */
29392 if (clear_mouse_face (hlinfo
))
29393 cursor
= No_Cursor
;
29395 /* If no overlay applies, get a text property. */
29396 if (NILP (overlay
))
29397 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29399 /* Next, compute the bounds of the mouse highlighting and
29401 if (!NILP (mouse_face
) && STRINGP (object
))
29403 /* The mouse-highlighting comes from a display string
29404 with a mouse-face. */
29408 s
= Fprevious_single_property_change
29409 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29410 e
= Fnext_single_property_change
29411 (position
, Qmouse_face
, object
, Qnil
);
29413 s
= make_number (0);
29415 e
= make_number (SCHARS (object
));
29416 mouse_face_from_string_pos (w
, hlinfo
, object
,
29417 XINT (s
), XINT (e
));
29418 hlinfo
->mouse_face_past_end
= 0;
29419 hlinfo
->mouse_face_window
= window
;
29420 hlinfo
->mouse_face_face_id
29421 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29422 glyph
->face_id
, 1);
29423 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29424 cursor
= No_Cursor
;
29428 /* The mouse-highlighting, if any, comes from an overlay
29429 or text property in the buffer. */
29430 Lisp_Object buffer
IF_LINT (= Qnil
);
29431 Lisp_Object disp_string
IF_LINT (= Qnil
);
29433 if (STRINGP (object
))
29435 /* If we are on a display string with no mouse-face,
29436 check if the text under it has one. */
29437 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29438 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29439 pos
= string_buffer_position (object
, start
);
29442 mouse_face
= get_char_property_and_overlay
29443 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29444 buffer
= w
->contents
;
29445 disp_string
= object
;
29451 disp_string
= Qnil
;
29454 if (!NILP (mouse_face
))
29456 Lisp_Object before
, after
;
29457 Lisp_Object before_string
, after_string
;
29458 /* To correctly find the limits of mouse highlight
29459 in a bidi-reordered buffer, we must not use the
29460 optimization of limiting the search in
29461 previous-single-property-change and
29462 next-single-property-change, because
29463 rows_from_pos_range needs the real start and end
29464 positions to DTRT in this case. That's because
29465 the first row visible in a window does not
29466 necessarily display the character whose position
29467 is the smallest. */
29469 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29470 ? Fmarker_position (w
->start
)
29473 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29474 ? make_number (BUF_Z (XBUFFER (buffer
))
29475 - w
->window_end_pos
)
29478 if (NILP (overlay
))
29480 /* Handle the text property case. */
29481 before
= Fprevious_single_property_change
29482 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29483 after
= Fnext_single_property_change
29484 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29485 before_string
= after_string
= Qnil
;
29489 /* Handle the overlay case. */
29490 before
= Foverlay_start (overlay
);
29491 after
= Foverlay_end (overlay
);
29492 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29493 after_string
= Foverlay_get (overlay
, Qafter_string
);
29495 if (!STRINGP (before_string
)) before_string
= Qnil
;
29496 if (!STRINGP (after_string
)) after_string
= Qnil
;
29499 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29502 : XFASTINT (before
),
29504 ? BUF_Z (XBUFFER (buffer
))
29505 : XFASTINT (after
),
29506 before_string
, after_string
,
29508 cursor
= No_Cursor
;
29515 /* Look for a `help-echo' property. */
29516 if (NILP (help_echo_string
)) {
29517 Lisp_Object help
, overlay
;
29519 /* Check overlays first. */
29520 help
= overlay
= Qnil
;
29521 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29523 overlay
= overlay_vec
[i
];
29524 help
= Foverlay_get (overlay
, Qhelp_echo
);
29529 help_echo_string
= help
;
29530 help_echo_window
= window
;
29531 help_echo_object
= overlay
;
29532 help_echo_pos
= pos
;
29536 Lisp_Object obj
= glyph
->object
;
29537 ptrdiff_t charpos
= glyph
->charpos
;
29539 /* Try text properties. */
29542 && charpos
< SCHARS (obj
))
29544 help
= Fget_text_property (make_number (charpos
),
29548 /* If the string itself doesn't specify a help-echo,
29549 see if the buffer text ``under'' it does. */
29550 struct glyph_row
*r
29551 = MATRIX_ROW (w
->current_matrix
, vpos
);
29552 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29553 ptrdiff_t p
= string_buffer_position (obj
, start
);
29556 help
= Fget_char_property (make_number (p
),
29557 Qhelp_echo
, w
->contents
);
29566 else if (BUFFERP (obj
)
29569 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29574 help_echo_string
= help
;
29575 help_echo_window
= window
;
29576 help_echo_object
= obj
;
29577 help_echo_pos
= charpos
;
29582 #ifdef HAVE_WINDOW_SYSTEM
29583 /* Look for a `pointer' property. */
29584 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29586 /* Check overlays first. */
29587 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29588 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29590 if (NILP (pointer
))
29592 Lisp_Object obj
= glyph
->object
;
29593 ptrdiff_t charpos
= glyph
->charpos
;
29595 /* Try text properties. */
29598 && charpos
< SCHARS (obj
))
29600 pointer
= Fget_text_property (make_number (charpos
),
29602 if (NILP (pointer
))
29604 /* If the string itself doesn't specify a pointer,
29605 see if the buffer text ``under'' it does. */
29606 struct glyph_row
*r
29607 = MATRIX_ROW (w
->current_matrix
, vpos
);
29608 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29609 ptrdiff_t p
= string_buffer_position (obj
, start
);
29611 pointer
= Fget_char_property (make_number (p
),
29612 Qpointer
, w
->contents
);
29615 else if (BUFFERP (obj
)
29618 pointer
= Fget_text_property (make_number (charpos
),
29622 #endif /* HAVE_WINDOW_SYSTEM */
29626 current_buffer
= obuf
;
29632 #ifdef HAVE_WINDOW_SYSTEM
29633 if (FRAME_WINDOW_P (f
))
29634 define_frame_cursor1 (f
, cursor
, pointer
);
29636 /* This is here to prevent a compiler error, about "label at end of
29637 compound statement". */
29644 Clear any mouse-face on window W. This function is part of the
29645 redisplay interface, and is called from try_window_id and similar
29646 functions to ensure the mouse-highlight is off. */
29649 x_clear_window_mouse_face (struct window
*w
)
29651 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29652 Lisp_Object window
;
29655 XSETWINDOW (window
, w
);
29656 if (EQ (window
, hlinfo
->mouse_face_window
))
29657 clear_mouse_face (hlinfo
);
29663 Just discard the mouse face information for frame F, if any.
29664 This is used when the size of F is changed. */
29667 cancel_mouse_face (struct frame
*f
)
29669 Lisp_Object window
;
29670 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29672 window
= hlinfo
->mouse_face_window
;
29673 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29674 reset_mouse_highlight (hlinfo
);
29679 /***********************************************************************
29681 ***********************************************************************/
29683 #ifdef HAVE_WINDOW_SYSTEM
29685 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29686 which intersects rectangle R. R is in window-relative coordinates. */
29689 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29690 enum glyph_row_area area
)
29692 struct glyph
*first
= row
->glyphs
[area
];
29693 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29694 struct glyph
*last
;
29695 int first_x
, start_x
, x
;
29697 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29698 /* If row extends face to end of line write the whole line. */
29699 draw_glyphs (w
, 0, row
, area
,
29700 0, row
->used
[area
],
29701 DRAW_NORMAL_TEXT
, 0);
29704 /* Set START_X to the window-relative start position for drawing glyphs of
29705 AREA. The first glyph of the text area can be partially visible.
29706 The first glyphs of other areas cannot. */
29707 start_x
= window_box_left_offset (w
, area
);
29709 if (area
== TEXT_AREA
)
29712 /* Find the first glyph that must be redrawn. */
29714 && x
+ first
->pixel_width
< r
->x
)
29716 x
+= first
->pixel_width
;
29720 /* Find the last one. */
29724 && x
< r
->x
+ r
->width
)
29726 x
+= last
->pixel_width
;
29732 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29733 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29734 DRAW_NORMAL_TEXT
, 0);
29739 /* Redraw the parts of the glyph row ROW on window W intersecting
29740 rectangle R. R is in window-relative coordinates. Value is
29741 non-zero if mouse-face was overwritten. */
29744 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29746 eassert (row
->enabled_p
);
29748 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29749 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29750 0, row
->used
[TEXT_AREA
],
29751 DRAW_NORMAL_TEXT
, 0);
29754 if (row
->used
[LEFT_MARGIN_AREA
])
29755 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29756 if (row
->used
[TEXT_AREA
])
29757 expose_area (w
, row
, r
, TEXT_AREA
);
29758 if (row
->used
[RIGHT_MARGIN_AREA
])
29759 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29760 draw_row_fringe_bitmaps (w
, row
);
29763 return row
->mouse_face_p
;
29767 /* Redraw those parts of glyphs rows during expose event handling that
29768 overlap other rows. Redrawing of an exposed line writes over parts
29769 of lines overlapping that exposed line; this function fixes that.
29771 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29772 row in W's current matrix that is exposed and overlaps other rows.
29773 LAST_OVERLAPPING_ROW is the last such row. */
29776 expose_overlaps (struct window
*w
,
29777 struct glyph_row
*first_overlapping_row
,
29778 struct glyph_row
*last_overlapping_row
,
29781 struct glyph_row
*row
;
29783 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29784 if (row
->overlapping_p
)
29786 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29789 if (row
->used
[LEFT_MARGIN_AREA
])
29790 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29792 if (row
->used
[TEXT_AREA
])
29793 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29795 if (row
->used
[RIGHT_MARGIN_AREA
])
29796 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29802 /* Return non-zero if W's cursor intersects rectangle R. */
29805 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29807 XRectangle cr
, result
;
29808 struct glyph
*cursor_glyph
;
29809 struct glyph_row
*row
;
29811 if (w
->phys_cursor
.vpos
>= 0
29812 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29813 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29815 && row
->cursor_in_fringe_p
)
29817 /* Cursor is in the fringe. */
29818 cr
.x
= window_box_right_offset (w
,
29819 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29820 ? RIGHT_MARGIN_AREA
29823 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29824 cr
.height
= row
->height
;
29825 return x_intersect_rectangles (&cr
, r
, &result
);
29828 cursor_glyph
= get_phys_cursor_glyph (w
);
29831 /* r is relative to W's box, but w->phys_cursor.x is relative
29832 to left edge of W's TEXT area. Adjust it. */
29833 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29834 cr
.y
= w
->phys_cursor
.y
;
29835 cr
.width
= cursor_glyph
->pixel_width
;
29836 cr
.height
= w
->phys_cursor_height
;
29837 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29838 I assume the effect is the same -- and this is portable. */
29839 return x_intersect_rectangles (&cr
, r
, &result
);
29841 /* If we don't understand the format, pretend we're not in the hot-spot. */
29847 Draw a vertical window border to the right of window W if W doesn't
29848 have vertical scroll bars. */
29851 x_draw_vertical_border (struct window
*w
)
29853 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29855 /* We could do better, if we knew what type of scroll-bar the adjacent
29856 windows (on either side) have... But we don't :-(
29857 However, I think this works ok. ++KFS 2003-04-25 */
29859 /* Redraw borders between horizontally adjacent windows. Don't
29860 do it for frames with vertical scroll bars because either the
29861 right scroll bar of a window, or the left scroll bar of its
29862 neighbor will suffice as a border. */
29863 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29866 /* Note: It is necessary to redraw both the left and the right
29867 borders, for when only this single window W is being
29869 if (!WINDOW_RIGHTMOST_P (w
)
29870 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29872 int x0
, x1
, y0
, y1
;
29874 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29877 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29880 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29883 if (!WINDOW_LEFTMOST_P (w
)
29884 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29886 int x0
, x1
, y0
, y1
;
29888 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29891 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29894 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29899 /* Draw window dividers for window W. */
29902 x_draw_right_divider (struct window
*w
)
29904 struct frame
*f
= WINDOW_XFRAME (w
);
29906 if (w
->mini
|| w
->pseudo_window_p
)
29908 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29910 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29911 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29912 int y0
= WINDOW_TOP_EDGE_Y (w
);
29913 /* The bottom divider prevails. */
29914 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29916 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29921 x_draw_bottom_divider (struct window
*w
)
29923 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29925 if (w
->mini
|| w
->pseudo_window_p
)
29927 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29929 int x0
= WINDOW_LEFT_EDGE_X (w
);
29930 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29931 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29932 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29934 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29938 /* Redraw the part of window W intersection rectangle FR. Pixel
29939 coordinates in FR are frame-relative. Call this function with
29940 input blocked. Value is non-zero if the exposure overwrites
29944 expose_window (struct window
*w
, XRectangle
*fr
)
29946 struct frame
*f
= XFRAME (w
->frame
);
29948 int mouse_face_overwritten_p
= 0;
29950 /* If window is not yet fully initialized, do nothing. This can
29951 happen when toolkit scroll bars are used and a window is split.
29952 Reconfiguring the scroll bar will generate an expose for a newly
29954 if (w
->current_matrix
== NULL
)
29957 /* When we're currently updating the window, display and current
29958 matrix usually don't agree. Arrange for a thorough display
29960 if (w
->must_be_updated_p
)
29962 SET_FRAME_GARBAGED (f
);
29966 /* Frame-relative pixel rectangle of W. */
29967 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29968 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29969 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29970 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29972 if (x_intersect_rectangles (fr
, &wr
, &r
))
29974 int yb
= window_text_bottom_y (w
);
29975 struct glyph_row
*row
;
29976 int cursor_cleared_p
, phys_cursor_on_p
;
29977 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29979 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29980 r
.x
, r
.y
, r
.width
, r
.height
));
29982 /* Convert to window coordinates. */
29983 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29984 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29986 /* Turn off the cursor. */
29987 if (!w
->pseudo_window_p
29988 && phys_cursor_in_rect_p (w
, &r
))
29990 x_clear_cursor (w
);
29991 cursor_cleared_p
= 1;
29994 cursor_cleared_p
= 0;
29996 /* If the row containing the cursor extends face to end of line,
29997 then expose_area might overwrite the cursor outside the
29998 rectangle and thus notice_overwritten_cursor might clear
29999 w->phys_cursor_on_p. We remember the original value and
30000 check later if it is changed. */
30001 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30003 /* Update lines intersecting rectangle R. */
30004 first_overlapping_row
= last_overlapping_row
= NULL
;
30005 for (row
= w
->current_matrix
->rows
;
30010 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30012 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30013 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30014 || (r
.y
>= y0
&& r
.y
< y1
)
30015 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30017 /* A header line may be overlapping, but there is no need
30018 to fix overlapping areas for them. KFS 2005-02-12 */
30019 if (row
->overlapping_p
&& !row
->mode_line_p
)
30021 if (first_overlapping_row
== NULL
)
30022 first_overlapping_row
= row
;
30023 last_overlapping_row
= row
;
30027 if (expose_line (w
, row
, &r
))
30028 mouse_face_overwritten_p
= 1;
30031 else if (row
->overlapping_p
)
30033 /* We must redraw a row overlapping the exposed area. */
30035 ? y0
+ row
->phys_height
> r
.y
30036 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30038 if (first_overlapping_row
== NULL
)
30039 first_overlapping_row
= row
;
30040 last_overlapping_row
= row
;
30048 /* Display the mode line if there is one. */
30049 if (WINDOW_WANTS_MODELINE_P (w
)
30050 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30052 && row
->y
< r
.y
+ r
.height
)
30054 if (expose_line (w
, row
, &r
))
30055 mouse_face_overwritten_p
= 1;
30058 if (!w
->pseudo_window_p
)
30060 /* Fix the display of overlapping rows. */
30061 if (first_overlapping_row
)
30062 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30065 /* Draw border between windows. */
30066 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30067 x_draw_right_divider (w
);
30069 x_draw_vertical_border (w
);
30071 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30072 x_draw_bottom_divider (w
);
30074 /* Turn the cursor on again. */
30075 if (cursor_cleared_p
30076 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30077 update_window_cursor (w
, 1);
30081 return mouse_face_overwritten_p
;
30086 /* Redraw (parts) of all windows in the window tree rooted at W that
30087 intersect R. R contains frame pixel coordinates. Value is
30088 non-zero if the exposure overwrites mouse-face. */
30091 expose_window_tree (struct window
*w
, XRectangle
*r
)
30093 struct frame
*f
= XFRAME (w
->frame
);
30094 int mouse_face_overwritten_p
= 0;
30096 while (w
&& !FRAME_GARBAGED_P (f
))
30098 if (WINDOWP (w
->contents
))
30099 mouse_face_overwritten_p
30100 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30102 mouse_face_overwritten_p
|= expose_window (w
, r
);
30104 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30107 return mouse_face_overwritten_p
;
30112 Redisplay an exposed area of frame F. X and Y are the upper-left
30113 corner of the exposed rectangle. W and H are width and height of
30114 the exposed area. All are pixel values. W or H zero means redraw
30115 the entire frame. */
30118 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30121 int mouse_face_overwritten_p
= 0;
30123 TRACE ((stderr
, "expose_frame "));
30125 /* No need to redraw if frame will be redrawn soon. */
30126 if (FRAME_GARBAGED_P (f
))
30128 TRACE ((stderr
, " garbaged\n"));
30132 /* If basic faces haven't been realized yet, there is no point in
30133 trying to redraw anything. This can happen when we get an expose
30134 event while Emacs is starting, e.g. by moving another window. */
30135 if (FRAME_FACE_CACHE (f
) == NULL
30136 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30138 TRACE ((stderr
, " no faces\n"));
30142 if (w
== 0 || h
== 0)
30145 r
.width
= FRAME_TEXT_WIDTH (f
);
30146 r
.height
= FRAME_TEXT_HEIGHT (f
);
30147 /** r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f); **/
30148 /** r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f); **/
30158 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30159 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30161 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30162 if (WINDOWP (f
->tool_bar_window
))
30163 mouse_face_overwritten_p
30164 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30167 #ifdef HAVE_X_WINDOWS
30169 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30170 if (WINDOWP (f
->menu_bar_window
))
30171 mouse_face_overwritten_p
30172 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30173 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30177 /* Some window managers support a focus-follows-mouse style with
30178 delayed raising of frames. Imagine a partially obscured frame,
30179 and moving the mouse into partially obscured mouse-face on that
30180 frame. The visible part of the mouse-face will be highlighted,
30181 then the WM raises the obscured frame. With at least one WM, KDE
30182 2.1, Emacs is not getting any event for the raising of the frame
30183 (even tried with SubstructureRedirectMask), only Expose events.
30184 These expose events will draw text normally, i.e. not
30185 highlighted. Which means we must redo the highlight here.
30186 Subsume it under ``we love X''. --gerd 2001-08-15 */
30187 /* Included in Windows version because Windows most likely does not
30188 do the right thing if any third party tool offers
30189 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30190 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30192 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30193 if (f
== hlinfo
->mouse_face_mouse_frame
)
30195 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30196 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30197 clear_mouse_face (hlinfo
);
30198 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30205 Determine the intersection of two rectangles R1 and R2. Return
30206 the intersection in *RESULT. Value is non-zero if RESULT is not
30210 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30212 XRectangle
*left
, *right
;
30213 XRectangle
*upper
, *lower
;
30214 int intersection_p
= 0;
30216 /* Rearrange so that R1 is the left-most rectangle. */
30218 left
= r1
, right
= r2
;
30220 left
= r2
, right
= r1
;
30222 /* X0 of the intersection is right.x0, if this is inside R1,
30223 otherwise there is no intersection. */
30224 if (right
->x
<= left
->x
+ left
->width
)
30226 result
->x
= right
->x
;
30228 /* The right end of the intersection is the minimum of
30229 the right ends of left and right. */
30230 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30233 /* Same game for Y. */
30235 upper
= r1
, lower
= r2
;
30237 upper
= r2
, lower
= r1
;
30239 /* The upper end of the intersection is lower.y0, if this is inside
30240 of upper. Otherwise, there is no intersection. */
30241 if (lower
->y
<= upper
->y
+ upper
->height
)
30243 result
->y
= lower
->y
;
30245 /* The lower end of the intersection is the minimum of the lower
30246 ends of upper and lower. */
30247 result
->height
= (min (lower
->y
+ lower
->height
,
30248 upper
->y
+ upper
->height
)
30250 intersection_p
= 1;
30254 return intersection_p
;
30257 #endif /* HAVE_WINDOW_SYSTEM */
30260 /***********************************************************************
30262 ***********************************************************************/
30265 syms_of_xdisp (void)
30267 Vwith_echo_area_save_vector
= Qnil
;
30268 staticpro (&Vwith_echo_area_save_vector
);
30270 Vmessage_stack
= Qnil
;
30271 staticpro (&Vmessage_stack
);
30273 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30274 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30276 message_dolog_marker1
= Fmake_marker ();
30277 staticpro (&message_dolog_marker1
);
30278 message_dolog_marker2
= Fmake_marker ();
30279 staticpro (&message_dolog_marker2
);
30280 message_dolog_marker3
= Fmake_marker ();
30281 staticpro (&message_dolog_marker3
);
30284 defsubr (&Sdump_frame_glyph_matrix
);
30285 defsubr (&Sdump_glyph_matrix
);
30286 defsubr (&Sdump_glyph_row
);
30287 defsubr (&Sdump_tool_bar_row
);
30288 defsubr (&Strace_redisplay
);
30289 defsubr (&Strace_to_stderr
);
30291 #ifdef HAVE_WINDOW_SYSTEM
30292 defsubr (&Stool_bar_height
);
30293 defsubr (&Slookup_image_map
);
30295 defsubr (&Sline_pixel_height
);
30296 defsubr (&Sformat_mode_line
);
30297 defsubr (&Sinvisible_p
);
30298 defsubr (&Scurrent_bidi_paragraph_direction
);
30299 defsubr (&Swindow_text_pixel_size
);
30300 defsubr (&Smove_point_visually
);
30302 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30303 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30304 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30305 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30306 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30307 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30308 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30309 DEFSYM (Qeval
, "eval");
30310 DEFSYM (QCdata
, ":data");
30311 DEFSYM (Qdisplay
, "display");
30312 DEFSYM (Qspace_width
, "space-width");
30313 DEFSYM (Qraise
, "raise");
30314 DEFSYM (Qslice
, "slice");
30315 DEFSYM (Qspace
, "space");
30316 DEFSYM (Qmargin
, "margin");
30317 DEFSYM (Qpointer
, "pointer");
30318 DEFSYM (Qleft_margin
, "left-margin");
30319 DEFSYM (Qright_margin
, "right-margin");
30320 DEFSYM (Qcenter
, "center");
30321 DEFSYM (Qline_height
, "line-height");
30322 DEFSYM (QCalign_to
, ":align-to");
30323 DEFSYM (QCrelative_width
, ":relative-width");
30324 DEFSYM (QCrelative_height
, ":relative-height");
30325 DEFSYM (QCeval
, ":eval");
30326 DEFSYM (QCpropertize
, ":propertize");
30327 DEFSYM (QCfile
, ":file");
30328 DEFSYM (Qfontified
, "fontified");
30329 DEFSYM (Qfontification_functions
, "fontification-functions");
30330 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30331 DEFSYM (Qescape_glyph
, "escape-glyph");
30332 DEFSYM (Qnobreak_space
, "nobreak-space");
30333 DEFSYM (Qimage
, "image");
30334 DEFSYM (Qtext
, "text");
30335 DEFSYM (Qboth
, "both");
30336 DEFSYM (Qboth_horiz
, "both-horiz");
30337 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30338 DEFSYM (QCmap
, ":map");
30339 DEFSYM (QCpointer
, ":pointer");
30340 DEFSYM (Qrect
, "rect");
30341 DEFSYM (Qcircle
, "circle");
30342 DEFSYM (Qpoly
, "poly");
30343 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30344 DEFSYM (Qgrow_only
, "grow-only");
30345 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30346 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30347 DEFSYM (Qposition
, "position");
30348 DEFSYM (Qbuffer_position
, "buffer-position");
30349 DEFSYM (Qobject
, "object");
30350 DEFSYM (Qbar
, "bar");
30351 DEFSYM (Qhbar
, "hbar");
30352 DEFSYM (Qbox
, "box");
30353 DEFSYM (Qhollow
, "hollow");
30354 DEFSYM (Qhand
, "hand");
30355 DEFSYM (Qarrow
, "arrow");
30356 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30358 list_of_error
= list1 (list2 (intern_c_string ("error"),
30359 intern_c_string ("void-variable")));
30360 staticpro (&list_of_error
);
30362 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30363 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30364 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30365 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30367 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30368 staticpro (&echo_buffer
[0]);
30369 staticpro (&echo_buffer
[1]);
30371 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30372 staticpro (&echo_area_buffer
[0]);
30373 staticpro (&echo_area_buffer
[1]);
30375 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30376 staticpro (&Vmessages_buffer_name
);
30378 mode_line_proptrans_alist
= Qnil
;
30379 staticpro (&mode_line_proptrans_alist
);
30380 mode_line_string_list
= Qnil
;
30381 staticpro (&mode_line_string_list
);
30382 mode_line_string_face
= Qnil
;
30383 staticpro (&mode_line_string_face
);
30384 mode_line_string_face_prop
= Qnil
;
30385 staticpro (&mode_line_string_face_prop
);
30386 Vmode_line_unwind_vector
= Qnil
;
30387 staticpro (&Vmode_line_unwind_vector
);
30389 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30391 help_echo_string
= Qnil
;
30392 staticpro (&help_echo_string
);
30393 help_echo_object
= Qnil
;
30394 staticpro (&help_echo_object
);
30395 help_echo_window
= Qnil
;
30396 staticpro (&help_echo_window
);
30397 previous_help_echo_string
= Qnil
;
30398 staticpro (&previous_help_echo_string
);
30399 help_echo_pos
= -1;
30401 DEFSYM (Qright_to_left
, "right-to-left");
30402 DEFSYM (Qleft_to_right
, "left-to-right");
30404 #ifdef HAVE_WINDOW_SYSTEM
30405 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30406 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30407 For example, if a block cursor is over a tab, it will be drawn as
30408 wide as that tab on the display. */);
30409 x_stretch_cursor_p
= 0;
30412 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30413 doc
: /* Non-nil means highlight trailing whitespace.
30414 The face used for trailing whitespace is `trailing-whitespace'. */);
30415 Vshow_trailing_whitespace
= Qnil
;
30417 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30418 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30419 If the value is t, Emacs highlights non-ASCII chars which have the
30420 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30421 or `escape-glyph' face respectively.
30423 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30424 U+2011 (non-breaking hyphen) are affected.
30426 Any other non-nil value means to display these characters as a escape
30427 glyph followed by an ordinary space or hyphen.
30429 A value of nil means no special handling of these characters. */);
30430 Vnobreak_char_display
= Qt
;
30432 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30433 doc
: /* The pointer shape to show in void text areas.
30434 A value of nil means to show the text pointer. Other options are
30435 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30437 Vvoid_text_area_pointer
= Qarrow
;
30439 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30440 doc
: /* Non-nil means don't actually do any redisplay.
30441 This is used for internal purposes. */);
30442 Vinhibit_redisplay
= Qnil
;
30444 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30445 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30446 Vglobal_mode_string
= Qnil
;
30448 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30449 doc
: /* Marker for where to display an arrow on top of the buffer text.
30450 This must be the beginning of a line in order to work.
30451 See also `overlay-arrow-string'. */);
30452 Voverlay_arrow_position
= Qnil
;
30454 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30455 doc
: /* String to display as an arrow in non-window frames.
30456 See also `overlay-arrow-position'. */);
30457 Voverlay_arrow_string
= build_pure_c_string ("=>");
30459 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30460 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30461 The symbols on this list are examined during redisplay to determine
30462 where to display overlay arrows. */);
30463 Voverlay_arrow_variable_list
30464 = list1 (intern_c_string ("overlay-arrow-position"));
30466 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30467 doc
: /* The number of lines to try scrolling a window by when point moves out.
30468 If that fails to bring point back on frame, point is centered instead.
30469 If this is zero, point is always centered after it moves off frame.
30470 If you want scrolling to always be a line at a time, you should set
30471 `scroll-conservatively' to a large value rather than set this to 1. */);
30473 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30474 doc
: /* Scroll up to this many lines, to bring point back on screen.
30475 If point moves off-screen, redisplay will scroll by up to
30476 `scroll-conservatively' lines in order to bring point just barely
30477 onto the screen again. If that cannot be done, then redisplay
30478 recenters point as usual.
30480 If the value is greater than 100, redisplay will never recenter point,
30481 but will always scroll just enough text to bring point into view, even
30482 if you move far away.
30484 A value of zero means always recenter point if it moves off screen. */);
30485 scroll_conservatively
= 0;
30487 DEFVAR_INT ("scroll-margin", scroll_margin
,
30488 doc
: /* Number of lines of margin at the top and bottom of a window.
30489 Recenter the window whenever point gets within this many lines
30490 of the top or bottom of the window. */);
30493 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30494 doc
: /* Pixels per inch value for non-window system displays.
30495 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30496 Vdisplay_pixels_per_inch
= make_float (72.0);
30499 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30502 DEFVAR_LISP ("truncate-partial-width-windows",
30503 Vtruncate_partial_width_windows
,
30504 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30505 For an integer value, truncate lines in each window narrower than the
30506 full frame width, provided the window width is less than that integer;
30507 otherwise, respect the value of `truncate-lines'.
30509 For any other non-nil value, truncate lines in all windows that do
30510 not span the full frame width.
30512 A value of nil means to respect the value of `truncate-lines'.
30514 If `word-wrap' is enabled, you might want to reduce this. */);
30515 Vtruncate_partial_width_windows
= make_number (50);
30517 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30518 doc
: /* Maximum buffer size for which line number should be displayed.
30519 If the buffer is bigger than this, the line number does not appear
30520 in the mode line. A value of nil means no limit. */);
30521 Vline_number_display_limit
= Qnil
;
30523 DEFVAR_INT ("line-number-display-limit-width",
30524 line_number_display_limit_width
,
30525 doc
: /* Maximum line width (in characters) for line number display.
30526 If the average length of the lines near point is bigger than this, then the
30527 line number may be omitted from the mode line. */);
30528 line_number_display_limit_width
= 200;
30530 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30531 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30532 highlight_nonselected_windows
= 0;
30534 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30535 doc
: /* Non-nil if more than one frame is visible on this display.
30536 Minibuffer-only frames don't count, but iconified frames do.
30537 This variable is not guaranteed to be accurate except while processing
30538 `frame-title-format' and `icon-title-format'. */);
30540 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30541 doc
: /* Template for displaying the title bar of visible frames.
30542 \(Assuming the window manager supports this feature.)
30544 This variable has the same structure as `mode-line-format', except that
30545 the %c and %l constructs are ignored. It is used only on frames for
30546 which no explicit name has been set \(see `modify-frame-parameters'). */);
30548 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30549 doc
: /* Template for displaying the title bar of an iconified frame.
30550 \(Assuming the window manager supports this feature.)
30551 This variable has the same structure as `mode-line-format' (which see),
30552 and is used only on frames for which no explicit name has been set
30553 \(see `modify-frame-parameters'). */);
30555 = Vframe_title_format
30556 = listn (CONSTYPE_PURE
, 3,
30557 intern_c_string ("multiple-frames"),
30558 build_pure_c_string ("%b"),
30559 listn (CONSTYPE_PURE
, 4,
30560 empty_unibyte_string
,
30561 intern_c_string ("invocation-name"),
30562 build_pure_c_string ("@"),
30563 intern_c_string ("system-name")));
30565 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30566 doc
: /* Maximum number of lines to keep in the message log buffer.
30567 If nil, disable message logging. If t, log messages but don't truncate
30568 the buffer when it becomes large. */);
30569 Vmessage_log_max
= make_number (1000);
30571 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30572 doc
: /* Functions called before redisplay, if window sizes have changed.
30573 The value should be a list of functions that take one argument.
30574 Just before redisplay, for each frame, if any of its windows have changed
30575 size since the last redisplay, or have been split or deleted,
30576 all the functions in the list are called, with the frame as argument. */);
30577 Vwindow_size_change_functions
= Qnil
;
30579 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30580 doc
: /* List of functions to call before redisplaying a window with scrolling.
30581 Each function is called with two arguments, the window and its new
30582 display-start position. Note that these functions are also called by
30583 `set-window-buffer'. Also note that the value of `window-end' is not
30584 valid when these functions are called.
30586 Warning: Do not use this feature to alter the way the window
30587 is scrolled. It is not designed for that, and such use probably won't
30589 Vwindow_scroll_functions
= Qnil
;
30591 DEFVAR_LISP ("window-text-change-functions",
30592 Vwindow_text_change_functions
,
30593 doc
: /* Functions to call in redisplay when text in the window might change. */);
30594 Vwindow_text_change_functions
= Qnil
;
30596 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30597 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30598 Each function is called with two arguments, the window and the end trigger value.
30599 See `set-window-redisplay-end-trigger'. */);
30600 Vredisplay_end_trigger_functions
= Qnil
;
30602 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30603 doc
: /* Non-nil means autoselect window with mouse pointer.
30604 If nil, do not autoselect windows.
30605 A positive number means delay autoselection by that many seconds: a
30606 window is autoselected only after the mouse has remained in that
30607 window for the duration of the delay.
30608 A negative number has a similar effect, but causes windows to be
30609 autoselected only after the mouse has stopped moving. \(Because of
30610 the way Emacs compares mouse events, you will occasionally wait twice
30611 that time before the window gets selected.\)
30612 Any other value means to autoselect window instantaneously when the
30613 mouse pointer enters it.
30615 Autoselection selects the minibuffer only if it is active, and never
30616 unselects the minibuffer if it is active.
30618 When customizing this variable make sure that the actual value of
30619 `focus-follows-mouse' matches the behavior of your window manager. */);
30620 Vmouse_autoselect_window
= Qnil
;
30622 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30623 doc
: /* Non-nil means automatically resize tool-bars.
30624 This dynamically changes the tool-bar's height to the minimum height
30625 that is needed to make all tool-bar items visible.
30626 If value is `grow-only', the tool-bar's height is only increased
30627 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30628 Vauto_resize_tool_bars
= Qt
;
30630 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30631 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30632 auto_raise_tool_bar_buttons_p
= 1;
30634 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30635 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30636 make_cursor_line_fully_visible_p
= 1;
30638 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30639 doc
: /* Border below tool-bar in pixels.
30640 If an integer, use it as the height of the border.
30641 If it is one of `internal-border-width' or `border-width', use the
30642 value of the corresponding frame parameter.
30643 Otherwise, no border is added below the tool-bar. */);
30644 Vtool_bar_border
= Qinternal_border_width
;
30646 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30647 doc
: /* Margin around tool-bar buttons in pixels.
30648 If an integer, use that for both horizontal and vertical margins.
30649 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30650 HORZ specifying the horizontal margin, and VERT specifying the
30651 vertical margin. */);
30652 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30654 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30655 doc
: /* Relief thickness of tool-bar buttons. */);
30656 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30658 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30659 doc
: /* Tool bar style to use.
30661 image - show images only
30662 text - show text only
30663 both - show both, text below image
30664 both-horiz - show text to the right of the image
30665 text-image-horiz - show text to the left of the image
30666 any other - use system default or image if no system default.
30668 This variable only affects the GTK+ toolkit version of Emacs. */);
30669 Vtool_bar_style
= Qnil
;
30671 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30672 doc
: /* Maximum number of characters a label can have to be shown.
30673 The tool bar style must also show labels for this to have any effect, see
30674 `tool-bar-style'. */);
30675 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30677 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30678 doc
: /* List of functions to call to fontify regions of text.
30679 Each function is called with one argument POS. Functions must
30680 fontify a region starting at POS in the current buffer, and give
30681 fontified regions the property `fontified'. */);
30682 Vfontification_functions
= Qnil
;
30683 Fmake_variable_buffer_local (Qfontification_functions
);
30685 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30686 unibyte_display_via_language_environment
,
30687 doc
: /* Non-nil means display unibyte text according to language environment.
30688 Specifically, this means that raw bytes in the range 160-255 decimal
30689 are displayed by converting them to the equivalent multibyte characters
30690 according to the current language environment. As a result, they are
30691 displayed according to the current fontset.
30693 Note that this variable affects only how these bytes are displayed,
30694 but does not change the fact they are interpreted as raw bytes. */);
30695 unibyte_display_via_language_environment
= 0;
30697 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30698 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30699 If a float, it specifies a fraction of the mini-window frame's height.
30700 If an integer, it specifies a number of lines. */);
30701 Vmax_mini_window_height
= make_float (0.25);
30703 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30704 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30705 A value of nil means don't automatically resize mini-windows.
30706 A value of t means resize them to fit the text displayed in them.
30707 A value of `grow-only', the default, means let mini-windows grow only;
30708 they return to their normal size when the minibuffer is closed, or the
30709 echo area becomes empty. */);
30710 Vresize_mini_windows
= Qgrow_only
;
30712 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30713 doc
: /* Alist specifying how to blink the cursor off.
30714 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30715 `cursor-type' frame-parameter or variable equals ON-STATE,
30716 comparing using `equal', Emacs uses OFF-STATE to specify
30717 how to blink it off. ON-STATE and OFF-STATE are values for
30718 the `cursor-type' frame parameter.
30720 If a frame's ON-STATE has no entry in this list,
30721 the frame's other specifications determine how to blink the cursor off. */);
30722 Vblink_cursor_alist
= Qnil
;
30724 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30725 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30726 If non-nil, windows are automatically scrolled horizontally to make
30727 point visible. */);
30728 automatic_hscrolling_p
= 1;
30729 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30731 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30732 doc
: /* How many columns away from the window edge point is allowed to get
30733 before automatic hscrolling will horizontally scroll the window. */);
30734 hscroll_margin
= 5;
30736 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30737 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30738 When point is less than `hscroll-margin' columns from the window
30739 edge, automatic hscrolling will scroll the window by the amount of columns
30740 determined by this variable. If its value is a positive integer, scroll that
30741 many columns. If it's a positive floating-point number, it specifies the
30742 fraction of the window's width to scroll. If it's nil or zero, point will be
30743 centered horizontally after the scroll. Any other value, including negative
30744 numbers, are treated as if the value were zero.
30746 Automatic hscrolling always moves point outside the scroll margin, so if
30747 point was more than scroll step columns inside the margin, the window will
30748 scroll more than the value given by the scroll step.
30750 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30751 and `scroll-right' overrides this variable's effect. */);
30752 Vhscroll_step
= make_number (0);
30754 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30755 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30756 Bind this around calls to `message' to let it take effect. */);
30757 message_truncate_lines
= 0;
30759 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30760 doc
: /* Normal hook run to update the menu bar definitions.
30761 Redisplay runs this hook before it redisplays the menu bar.
30762 This is used to update menus such as Buffers, whose contents depend on
30764 Vmenu_bar_update_hook
= Qnil
;
30766 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30767 doc
: /* Frame for which we are updating a menu.
30768 The enable predicate for a menu binding should check this variable. */);
30769 Vmenu_updating_frame
= Qnil
;
30771 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30772 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30773 inhibit_menubar_update
= 0;
30775 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30776 doc
: /* Prefix prepended to all continuation lines at display time.
30777 The value may be a string, an image, or a stretch-glyph; it is
30778 interpreted in the same way as the value of a `display' text property.
30780 This variable is overridden by any `wrap-prefix' text or overlay
30783 To add a prefix to non-continuation lines, use `line-prefix'. */);
30784 Vwrap_prefix
= Qnil
;
30785 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30786 Fmake_variable_buffer_local (Qwrap_prefix
);
30788 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30789 doc
: /* Prefix prepended to all non-continuation lines at display time.
30790 The value may be a string, an image, or a stretch-glyph; it is
30791 interpreted in the same way as the value of a `display' text property.
30793 This variable is overridden by any `line-prefix' text or overlay
30796 To add a prefix to continuation lines, use `wrap-prefix'. */);
30797 Vline_prefix
= Qnil
;
30798 DEFSYM (Qline_prefix
, "line-prefix");
30799 Fmake_variable_buffer_local (Qline_prefix
);
30801 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30802 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30803 inhibit_eval_during_redisplay
= 0;
30805 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30806 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30807 inhibit_free_realized_faces
= 0;
30810 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30811 doc
: /* Inhibit try_window_id display optimization. */);
30812 inhibit_try_window_id
= 0;
30814 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30815 doc
: /* Inhibit try_window_reusing display optimization. */);
30816 inhibit_try_window_reusing
= 0;
30818 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30819 doc
: /* Inhibit try_cursor_movement display optimization. */);
30820 inhibit_try_cursor_movement
= 0;
30821 #endif /* GLYPH_DEBUG */
30823 DEFVAR_INT ("overline-margin", overline_margin
,
30824 doc
: /* Space between overline and text, in pixels.
30825 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30826 margin to the character height. */);
30827 overline_margin
= 2;
30829 DEFVAR_INT ("underline-minimum-offset",
30830 underline_minimum_offset
,
30831 doc
: /* Minimum distance between baseline and underline.
30832 This can improve legibility of underlined text at small font sizes,
30833 particularly when using variable `x-use-underline-position-properties'
30834 with fonts that specify an UNDERLINE_POSITION relatively close to the
30835 baseline. The default value is 1. */);
30836 underline_minimum_offset
= 1;
30838 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30839 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30840 This feature only works when on a window system that can change
30841 cursor shapes. */);
30842 display_hourglass_p
= 1;
30844 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30845 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30846 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30848 #ifdef HAVE_WINDOW_SYSTEM
30849 hourglass_atimer
= NULL
;
30850 hourglass_shown_p
= 0;
30851 #endif /* HAVE_WINDOW_SYSTEM */
30853 DEFSYM (Qglyphless_char
, "glyphless-char");
30854 DEFSYM (Qhex_code
, "hex-code");
30855 DEFSYM (Qempty_box
, "empty-box");
30856 DEFSYM (Qthin_space
, "thin-space");
30857 DEFSYM (Qzero_width
, "zero-width");
30859 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30860 doc
: /* Function run just before redisplay.
30861 It is called with one argument, which is the set of windows that are to
30862 be redisplayed. This set can be nil (meaning, only the selected window),
30863 or t (meaning all windows). */);
30864 Vpre_redisplay_function
= intern ("ignore");
30866 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30867 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30869 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30870 doc
: /* Char-table defining glyphless characters.
30871 Each element, if non-nil, should be one of the following:
30872 an ASCII acronym string: display this string in a box
30873 `hex-code': display the hexadecimal code of a character in a box
30874 `empty-box': display as an empty box
30875 `thin-space': display as 1-pixel width space
30876 `zero-width': don't display
30877 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30878 display method for graphical terminals and text terminals respectively.
30879 GRAPHICAL and TEXT should each have one of the values listed above.
30881 The char-table has one extra slot to control the display of a character for
30882 which no font is found. This slot only takes effect on graphical terminals.
30883 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30884 `thin-space'. The default is `empty-box'.
30886 If a character has a non-nil entry in an active display table, the
30887 display table takes effect; in this case, Emacs does not consult
30888 `glyphless-char-display' at all. */);
30889 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30890 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30893 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30894 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30895 Vdebug_on_message
= Qnil
;
30897 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30899 Vredisplay__all_windows_cause
30900 = Fmake_vector (make_number (100), make_number (0));
30902 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30904 Vredisplay__mode_lines_cause
30905 = Fmake_vector (make_number (100), make_number (0));
30909 /* Initialize this module when Emacs starts. */
30914 CHARPOS (this_line_start_pos
) = 0;
30916 if (!noninteractive
)
30918 struct window
*m
= XWINDOW (minibuf_window
);
30919 Lisp_Object frame
= m
->frame
;
30920 struct frame
*f
= XFRAME (frame
);
30921 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30922 struct window
*r
= XWINDOW (root
);
30925 echo_area_window
= minibuf_window
;
30927 r
->top_line
= FRAME_TOP_MARGIN (f
);
30928 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30929 r
->total_cols
= FRAME_COLS (f
);
30930 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30931 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30932 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30934 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
30935 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30936 m
->total_cols
= FRAME_COLS (f
);
30937 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30938 m
->total_lines
= 1;
30939 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30941 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30942 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30943 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30945 /* The default ellipsis glyphs `...'. */
30946 for (i
= 0; i
< 3; ++i
)
30947 default_invis_vector
[i
] = make_number ('.');
30951 /* Allocate the buffer for frame titles.
30952 Also used for `format-mode-line'. */
30954 mode_line_noprop_buf
= xmalloc (size
);
30955 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30956 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30957 mode_line_target
= MODE_LINE_DISPLAY
;
30960 help_echo_showing_p
= 0;
30963 #ifdef HAVE_WINDOW_SYSTEM
30965 /* Platform-independent portion of hourglass implementation. */
30967 /* Timer function of hourglass_atimer. */
30970 show_hourglass (struct atimer
*timer
)
30972 /* The timer implementation will cancel this timer automatically
30973 after this function has run. Set hourglass_atimer to null
30974 so that we know the timer doesn't have to be canceled. */
30975 hourglass_atimer
= NULL
;
30977 if (!hourglass_shown_p
)
30979 Lisp_Object tail
, frame
;
30983 FOR_EACH_FRAME (tail
, frame
)
30985 struct frame
*f
= XFRAME (frame
);
30987 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
30988 && FRAME_RIF (f
)->show_hourglass
)
30989 FRAME_RIF (f
)->show_hourglass (f
);
30992 hourglass_shown_p
= 1;
30997 /* Cancel a currently active hourglass timer, and start a new one. */
31000 start_hourglass (void)
31002 struct timespec delay
;
31004 cancel_hourglass ();
31006 if (INTEGERP (Vhourglass_delay
)
31007 && XINT (Vhourglass_delay
) > 0)
31008 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31009 TYPE_MAXIMUM (time_t)),
31011 else if (FLOATP (Vhourglass_delay
)
31012 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31013 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31015 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31017 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31018 show_hourglass
, NULL
);
31021 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31025 cancel_hourglass (void)
31027 if (hourglass_atimer
)
31029 cancel_atimer (hourglass_atimer
);
31030 hourglass_atimer
= NULL
;
31033 if (hourglass_shown_p
)
31035 Lisp_Object tail
, frame
;
31039 FOR_EACH_FRAME (tail
, frame
)
31041 struct frame
*f
= XFRAME (frame
);
31043 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31044 && FRAME_RIF (f
)->hide_hourglass
)
31045 FRAME_RIF (f
)->hide_hourglass (f
);
31047 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31048 else if (!FRAME_W32_P (f
))
31049 w32_arrow_cursor ();
31053 hourglass_shown_p
= 0;
31058 #endif /* HAVE_WINDOW_SYSTEM */